-
Glenn Vorhes authoredGlenn Vorhes authored
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
MapMoveCls.html 23.33 KiB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: MapMoveCls</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: MapMoveCls</h1>
<section>
<header>
<h2>MapMoveCls</h2>
<div class="class-description">assists with map move interactions, trigger callback functions</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="MapMoveCls"><span class="type-signature"></span>new MapMoveCls<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
constructor called implicitly
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapMoveCls.js.html">olHelpers/mapMoveCls.js</a>, <a href="olHelpers_mapMoveCls.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="MapInteractionBase.html">MapInteractionBase</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="initialized"><span class="type-signature"></span>initialized<span class="type-signature"></span></h4>
<div class="description">
get if is initialized
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="MapInteractionBase.html#initialized">MapInteractionBase#initialized</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapInteractionBase.js.html">olHelpers/mapInteractionBase.js</a>, <a href="olHelpers_mapInteractionBase.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<h4 class="name" id="map"><span class="type-signature"></span>map<span class="type-signature"></span></h4>
<div class="description">
get reference to the ol map object
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="MapInteractionBase.html#map">MapInteractionBase#map</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapInteractionBase.js.html">olHelpers/mapInteractionBase.js</a>, <a href="olHelpers_mapInteractionBase.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="mapExtent"><span class="type-signature"></span>mapExtent<span class="type-signature"></span></h4>
<div class="description">
return the map extent
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapMoveCls.js.html">olHelpers/mapMoveCls.js</a>, <a href="olHelpers_mapMoveCls.js.html#line83">line 83</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="_checkInit"><span class="type-signature">(protected) </span>_checkInit<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Check the initialization status and throw exception if not valid yet
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="MapInteractionBase.html#_checkInit">MapInteractionBase#_checkInit</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapInteractionBase.js.html">olHelpers/mapInteractionBase.js</a>, <a href="olHelpers_mapInteractionBase.js.html#line59">line 59</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addCallback"><span class="type-signature"></span>addCallback<span class="signature">(func, context, delay<span class="signature-attributes">opt</span>, triggerOnAdd<span class="signature-attributes">opt</span>, functionId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
add a callback to the map move event
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>func</code></td>
<td class="type">
<span class="param-type"><a href="global.html#mapMoveCallbackFunction">mapMoveCallbackFunction</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">callback function</td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">the context to use for this function</td>
</tr>
<tr>
<td class="name"><code>delay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
50
</td>
<td class="description last">the delay before call load</td>
</tr>
<tr>
<td class="name"><code>triggerOnAdd</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">if the layer should be loaded on add to mapMove</td>
</tr>
<tr>
<td class="name"><code>functionId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">optional id to reference the function later for outside triggering</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapMoveCls.js.html">olHelpers/mapMoveCls.js</a>, <a href="olHelpers_mapMoveCls.js.html#line252">line 252</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addVectorLayer"><span class="type-signature"></span>addVectorLayer<span class="signature">(lyr, triggerOnAdd<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Add a layer to the interaction
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>lyr</code></td>
<td class="type">
<span class="param-type"><a href="LayerBaseVector.html">LayerBaseVector</a></span>
|
<span class="param-type">*</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">layer to add</td>
</tr>
<tr>
<td class="name"><code>triggerOnAdd</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">if the layer should be loaded on add</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapMoveCls.js.html">olHelpers/mapMoveCls.js</a>, <a href="olHelpers_mapMoveCls.js.html#line209">line 209</a>
</li></ul></dd>
</dl>
<h4 class="name" id="checkInit"><span class="type-signature"></span>checkInit<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Check the initialization status and throw exception if not valid yet
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="MapInteractionBase.html#checkInit">MapInteractionBase#checkInit</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapInteractionBase.js.html">olHelpers/mapInteractionBase.js</a>, <a href="olHelpers_mapInteractionBase.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
<h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(theMap)</span><span class="type-signature"></span></h4>
<div class="description">
initialize the map move object
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>theMap</code></td>
<td class="type">
<span class="param-type">ol.Map</span>
</td>
<td class="description last">the ol map</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="MapInteractionBase.html#init">MapInteractionBase#init</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapMoveCls.js.html">olHelpers/mapMoveCls.js</a>, <a href="olHelpers_mapMoveCls.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h4 class="name" id="triggerLyrLoad"><span class="type-signature"></span>triggerLyrLoad<span class="signature">(lyr, index<span class="signature-attributes">opt</span>, eventType<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Trigger the layer load
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th> </tr>
</thead>
<tbody>
<tr>
<td class="name"><code>lyr</code></td>
<td class="type">
<span class="param-type"><a href="LayerBaseVector.html">LayerBaseVector</a></span>
|
<span class="param-type">*</span>
</td>
<td class="attributes">
</td>
<td class="description last">the layer being acted on</td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">index of the layer</td>
</tr>
<tr>
<td class="name"><code>eventType</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">*</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">the event triggering the load, as 'change:center' or 'change:resolution'</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapMoveCls.js.html">olHelpers/mapMoveCls.js</a>, <a href="olHelpers_mapMoveCls.js.html#line97">line 97</a>
</li></ul></dd>
</dl>
<h4 class="name" id="triggerMoveCallback"><span class="type-signature"></span>triggerMoveCallback<span class="signature">(ind, eventType<span class="signature-attributes">opt</span>, functionId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
trigger the map move call back at the given index
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ind</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="description last">the index of the layer</td>
</tr>
<tr>
<td class="name"><code>eventType</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">*</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">the event triggering the load as 'change:center' or 'change:resolution'</td>
</tr>
<tr>
<td class="name"><code>functionId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">the function id used to reference the added callback function</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapMoveCls.js.html">olHelpers/mapMoveCls.js</a>, <a href="olHelpers_mapMoveCls.js.html#line166">line 166</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="-_FeatureLayerProperties.html">_FeatureLayerProperties</a></li><li><a href="-_Slider.html">_Slider</a></li><li><a href="CommonSymbol.html">CommonSymbol</a></li><li><a href="DayRange.html">DayRange</a></li><li><a href="ItsLayerCollection.html">ItsLayerCollection</a></li><li><a href="LayerBase.html">LayerBase</a></li><li><a href="LayerBaseVector.html">LayerBaseVector</a></li><li><a href="LayerBaseVectorEsri.html">LayerBaseVectorEsri</a></li><li><a href="LayerBaseVectorGeoJson.html">LayerBaseVectorGeoJson</a></li><li><a href="LayerBaseXyzTile.html">LayerBaseXyzTile</a></li><li><a href="LayerEsriMapServer.html">LayerEsriMapServer</a></li><li><a href="LayerEsriTile.html">LayerEsriTile</a></li><li><a href="LayerGroup.html">LayerGroup</a></li><li><a href="LayerItsInventory.html">LayerItsInventory</a></li><li><a href="LayerLegend.html">LayerLegend</a></li><li><a href="LayerRealEarthTile.html">LayerRealEarthTile</a></li><li><a href="LayerSwipe.html">LayerSwipe</a></li><li><a href="LayerVectorRealEarth.html">LayerVectorRealEarth</a></li><li><a href="MapInteractionBase.html">MapInteractionBase</a></li><li><a href="MapMoveCls.html">MapMoveCls</a></li><li><a href="MapPopupCls.html">MapPopupCls</a></li><li><a href="RealEarthAnimate.html">RealEarthAnimate</a></li><li><a href="RealEarthAnimateTile.html">RealEarthAnimateTile</a></li><li><a href="RealEarthAnimateVector.html">RealEarthAnimateVector</a></li><li><a href="SingleSymbol.html">SingleSymbol</a></li><li><a href="Sliders.html">Sliders</a></li><li><a href="SortedFeatures.html">SortedFeatures</a></li><li><a href="UniqueValueSymbol.html">UniqueValueSymbol</a></li></ul><h3>Global</h3><ul><li><a href="global.html#bundleEs2015Multiple">bundleEs2015Multiple</a></li><li><a href="global.html#dateToYyyyMmDdHh000">dateToYyyyMmDdHh000</a></li><li><a href="global.html#dateToYyyyMmDdHhMmSs">dateToYyyyMmDdHhMmSs</a></li><li><a href="global.html#definedAndNotNull">definedAndNotNull</a></li><li><a href="global.html#defineLegend">defineLegend</a></li><li><a href="global.html#defineStyle">defineStyle</a></li><li><a href="global.html#gulp">gulp</a></li><li><a href="global.html#hexAlphaToRgbOrRgba">hexAlphaToRgbOrRgba</a></li><li><a href="global.html#htmlEscape">htmlEscape</a></li><li><a href="global.html#keyValPairs">keyValPairs</a></li><li><a href="global.html#makeBlueGreenRedGradient">makeBlueGreenRedGradient</a></li><li><a href="global.html#makeBlueGreenRedGradientZScore">makeBlueGreenRedGradientZScore</a></li><li><a href="global.html#makeFeatureServiceLegendAndSymbol">makeFeatureServiceLegendAndSymbol</a></li><li><a href="global.html#makeGuid">makeGuid</a></li><li><a href="global.html#makeMapServiceLegend">makeMapServiceLegend</a></li><li><a href="global.html#mapServiceLegendItem">mapServiceLegendItem</a></li><li><a href="global.html#offsetMinutes">offsetMinutes</a></li><li><a href="global.html#processLessFile">processLessFile</a></li><li><a href="global.html#propertiesZoomStyle">propertiesZoomStyle</a></li><li><a href="global.html#provide">provide</a></li><li><a href="global.html#quickMap">quickMap</a></li><li><a href="global.html#quickMapBase">quickMapBase</a></li><li><a href="global.html#quickMapMulti">quickMapMulti</a></li><li><a href="global.html#resolutionToZoom">resolutionToZoom</a></li><li><a href="global.html#rgb2hex">rgb2hex</a></li><li><a href="global.html#rgbToRgba">rgbToRgba</a></li><li><a href="global.html#triggerCallback">triggerCallback</a></li><li><a href="global.html#undefinedOrNull">undefinedOrNull</a></li><li><a href="global.html#zoomToResolution">zoomToResolution</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jun 07 2016 12:31:53 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>