GeoCoder.html 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: service: GeoCoder</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">service: GeoCoder</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. GeoCoder
  21. </h2>
  22. </header>
  23. <article>
  24. <div class="container-overview">
  25. <dt>
  26. <a href="geo_coder.js.html#line1" class="name-link"><h4 class="name" id="GeoCoder"><span class="type-signature"></span>GeoCoder<span class="signature">()</span><span class="type-signature"></span></h4></a>
  27. </dt>
  28. <dd>
  29. <div class="description">
  30. <p>Provides <a href="https://docs.angularjs.org/api/ng/service/$q">defered/promise API</a> service for Google Geocoder service</p>
  31. </div>
  32. <dl class="details">
  33. <dt class="tag-source">Source:</dt>
  34. <dd class="tag-source"><ul class="dummy"><li>
  35. <a href="geo_coder.js.html">services/geo_coder.js</a>, <a href="geo_coder.js.html#line1">line 1</a>
  36. </li></ul></dd>
  37. </dl>
  38. </dd>
  39. </div>
  40. <h3 class="subsection-title">Methods</h3>
  41. <dl>
  42. <dt>
  43. <a href="geo_coder.js.html#line20" class="name-link"><h4 class="name" id="geocode"><span class="type-signature">(static) </span>geocode<span class="signature">(options)</span><span class="type-signature"> &rarr; {HttpPromise}</span></h4></a>
  44. </dt>
  45. <dd>
  46. <h5>Parameters:</h5>
  47. <table class="params">
  48. <thead>
  49. <tr>
  50. <th>Name</th>
  51. <th>Type</th>
  52. <th class="last">Description</th>
  53. </tr>
  54. </thead>
  55. <tbody>
  56. <tr>
  57. <td class="name"><code>options</code></td>
  58. <td class="type">
  59. <span class="param-type">Hash</span>
  60. </td>
  61. <td class="description last"><p>https://developers.google.com/maps/documentation/geocoding/#geocoding</p></td>
  62. </tr>
  63. </tbody>
  64. </table>
  65. <dl class="details">
  66. <dt class="tag-source">Source:</dt>
  67. <dd class="tag-source"><ul class="dummy"><li>
  68. <a href="geo_coder.js.html">services/geo_coder.js</a>, <a href="geo_coder.js.html#line20">line 20</a>
  69. </li></ul></dd>
  70. </dl>
  71. <h5>Returns:</h5>
  72. <div class="param-desc">
  73. <p>Future object</p>
  74. </div>
  75. <dl>
  76. <dt>
  77. Type
  78. </dt>
  79. <dd>
  80. <span class="param-type">HttpPromise</span>
  81. </dd>
  82. </dl>
  83. <h5>Example</h5>
  84. <pre class="prettyprint"><code>```
  85. GeoCoder.geocode({address: 'the cn tower'}).then(function(result) {
  86. //... do something with result
  87. });
  88. ```</code></pre>
  89. </dd>
  90. </dl>
  91. </article>
  92. </section>
  93. </div>
  94. <nav>
  95. <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>
  96. </nav>
  97. <br clear="both">
  98. <footer>
  99. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
  100. and <a href="https://github.com/allenhwkim/angular-jsdoc">angular-jsdoc</a>
  101. </footer>
  102. <script> prettyPrint(); </script>
  103. <script src="scripts/linenumber.js"> </script>
  104. <script>
  105. var href=window.location.href.match(/\/([^\/]+$)/)[1];
  106. document.querySelector("nav a[href='"+href+"']").scrollIntoView(true);
  107. if (window.location.hash == "")
  108. document.querySelector("body").scrollIntoView(true);
  109. </script>
  110. </body>
  111. </html>