apollodec/Apollo/bower_components/ngmap/build/docs/map.html
venbatechnologies@gmail.com d06b1c0cba status file
2017-12-07 11:31:25 +05:30

493 lines
8.7 KiB
HTML
Executable File

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: directive: map</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">directive: map</h1>
<section>
<header>
<h2>
map
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<a href="map.js.html#line1" class="name-link"><h4 class="name" id="map"><span class="type-signature"></span>map<span class="signature">(geo-fallback-center, init-event, &lt;MapOption>, &lt;MapEvent>)</span><span class="type-signature"></span></h4></a>
</dt>
<dd>
<div class="description">
<p>Implementation of <a href="MapController.html"><code>MapController</code></a>
Initialize a Google map within a <code>&lt;div&gt;</code> tag with given options and register events
It accepts children directives; marker, shape, or marker-clusterer</p>
<p> It initialize map, children tags, then emits message as soon as the action is done
The message emitted from this directive is;
. mapInitialized</p>
<p> Restrict To:
Element</p>
</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>geo-fallback-center</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last"><p>The center of map incase geolocation failed. i.e. [0,0]</p></td>
</tr>
<tr>
<td class="name"><code>init-event</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of event to initialize this map.
If this option is given, the map won't be initialized until the event is received.
To invoke the event, use $scope.$emit or $scope.$broacast.
i.e. <map init-event="init-map" ng-click="$emit('init-map')" center=... ></map></p></td>
</tr>
<tr>
<td class="name"><code>&lt;MapOption></code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>Any Google map options,
https://developers.google.com/maps/documentation/javascript/reference?csw=1#MapOptions</p></td>
</tr>
<tr>
<td class="name"><code>&lt;MapEvent></code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>Any Google map events,
https://rawgit.com/allenhwkim/angularjs-google-maps/master/build/map_events.html</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="map.js.html">directives/map.js</a>, <a href="map.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>module:Attr2Options</li>
</ul>
<h5>Example</h5>
<pre class="prettyprint"><code>Usage:
&lt;map MAP_OPTIONS_OR_MAP_EVENTS ..>
... Any children directives
&lt;/map>
Example:
&lt;map center="[40.74, -74.18]" on-click="doThat()">
&lt;/map>
&lt;map geo-fallback-center="[40.74, -74.18]">
&lt;/map></code></pre>
</dd>
</div>
<h3 class="subsection-title">Requires</h3>
<ul>
<li>module:Attr2Options</li>
</ul>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<a href="map.js.html#line64" class="name-link"><h4 class="name" id="link"><span class="type-signature">(static) </span>link<span class="signature">(scope, element, attrs)</span><span class="type-signature"></span></h4></a>
</dt>
<dd>
<div class="description">
<p>Initialize map and events</p>
</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>scope</code></td>
<td class="type">
<span class="param-type">$scope</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
<span class="param-type">angular.element</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">Hash</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="map.js.html">directives/map.js</a>, <a href="map.js.html#line64">line 64</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>service</h3><ul><li><a href="Attr2Options.html">Attr2Options</a></li><li><a href="GeoCoder.html">GeoCoder</a></li><li><a href="NavigatorGeolocation.html">NavigatorGeolocation</a></li><li><a href="StreetView.html">StreetView</a></li></ul><h3>directive</h3><ul><li><a href="bicycling-layer.html">bicycling-layer</a></li><li><a href="cloud-layer.html">cloud-layer</a></li><li><a href="custom-control.html">custom-control</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="lazy-load.html">lazy-load</a></li><li><a href="map.html">map</a></li><li><a href="map-data.html">map-data</a></li><li><a href="map-type.html">map-type</a></li><li><a href="MapController.html">MapController</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="shape.html">shape</a></li><li><a href="traffic-layer.html">traffic-layer</a></li><li><a href="transit-layer.html">transit-layer</a></li><li><a href="weather-layer.html">weather-layer</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
and <a href="https://github.com/allenhwkim/angular-jsdoc">angular-jsdoc</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
<script>
var href=window.location.href.match(/\/([^\/]+$)/)[1];
document.querySelector("nav a[href='"+href+"']").scrollIntoView(true);
if (window.location.hash == "")
document.querySelector("body").scrollIntoView(true);
</script>
</body>
</html>