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

315 lines
7.6 KiB
HTML
Executable File

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: directive: shape</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: shape</h1>
<section>
<header>
<h2>
shape
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<a href="shape.js.html#line1" class="name-link"><h4 class="name" id="shape"><span class="type-signature"></span>shape<span class="signature">(centered, &lt;OPTIONS>, &lt;MapEvent>)</span><span class="type-signature"></span></h4></a>
</dt>
<dd>
<div class="description">
<p>Initialize a Google map shape in map with given options and register events<br> The shapes are:
. circle
. polygon
. polyline
. rectangle
. groundOverlay(or image)</p>
<p> Requires: map directive</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>centered</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>if set, map will be centered with this marker</p></td>
</tr>
<tr>
<td class="name"><code>&lt;OPTIONS></code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>For circle, <a href="https://developers.google.com/maps/documentation/javascript/reference#CircleOptions">any circle options</a><br> For polygon, <a href="https://developers.google.com/maps/documentation/javascript/reference#PolygonOptions">any polygon options</a><br> For polyline, <a href="https://developers.google.com/maps/documentation/javascript/reference#PolylineOptions">any polyline options</a><br> For rectangle, <a href="https://developers.google.com/maps/documentation/javascript/reference#RectangleOptions">any rectangle options</a><br> For image, <a href="https://developers.google.com/maps/documentation/javascript/reference#GroundOverlayOptions">any groundOverlay options</a></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 Shape events, https://developers.google.com/maps/documentation/javascript/reference</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shape.js.html">directives/shape.js</a>, <a href="shape.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_ATTRIBUTES>
&lt;shape name=SHAPE_NAME ANY_SHAPE_OPTIONS ANY_SHAPE_EVENTS">&lt;/MARKER>
&lt;/map>
Example:
&lt;map zoom="11" center="[40.74, -74.18]">
&lt;shape id="polyline" name="polyline" geodesic="true" stroke-color="#FF0000" stroke-opacity="1.0" stroke-weight="2"
path="[[40.74,-74.18],[40.64,-74.10],[40.54,-74.05],[40.44,-74]]" >&lt;/shape>
&lt;/map>
&lt;map zoom="11" center="[40.74, -74.18]">
&lt;shape id="polygon" name="polygon" stroke-color="#FF0000" stroke-opacity="1.0" stroke-weight="2"
paths="[[40.74,-74.18],[40.64,-74.18],[40.84,-74.08],[40.74,-74.18]]" >&lt;/shape>
&lt;/map>
&lt;map zoom="11" center="[40.74, -74.18]">
&lt;shape id="rectangle" name="rectangle" stroke-color='#FF0000' stroke-opacity="0.8" stroke-weight="2"
bounds="[[40.74,-74.18], [40.78,-74.14]]" editable="true" >&lt;/shape>
&lt;/map>
&lt;map zoom="11" center="[40.74, -74.18]">
&lt;shape id="circle" name="circle" stroke-color='#FF0000' stroke-opacity="0.8"stroke-weight="2"
center="[40.70,-74.14]" radius="4000" editable="true" >&lt;/shape>
&lt;/map>
&lt;map zoom="11" center="[40.74, -74.18]">
&lt;shape id="image" name="image" url="https://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg"
bounds="[[40.71,-74.22],[40.77,-74.12]]" opacity="0.7" clickable="true" >&lt;/shape>
&lt;/map>
For full-working example, please visit
[shape example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/build/shape.html)</code></pre>
</dd>
</div>
<h3 class="subsection-title">Requires</h3>
<ul>
<li>module:Attr2Options</li>
</ul>
</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>