1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
3 <html><head><title>OpenLayers.Control.Snapping - OpenLayers</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script><script language=JavaScript src="../../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
4 if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
6 <!-- Generated by Natural Docs, version 1.4 -->
7 <!-- http://www.naturaldocs.org -->
9 <!-- saved from url=(0026)http://www.naturaldocs.org -->
14 <div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="OpenLayers.Control.Snapping"></a>OpenLayers.<wbr>Control.<wbr>Snapping</h1><div class=CBody><p>Acts as a snapping agent while editing vector features.</p><h4 class=CHeading>Inherits from</h4><ul><li><a href="../Control-js.html#OpenLayers.Control" class=LClass id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')">OpenLayers.Control</a></li></ul><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#OpenLayers.Control.Snapping" >OpenLayers.<wbr>Control.<wbr>Snapping</a></td><td class=SDescription>Acts as a snapping agent while editing vector features.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Control.Snapping.Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.EVENT_TYPES" >EVENT_TYPES</a></td><td class=SDescription>{Array(String)} Supported application event types. </td></tr><tr class="SConstant SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.DEFAULTS" >DEFAULTS</a></td><td class=SDescription>Default target properties.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Control.Snapping.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.greedy" >greedy</a></td><td class=SDescription>{Boolean} Snap to closest feature in first layer with an eligible feature. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.precedence" >precedence</a></td><td class=SDescription>{Array} List representing precedence of different snapping types. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.resolution" >resolution</a></td><td class=SDescription>{Float} The map resolution for the previously considered snap.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.geoToleranceCache" >geoToleranceCache</a></td><td class=SDescription>{Object} A cache of geo-tolerances. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.layer" >layer</a></td><td class=SDescription>{<a href="../Layer/Vector-js.html#OpenLayers.Layer.Vector" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">OpenLayers.Layer.Vector</a>} The current editable layer. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.feature" >feature</a></td><td class=SDescription>{<a href="../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">OpenLayers.Feature.Vector</a>} The current editable feature.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.point" >point</a></td><td class=SDescription>{<a href="../Geometry/Point-js.html#OpenLayers.Geometry.Point" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">OpenLayers.Geometry.Point</a>} The currently snapped vertex.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Control.Snapping.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SConstructor SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.OpenLayers.Control.Snapping" >OpenLayers.<wbr>Control.<wbr>Snapping</a></td><td class=SDescription>Creates a new snapping control. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Control.Snapping.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.setLayer" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">setLayer</a></td><td class=SDescription>Set the editable layer. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.setTargets" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">setTargets</a></td><td class=SDescription>Set the targets for the snapping agent.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.addTargetLayer" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">addTargetLayer</a></td><td class=SDescription>Add a target layer with the default target config.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.addTarget" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">addTarget</a></td><td class=SDescription>Add a configured target layer.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.removeTargetLayer" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">removeTargetLayer</a></td><td class=SDescription>Remove a target layer.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.removeTarget" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">removeTarget</a></td><td class=SDescription>Remove a target.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.activate" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">activate</a></td><td class=SDescription>Activate the control. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.deactivate" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">deactivate</a></td><td class=SDescription>Deactivate the control. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.onSketchModified" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">onSketchModified</a></td><td class=SDescription>Registered as a listener for the sketchmodified event on the editable layer.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.onVertexModified" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">onVertexModified</a></td><td class=SDescription>Registered as a listener for the vertexmodified event on the editable layer.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.considerSnapping" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">considerSnapping</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.testTarget" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">testTarget</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Control.Snapping.getGeoTolerance" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">getGeoTolerance</a></td><td class=SDescription>Calculate a tolerance in map units given a tolerance in pixels. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Control.Snapping.destroy" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')">destroy</a></td><td class=SDescription>Clean up the control.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
16 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.Constants"></a>Constants</h3></div></div>
18 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.EVENT_TYPES"></a>EVENT_TYPES</h3><div class=CBody><p>{Array(String)} Supported application event types. Register a listener for a particular event with the following syntax:</p><blockquote><pre>control.events.register(type, obj, listener);</pre></blockquote><p>Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened.</p><h4 class=CHeading>Supported control event types (in addition to those from <a href="../Control-js.html#OpenLayers.Control" class=LClass id=link19 onMouseOver="ShowTip(event, 'tt18', 'link19')" onMouseOut="HideTip('tt18')">OpenLayers.Control</a>)</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>beforesnap</td><td class=CDLDescription>Triggered before a snap occurs. Listeners receive an event object with <b>point</b>, <b>x</b>, <b>y</b>, <b>distance</b>, <b>layer</b>, and <b>snapType</b> properties. The point property will be original point geometry considered for snapping. The x and y properties represent coordinates the point will receive. The distance is the distance of the snap. The layer is the target layer. The snapType property will be one of “node”, “vertex”, or “edge”. Return false to stop snapping from occurring.</td></tr><tr><td class=CDLEntry>snap</td><td class=CDLDescription>Triggered when a snap occurs. Listeners receive an event with <b>point</b>, <b>snapType</b>, <b>layer</b>, and <b>distance</b> properties. The point will be the location snapped to. The snapType will be one of “node”, “vertex”, or “edge”. The layer will be the target layer. The distance will be the distance of the snap in map units.</td></tr><tr><td class=CDLEntry>unsnap</td><td class=CDLDescription>Triggered when a vertex is unsnapped. Listeners receive an event with a <b>point</b> property.</td></tr></table></div></div></div>
20 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.DEFAULTS"></a>DEFAULTS</h3><div class=CBody><p>Default target properties.</p></div></div></div>
22 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.Properties"></a>Properties</h3></div></div>
24 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.greedy"></a>greedy</h3><div class=CBody><p>{Boolean} Snap to closest feature in first layer with an eligible feature. Default is true.</p></div></div></div>
26 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.precedence"></a>precedence</h3><div class=CBody><p>{Array} List representing precedence of different snapping types. Default is “node”, “vertex”, “edge”.</p></div></div></div>
28 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.resolution"></a>resolution</h3><div class=CBody><p>{Float} The map resolution for the previously considered snap.</p></div></div></div>
30 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.geoToleranceCache"></a>geoToleranceCache</h3><div class=CBody><p>{Object} A cache of geo-tolerances. Tolerance values (in map units) are calculated when the map resolution changes.</p></div></div></div>
32 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.layer"></a>layer</h3><div class=CBody><p>{<a href="../Layer/Vector-js.html#OpenLayers.Layer.Vector" class=LClass id=link20 onMouseOver="ShowTip(event, 'tt1', 'link20')" onMouseOut="HideTip('tt1')">OpenLayers.Layer.Vector</a>} The current editable layer. Set at construction or after construction with <a href="#OpenLayers.Control.Snapping.setLayer" class=LFunction id=link21 onMouseOver="ShowTip(event, 'tt4', 'link21')" onMouseOut="HideTip('tt4')">setLayer</a>.</p></div></div></div>
34 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.feature"></a>feature</h3><div class=CBody><p>{<a href="../Feature/Vector-js.html#OpenLayers.Feature.Vector" class=LClass id=link22 onMouseOver="ShowTip(event, 'tt2', 'link22')" onMouseOut="HideTip('tt2')">OpenLayers.Feature.Vector</a>} The current editable feature.</p></div></div></div>
36 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.point"></a>point</h3><div class=CBody><p>{<a href="../Geometry/Point-js.html#OpenLayers.Geometry.Point" class=LClass id=link23 onMouseOver="ShowTip(event, 'tt3', 'link23')" onMouseOut="HideTip('tt3')">OpenLayers.Geometry.Point</a>} The currently snapped vertex.</p></div></div></div>
38 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.Constructor"></a>Constructor</h3></div></div>
40 <div class="CConstructor"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.OpenLayers.Control.Snapping"></a>OpenLayers.<wbr>Control.<wbr>Snapping</h3><div class=CBody><p>Creates a new snapping control. A control is constructed with an editable layer and a set of configuration objects for target layers. While the control is active, dragging vertices while drawing new features or modifying existing features on the editable layer will engage snapping to features on the target layers. Whether a vertex snaps to a feature on a target layer depends on the target layer configuration.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} An object containing all configuration properties for the control.</td></tr></table><h4 class=CHeading>Valid options</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{OpenLayers.Layer.Vector} The editable layer. Features from this layer that are digitized or modified may have vertices snapped to features from any of the target layers.</td></tr><tr><td class=CDLEntry>targets</td><td class=CDLDescription>{Array(Object | OpenLayers.Layer.Vector)} A list of objects for configuring target layers. See valid properties of the target objects below. If the items in the targets list are vector layers (instead of configuration objects), the defaults from the <defaults> property will apply. The editable layer itself may be a target</td></tr><tr><td class=CDLEntry>layer</td><td class=CDLDescription>allowing newly created or edited features to be snapped to existing features from the same layer. If no targets are provided the layer given in the constructor (as <a href="#OpenLayers.Control.Snapping.layer" class=LProperty id=link24 onMouseOver="ShowTip(event, 'tt19', 'link24')" onMouseOut="HideTip('tt19')">layer</a>) will become the initial target.</td></tr><tr><td class=CDLEntry>defaults</td><td class=CDLDescription>{Object} An object with default properties to be applied to all target objects.</td></tr><tr><td class=CDLEntry>greedy</td><td class=CDLDescription>{Boolean} Snap to closest feature in first target layer that applies. Default is true. If false, all features in all target layers will be checked and the closest feature in all target layers will be chosen. The greedy property determines if the order of the target layers is significant. By default, the order of the target layers is significant where layers earlier in the target layer list have precedence over layers later in the list. Within a single layer, the closest feature is always chosen for snapping. This property only determines whether the search for a closer feature continues after an eligible feature is found in a target layer.</td></tr></table><h4 class=CHeading>Valid target properties</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{OpenLayers.Layer.Vector} A target layer. Features from this layer will be eligible to act as snapping target for the editable layer.</td></tr><tr><td class=CDLEntry>tolerance</td><td class=CDLDescription>{Float} The distance (in pixels) at which snapping may occur. Default is 10.</td></tr><tr><td class=CDLEntry>node</td><td class=CDLDescription>{Boolean} Snap to nodes (first or last point in a geometry) in target layer. Default is true.</td></tr><tr><td class=CDLEntry>nodeTolerance</td><td class=CDLDescription>{Float} Optional distance at which snapping may occur for nodes specifically. If none is provided, <tolerance> will be used.</td></tr><tr><td class=CDLEntry>vertex</td><td class=CDLDescription>{Boolean} Snap to vertices in target layer. Default is true.</td></tr><tr><td class=CDLEntry>vertexTolerance</td><td class=CDLDescription>{Float} Optional distance at which snapping may occur for vertices specifically. If none is provided, <tolerance> will be used.</td></tr><tr><td class=CDLEntry>edge</td><td class=CDLDescription>{Boolean} Snap to edges in target layer. Default is true.</td></tr><tr><td class=CDLEntry>edgeTolerance</td><td class=CDLDescription>{Float} Optional distance at which snapping may occur for edges specifically. If none is provided, <tolerance> will be used.</td></tr><tr><td class=CDLEntry>filter</td><td class=CDLDescription>{OpenLayers.Filter} Optional filter to evaluate to determine if feature is eligible for snapping. If filter evaluates to true for a target feature a vertex may be snapped to the feature.</td></tr></table></div></div></div>
42 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.Functions"></a>Functions</h3></div></div>
44 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.setLayer"></a>setLayer</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>setLayer: function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the editable layer. Call the setLayer method if the editable layer changes and the same control should be used on a new editable layer. If the control is already active, it will be active after the new layer is set.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>layer</td><td class=CDLDescription>{OpenLayers.Layer.Vector} The new editable layer.</td></tr></table></div></div></div>
46 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.setTargets"></a>setTargets</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>setTargets: function(</td><td class=PParameter nowrap>targets</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the targets for the snapping agent.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>targets</td><td class=CDLDescription>{Array} An array of target configs or target layers.</td></tr></table></div></div></div>
48 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.addTargetLayer"></a>addTargetLayer</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>addTargetLayer: function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Add a target layer with the default target config.</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/Vector-js.html#OpenLayers.Layer.Vector" class=LClass id=link25 onMouseOver="ShowTip(event, 'tt1', 'link25')" onMouseOut="HideTip('tt1')">OpenLayers.Layer.Vector</a>} A target layer.</td></tr></table></div></div></div>
50 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.addTarget"></a>addTarget</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>addTarget: function(</td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Add a configured target layer.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>target</td><td class=CDLDescription>{Object} A target config.</td></tr></table></div></div></div>
52 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.removeTargetLayer"></a>removeTargetLayer</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>removeTargetLayer: function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Remove a target layer.</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/Vector-js.html#OpenLayers.Layer.Vector" class=LClass id=link26 onMouseOver="ShowTip(event, 'tt1', 'link26')" onMouseOut="HideTip('tt1')">OpenLayers.Layer.Vector</a>} The target layer to remove.</td></tr></table></div></div></div>
54 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.removeTarget"></a>removeTarget</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>removeTarget: function(</td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Remove a target.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>target</td><td class=CDLDescription>{Object} A target config.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Array} The targets array.</p></div></div></div>
56 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.activate"></a>activate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>activate: function()</td></tr></table></blockquote><p>Activate the control. Activating the control registers listeners for editing related events so that during feature creation and modification, moving vertices will trigger snapping.</p></div></div></div>
58 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.deactivate"></a>deactivate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>deactivate: function()</td></tr></table></blockquote><p>Deactivate the control. Deactivating the control unregisters listeners so feature editing may proceed without engaging the snapping agent.</p></div></div></div>
60 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.onSketchModified"></a>onSketchModified</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>onSketchModified: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Registered as a listener for the sketchmodified event on the editable layer.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>{Object} The sketch modified event.</td></tr></table></div></div></div>
62 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.onVertexModified"></a>onVertexModified</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>onVertexModified: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Registered as a listener for the vertexmodified event on the editable layer.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>{Object} The vertex modified event.</td></tr></table></div></div></div>
64 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.considerSnapping"></a>considerSnapping</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>considerSnapping: function(</td><td class=PParameter nowrap>point,</td></tr><tr><td></td><td class=PParameter nowrap>loc</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>point</td><td class=CDLDescription>{<OpenLayers.Geometry.Point}} The vertex to be snapped (or unsnapped).</td></tr><tr><td class=CDLEntry>loc</td><td class=CDLDescription>{<a href="../Geometry/Point-js.html#OpenLayers.Geometry.Point" class=LClass id=link27 onMouseOver="ShowTip(event, 'tt3', 'link27')" onMouseOut="HideTip('tt3')">OpenLayers.Geometry.Point</a>} The location of the mouse in map coords.</td></tr></table></div></div></div>
66 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.testTarget"></a>testTarget</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>testTarget: function(</td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>loc</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>target</td><td class=CDLDescription>{Object} Object with target layer configuration.</td></tr><tr><td class=CDLEntry>loc</td><td class=CDLDescription>{<a href="../Geometry/Point-js.html#OpenLayers.Geometry.Point" class=LClass id=link28 onMouseOver="ShowTip(event, 'tt3', 'link28')" onMouseOut="HideTip('tt3')">OpenLayers.Geometry.Point</a>} The location of the mouse in map coords.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Object} A result object with rank, dist, x, and y properties. Returns null if candidate is not eligible for snapping.</p></div></div></div>
68 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.getGeoTolerance"></a>getGeoTolerance</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>getGeoTolerance: function(</td><td class=PParameter nowrap>tolerance</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Calculate a tolerance in map units given a tolerance in pixels. This takes advantage of the <a href="#OpenLayers.Control.Snapping.geoToleranceCache" class=LProperty id=link29 onMouseOver="ShowTip(event, 'tt20', 'link29')" onMouseOut="HideTip('tt20')">geoToleranceCache</a> when the map resolution has not changed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>tolerance</td><td class=CDLDescription>{Number} A tolerance value in pixels.</td></tr></table><h4 class=CHeading>Returns</h4><p>{Number} A tolerance value in map units.</p></div></div></div>
70 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Snapping.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>Clean up the control.</p></div></div></div>
75 <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
78 <div id=Menu><div class=MTitle>OpenLayers<div class=MSubTitle>JavaScript Mapping Library</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent29')">OpenLayers</a><div class=MGroupContent id=MGroupContent29><div class=MEntry><div class=MFile><a href="../../OpenLayers-js.html">OpenLayers</a></div></div><div class=MEntry><div class=MFile><a href="../Ajax-js.html">Ajax</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">BaseTypes</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../BaseTypes-js.html">Base Types</a></div></div><div class=MEntry><div class=MFile><a href="../BaseTypes/Bounds-js.html">Bounds</a></div></div><div class=MEntry><div class=MFile><a href="../BaseTypes/Class-js.html">Class</a></div></div><div class=MEntry><div class=MFile><a href="../BaseTypes/Element-js.html">Element</a></div></div><div class=MEntry><div class=MFile><a href="../BaseTypes/LonLat-js.html">LonLat</a></div></div><div class=MEntry><div class=MFile><a href="../BaseTypes/Pixel-js.html">Pixel</a></div></div><div class=MEntry><div class=MFile><a href="../BaseTypes/Size-js.html">Size</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Console-js.html">Console</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Control</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../Control-js.html">Control</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Control</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="ArgParser-js.html">ArgParser</a></div></div><div class=MEntry><div class=MFile><a href="Attribution-js.html">Attribution</a></div></div><div class=MEntry><div class=MFile><a href="Button-js.html">Button</a></div></div><div class=MEntry><div class=MFile><a href="DragFeature-js.html">DragFeature</a></div></div><div class=MEntry><div class=MFile><a href="DragPan-js.html">DragPan</a></div></div><div class=MEntry><div class=MFile><a href="DrawFeature-js.html">DrawFeature</a></div></div><div class=MEntry><div class=MFile><a href="EditingToolbar-js.html">EditingToolbar</a></div></div><div class=MEntry><div class=MFile><a href="GetFeature-js.html">GetFeature</a></div></div><div class=MEntry><div class=MFile><a href="KeyboardDefaults-js.html">KeyboardDefaults</a></div></div><div class=MEntry><div class=MFile><a href="LayerSwitcher-js.html">LayerSwitcher</a></div></div><div class=MEntry><div class=MFile><a href="Measure-js.html">Measure</a></div></div><div class=MEntry><div class=MFile><a href="ModifyFeature-js.html">ModifyFeature</a></div></div><div class=MEntry><div class=MFile><a href="MouseDefaults-js.html">MouseDefaults</a></div></div><div class=MEntry><div class=MFile><a href="MousePosition-js.html">MousePosition</a></div></div><div class=MEntry><div class=MFile><a href="MouseToolbar-js.html">MouseToolbar</a></div></div><div class=MEntry><div class=MFile><a href="Navigation-js.html">Navigation</a></div></div><div class=MEntry><div class=MFile><a href="NavigationHistory-js.html">NavigationHistory</a></div></div><div class=MEntry><div class=MFile><a href="NavToolbar-js.html">NavToolbar</a></div></div><div class=MEntry><div class=MFile><a href="OverviewMap-js.html">OverviewMap</a></div></div><div class=MEntry><div class=MFile><a href="Pan-js.html">Pan</a></div></div><div class=MEntry><div class=MFile><a href="Panel-js.html">Panel</a></div></div><div class=MEntry><div class=MFile><a href="PanPanel-js.html">PanPanel</a></div></div><div class=MEntry><div class=MFile><a href="PanZoom-js.html">PanZoom</a></div></div><div class=MEntry><div class=MFile><a href="PanZoomBar-js.html">PanZoomBar</a></div></div><div class=MEntry><div class=MFile><a href="Permalink-js.html">Permalink</a></div></div><div class=MEntry><div class=MFile><a href="Scale-js.html">Scale</a></div></div><div class=MEntry><div class=MFile><a href="ScaleLine-js.html">ScaleLine</a></div></div><div class=MEntry><div class=MFile><a href="SelectFeature-js.html">SelectFeature</a></div></div><div class=MEntry><div class=MFile id=MSelected>Snapping</div></div><div class=MEntry><div class=MFile><a href="Split-js.html">Split</a></div></div><div class=MEntry><div class=MFile><a href="WMSGetFeatureInfo-js.html">WMSGetFeatureInfo</a></div></div><div class=MEntry><div class=MFile><a href="ZoomBox-js.html">ZoomBox</a></div></div><div class=MEntry><div class=MFile><a href="ZoomIn-js.html">ZoomIn</a></div></div><div class=MEntry><div class=MFile><a href="ZoomOut-js.html">ZoomOut</a></div></div><div class=MEntry><div class=MFile><a href="ZoomPanel-js.html">ZoomPanel</a></div></div><div class=MEntry><div class=MFile><a href="ZoomToMaxExtent-js.html">ZoomToMaxExtent</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Events-js.html">Events</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Feature</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="../Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="../Feature/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="../Feature/WFS-js.html">WFS</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Filter</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="../Filter-js.html">Filter</a></div></div><div class=MEntry><div class=MFile><a href="../Filter/Comparison-js.html">Comparison</a></div></div><div class=MEntry><div class=MFile><a href="../Filter/FeatureId-js.html">FeatureId</a></div></div><div class=MEntry><div class=MFile><a href="../Filter/Logical-js.html">Logical</a></div></div><div class=MEntry><div class=MFile><a href="../Filter/Spatial-js.html">Spatial</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent14')">Format</a><div class=MGroupContent id=MGroupContent14><div class=MEntry><div class=MFile><a href="../Format-js.html">Format</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Filter</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="../Format/Filter-js.html">Filter</a></div></div><div class=MEntry><div class=MFile><a href="../Format/Filter/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../Format/Filter/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../Format/Filter/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">GML</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MFile><a href="../Format/GML-js.html">GML</a></div></div><div class=MEntry><div class=MFile><a href="../Format/GML/Base-js.html">Base</a></div></div><div class=MEntry><div class=MFile><a href="../Format/GML/v2-js.html">v2</a></div></div><div class=MEntry><div class=MFile><a href="../Format/GML/v3-js.html">v3</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent8')">SLD</a><div class=MGroupContent id=MGroupContent8><div class=MEntry><div class=MFile><a href="../Format/SLD-js.html">SLD</a></div></div><div class=MEntry><div class=MFile><a href="../Format/SLD/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../Format/SLD/v1_0_0-js.html">v1_0_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent9')">WMC</a><div class=MGroupContent id=MGroupContent9><div class=MEntry><div class=MFile><a href="../Format/WMC-js.html">WMC</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WMC/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WMC/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WMC/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent13')">Format</a><div class=MGroupContent id=MGroupContent13><div class=MEntry><div class=MFile><a href="../Format/ArcXML-js.html">ArcXML</a></div></div><div class=MEntry><div class=MFile><a href="../Format/ArcXML/Features-js.html">ArcXML.<wbr>Features</a></div></div><div class=MEntry><div class=MFile><a href="../Format/GeoJSON-js.html">GeoJSON</a></div></div><div class=MEntry><div class=MFile><a href="../Format/GeoRSS-js.html">GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="../Format/GPX-js.html">GPX</a></div></div><div class=MEntry><div class=MFile><a href="../Format/JSON-js.html">JSON</a></div></div><div class=MEntry><div class=MFile><a href="../Format/KML-js.html">KML</a></div></div><div class=MEntry><div class=MFile><a href="../Format/OSM-js.html">OSM</a></div></div><div class=MEntry><div class=MFile><a href="../Format/Text-js.html">Text</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WFSCapabilities-js.html">WFSCapabilities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent10')">WFSCapabilities</a><div class=MGroupContent id=MGroupContent10><div class=MEntry><div class=MFile><a href="../Format/WFSCapabilities/v1-js.html">WFSCapabilities.v1</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WFSCapabilities/v1_0_0-js.html">WFSCapabilities/<wbr>v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WFSCapabilities/v1_1_0-js.html">WFSCapabilities/<wbr>v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Format/WFSDescribeFeatureType-js.html">WFSDescribeFeatureType.js</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent11')">WFST</a><div class=MGroupContent id=MGroupContent11><div class=MEntry><div class=MFile><a href="../Format/WFST-js.html">WFST</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WFST/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WFST/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WFST/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Format/WKT-js.html">WKT</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WMSCapabilities-js.html">WMSCapabilities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent12')">WMSCapabilities</a><div class=MGroupContent id=MGroupContent12><div class=MEntry><div class=MFile><a href="../Format/WMSCapabilities/v1_1-js.html">WMSCapabilities.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WMSCapabilities/v1_1_0-js.html">WMSCapabilities/<wbr>v1_1_0</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WMSCapabilities/v1_1_1-js.html">WMSCapabilities/<wbr>v1_1_1</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Format/WMSDescribeLayer-js.html">WMSDescribeLayer</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WMSDescribeLayer/v1_1-js.html">WMSDescribeLayer.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="../Format/WMSGetFeatureInfo-js.html">WMSGetFeatureInfo</a></div></div><div class=MEntry><div class=MFile><a href="../Format/XML-js.html">XML</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent15')">Geometry</a><div class=MGroupContent id=MGroupContent15><div class=MEntry><div class=MFile><a href="../Geometry-js.html">Geometry</a></div></div><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/Curve-js.html">Curve</a></div></div><div class=MEntry><div class=MFile><a href="../Geometry/LinearRing-js.html">LinearRing</a></div></div><div class=MEntry><div class=MFile><a href="../Geometry/LineString-js.html">LineString</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/MultiPolygon-js.html">MultiPolygon</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 class=MEntry><div class=MFile><a href="../Geometry/Rectangle-js.html">Rectangle</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent16')">Handler</a><div class=MGroupContent id=MGroupContent16><div class=MEntry><div class=MFile><a href="../Handler-js.html">Handler</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/Box-js.html">Box</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/Click-js.html">Click</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/Drag-js.html">Drag</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/Hover-js.html">Hover</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/Keyboard-js.html">Keyboard</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/MouseWheel-js.html">MouseWheel</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/Path-js.html">Path</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/Polygon-js.html">Polygon</a></div></div><div class=MEntry><div class=MFile><a href="../Handler/RegularPolygon-js.html">RegularPolygon</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Icon-js.html">Icon</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent17')">Lang</a><div class=MGroupContent id=MGroupContent17><div class=MEntry><div class=MFile><a href="../Lang-js.html">Lang</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/ca-js.html">ca</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/cs-CZ-js.html">cs-CZ</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/da-DK-js.html">da-DK</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/de-js.html">de</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/en-js.html">en</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/en-CA-js.html">en-CA</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/es-js.html">es</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/fr-js.html">fr</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/it-js.html">it</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/nb-js.html">nb</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/nl-js.html">nl</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/pt-BR-js.html">pt-BR</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/sv-SE-js.html">sv-SE</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/zh-CN-js.html">zh-CN</a></div></div><div class=MEntry><div class=MFile><a href="../Lang/zh-TW-js.html">zh-TW</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent19')">Layer</a><div class=MGroupContent id=MGroupContent19><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('MGroupContent18')">Layer</a><div class=MGroupContent id=MGroupContent18><div class=MEntry><div class=MFile><a href="../Layer/ArcGIS93Rest-js.html">ArcGIS93Rest</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/Boxes-js.html">Boxes</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/EventPane-js.html">EventPane</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/FixedZoomLevels-js.html">FixedZoomLevels</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/GeoRSS-js.html">GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/GML-js.html">GML</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/Google-js.html">Google</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/Grid-js.html">Grid</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/HTTPRequest-js.html">HTTPRequest</a></div></div><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/KaMap-js.html">KaMap</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/KaMapCache-js.html">KaMapCache</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/MapGuide-js.html">MapGuide</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/MapServer-js.html">MapServer</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/MapServer/Untiled-js.html">MapServer.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/Markers-js.html">Markers</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/MultiMap-js.html">MultiMap</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/PointTrack-js.html">PointTrack</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/SphericalMercator-js.html">SphericalMercator</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/Text-js.html">Text</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/TileCache-js.html">TileCache</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/TMS-js.html">TMS</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/Vector/RootContainer-js.html">Vector.<wbr>RootContainer</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/VirtualEarth-js.html">VirtualEarth</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/WMS-js.html">WMS</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/WMS/Untiled-js.html">WMS.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/WorldWind-js.html">WorldWind</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/Yahoo-js.html">Yahoo</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/ArcIMS-js.html">ArcIMS</a></div></div><div class=MEntry><div class=MFile><a href="../Layer/XYZ-js.html">XYZ</a></div></div></div></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=MGroup><a href="javascript:ToggleMenu('MGroupContent20')">Marker</a><div class=MGroupContent id=MGroupContent20><div class=MEntry><div class=MFile><a href="../Marker-js.html">Marker</a></div></div><div class=MEntry><div class=MFile><a href="../Marker/Box-js.html">Box</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent21')">Popup</a><div class=MGroupContent id=MGroupContent21><div class=MEntry><div class=MFile><a href="../Popup-js.html">Popup</a></div></div><div class=MEntry><div class=MFile><a href="../Popup/Anchored-js.html">Anchored</a></div></div><div class=MEntry><div class=MFile><a href="../Popup/AnchoredBubble-js.html">AnchoredBubble</a></div></div><div class=MEntry><div class=MFile><a href="../Popup/Framed-js.html">Framed</a></div></div><div class=MEntry><div class=MFile><a href="../Popup/FramedCloud-js.html">FramedCloud</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Projection-js.html">Projection</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent24')">Protocol</a><div class=MGroupContent id=MGroupContent24><div class=MEntry><div class=MFile><a href="../Protocol-js.html">Protocol</a></div></div><div class=MEntry><div class=MFile><a href="../Protocol/HTTP-js.html">HTTP</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent22')">SQL</a><div class=MGroupContent id=MGroupContent22><div class=MEntry><div class=MFile><a href="../Protocol/SQL-js.html">SQL</a></div></div><div class=MEntry><div class=MFile><a href="../Protocol/SQL/Gears-js.html">Gears</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent23')">WFS</a><div class=MGroupContent id=MGroupContent23><div class=MEntry><div class=MFile><a href="../Protocol/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="../Protocol/WFS/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="../Protocol/WFS/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="../Protocol/WFS/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent25')">Renderer</a><div class=MGroupContent id=MGroupContent25><div class=MEntry><div class=MFile><a href="../Renderer-js.html">Renderer</a></div></div><div class=MEntry><div class=MFile><a href="../Renderer/Canvas-js.html">Canvas</a></div></div><div class=MEntry><div class=MFile><a href="../Renderer/Elements-js.html">Elements</a></div></div><div class=MEntry><div class=MFile><a href="../Renderer/SVG-js.html">SVG</a></div></div><div class=MEntry><div class=MFile><a href="../Renderer/VML-js.html">VML</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent26')">Request</a><div class=MGroupContent id=MGroupContent26><div class=MEntry><div class=MFile><a href="../Request-js.html">Request</a></div></div><div class=MEntry><div class=MFile><a href="../Request/XMLHttpRequest-js.html">XMLHttpRequest</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Rule-js.html">Rule</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent27')">Strategy</a><div class=MGroupContent id=MGroupContent27><div class=MEntry><div class=MFile><a href="../Strategy-js.html">Strategy</a></div></div><div class=MEntry><div class=MFile><a href="../Strategy/BBOX-js.html">BBOX</a></div></div><div class=MEntry><div class=MFile><a href="../Strategy/Cluster-js.html">Cluster</a></div></div><div class=MEntry><div class=MFile><a href="../Strategy/Fixed-js.html">Fixed</a></div></div><div class=MEntry><div class=MFile><a href="../Strategy/Paging-js.html">Paging</a></div></div><div class=MEntry><div class=MFile><a href="../Strategy/Save-js.html">Save</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Style-js.html">Style</a></div></div><div class=MEntry><div class=MFile><a href="../StyleMap-js.html">StyleMap</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent28')">Tile</a><div class=MGroupContent id=MGroupContent28><div class=MEntry><div class=MFile><a href="../Tile-js.html">Tile</a></div></div><div class=MEntry><div class=MFile><a href="../Tile/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="../Tile/WFS-js.html">WFS</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../Tween-js.html">Tween</a></div></div><div class=MEntry><div class=MFile><a href="../Util-js.html">Util</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent30')">Index</a><div class=MGroupContent id=MGroupContent30><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 class=MEntry><div class=MIndex><a href="../../../index/Constructor.html">Constructor</a></div></div></div></div></div><script type="text/javascript"><!--
79 var searchPanel = new SearchPanel("searchPanel", "HTML", "../../../search");
80 --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Constants">Constants</option><option value="Constructor">Constructor</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Properties">Properties</option></select></div><script language=JavaScript><!--
81 HideAllBut([2, 3, 29], 31);// --></script></div><!--Menu-->
85 <!--START_ND_TOOLTIPS-->
86 <div class=CToolTip id="tt1"><div class=CClass>Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources. </div></div><div class=CToolTip id="tt2"><div class=CClass>Vector features use the OpenLayers.Geometry classes as geometry description. </div></div><div class=CToolTip id="tt3"><div class=CClass>Point geometry class.</div></div><div class=CToolTip id="tt4"><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>setLayer: function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Set the editable layer. </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>setTargets: function(</td><td class=PParameter nowrap>targets</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Set the targets for the snapping agent.</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>addTargetLayer: function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Add a target layer with the default target config.</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>addTarget: function(</td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Add a configured target layer.</div></div><div class=CToolTip id="tt8"><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>removeTargetLayer: function(</td><td class=PParameter nowrap>layer</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Remove a target layer.</div></div><div class=CToolTip id="tt9"><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>removeTarget: function(</td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Remove a target.</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>activate: function()</td></tr></table></blockquote>Activate the control. </div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>deactivate: function()</td></tr></table></blockquote>Deactivate the control. </div></div><div class=CToolTip id="tt12"><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>onSketchModified: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Registered as a listener for the sketchmodified event on the editable layer.</div></div><div class=CToolTip id="tt13"><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>onVertexModified: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Registered as a listener for the vertexmodified event on the editable layer.</div></div><div class=CToolTip id="tt14"><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>considerSnapping: function(</td><td class=PParameter nowrap>point,</td></tr><tr><td></td><td class=PParameter nowrap>loc</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt15"><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>testTarget: function(</td><td class=PParameter nowrap>target,</td></tr><tr><td></td><td class=PParameter nowrap>loc</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt16"><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>getGeoTolerance: function(</td><td class=PParameter nowrap>tolerance</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Calculate a tolerance in map units given a tolerance in pixels. </div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy: function()</td></tr></table></blockquote>Clean up the control.</div></div><div class=CToolTip id="tt18"><div class=CClass>Controls affect the display or behavior of the map. </div></div><div class=CToolTip id="tt19"><div class=CProperty>{OpenLayers.Layer.Vector} The current editable layer. </div></div><div class=CToolTip id="tt20"><div class=CProperty>{Object} A cache of geo-tolerances. </div></div><!--END_ND_TOOLTIPS-->
91 <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
94 <script language=JavaScript><!--
95 if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>