ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
14530c26219788c277ab9f3a0d30ddb77844a10f
openlayers/files/OpenLayers/Tile/WFS-js.html
crschmidt 14530c2621 Generate More docs, new docs. 
git-svn-id: http://svn.openlayers.org/sandbox/tschaub/naturaldocs/doc@3392 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2007-06-21 00:29:02 +00:00

47 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><title>OpenLayers.Tile.WFS - OpenLayers</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script></head><body class=UnframedPage onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.35 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td class=MenuSection valign=top><!--START_ND_MENU--><div class=MTitle>OpenLayers<div class=MSubTitle>JavaScript Mapping Library</div></div><div class=MEntry><div class=MFile><a href="../../OpenLayers-js.html">OpenLayers</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">OpenLayers</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="../BaseTypes-js.html">Base Types</a></div></div><div class=MEntry><div class=MFile><a href="../Console-js.html">Console</a></div></div><div class=MEntry><div class=MFile><a href="../Control-js.html">Control.js</a></div></div><div class=MEntry><div class=MFile><a href="../Format-js.html">Format</a></div></div><div class=MEntry><div class=MFile><a href="../Geometry-js.html">Geometry</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Geometry</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../Geometry/Collection-js.html">Collection</a></div></div><div class=MEntry><div class=MFile><a href="../Geometry/MultiLineString-js.html">MultiLineString</a></div></div><div class=MEntry><div class=MFile><a href="../Geometry/MultiPoint-js.html">MultiPoint</a></div></div><div class=MEntry><div class=MFile><a href="../Geometry/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="../Geometry/Polygon-js.html">Polygon</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Layer-js.html">Layer</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Layer</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../Layer/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/WMS-js.html">WMS</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Map-js.html">Map</a></div></div><div class=MEntry><div class=MFile><a href="../Marker-js.html">Marker</a></div></div><div class=MEntry><div class=MFile><a href="../Tile-js.html">Tile</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Tile</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile id=MSelected>WFS</div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Index</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MIndex><a href="../../../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Constants.html">Constants</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Properties.html">Properties</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Files.html">Files</a></div></div></div></div></div><script language=JavaScript><!--
if (document.getElementById){for (var menu = 1; menu < 6; menu++){if (menu != 3 && menu != 4 && menu != 2 && menu != 1){document.getElementById("MGroupContent" + menu).style.display = "none";};};}// --></script><!--END_ND_MENU--></td>
<td class=ContentSection valign=top><div class=CClass id=MainTopic><div class=CTopic><h1 class=CTitle><a name="OpenLayers.Tile.WFS"></a>OpenLayers.<span class=HB> </span>Tile.WFS</h1><div class=CBody><p class=CParagraph>Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers.&nbsp; Create a new image tile with the <a href="#OpenLayers.Tile.WFS.OpenLayers.Tile.WFS" class=LFunction id=link9 onMouseOver="ShowTip(event, 'tt1', 'link9')" onMouseOut="HideTip('tt1')">OpenLayers.Tile.WFS</a> constructor.&nbsp; Inherits from <a href="../Tile-js.html#OpenLayers.Tile" class=LClass id=link10 onMouseOver="ShowTip(event, 'tt9', 'link10')" onMouseOut="HideTip('tt9')">OpenLayers.Tile</a>.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr><td class=SEntrySize><div class=SMain><div class=SEntry><a href="#OpenLayers.Tile.WFS" >OpenLayers.<span class=HB> </span>Tile.WFS</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription>Instances of OpenLayers.Tile.WFS are used to manage the image tiles used by various layers. </div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Tile.WFS.Properties" >Properties</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.features" >features</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Array(&lt;OpenLayers.Feature&gt;)} list of features in this tile</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.url" >url</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String}</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Tile.WFS.Functions" >Functions</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.OpenLayers.Tile.WFS" >OpenLayers.<span class=HB> </span>Tile.WFS</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Constructor for a new <a href="#OpenLayers.Tile.WFS.OpenLayers.Tile.WFS" class=LFunction id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">OpenLayers.Tile.WFS</a> instance.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.destroy" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">destroy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>nullify references to prevent circular references and memory leaks</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.clear" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">clear</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Clear the tile of any bounds/position-related data so that it can be reused in a new location.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.draw" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">draw</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Check that a tile should be drawn, and load features for it.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.loadFeaturesForRegion" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">loadFeaturesForRegion</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>get the full request string from the ds and the tile params and call the AJAX loadURL().</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.requestSuccess" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">requestSuccess</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Called on return from request succcess. </div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.addResults" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">addResults</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Construct new feature via layer featureClass constructor, and add to this.features.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Tile.WFS.destroyAllFeatures" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">destroyAllFeatures</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Iterate through and call destroy() on each feature, removing it from the local array</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.Properties"></a>Properties</h3></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.features"></a>features</h3><div class=CBody><p class=CParagraph>{Array(&lt;OpenLayers.Feature&gt;)} list of features in this tile</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.url"></a>url</h3><div class=CBody><p class=CParagraph>{String}</p></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.Functions"></a>Functions</h3></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.OpenLayers.Tile.WFS"></a>OpenLayers.<span class=HB> </span>Tile.WFS</h3><div class=CBody><p class=CParagraph>Constructor for a new <a href="#OpenLayers.Tile.WFS.OpenLayers.Tile.WFS" class=LFunction id=link11 onMouseOver="ShowTip(event, 'tt1', 'link11')" onMouseOut="HideTip('tt1')">OpenLayers.Tile.WFS</a> instance.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{<a href="../Layer-js.html#OpenLayers.Layer" class=LClass >OpenLayers.Layer</a>} layer that the tile will go in.</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription>{<a href="../BaseTypes-js.html#OpenLayers.Pixel" class=LClass id=link12 onMouseOver="ShowTip(event, 'tt10', 'link12')" onMouseOut="HideTip('tt10')">OpenLayers.Pixel</a>}</td></tr><tr><td class=CDLEntry>bounds</td><td class=CDLDescription>{<a href="../BaseTypes-js.html#OpenLayers.Bounds" class=LClass id=link13 onMouseOver="ShowTip(event, 'tt11', 'link13')" onMouseOut="HideTip('tt11')">OpenLayers.Bounds</a>}</td></tr><tr><td class=CDLEntry>url</td><td class=CDLDescription>{&lt;String&gt;}</td></tr><tr><td class=CDLEntry>size</td><td class=CDLDescription>{<a href="../BaseTypes-js.html#OpenLayers.Size" class=LClass id=link14 onMouseOver="ShowTip(event, 'tt12', 'link14')" onMouseOut="HideTip('tt12')">OpenLayers.Size</a>}</td></tr></table></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy: function()</td></tr></table></blockquote><p class=CParagraph>nullify references to prevent circular references and memory leaks</p></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.clear"></a>clear</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>clear: function()</td></tr></table></blockquote><p class=CParagraph>Clear the tile of any bounds/position-related data so that it can be reused in a new location.</p></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.draw"></a>draw</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>draw:function()</td></tr></table></blockquote><p class=CParagraph>Check that a tile should be drawn, and load features for it.</p></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.loadFeaturesForRegion"></a>loadFeaturesForRegion</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>loadFeaturesForRegion:function(</td><td class=PParameter nowrap>success,</td></tr><tr><td></td><td class=PParameter nowrap>failure</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>get the full request string from the ds and the tile params and call the AJAX loadURL().</p><p class=CParagraph>Input are function pointers for what to do on success and failure.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>success</td><td class=CDLDescription>{function}</td></tr><tr><td class=CDLEntry>failure</td><td class=CDLDescription>{function}</td></tr></table></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.requestSuccess"></a>requestSuccess</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>requestSuccess:function(</td><td class=PParameter nowrap>request</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Called on return from request succcess.&nbsp; Adds results via layer.addFeatures in vector mode, addResults otherwise.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>request</td><td class=CDLDescription>{XMLHttpRequest}</td></tr></table></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.addResults"></a>addResults</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addResults: function(</td><td class=PParameter nowrap>results</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Construct new feature via layer featureClass constructor, and add to this.features.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>results</td><td class=CDLDescription>{Object}</td></tr></table></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Tile.WFS.destroyAllFeatures"></a>destroyAllFeatures</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroyAllFeatures: function()</td></tr></table></blockquote><p class=CParagraph>Iterate through and call destroy() on each feature, removing it from the local array</p><p class=CParagraph>@private</p></div></div></div>
</td>
</tr></table><div class=Footer><!--START_ND_FOOTER-->Generated by <a href="http://www.naturaldocs.org">Natural Docs</a><!--END_ND_FOOTER--></div>
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction>Constructor for a new OpenLayers.Tile.WFS instance.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy: function()</td></tr></table></blockquote>nullify references to prevent circular references and memory leaks</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>clear: function()</td></tr></table></blockquote>Clear the tile of any bounds/position-related data so that it can be reused in a new location.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>draw:function()</td></tr></table></blockquote>Check that a tile should be drawn, and load features for it.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>loadFeaturesForRegion:function(</td><td class=PParameter nowrap>success,</td></tr><tr><td></td><td class=PParameter nowrap>failure</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>get the full request string from the ds and the tile params and call the AJAX loadURL().</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>requestSuccess:function(</td><td class=PParameter nowrap>request</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Called on return from request succcess. </div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>addResults: function(</td><td class=PParameter nowrap>results</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Construct new feature via layer featureClass constructor, and add to this.features.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroyAllFeatures: function()</td></tr></table></blockquote>Iterate through and call destroy() on each feature, removing it from the local array</div></div><div class=CToolTip id="tt9"><div class=CClass>This is a class designed to designate a single tile, however it is explicitly designed to do relatively little. </div></div><div class=CToolTip id="tt10"><div class=CClass>This class represents a screen coordinate, in x and y coordinates</div></div><div class=CToolTip id="tt11"><div class=CClass>Instances of this class represent bounding boxes. </div></div><div class=CToolTip id="tt12"><div class=CClass>Instances of this class represent a width/height pair</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
Reference in New Issue View Git Blame Copy Permalink