global.html 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Global</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">Global</h1>
  17. <section>
  18. <header>
  19. <h2></h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <dl class="details">
  24. </dl>
  25. </div>
  26. <h3 class="subsection-title">Type Definitions</h3>
  27. <h4 class="name" id="callback"><span class="type-signature"></span>callback<span class="signature">(points, maxResults)</span><span class="type-signature"> &rarr; {Array.&lt;object>}</span></h4>
  28. <div class="description">
  29. Local reverse geocoder based on GeoNames data.
  30. </div>
  31. <h5>Parameters:</h5>
  32. <table class="params">
  33. <thead>
  34. <tr>
  35. <th>Name</th>
  36. <th>Type</th>
  37. <th class="last">Description</th>
  38. </tr>
  39. </thead>
  40. <tbody>
  41. <tr>
  42. <td class="name"><code>points</code></td>
  43. <td class="type">
  44. <span class="param-type">object</span>
  45. |
  46. <span class="param-type">Array.&lt;object></span>
  47. </td>
  48. <td class="description last">One single or an array of
  49. latitude/longitude pairs</td>
  50. </tr>
  51. <tr>
  52. <td class="name"><code>maxResults</code></td>
  53. <td class="type">
  54. <span class="param-type">integer</span>
  55. </td>
  56. <td class="description last">The maximum number of results to return</td>
  57. </tr>
  58. </tbody>
  59. </table>
  60. <dl class="details">
  61. <dt class="tag-author">Author:</dt>
  62. <dd class="tag-author">
  63. <ul>
  64. <li>Thomas Steiner (tomac@google.com)</li>
  65. </ul>
  66. </dd>
  67. <dt class="tag-license">License:</dt>
  68. <dd class="tag-license"><ul class="dummy"><li>Apache 2.0</li></ul></dd>
  69. <dt class="tag-source">Source:</dt>
  70. <dd class="tag-source"><ul class="dummy"><li>
  71. <a href="geocoder.js.html">geocoder.js</a>, <a href="geocoder.js.html#line1">line 1</a>
  72. </li></ul></dd>
  73. </dl>
  74. <h5>Returns:</h5>
  75. <div class="param-desc">
  76. An array of GeoNames-based geocode results
  77. </div>
  78. <dl>
  79. <dt>
  80. Type
  81. </dt>
  82. <dd>
  83. <span class="param-type">Array.&lt;object></span>
  84. </dd>
  85. </dl>
  86. <h5>Example</h5>
  87. <pre class="prettyprint"><code>// With just one point
  88. var point = {latitude: 42.083333, longitude: 3.1};
  89. geocoder.lookUp(point, 1, function(err, res) {
  90. console.log(JSON.stringify(res, null, 2));
  91. });
  92. // In batch mode with many points
  93. var points = [
  94. {latitude: 42.083333, longitude: 3.1},
  95. {latitude: 48.466667, longitude: 9.133333}
  96. ];
  97. geocoder.lookUp(points, 1, function(err, res) {
  98. console.log(JSON.stringify(res, null, 2));
  99. });</code></pre>
  100. </article>
  101. </section>
  102. </div>
  103. <nav>
  104. <h2><a href="index.html">Home</a></h2><h3><a href="global.html">Global</a></h3>
  105. </nav>
  106. <br class="clear">
  107. <footer>
  108. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sat Sep 07 2019 23:12:47 GMT+0300 (Moscow Standard Time)
  109. </footer>
  110. <script> prettyPrint(); </script>
  111. <script src="scripts/linenumber.js"> </script>
  112. </body>
  113. </html>