Skip to content

javascriptHustler/geo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

</h2>

</div>

convertMiles(kilo)

<div class="description">
    Convert kilo to miles
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

number

        </td>

        

        

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


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line76">line 76</a>
</li></ul></dd>

createCluster(map, markers, options)

<div class="description">
    Create map clusters
</div>







    <h5>Parameters:</h5>
    <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">

Object

        </td>

        

        

        <td class="description last">Instance of map instance</td>
    </tr>



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

        <td class="type">

Array

        </td>

        

        

        <td class="description last">An array of markers</td>
    </tr>



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

        <td class="type">

object

        </td>

        

        

        <td class="description last">Options for the clusters</td>
    </tr>


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line97">line 97</a>
</li></ul></dd>

createInfoWindow(content)

<div class="description">
    Create an infowindow
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

String

        </td>

        

        

        <td class="description last">Contains HTML for infowindow</td>
    </tr>


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line63">line 63</a>
</li></ul></dd>

createMap(id, config)

<div class="description">
    Creates a map in the id param
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

String

        </td>

        

        

        <td class="description last">Element that map will be displayed</td>
    </tr>



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

        <td class="type">

Object

        </td>

        

        

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


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line33">line 33</a>
</li></ul></dd>

createMarker(position, map, icon)

<div class="description">
    Create a marker on map
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

Object

        </td>

        

        

        <td class="description last">GoogleReady lat/lng</td>
    </tr>



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

        <td class="type">

Object

        </td>

        

        

        <td class="description last">Instance of map instance</td>
    </tr>



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

        <td class="type">

String

        </td>

        

        

        <td class="description last">Relative path of icon image</td>
    </tr>


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line47">line 47</a>
</li></ul></dd>

directions(origin, destination, cb)

<div class="description">
    Calculate directions
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

String

        </td>

        

        

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



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

        <td class="type">

String

        </td>

        

        

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



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

        <td class="type">

Geo~requestCallback

        </td>

        

        

        <td class="description last">The callback that handles the response.</td>
    </tr>


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line229">line 229</a>
</li></ul></dd>

distanceMatrix(address, destinations, cb)

<div class="description">
    Travel distance and time for a matrix of origins and destinations
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

Object

        </td>

        

        

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



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

        <td class="type">

Array

        </td>

        

        

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



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

        <td class="type">

Geo~requestCallback

        </td>

        

        

        <td class="description last">The callback that handles the response.</td>
    </tr>


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line197">line 197</a>
</li></ul></dd>

extractGeocoding(cb)

<div class="description">
    Gets Current Position
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

Geo~requestCallback

        </td>

        

        

        <td class="description last">The callback that handles the response.</td>
    </tr>


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line109">line 109</a>
</li></ul></dd>

forwardGeocoding(address, cb)

<div class="description">
    Changes address into lat/lngs
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

String

        </td>

        

        

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



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

        <td class="type">

Geo~requestCallback

        </td>

        

        

        <td class="description last">The callback that handles the response.</td>
    </tr>


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line166">line 166</a>
</li></ul></dd>

googleLatLng(lat, lng)

<div class="description">
    Converts Lat|Lngs to google map objects
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

number

        </td>

        

        

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



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

        <td class="type">

number

        </td>

        

        

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


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line86">line 86</a>
</li></ul></dd>

reverseGeocoding(lat, lng, cb)

<div class="description">
    Changes lat/lngs into address
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

Number

        </td>

        

        

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



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

        <td class="type">

Number

        </td>

        

        

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



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

        <td class="type">

Geo~requestCallback

        </td>

        

        

        <td class="description last">The callback that handles the response.</td>
    </tr>


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line138">line 138</a>
</li></ul></dd>

streetViewPanorama(id, position)

<div class="description">
    Will show street view on map
</div>







    <h5>Parameters:</h5>
    <th>Name</th>
    

    <th>Type</th>

    

    

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

<tbody>


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

        <td class="type">

String

        </td>

        

        

        <td class="description last">Element that map will be displayed</td>
    </tr>



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

        <td class="type">

String

        </td>

        

        

        <td class="description last">GoogleReady lat/lng</td>
    </tr>


</tbody>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
    <a href="geo.js.html">geo.js</a>, <a href="geo.js.html#line15">line 15</a>
</li></ul></dd>

Documentation generated by JSDoc 3.3.0-alpha5 on Thu Apr 10 2014 10:03:21 GMT-0400 (EDT) <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script>

About

Created a Google Maps API V3 wrapper

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published