Skip to content
Snippets Groups Projects
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
global.html 119.24 KiB
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</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">Global</h1>

    




<section>

<header>
    
        <h2></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

        


<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>


        
    
    </div>

    

    

    

     

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 11/3/2015.
</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#line6">line 6</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 11/3/2015.
</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#line5">line 5</a>
    </li></ul></dd>
    

    
    

    
</dl>






        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 11/2/2015.
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="layers_LayerBaseVectorGeoJson.js.html">layers/LayerBaseVectorGeoJson.js</a>, <a href="layers_LayerBaseVectorGeoJson.js.html#line4">line 4</a>
    </li></ul></dd>
    

    

    

    
</dl>





        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 12/16/2015.
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="collections_LayerLegend.js.html">collections/LayerLegend.js</a>, <a href="collections_LayerLegend.js.html#line4">line 4</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>



<div class="description">
    Created by gavorhes on 12/4/2015.
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="layers_LayerBaseXyzTile.js.html">layers/LayerBaseXyzTile.js</a>, <a href="layers_LayerBaseXyzTile.js.html#line4">line 4</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 12/15/2015.
</div>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="olHelpers_quickMapBase.js.html">olHelpers/quickMapBase.js</a>, <a href="olHelpers_quickMapBase.js.html#line9">line 9</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 11/2/2015.
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="jquery-plugin_rangeChange.js.html">jquery-plugin/rangeChange.js</a>, <a href="jquery-plugin_rangeChange.js.html#line7">line 7</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 11/2/2015.
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="layers_LayerBaseVectorEsri.js.html">layers/LayerBaseVectorEsri.js</a>, <a href="layers_LayerBaseVectorEsri.js.html#line4">line 4</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 12/7/2015.
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="layers_LayerEsriMapServer.js.html">layers/LayerEsriMapServer.js</a>, <a href="layers_LayerEsriMapServer.js.html#line4">line 4</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 12/8/2015.
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="layers_LayerItsInventory.js.html">layers/LayerItsInventory.js</a>, <a href="layers_LayerItsInventory.js.html#line5">line 5</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="$"><span class="type-signature">(constant) </span>$<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 11/4/2015.
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="layers_LayerRealEarthTile.js.html">layers/LayerRealEarthTile.js</a>, <a href="layers_LayerRealEarthTile.js.html#line5">line 5</a>
    </li></ul></dd>
    

    

    
    
</dl>






        
            
<h4 class="name" id="offsetMinutes"><span class="type-signature"></span>offsetMinutes<span class="type-signature"> :number</span></h4>




<div class="description">
    The GMT offset time in minutes
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="mixin_RealEarthAnimate.js.html">mixin/RealEarthAnimate.js</a>, <a href="mixin_RealEarthAnimate.js.html#line14">line 14</a>
    </li></ul></dd>
    

    
    

    
</dl>






        
            
<h4 class="name" id="ol"><span class="type-signature">(constant) </span>ol<span class="type-signature"></span></h4>




<div class="description">
    Created by gavorhes on 4/26/2016.
</div>







<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="custom-ol.js.html">custom-ol.js</a>, <a href="custom-ol.js.html#line8">line 8</a>
    </li></ul></dd>
    

    

    

    
</dl>





        
            
<h4 class="name" id="returnedColors"><span class="type-signature"></span>returnedColors<span class="type-signature"> :Array</span></h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="jquery-plugin_ssaCorridorPicker.js.html">jquery-plugin/ssaCorridorPicker.js</a>, <a href="jquery-plugin_ssaCorridorPicker.js.html#line32">line 32</a>
    </li></ul></dd>
    

    

    

    
</dl>





        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    <h4 class="name" id="dateToYyyyMmDdHh000"><span class="type-signature"></span>dateToYyyyMmDdHh000<span class="signature">(dte)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    Given a date return a string in the format YYYYmmdd_hh0000
</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>dte</code></td>
            

            <td class="type">
            
                
