-
Glenn Vorhes authoredGlenn Vorhes authored
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
MapPopupCls.html 29.09 KiB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: MapPopupCls</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: MapPopupCls</h1>
<section>
<header>
<h2>MapPopupCls</h2>
<div class="class-description">map popup class</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="MapPopupCls"><span class="type-signature"></span>new MapPopupCls<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
map popup constructor
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line47">line 47</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="_passThroughLayerFeatureArray"><span class="type-signature"></span>_passThroughLayerFeatureArray<span class="type-signature"> :Array.<<a href="-_FeatureLayerProperties.html">_FeatureLayerProperties</a>></span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="-_FeatureLayerProperties.html">_FeatureLayerProperties</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line102">line 102</a>
</li></ul></dd>
</dl>
<h4 class="name" id="_passThroughLayerFeatureArray"><span class="type-signature"></span>_passThroughLayerFeatureArray<span class="type-signature"> :Array.<<a href="-_FeatureLayerProperties.html">_FeatureLayerProperties</a>></span></h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="-_FeatureLayerProperties.html">_FeatureLayerProperties</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line173">line 173</a>
</li></ul></dd>
</dl>
<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>
<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="addMapClickFunction"><span class="type-signature"></span>addMapClickFunction<span class="signature">(func)</span><span class="type-signature"></span></h4>
<div class="description">
Add a function to be called when the map is clicked but before any popups are implemented
</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>func</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">the map click 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_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line486">line 486</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addMapServicePopup"><span class="type-signature"></span>addMapServicePopup<span class="signature">(lyr, selectionStyle<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {object}</span></h4>
<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="LayerEsriMapServer.html">LayerEsriMapServer</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">map server layer</td>
</tr>
<tr>
<td class="name"><code>selectionStyle</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{}
</td>
<td class="description last">the selection style configuration
<h6>Properties</h6>
<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>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
rgba(255,170,0,0.5)
</td>
<td class="description last">the selection color</td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
10
</td>
<td class="description last">the selection width for linear features</td>
</tr>
<tr>
<td class="name"><code>olStyle</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">an openlayers style object or function</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line465">line 465</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
a reference to the ol selection layer
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="addMapServicePopupContent"><span class="type-signature"></span>addMapServicePopupContent<span class="signature">(feature, lyr, popupContent, esriName)</span><span class="type-signature"></span></h4>
<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>feature</code></td>
<td class="type">
<span class="param-type">ol.Feature</span>
</td>
<td class="description last">the ol feature</td>
</tr>
<tr>
<td class="name"><code>lyr</code></td>
<td class="type">
<span class="param-type"><a href="LayerEsriMapServer.html">LayerEsriMapServer</a></span>
</td>
<td class="description last">the map server layer</td>
</tr>
<tr>
<td class="name"><code>popupContent</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">popup content</td>
</tr>
<tr>
<td class="name"><code>esriName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">esri layer name</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line296">line 296</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addPopupChangedFunction"><span class="type-signature"></span>addPopupChangedFunction<span class="signature">(chgFunction)</span><span class="type-signature"></span></h4>
<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>chgFunction</code></td>
<td class="type">
<span class="param-type"><a href="global.html#popupChangedFunction">popupChangedFunction</a></span>
</td>
<td class="description last">popup change 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_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line352">line 352</a>
</li></ul></dd>
</dl>
<h4 class="name" id="addVectorPopup"><span class="type-signature"></span>addVectorPopup<span class="signature">(lyr, popupContentFunction, selectionStyle<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {object}</span></h4>
<div class="description">
Add popup to the map
</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="LayerBase.html">LayerBase</a></span>
|
<span class="param-type">*</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">The layer that the popup with act on</td>
</tr>
<tr>
<td class="name"><code>popupContentFunction</code></td>
<td class="type">
<span class="param-type"><a href="global.html#popupCallback">popupCallback</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">popup content function that makes popup info</td>
</tr>
<tr>
<td class="name"><code>selectionStyle</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
{}
</td>
<td class="description last">the selection style configuration
<h6>Properties</h6>
<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>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
rgba(255,170,0,0.5)
</td>
<td class="description last">the selection color</td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
10
</td>
<td class="description last">the selection width for linear features</td>
</tr>
<tr>
<td class="name"><code>olStyle</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">function</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
</td>
<td class="description last">an openlayers style object or function</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line427">line 427</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
a reference to the ol selection layer
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</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">
map popup initialization
</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_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line113">line 113</a>
</li></ul></dd>
</dl>
<h4 class="name" id="removeVectorPopup"><span class="type-signature"></span>removeVectorPopup<span class="signature">(lyr)</span><span class="type-signature"></span></h4>
<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>lyr</code></td>
<td class="type">
<span class="param-type"><a href="LayerBase.html">LayerBase</a></span>
</td>
<td class="description last">layer</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="olHelpers_mapPopupCls.js.html">olHelpers/mapPopupCls.js</a>, <a href="olHelpers_mapPopupCls.js.html#line442">line 442</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#$">$</a></li><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#getUrlParams">getUrlParams</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#overflowScroll">overflowScroll</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#responsiveScroll">responsiveScroll</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#windowScroll">windowScroll</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 Thu Jun 23 2016 08:20:56 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>