custom-control.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: directive: custom-control</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">directive: custom-control</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. custom-control
  21. </h2>
  22. </header>
  23. <article>
  24. <div class="container-overview">
  25. <dt>
  26. <a href="custom-control.js.html#line2" class="name-link"><h4 class="name" id="custom-control"><span class="type-signature"></span>custom-control<span class="signature">(position, index)</span><span class="type-signature"></span></h4></a>
  27. </dt>
  28. <dd>
  29. <div class="description">
  30. <p>Build custom control and set to the map with position</p>
  31. <p> Requires: map directive</p>
  32. <p> Restrict To: Element</p>
  33. </div>
  34. <h5>Parameters:</h5>
  35. <table class="params">
  36. <thead>
  37. <tr>
  38. <th>Name</th>
  39. <th>Type</th>
  40. <th class="last">Description</th>
  41. </tr>
  42. </thead>
  43. <tbody>
  44. <tr>
  45. <td class="name"><code>position</code></td>
  46. <td class="type">
  47. <span class="param-type">String</span>
  48. </td>
  49. <td class="description last"><p>position of this control
  50. i.e. TOP_RIGHT</p></td>
  51. </tr>
  52. <tr>
  53. <td class="name"><code>index</code></td>
  54. <td class="type">
  55. <span class="param-type">Number</span>
  56. </td>
  57. <td class="description last"><p>index of the control</p></td>
  58. </tr>
  59. </tbody>
  60. </table>
  61. <dl class="details">
  62. <dt class="tag-source">Source:</dt>
  63. <dd class="tag-source"><ul class="dummy"><li>
  64. <a href="custom-control.js.html">directives/custom-control.js</a>, <a href="custom-control.js.html#line2">line 2</a>
  65. </li></ul></dd>
  66. </dl>
  67. <h5>Requires:</h5>
  68. <ul>
  69. <li>module:Attr2Options</li>
  70. <li>module:$compile</li>
  71. </ul>
  72. <h5>Example</h5>
  73. <pre class="prettyprint"><code>Example:
  74. &lt;map center="41.850033,-87.6500523" zoom="3">
  75. &lt;custom-control id="home" position="TOP_LEFT" index="1">
  76. &lt;div style="background-color: white;">
  77. &lt;b>Home&lt;/b>
  78. &lt;/div>
  79. &lt;/custom-control>
  80. &lt;/map></code></pre>
  81. </dd>
  82. </div>
  83. <h3 class="subsection-title">Requires</h3>
  84. <ul>
  85. <li>module:Attr2Options</li>
  86. <li>module:$compile</li>
  87. </ul>
  88. </article>
  89. </section>
  90. </div>
  91. <nav>
  92. <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>
  93. </nav>
  94. <br clear="both">
  95. <footer>
  96. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
  97. and <a href="https://github.com/allenhwkim/angular-jsdoc">angular-jsdoc</a>
  98. </footer>
  99. <script> prettyPrint(); </script>
  100. <script src="scripts/linenumber.js"> </script>
  101. <script>
  102. var href=window.location.href.match(/\/([^\/]+$)/)[1];
  103. document.querySelector("nav a[href='"+href+"']").scrollIntoView(true);
  104. if (window.location.hash == "")
  105. document.querySelector("body").scrollIntoView(true);
  106. </script>
  107. </body>
  108. </html>