<span class="param-type">Date</span>


            
            </td>

            

            
            <td class="description last">the input date</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_dateConvert.js.html">util/dateConvert.js</a>, <a href="util_dateConvert.js.html#line43">line 43</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    the formatted date string
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="dateToYyyyMmDdHhMmSs"><span class="type-signature"></span>dateToYyyyMmDdHhMmSs<span class="signature">(dte)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    Given a date return a string in the format YYYY-mm-dd hh:MM:SS
</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>dte</code></td>
            
            <td class="type">
            
                
<span class="param-type">Date</span>


            
            </td>

            

            

            <td class="description last">to convert</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_dateConvert.js.html">util/dateConvert.js</a>, <a href="util_dateConvert.js.html#line24">line 24</a>
    </li></ul></dd>
    

    

    

    
</dl>












<h5>Returns:</h5>

        
<div class="param-desc">
    the formatted date string
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="definedAndNotNull"><span class="type-signature"></span>definedAndNotNull<span class="signature">(input)</span><span class="type-signature"> &rarr; {boolean}</span></h4>

    



<div class="description">
    check if the input is defined and not null
</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>input</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">input pointer</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_checkDefined.js.html">util/checkDefined.js</a>, <a href="util_checkDefined.js.html#line26">line 26</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    true defined and not null
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="defineLegend"><span class="type-signature"></span>defineLegend<span class="signature">(itsIcon<span class="signature-attributes">opt</span>, itsLineStyle<span class="signature-attributes">opt</span>, itsIconConfig<span class="signature-attributes">opt</span>, itsLineConfig<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>

    











    <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>itsIcon</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">the ITS device type icon image see http://transportal.cee.wisc.edu/its/inventory/icons/</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>itsLineStyle</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">A single line style
                <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">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">the line color as rgb or hex</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    5
                
                </td>
            

            <td class="description last">the line width</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>itsIconConfig</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">The icon subtype 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>prop</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">The property used to define icon attribute symbolization</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>defaultName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">The default name to be used if no other match is found</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaultIcon</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">The default icon to be used for no other matches</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>iconArray</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    []
                
                </td>
            

            <td class="description last">an array, items with format [property, name, img]</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>itsLineConfig</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">The property used to define icon attribute symbolization
                <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>prop</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">The property used to define icon attribute symbolization</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaultName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    Other
                
                </td>
            

            <td class="description last">The default name to be used if no other match is found</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaultColor</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    red
                
                </td>
            
            <td class="description last">The default line color to be used for no other matches</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaultWidth</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    5
                
                </td>
            

            <td class="description last">The default line width to be used for no other matches</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lineArray</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            
            
                <td class="default">
                
                    []
                
                </td>
            

            <td class="description last">an array, items with format [property, name, color, optional width]</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="layers_LayerItsInventory.js.html">layers/LayerItsInventory.js</a>, <a href="layers_LayerItsInventory.js.html#line171">line 171</a>
    </li></ul></dd>
    

    

    

    
</dl>












<h5>Returns:</h5>

        
<div class="param-desc">
    html to be added to the legend
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="defineStyle"><span class="type-signature"></span>defineStyle<span class="signature">(itsIcon<span class="signature-attributes">opt</span>, itsLineStyle<span class="signature-attributes">opt</span>, itsIconConfig<span class="signature-attributes">opt</span>, itsLineConfig<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {*}</span></h4>

    











    <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>itsIcon</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">the ITS device type icon image see http://transportal.cee.wisc.edu/its/inventory/icons/</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>itsLineStyle</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">A single line style
                <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">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">the line color as rgb or hex</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    5
                
                </td>
            

            <td class="description last">the line width</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>itsIconConfig</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">The icon subtype 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>prop</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">The property used to define icon attribute symbolization</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaultName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>

            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">The default name to be used if no other match is found</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaultIcon</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">The default icon to be used for no other matches</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>iconArray</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>

            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    []
                
                </td>
            

            <td class="description last">an array, items with format [property, name, img]</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>itsLineConfig</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">The property used to define icon attribute symbolization
                <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>prop</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">The property used to define icon attribute symbolization</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaultName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>
            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    Other
                
                </td>
            

            <td class="description last">The default name to be used if no other match is found</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaultColor</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    red
                
                </td>
            

            <td class="description last">The default line color to be used for no other matches</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>defaultWidth</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    5
                
                </td>
            

            <td class="description last">The default line width to be used for no other matches</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lineArray</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    []
                
                </td>
            

            <td class="description last">an array, items with format [property, name, color, optional width]</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="layers_LayerItsInventory.js.html">layers/LayerItsInventory.js</a>, <a href="layers_LayerItsInventory.js.html#line86">line 86</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>
        
<div class="param-desc">
    undefined, style, or style function
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">*</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="hexAlphaToRgbOrRgba"><span class="type-signature"></span>hexAlphaToRgbOrRgba<span class="signature">(hexString, alphaVal<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    Convert hex string to RGB or RGBA string
</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>hexString</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">hex color string</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>alphaVal</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">Alpha value</td>
        </tr>

    
    </tbody>
</table>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_colors.js.html">util/colors.js</a>, <a href="util_colors.js.html#line41">line 41</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    - rgb or rgba color
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="highwayConvert"><span class="type-signature"></span>highwayConvert<span class="signature">(inputString)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    take the verbose string and turn it into a padded 00 and direction hwy
</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>inputString</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">the input string</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="jquery-plugin_rpPicker.js.html">jquery-plugin/rpPicker.js</a>, <a href="jquery-plugin_rpPicker.js.html#line24">line 24</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    converted highway string
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="htmlEscape"><span class="type-signature"></span>htmlEscape<span class="signature">(str)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    escape html charcters
</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>str</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">input string</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="olHelpers_esriToOlStyle.js.html">olHelpers/esriToOlStyle.js</a>, <a href="olHelpers_esriToOlStyle.js.html#line27">line 27</a>
    </li></ul></dd>
    

    

    

    
</dl>












<h5>Returns:</h5>

        
<div class="param-desc">
    escaped string
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="makeBlueGreenRedGradient"><span class="type-signature"></span>makeBlueGreenRedGradient<span class="signature">(minVal, maxVal, flipColors)</span><span class="type-signature"> &rarr; {<a href="global.html#colorLookupByNumber">colorLookupByNumber</a>}</span></h4>

    



<div class="description">
    Make a blue green red gradient
</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>minVal</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">minimum value</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxVal</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">maximum value</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>flipColors</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last">if the colors should be flipped</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_colors.js.html">util/colors.js</a>, <a href="util_colors.js.html#line88">line 88</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    color lookup function
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#colorLookupByNumber">colorLookupByNumber</a></span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="makeBlueGreenRedGradientZScore"><span class="type-signature"></span>makeBlueGreenRedGradientZScore<span class="signature">(median, stdDev, flipColors)</span><span class="type-signature"> &rarr; {<a href="global.html#colorLookupByNumber">colorLookupByNumber</a>}</span></h4>

    



<div class="description">
    Create a function that will return colors based on a gradient
</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>median</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">median value</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stdDev</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">standard deviation</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>flipColors</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last">if the colors should be flipped</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_colors.js.html">util/colors.js</a>, <a href="util_colors.js.html#line159">line 159</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    color lookup function
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#colorLookupByNumber">colorLookupByNumber</a></span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="makeFeatureServiceLegendAndSymbol"><span class="type-signature"></span>makeFeatureServiceLegendAndSymbol<span class="signature">(esriResponse)</span><span class="type-signature"> &rarr; {<a href="global.html#styleAndLegend">styleAndLegend</a>}</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>esriResponse</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">layer info</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="olHelpers_esriToOlStyle.js.html">olHelpers/esriToOlStyle.js</a>, <a href="olHelpers_esriToOlStyle.js.html#line257">line 257</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    style and legend object
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#styleAndLegend">styleAndLegend</a></span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="makeGuid"><span class="type-signature"></span>makeGuid<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    guids are used to uniquely identify groups and features
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_makeGuid.js.html">util/makeGuid.js</a>, <a href="util_makeGuid.js.html#line13">line 13</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    a new guid
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="makeMapServiceLegend"><span class="type-signature"></span>makeMapServiceLegend<span class="signature">(esriResponse)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    make map service legent
</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>esriResponse</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">layer info</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    
    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="olHelpers_esriToOlStyle.js.html">olHelpers/esriToOlStyle.js</a>, <a href="olHelpers_esriToOlStyle.js.html#line347">line 347</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    legend content
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="mapServiceLegendItem"><span class="type-signature"></span>mapServiceLegendItem<span class="signature">(lyrObject, iconsOnly<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</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>lyrObject</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">the layer as defined in the response</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>iconsOnly</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last">use only icons</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    
    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="olHelpers_esriToOlStyle.js.html">olHelpers/esriToOlStyle.js</a>, <a href="olHelpers_esriToOlStyle.js.html#line314">line 314</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    legend html
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="propertiesZoomStyle"><span class="type-signature"></span>propertiesZoomStyle<span class="signature">(styleFunc)</span><span class="type-signature"> &rarr; {function|*}</span></h4>
    



<div class="description">
    wrapper to define a style function by properties and zoom level
</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>styleFunc</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#propertiesZoomStyle">propertiesZoomStyle</a></span>
|

<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">style 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_propertiesZoomStyle.js.html">olHelpers/propertiesZoomStyle.js</a>, <a href="olHelpers_propertiesZoomStyle.js.html#line22">line 22</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    new function
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">function</span>
|

<span class="param-type">*</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="provide"><span class="type-signature"></span>provide<span class="signature">(namespace)</span><span class="type-signature"> &rarr; {object}</span></h4>

    



<div class="description">
    create a namespace on the gv 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>namespace</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">to create</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_provide.js.html">util/provide.js</a>, <a href="util_provide.js.html#line11">line 11</a>
    </li></ul></dd>
    

    

    

    
</dl>












<h5>Returns:</h5>

        
<div class="param-desc">
    object representing the namespace
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="quickMap"><span class="type-signature"></span>quickMap<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {ol.Map}</span></h4>

    



<div class="description">
    Sets up a map with some default parameters and initializes
mapMove and mapPopup
</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>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last">config options
                <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>divId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    map
                
                </td>
            

            <td class="description last">map div id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>center</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {}
                
                </td>
            
            <td class="description last">center config object
                <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>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    -10018378
                
                </td>
            

            <td class="description last">center x, web mercator x or lon</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    5574910
                
                </td>
            

            <td class="description last">center y, web mercator y or lat</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    7
                
                </td>
            

            <td class="description last">zoom level</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minZoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">min zoom</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxZoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">max zoom</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>baseSwitcher</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">if add base map switcher</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_quickMap.js.html">olHelpers/quickMap.js</a>, <a href="olHelpers_quickMap.js.html#line26">line 26</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    the ol map
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">ol.Map</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="quickMapBase"><span class="type-signature"></span>quickMapBase<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {ol.Map}</span></h4>

    



<div class="description">
    Sets up a map with some default parameters and initializes
mapMove and mapPopup
</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>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>
            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last">config options
                <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>divId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                
                </td>
            

            
                <td class="default">
                
                    map
                
                </td>
            

            <td class="description last">map div id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>center</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last">center config object
                <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>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    -10018378
                
                </td>
            

            <td class="description last">center x, web mercator x or lon</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                
                </td>
            

            
                <td class="default">
                
                    5574910
                
                </td>
            

            <td class="description last">center y, web mercator y or lat</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    7
                
                </td>
            

            <td class="description last">zoom level</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minZoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">min zoom</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxZoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">max zoom</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>baseSwitcher</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">if add base map switcher</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_quickMapBase.js.html">olHelpers/quickMapBase.js</a>, <a href="olHelpers_quickMapBase.js.html#line32">line 32</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    the ol map
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">ol.Map</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="quickMapMulti"><span class="type-signature"></span>quickMapMulti<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="global.html#quickMapMultiReturn">quickMapMultiReturn</a>}</span></h4>

    



<div class="description">
    Sets up a map with some default parameters and initializes
mapMove and mapPopup
</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>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last">config options
                <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>divId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    map
                
                </td>
            

            <td class="description last">map div id</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>center</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    {}
                
                </td>
            

            <td class="description last">center config object
                <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>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>

            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    -10018378
                
                </td>
            

            <td class="description last">center x, web mercator x or lon</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    5574910
                
                </td>
            

            <td class="description last">center y, web mercator y or lat</td>
        </tr>

    
    </tbody>
</table>
            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    7
                
                </td>
            

            <td class="description last">zoom level</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minZoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            
            
                <td class="default">
                
                </td>
            

            <td class="description last">min zoom</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxZoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last">max zoom</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>baseSwitcher</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last">if add base map switcher</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_quickMapMulti.js.html">olHelpers/quickMapMulti.js</a>, <a href="olHelpers_quickMapMulti.js.html#line34">line 34</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    return map, map move, and map popup objects
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#quickMapMultiReturn">quickMapMultiReturn</a></span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="resolutionToZoom"><span class="type-signature"></span>resolutionToZoom<span class="signature">(resolution)</span><span class="type-signature"> &rarr; {number|*}</span></h4>

    



<div class="description">
    Get resolution from the zoom level
</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>resolution</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">the 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_zoomResolutionConvert.js.html">olHelpers/zoomResolutionConvert.js</a>, <a href="olHelpers_zoomResolutionConvert.js.html#line68">line 68</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    the zoom level
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">number</span>
|

<span class="param-type">*</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="rgb2hex"><span class="type-signature"></span>rgb2hex<span class="signature">(rgb)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    converts an RGB string to hex
</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>rgb</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">rgb color</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    
    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_colors.js.html">util/colors.js</a>, <a href="util_colors.js.html#line26">line 26</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    rbg as hex
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            
    

    <h4 class="name" id="rgbToRgba"><span class="type-signature"></span>rgbToRgba<span class="signature">(rgb, alpha)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    adds alpha value to rgb string 'rgb(r, b, g)', returns 'rgba(r, g, b, a)'
</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>rgb</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">rgb color</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>alpha</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">alpha value 0 to 1</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_colors.js.html">util/colors.js</a>, <a href="util_colors.js.html#line62">line 62</a>
    </li></ul></dd>
    

    

    

    
</dl>












<h5>Returns:</h5>

        
<div class="param-desc">
    rgba color
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="undefinedOrNull"><span class="type-signature"></span>undefinedOrNull<span class="signature">(input)</span><span class="type-signature"> &rarr; {boolean}</span></h4>

    



<div class="description">
    check if the input is undefined or null
</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>input</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>


            
            </td>

            

            

            <td class="description last">input pointer</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_checkDefined.js.html">util/checkDefined.js</a>, <a href="util_checkDefined.js.html#line12">line 12</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    true undefined or null
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="zoomToResolution"><span class="type-signature"></span>zoomToResolution<span class="signature">(zoomLevel)</span><span class="type-signature"> &rarr; {number|*}</span></h4>

    



<div class="description">
    Get the resolution given the zoom level
</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>zoomLevel</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">the zoom level</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    
    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="olHelpers_zoomResolutionConvert.js.html">olHelpers/zoomResolutionConvert.js</a>, <a href="olHelpers_zoomResolutionConvert.js.html#line45">line 45</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    the map resolution
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">number</span>
|

<span class="param-type">*</span>


    </dd>
</dl>

    



        
    

    
        <h3 class="subsection-title">Type Definitions</h3>

        
                

    

    <h4 class="name" id="colorLookupByNumber"><span class="type-signature"></span>colorLookupByNumber<span class="signature">(num)</span><span class="type-signature"> &rarr; {string}</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>num</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">the number to use to retrieve the color</td>
        </tr>

    
    </tbody>
</table>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="util_colors.js.html">util/colors.js</a>, <a href="util_colors.js.html#line74">line 74</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    rgb color
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>

    </dd>
</dl>

    



            
                

    

    <h4 class="name" id="makeGetParams"><span class="type-signature"></span>makeGetParams<span class="signature">(extent, zoomLevel)</span><span class="type-signature"></span></h4>

    



<div class="description">
    callback to generate the parameters passed in the get request
</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>extent</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">extent object
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>minX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">minX</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">minY</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">maxX</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">maxY</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zoomLevel</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
            

            <td class="description last">zoom level</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="layers_LayerItsInventory.js.html">layers/LayerItsInventory.js</a>, <a href="layers_LayerItsInventory.js.html#line298">line 298</a>
    </li></ul></dd>
    

    

    

    
</dl>
















            
                

    

    <h4 class="name" id="mapMoveCallbackFunction"><span class="type-signature"></span>mapMoveCallbackFunction<span class="signature">(extent, zoomLevel, evtType<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    



<div class="description">
    This callback is displayed as a global member.
</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>extent</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">extent object
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>minX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">minX</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">minY</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">maxX</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">maxY</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zoomLevel</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>
            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last">zoom level</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>evtType</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last">undefined for initial load, otherwise one of 'change:center', '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#line232">line 232</a>
    </li></ul></dd>
    

    

    

    
</dl>
















            
                

    

    <h4 class="name" id="mapMoveMakeGetParams"><span class="type-signature"></span>mapMoveMakeGetParams<span class="signature">(lyr, extent, zoomLevel)</span><span class="type-signature"></span></h4>

    



<div class="description">
    The make mapMoveGetParams function takes the extent and the zoom level
context is 'this' object, probably want to do something with this.mapMoveParams
</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>lyr</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="LayerBaseVector.html">LayerBaseVector</a></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>extent</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        
        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>minX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>

            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zoomLevel</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="layers_LayerBaseVector.js.html">layers/LayerBaseVector.js</a>, <a href="layers_LayerBaseVector.js.html#line8">line 8</a>
    </li></ul></dd>
    

    

    

    
</dl>
















            
                

    

    <h4 class="name" id="mediaCallback"><span class="type-signature"></span>mediaCallback<span class="signature">(newValue)</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>newValue</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="jquery-plugin_mediaControl.js.html">jquery-plugin/mediaControl.js</a>, <a href="jquery-plugin_mediaControl.js.html#line9">line 9</a>
    </li></ul></dd>
    

    

    

    
</dl>
















            
                

    

    <h4 class="name" id="olStyleFunction"><span class="type-signature"></span>olStyleFunction<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Definition for openlayers style function
</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>
















            
                

    

    <h4 class="name" id="popupCallback"><span class="type-signature"></span>popupCallback<span class="signature">(featureProperties, jqRef)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    The popup callback function
</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>featureProperties</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last">the feature properties</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>jqRef</code></td>
            

            <td class="type">
            
                
<span class="param-type">jQuery</span>


            
            </td>

            

            

            <td class="description last">reference to the div content to do some async stuff inside the div</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#line407">line 407</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    the html content to be added to the popup
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



            
                

    

    <h4 class="name" id="popupChangedFunction"><span class="type-signature"></span>popupChangedFunction<span class="signature">($popContent)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Definition for popup changed callback functions
</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>$popContent</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last">jquery reference to the popup content</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#line54">line 54</a>
    </li></ul></dd>
    

    

    

    
</dl>















            
                

    

    <h4 class="name" id="propertiesZoomStyle"><span class="type-signature"></span>propertiesZoomStyle<span class="signature">(properties, zoom)</span><span class="type-signature"></span></h4>

    



<div class="description">
    A style function based on properties and zoom level, wraps normal feature, resolution function
</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>properties</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            
            

            <td class="description last">the feature properties</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>zoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">level</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="olHelpers_propertiesZoomStyle.js.html">olHelpers/propertiesZoomStyle.js</a>, <a href="olHelpers_propertiesZoomStyle.js.html#line9">line 9</a>
    </li></ul></dd>
    
    

    

    
</dl>
















            
                
<h4 class="name" id="quickMapMultiReturn">quickMapMultiReturn</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>map</code></td>
            

            <td class="type">
            
                
<span class="param-type">ol.Map</span>


            
            </td>

            

            

            <td class="description last">The X Coordinate</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mapMove</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="MapMoveCls.html">MapMoveCls</a></span>


            
            </td>

            

            

            <td class="description last">The Y Coordinate</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mapPopup</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="MapPopupCls.html">MapPopupCls</a></span>


            
            </td>

            

            

            <td class="description last">The Y Coordinate</td>
        </tr>

    
    </tbody>
</table>



<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="olHelpers_quickMapMulti.js.html">olHelpers/quickMapMulti.js</a>, <a href="olHelpers_quickMapMulti.js.html#line12">line 12</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                

    

    <h4 class="name" id="rangeChangeCallback"><span class="type-signature"></span>rangeChangeCallback<span class="signature">(newValue, ratio, evt)</span><span class="type-signature"></span></h4>

    



<div class="description">
    callback on range change interaction, context of this is the firing dom element
</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>newValue</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>ratio</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">value from 0 to 1 relative of the value to the min and max</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>evt</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="jquery-plugin_rangeChange.js.html">jquery-plugin/rangeChange.js</a>, <a href="jquery-plugin_rangeChange.js.html#line35">line 35</a>
    </li></ul></dd>
    

    

    

    
</dl>















            
                

    

    <h4 class="name" id="rpSetCallback"><span class="type-signature"></span>rpSetCallback<span class="signature">(rpId, rpFeature)</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>rpId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>rpFeature</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="jquery-plugin_rpPicker.js.html">jquery-plugin/rpPicker.js</a>, <a href="jquery-plugin_rpPicker.js.html#line12">line 12</a>
    </li></ul></dd>
    

    
    

    
</dl>
















            
                
<h4 class="name" id="styleAndLegend">styleAndLegend</h4>




<div class="description">
    style and legend object
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">oject</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>style</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#styleFunc">styleFunc</a></span>


            
            </td>

            

            

            <td class="description last">style function</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>legend</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">legend content</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    
    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="olHelpers_esriToOlStyle.js.html">olHelpers/esriToOlStyle.js</a>, <a href="olHelpers_esriToOlStyle.js.html#line245">line 245</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                

    

    <h4 class="name" id="styleFunc"><span class="type-signature"></span>styleFunc<span class="signature">(feat, resolution)</span><span class="type-signature"></span></h4>

    



<div class="description">
    This callback is displayed as part of the Requester class.
</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>feat</code></td>
            

            <td class="type">
            
                
<span class="param-type">ol.Feature</span>


            
            </td>

            

            

            <td class="description last">openlayers feature</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>resolution</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">map 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_esriToOlStyle.js.html">olHelpers/esriToOlStyle.js</a>, <a href="olHelpers_esriToOlStyle.js.html#line8">line 8</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="Corridor.html">Corridor</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="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="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="RpPicker.html">RpPicker</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="SsaCorridorPicker.html">SsaCorridorPicker</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#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#hexAlphaToRgbOrRgba">hexAlphaToRgbOrRgba</a></li><li><a href="global.html#highwayConvert">highwayConvert</a></li><li><a href="global.html#htmlEscape">htmlEscape</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#ol">ol</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#returnedColors">returnedColors</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#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 Mon May 02 2016 16:37:12 GMT-0500 (Central Daylight Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>