ngmap
Version:
The Simplest AngularJS Google Maps V3 Directive
7 lines • 16.9 kB
HTML
<html>
<head>
<meta charset="utf-8">
<title>JSDoc: Attr2MapOptions</title>
<link href="css/prettify-tomorrow.css" type="text/css" rel="stylesheet">
<link href="css/site.css" type="text/css" rel="stylesheet">
</head>
<body ng-app="">
<nav id="toc">
<input placeholder="Filter" id="filter-input" class="col12 block field" type="text">
<div class="nav-wrapper">
<h2><a href="index.html">Index</a></h2>
<ul class="module">
<!-- undefined -->
<h2 class="module">
<a chref="" ng-click="moduleundefined = !moduleundefined">
module: undefined
</a>
<i ng-cloak="" ng-show="moduleundefined">+</i>
</h2>
<li id="undefined" ng-hide="moduleundefined">
<ul class="group">
<h2>
<a href="" ng-click="undefinedservice = !undefinedservice">
service
</a>
<i ng-cloak="" ng-show="undefinedservice">+</i>
</h2>
<ul ng-hide="undefinedservice">
<li>
<a href="Attr2MapOptions.html">Attr2MapOptions</a>
</li><li>
<a href="GeoCoder.html">GeoCoder</a>
</li><li>
<a href="GoogleMapsApi.html">GoogleMapsApi</a>
</li><li>
<a href="NavigatorGeolocation.html">NavigatorGeolocation</a>
</li><li>
<a href="StreetView.html">StreetView</a>
</li>
</ul>
</ul><ul class="group">
<h2>
<a href="" ng-click="undefineddirective = !undefineddirective">
directive
</a>
<i ng-cloak="" ng-show="undefineddirective">+</i>
</h2>
<ul ng-hide="undefineddirective">
<li>
<a href="bicycling-layer.html">bicycling-layer</a>
</li><li>
<a href="custom-control.html">custom-control</a>
</li><li>
<a href="directions.html">directions</a>
</li><li>
<a href="drawing-manager.html">drawing-manager</a>
</li><li>
<a href="dynamic-maps-engine-layer.html">dynamic-maps-engine-layer</a>
</li><li>
<a href="fusion-tables-layer.html">fusion-tables-layer</a>
</li><li>
<a href="heatmap-layer.html">heatmap-layer</a>
</li><li>
<a href="info-window.html">info-window</a>
</li><li>
<a href="kml-layer.html">kml-layer</a>
</li><li>
<a href="map-data.html">map-data</a>
</li><li>
<a href="map-lazy-load.html">map-lazy-load</a>
</li><li>
<a href="map-type.html">map-type</a>
</li><li>
<a href="maps-engine-layer.html">maps-engine-layer</a>
</li><li>
<a href="marker.html">marker</a>
</li><li>
<a href="overlay-map-type.html">overlay-map-type</a>
</li><li>
<a href="places-auto-complete.html">places-auto-complete</a>
</li><li>
<a href="shape.html">shape</a>
</li><li>
<a href="streetview-panorama.html">streetview-panorama</a>
</li><li>
<a href="traffic-layer.html">traffic-layer</a>
</li><li>
<a href="transit-layer.html">transit-layer</a>
</li>
</ul>
</ul><ul class="group">
<h2>
<a href="" ng-click="undefinedprovider = !undefinedprovider">
provider
</a>
<i ng-cloak="" ng-show="undefinedprovider">+</i>
</h2>
<ul ng-hide="undefinedprovider">
<li>
<a href="NgMap.html">NgMap</a>
</li>
</ul>
</ul><ul class="group">
<h2>
<a href="" ng-click="undefinedfactory = !undefinedfactory">
factory
</a>
<i ng-cloak="" ng-show="undefinedfactory">+</i>
</h2>
<ul ng-hide="undefinedfactory">
<li>
<a href="NgMapPool.html">NgMapPool</a>
</li>
</ul>
</ul>
</li>
</ul><ul class="module">
<!-- ngmap -->
<h2 class="module">
<a chref="" ng-click="modulengmap = !modulengmap">
module: ngmap
</a>
<i ng-cloak="" ng-show="modulengmap">+</i>
</h2>
<li id="ngmap" ng-hide="modulengmap">
<ul class="group">
<h2>
<a href="" ng-click="ngmapdirective = !ngmapdirective">
directive
</a>
<i ng-cloak="" ng-show="ngmapdirective">+</i>
</h2>
<ul ng-hide="ngmapdirective">
<li>
<a href="ngmap.custom-marker.html">custom-marker</a>
</li>
</ul>
</ul>
</li>
</ul><ul class="module">
<!-- ng_ap -->
<h2 class="module">
<a chref="" ng-click="moduleng_ap = !moduleng_ap">
module: ngMap
</a>
<i ng-cloak="" ng-show="moduleng_ap">+</i>
</h2>
<li id="ngMap" ng-hide="moduleng_ap">
<ul class="group">
<h2>
<a href="" ng-click="ng_apdirective = !ng_apdirective">
directive
</a>
<i ng-cloak="" ng-show="ng_apdirective">+</i>
</h2>
<ul ng-hide="ng_apdirective">
<li>
<a href="ngMap.ng-map.html">ng-map</a>
</li>
</ul>
</ul>
</li>
</ul>
</div>
</nav>
<div id="content" class="page-wrap">
<h3 style="float:right; color:#ccc">
Angular service
</h3>
<h1 class="title">
Attr2MapOptions
<a class="name-link signature-attributes" href="source/Attr2MapOptions.html#line1">source</a>
</h1>
<div id="main" class="big-container">
<!-- source code html -->
<!-- index.html -->
<!-- class files -->
<div>
<div><div class="container-overview">
<ul class="chips">
</ul>
<div class="clearfix"></div>
<div class="description">
<h4>Description</h4>
<p>Converts tag attributes to options used by google api v3 objects</p>
</div>
<div class="details"></div>
</div>
<div class="functions">
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<a href="source/Attr2MapOptions.html#line214" class="name-link" id="filter">
<h4 class="name">
filter
<span class="signature">(attrs)</span>
<span class="type-signature">
-> Hash
</span>
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>filters attributes by skipping angularjs methods $.. $$..</p>
</span>
</div>
<div>
<h4>Parameters</h4>
<table class="params">
<thead>
<tr><th>Name</th><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="name">attrs</td>
<td class="type"><span class="param-type">
<a href="Hash.html">Hash</a>
</span></td>
<td class="description last">
<span>
<p>tag attributes</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Returns</h4>
<table class="params">
<thead>
<tr><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">
<a href="Hash.html">Hash</a>
</span>
</td>
<td class="description last">
<span>
<p>filterd attributes</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl><dl>
<dt>
<a href="source/Attr2MapOptions.html#line323" class="name-link" id="getControlOptions">
<h4 class="name">
getControlOptions
<span class="signature">(filtered)</span>
<span class="type-signature">
-> Hash
</span>
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>control means map controls, i.e streetview, pan, etc, not a general control</p>
</span>
</div>
<div>
<h4>Parameters</h4>
<table class="params">
<thead>
<tr><th>Name</th><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="name">filtered</td>
<td class="type"><span class="param-type">
<a href="Hash.html">Hash</a>
</span></td>
<td class="description last">
<span>
<p>filtered tag attributes</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Returns</h4>
<table class="params">
<thead>
<tr><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">
<a href="Hash.html">Hash</a>
</span>
</td>
<td class="description last">
<span>
<p>Google Map options</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl><dl>
<dt>
<a href="source/Attr2MapOptions.html#line277" class="name-link" id="getEvents">
<h4 class="name">
getEvents
<span class="signature">(scope, attrs)</span>
<span class="type-signature">
-> Hash
</span>
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>converts attributes hash to scope-specific event function</p>
</span>
</div>
<div>
<h4>Parameters</h4>
<table class="params">
<thead>
<tr><th>Name</th><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="name">scope</td>
<td class="type"><span class="param-type">
<a href="scope.html">scope</a>
</span></td>
<td class="description last">
<span>
<p>angularjs scope</p>
</span>
</td>
</tr><tr>
<td class="name">attrs</td>
<td class="type"><span class="param-type">
<a href="Hash.html">Hash</a>
</span></td>
<td class="description last">
<span>
<p>tag attributes</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Returns</h4>
<table class="params">
<thead>
<tr><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">
<a href="Hash.html">Hash</a>
</span>
</td>
<td class="description last">
<span>
<p>events converted events</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl><dl>
<dt>
<a href="source/Attr2MapOptions.html#line241" class="name-link" id="getOptions">
<h4 class="name">
getOptions
<span class="signature">(attrs, options)</span>
<span class="type-signature">
-> Hash
</span>
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>converts attributes hash to Google Maps API v3 options</p>
<pre class="prettyprint source"><code> . converts numbers to number
. converts class-like string to google maps instance
i.e. `LatLng(1,1)` to `new google.maps.LatLng(1,1)`
. converts constant-like string to google maps constant
i.e. `MapTypeId.HYBRID` to `google.maps.MapTypeId.HYBRID`
i.e. `HYBRID"` to `google.maps.MapTypeId.HYBRID`</code></pre>
</span>
</div>
<div>
<h4>Parameters</h4>
<table class="params">
<thead>
<tr><th>Name</th><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="name">attrs</td>
<td class="type"><span class="param-type">
<a href="Hash.html">Hash</a>
</span></td>
<td class="description last">
<span>
<p>tag attributes</p>
</span>
</td>
</tr><tr>
<td class="name">options</td>
<td class="type"><span class="param-type">
<a href="Hash.html">Hash</a>
</span></td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Returns</h4>
<table class="params">
<thead>
<tr><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">
<a href="Hash.html">Hash</a>
</span>
</td>
<td class="description last">
<span>
<p>options converted attributess</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl><dl>
<dt>
<a href="source/Attr2MapOptions.html#line29" class="name-link" id="orgAttributes">
<h4 class="name">
orgAttributes
<span class="signature">(el)</span>
<span class="type-signature">
-> Hash
</span>
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>Returns the attributes of an element as hash</p>
</span>
</div>
<div>
<h4>Parameters</h4>
<table class="params">
<thead>
<tr><th>Name</th><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="name">el</td>
<td class="type"><span class="param-type">
<a href="HTMLElement.html">HTMLElement</a>
</span></td>
<td class="description last">
<span>
<p>html element</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Returns</h4>
<table class="params">
<thead>
<tr><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">
<a href="Hash.html">Hash</a>
</span>
</td>
<td class="description last">
<span>
<p>attributes</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div></div>
</div>
</div>
<footer style="clear:both">
Documentation generated by
<a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a>
using
<a href="https://github.com/allenhwkim/angular-jsdoc">Angular-JSDoc template</a>
</footer>
</div>
<script src="js/prettify.js"></script>
<script src="js/angular.min.js"></script>
<script src="js/site.js"></script>
<!--%= prettyJson %-->
<script>
prettyPrint();
var lineNo = window.location.hash.match(/#line([0-9]+)$/);
lineNo && document.querySelector("ol li:nth-child("+(lineNo[1])+")").scrollIntoView();
</script>
</body>
</html>