@maptiler/client 1.0.2 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/npm-publish.yml +0 -1
- package/dist/maptiler-client.cjs +465 -21
- package/dist/maptiler-client.cjs.map +1 -1
- package/dist/maptiler-client.d.ts +395 -2
- package/dist/maptiler-client.min.mjs +1 -1
- package/dist/maptiler-client.mjs +461 -22
- package/dist/maptiler-client.mjs.map +1 -1
- package/dist/maptiler-client.umd.js +465 -21
- package/dist/maptiler-client.umd.js.map +1 -1
- package/dist/maptiler-client.umd.min.js +1 -1
- package/docs/assets/custom.css +118 -0
- package/docs/assets/highlight.css +10 -10
- package/docs/assets/main.js +56 -52
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +23 -0
- package/docs/classes/{ClientConfig.html → config.ClientConfig.html} +34 -24
- package/docs/classes/{ServiceError.html → services_ServiceError.ServiceError.html} +26 -16
- package/docs/functions/language.getAutoLanguageGeocoding.html +60 -0
- package/docs/functions/services_simplify.default.html +65 -0
- package/docs/images/maptiler-logo-256.png +0 -0
- package/docs/index.html +118 -57
- package/docs/modules/config.html +71 -0
- package/docs/modules/language.html +71 -0
- package/docs/modules/services_ServiceError.html +61 -0
- package/docs/modules/services_coordinates.html +84 -0
- package/docs/modules/services_data.html +66 -0
- package/docs/modules/services_geocoding.html +76 -0
- package/docs/modules/services_geolocation.html +68 -0
- package/docs/modules/services_simplify.html +61 -0
- package/docs/modules/services_staticMaps.html +74 -0
- package/docs/modules.html +23 -83
- package/docs/types/config.FetchFunction.html +71 -0
- package/docs/types/language.LanguageGeocodingString.html +58 -0
- package/docs/types/services_coordinates.CoordinateExport.html +71 -0
- package/docs/types/services_coordinates.CoordinateGrid.html +69 -0
- package/docs/types/services_coordinates.CoordinateId.html +71 -0
- package/docs/types/services_coordinates.CoordinateSearch.html +93 -0
- package/docs/types/services_coordinates.CoordinateSearchResult.html +75 -0
- package/docs/types/services_coordinates.CoordinateTransformResult.html +76 -0
- package/docs/types/services_coordinates.CoordinateTransformation.html +89 -0
- package/docs/types/services_coordinates.CoordinatesSearchOptions.html +83 -0
- package/docs/types/services_coordinates.CoordinatesTransformOptions.html +85 -0
- package/docs/types/services_coordinates.XYZ.html +73 -0
- package/docs/types/services_data.GetDataOptions.html +64 -0
- package/docs/types/services_geocoding.Coordinates.html +60 -0
- package/docs/types/services_geocoding.FeatureHierarchy.html +71 -0
- package/docs/types/services_geocoding.GeocodingFeature.html +60 -0
- package/docs/types/services_geocoding.GeocodingOptions.html +79 -0
- package/docs/types/services_geocoding.GeocodingSearchResult.html +77 -0
- package/docs/types/services_geocoding.ReverseGeocodingOptions.html +71 -0
- package/docs/types/services_geolocation.GeolocationInfoOptions.html +65 -0
- package/docs/types/services_geolocation.GeolocationResult.html +128 -0
- package/docs/types/services_staticMaps.AutomaticStaticMapOptions.html +61 -0
- package/docs/types/services_staticMaps.BoundedStaticMapOptions.html +61 -0
- package/docs/types/services_staticMaps.CenteredStaticMapOptions.html +61 -0
- package/docs/types/{StaticMapBaseOptions.html → services_staticMaps.StaticMapBaseOptions.html} +26 -45
- package/docs/types/services_staticMaps.StaticMapMarker.html +61 -0
- package/docs/variables/config.config.html +58 -0
- package/docs/variables/{LanguageGeocoding.html → language.LanguageGeocoding.html} +20 -42
- package/docs/variables/services_coordinates.coordinates.html +110 -0
- package/docs/variables/services_data.data.html +80 -0
- package/docs/variables/{geocoding.html → services_geocoding.geocoding.html} +35 -53
- package/docs/variables/services_geolocation.geolocation.html +79 -0
- package/docs/variables/services_staticMaps.staticMaps.html +128 -0
- package/docsmd/README.md +143 -36
- package/docsmd/assets/custom.css +118 -0
- package/docsmd/classes/ClientConfig.md +5 -5
- package/docsmd/classes/MapStyleVariant.md +217 -0
- package/docsmd/classes/ReferenceMapStyle.md +169 -0
- package/docsmd/classes/ServiceError.md +3 -3
- package/examples/test-browser-umd.html +1 -1
- package/images/maptiler-logo-256.png +0 -0
- package/package.json +5 -5
- package/readme.md +65 -5
- package/src/index.ts +17 -0
- package/src/mapstyle.ts +841 -0
- package/src/services/staticMaps.ts +5 -4
- package/tsconfig.json +0 -1
- package/typedoc.css +118 -0
- package/typedoc.json +7 -3
- package/docs/types/AutomaticStaticMapOptions.html +0 -80
- package/docs/types/BoundedStaticMapOptions.html +0 -80
- package/docs/types/CenteredStaticMapOptions.html +0 -80
- package/docs/types/CoordinateExport.html +0 -85
- package/docs/types/CoordinateGrid.html +0 -83
- package/docs/types/CoordinateId.html +0 -85
- package/docs/types/CoordinateSearch.html +0 -107
- package/docs/types/CoordinateSearchResult.html +0 -89
- package/docs/types/CoordinateTransformResult.html +0 -90
- package/docs/types/CoordinateTransformation.html +0 -103
- package/docs/types/Coordinates.html +0 -78
- package/docs/types/CoordinatesSearchOptions.html +0 -97
- package/docs/types/CoordinatesTransformOptions.html +0 -99
- package/docs/types/FeatureHierarchy.html +0 -89
- package/docs/types/FetchFunction.html +0 -93
- package/docs/types/GeocodingFeature.html +0 -78
- package/docs/types/GeocodingOptions.html +0 -97
- package/docs/types/GeocodingSearchResult.html +0 -95
- package/docs/types/GeolocationInfoOptions.html +0 -87
- package/docs/types/GeolocationResult.html +0 -150
- package/docs/types/GetDataOptions.html +0 -87
- package/docs/types/LanguageGeocodingString.html +0 -80
- package/docs/types/ReverseGeocodingOptions.html +0 -89
- package/docs/types/StaticMapMarker.html +0 -80
- package/docs/types/XYZ.html +0 -87
- package/docs/variables/config.html +0 -80
- package/docs/variables/coordinates-1.html +0 -124
- package/docs/variables/data.html +0 -103
- package/docs/variables/geolocation.html +0 -101
- package/docs/variables/staticMaps.html +0 -147
- package/docsmd/images/JS-logo.svg +0 -4
- package/docsmd/images/TS-logo.svg +0 -6
- package/docsmd/images/maptiler-client-logo.afdesign +0 -0
- package/docsmd/images/maptiler-client-logo.svg +0 -75
- package/docsmd/images/maptiler-logo.svg +0 -23
- package/docsmd/images/screenshots/static-bounded-europe-1024.png +0 -0
- package/docsmd/images/screenshots/static-bounded-europe-2048.png +0 -0
- package/docsmd/images/screenshots/static-bounded-portugal-1024x2048.png +0 -0
- package/docsmd/images/screenshots/static-bounded-portugal-2048x2048.png +0 -0
- package/docsmd/images/screenshots/static-with-path.png +0 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>geocoding | MapTiler Client
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>geocoding | MapTiler Client - v1.1.0</title><meta name="description" content="Documentation for MapTiler Client - v1.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
2
|
<div class="tsd-toolbar-contents container">
|
|
3
3
|
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
4
|
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
@@ -6,16 +6,17 @@
|
|
|
6
6
|
<div id="tsd-toolbar-links"></div></div>
|
|
7
7
|
<ul class="results">
|
|
8
8
|
<li class="state loading">Preparing search index...</li>
|
|
9
|
-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">MapTiler Client
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">MapTiler Client - v1.1.0</a></div>
|
|
10
10
|
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
11
|
<div class="container container-main">
|
|
12
12
|
<div class="col-8 col-content">
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
14
|
<ul class="tsd-breadcrumb">
|
|
15
|
-
<li><a href="../modules.html">MapTiler Client
|
|
16
|
-
<li><a href="
|
|
15
|
+
<li><a href="../modules.html">MapTiler Client - v1.1.0</a></li>
|
|
16
|
+
<li><a href="../modules/services_geocoding.html">services/geocoding</a></li>
|
|
17
|
+
<li><a href="services_geocoding.geocoding.html">geocoding</a></li></ul>
|
|
17
18
|
<h1>Variable geocoding<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
|
|
18
|
-
<div class="tsd-signature">geocoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>forward<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/GeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span>language<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ALBANIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ARABIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ARMENIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>AUTO<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>AZERBAIJANI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BELORUSSIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BOSNIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BRETON<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BULGARIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CATALAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CHINESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CROATIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CZECH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>DANISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>DUTCH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ENGLISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ESPERANTO<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ESTONIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>FINNISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>FRENCH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>FRISIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>GEORGIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>GERMAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>GREEK<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>HEBREW<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>HUNGARIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ICELANDIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>IRISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ITALIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>JAPANESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>KANNADA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>KAZAKH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>KOREAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>LATVIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>LITHUANIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>LUXEMBOURGISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>MACEDONIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>MALTESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>NORWEGIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>POLISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>PORTUGUESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ROMANIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ROMANSH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ROMAN_LATIN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>RUSSIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SCOTTISH_GAELIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SERBIAN_CYRILLIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SLOVAK<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SLOVENE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SPANISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SWEDISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>THAI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>TURKISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>UKRAINIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>WELSH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>reverse<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Position</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/ReverseGeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ReverseGeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
19
|
+
<div class="tsd-signature">geocoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>forward<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_geocoding.GeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geocoding.GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span>language<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ALBANIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ARABIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ARMENIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>AUTO<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>AZERBAIJANI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BELORUSSIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BOSNIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BRETON<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BULGARIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CATALAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CHINESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CROATIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CZECH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>DANISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>DUTCH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ENGLISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ESPERANTO<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ESTONIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>FINNISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>FRENCH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>FRISIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>GEORGIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>GERMAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>GREEK<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>HEBREW<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>HUNGARIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ICELANDIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>IRISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ITALIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>JAPANESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>KANNADA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>KAZAKH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>KOREAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>LATVIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>LITHUANIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>LUXEMBOURGISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>MACEDONIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>MALTESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>NORWEGIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>POLISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>PORTUGUESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ROMANIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ROMANSH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ROMAN_LATIN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>RUSSIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SCOTTISH_GAELIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SERBIAN_CYRILLIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SLOVAK<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SLOVENE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SPANISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SWEDISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>THAI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>TURKISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>UKRAINIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>WELSH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>reverse<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Position</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_geocoding.ReverseGeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ReverseGeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geocoding.GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
19
20
|
<div class="tsd-comment tsd-typography"><p>The <strong>geocoding</strong> namespace contains asynchronous functions to call the <a href="https://docs.maptiler.com/cloud/api/geocoding/">MapTiler Geocoding API</a>.
|
|
20
21
|
The <strong>Geocoding API</strong> provides ways to get geographic coordinates from a human-readable search query of a place (forward geocoding)
|
|
21
22
|
and to get the location details (country, city, street, etc.) from a geographic coordinate (reverse geocoding);</p>
|
|
@@ -24,11 +25,11 @@ and to get the location details (country, city, street, etc.) from a geographic
|
|
|
24
25
|
<h4>Type declaration</h4>
|
|
25
26
|
<ul class="tsd-parameters">
|
|
26
27
|
<li class="tsd-parameter">
|
|
27
|
-
<h5>forward<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/GeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5>
|
|
28
|
+
<h5>forward<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_geocoding.GeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geocoding.GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5>
|
|
28
29
|
<ul class="tsd-parameters">
|
|
29
30
|
<li class="tsd-parameter-signature">
|
|
30
|
-
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-
|
|
31
|
-
<li class="tsd-signature" id="__type.__type-1.__type-2"><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/GeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span></li>
|
|
31
|
+
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
|
32
|
+
<li class="tsd-signature" id="__type.forward.__type-1.__type-2"><span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_geocoding.GeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geocoding.GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span></li>
|
|
32
33
|
<li class="tsd-description">
|
|
33
34
|
<div class="tsd-comment tsd-typography"><p>Performs a forward geocoding query to MapTiler API.
|
|
34
35
|
Providing a human readable place name (of a city, country, street, etc.), the function returns
|
|
@@ -42,8 +43,8 @@ Learn more on the MapTiler API reference page: <a href="https://docs.maptiler.co
|
|
|
42
43
|
<li>
|
|
43
44
|
<h5>query: <span class="tsd-signature-type">string</span></h5></li>
|
|
44
45
|
<li>
|
|
45
|
-
<h5>options: <a href="../types/GeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
|
|
46
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li>
|
|
46
|
+
<h5>options: <a href="../types/services_geocoding.GeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
|
|
47
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geocoding.GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li>
|
|
47
48
|
<li class="tsd-parameter">
|
|
48
49
|
<h5>language<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>ALBANIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ARABIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ARMENIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>AUTO<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>AZERBAIJANI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BELORUSSIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BOSNIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BRETON<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>BULGARIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CATALAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CHINESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CROATIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>CZECH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>DANISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>DUTCH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ENGLISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ESPERANTO<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ESTONIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>FINNISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>FRENCH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>FRISIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>GEORGIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>GERMAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>GREEK<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>HEBREW<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>HUNGARIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ICELANDIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>IRISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ITALIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>JAPANESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>KANNADA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>KAZAKH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>KOREAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>LATVIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>LITHUANIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>LUXEMBOURGISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>MACEDONIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>MALTESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>NORWEGIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>POLISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>PORTUGUESE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ROMANIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ROMANSH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>ROMAN_LATIN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>RUSSIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SCOTTISH_GAELIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SERBIAN_CYRILLIC<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SLOVAK<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SLOVENE<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SPANISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>SWEDISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>THAI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>TURKISH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>UKRAINIAN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>WELSH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
49
50
|
<ul class="tsd-parameters">
|
|
@@ -158,11 +159,11 @@ Learn more on the MapTiler API reference page: <a href="https://docs.maptiler.co
|
|
|
158
159
|
<li class="tsd-parameter">
|
|
159
160
|
<h5>WELSH<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li>
|
|
160
161
|
<li class="tsd-parameter">
|
|
161
|
-
<h5>reverse<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Position</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/ReverseGeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ReverseGeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5>
|
|
162
|
+
<h5>reverse<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Position</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_geocoding.ReverseGeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ReverseGeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geocoding.GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5>
|
|
162
163
|
<ul class="tsd-parameters">
|
|
163
164
|
<li class="tsd-parameter-signature">
|
|
164
|
-
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-
|
|
165
|
-
<li class="tsd-signature" id="__type.__type-4.__type-5"><span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Position</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/ReverseGeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ReverseGeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span></li>
|
|
165
|
+
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
|
166
|
+
<li class="tsd-signature" id="__type.reverse.__type-4.__type-5"><span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Position</span>, options<span class="tsd-signature-symbol">?: </span><a href="../types/services_geocoding.ReverseGeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ReverseGeocodingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geocoding.GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span></li>
|
|
166
167
|
<li class="tsd-description">
|
|
167
168
|
<div class="tsd-comment tsd-typography"><p>Perform a reverse geocoding query to MapTiler API.
|
|
168
169
|
Providing a longitude and latitude, this function returns a set of human readable information abou this place (country, city, street, etc.)
|
|
@@ -175,10 +176,10 @@ Learn more on the MapTiler API reference page: <a href="https://docs.maptiler.co
|
|
|
175
176
|
<li>
|
|
176
177
|
<h5>position: <span class="tsd-signature-type">Position</span></h5></li>
|
|
177
178
|
<li>
|
|
178
|
-
<h5>options: <a href="../types/ReverseGeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ReverseGeocodingOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
|
|
179
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources">
|
|
179
|
+
<h5>options: <a href="../types/services_geocoding.ReverseGeocodingOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">ReverseGeocodingOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
|
|
180
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geocoding.GeocodingSearchResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeocodingSearchResult</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources">
|
|
180
181
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/maptiler/maptiler-client-js/blob/
|
|
182
|
+
<li>Defined in <a href="https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geocoding.ts#L233">services/geocoding.ts:233</a></li></ul></aside></div>
|
|
182
183
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
183
184
|
<div class="tsd-navigation settings">
|
|
184
185
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -195,45 +196,26 @@ Learn more on the MapTiler API reference page: <a href="https://docs.maptiler.co
|
|
|
195
196
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
196
197
|
<div class="tsd-accordion-details">
|
|
197
198
|
<ul>
|
|
198
|
-
<li><a href="../modules.html">Map<wbr/>Tiler <wbr/>Client
|
|
199
|
-
<ul
|
|
199
|
+
<li class="current"><a href="../modules.html">Map<wbr/>Tiler <wbr/>Client -<wbr/> v1.1.0</a>
|
|
200
|
+
<ul>
|
|
201
|
+
<li class="tsd-kind-module"><a href="../modules/config.html">config</a></li>
|
|
202
|
+
<li class="tsd-kind-module"><a href="../modules/language.html">language</a></li>
|
|
203
|
+
<li class="tsd-kind-module"><a href="../modules/services_ServiceError.html">services/<wbr/>Service<wbr/>Error</a></li>
|
|
204
|
+
<li class="tsd-kind-module"><a href="../modules/services_coordinates.html">services/coordinates</a></li>
|
|
205
|
+
<li class="tsd-kind-module"><a href="../modules/services_data.html">services/data</a></li>
|
|
206
|
+
<li class="current tsd-kind-module"><a href="../modules/services_geocoding.html">services/geocoding</a></li>
|
|
207
|
+
<li class="tsd-kind-module"><a href="../modules/services_geolocation.html">services/geolocation</a></li>
|
|
208
|
+
<li class="tsd-kind-module"><a href="../modules/services_simplify.html">services/simplify</a></li>
|
|
209
|
+
<li class="tsd-kind-module"><a href="../modules/services_staticMaps.html">services/static<wbr/>Maps</a></li></ul></li></ul></div></details></nav>
|
|
200
210
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
201
211
|
<ul>
|
|
202
|
-
<li class="tsd-kind-
|
|
203
|
-
<li class="tsd-kind-
|
|
204
|
-
<li class="tsd-kind-type-alias"><a href="../types/
|
|
205
|
-
<li class="tsd-kind-type-alias"><a href="../types/
|
|
206
|
-
<li class="tsd-kind-type-alias"><a href="../types/
|
|
207
|
-
<li class="tsd-kind-type-alias"><a href="../types/
|
|
208
|
-
<li class="tsd-kind-
|
|
209
|
-
<li class="tsd-kind-type-alias"><a href="../types/CoordinateId.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Coordinate<wbr/>Id</a></li>
|
|
210
|
-
<li class="tsd-kind-type-alias"><a href="../types/CoordinateSearch.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Coordinate<wbr/>Search</a></li>
|
|
211
|
-
<li class="tsd-kind-type-alias"><a href="../types/CoordinateSearchResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Coordinate<wbr/>Search<wbr/>Result</a></li>
|
|
212
|
-
<li class="tsd-kind-type-alias"><a href="../types/CoordinateTransformResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Coordinate<wbr/>Transform<wbr/>Result</a></li>
|
|
213
|
-
<li class="tsd-kind-type-alias"><a href="../types/CoordinateTransformation.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Coordinate<wbr/>Transformation</a></li>
|
|
214
|
-
<li class="tsd-kind-type-alias"><a href="../types/Coordinates.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Coordinates</a></li>
|
|
215
|
-
<li class="tsd-kind-type-alias"><a href="../types/CoordinatesSearchOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Coordinates<wbr/>Search<wbr/>Options</a></li>
|
|
216
|
-
<li class="tsd-kind-type-alias"><a href="../types/CoordinatesTransformOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Coordinates<wbr/>Transform<wbr/>Options</a></li>
|
|
217
|
-
<li class="tsd-kind-type-alias"><a href="../types/FeatureHierarchy.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Feature<wbr/>Hierarchy</a></li>
|
|
218
|
-
<li class="tsd-kind-type-alias"><a href="../types/FetchFunction.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Fetch<wbr/>Function</a></li>
|
|
219
|
-
<li class="tsd-kind-type-alias"><a href="../types/GeocodingFeature.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Geocoding<wbr/>Feature</a></li>
|
|
220
|
-
<li class="tsd-kind-type-alias"><a href="../types/GeocodingOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Geocoding<wbr/>Options</a></li>
|
|
221
|
-
<li class="tsd-kind-type-alias"><a href="../types/GeocodingSearchResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Geocoding<wbr/>Search<wbr/>Result</a></li>
|
|
222
|
-
<li class="tsd-kind-type-alias"><a href="../types/GeolocationInfoOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Geolocation<wbr/>Info<wbr/>Options</a></li>
|
|
223
|
-
<li class="tsd-kind-type-alias"><a href="../types/GeolocationResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Geolocation<wbr/>Result</a></li>
|
|
224
|
-
<li class="tsd-kind-type-alias"><a href="../types/GetDataOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Data<wbr/>Options</a></li>
|
|
225
|
-
<li class="tsd-kind-type-alias"><a href="../types/LanguageGeocodingString.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Language<wbr/>Geocoding<wbr/>String</a></li>
|
|
226
|
-
<li class="tsd-kind-type-alias"><a href="../types/ReverseGeocodingOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Reverse<wbr/>Geocoding<wbr/>Options</a></li>
|
|
227
|
-
<li class="tsd-kind-type-alias"><a href="../types/StaticMapBaseOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Static<wbr/>Map<wbr/>Base<wbr/>Options</a></li>
|
|
228
|
-
<li class="tsd-kind-type-alias"><a href="../types/StaticMapMarker.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Static<wbr/>Map<wbr/>Marker</a></li>
|
|
229
|
-
<li class="tsd-kind-type-alias"><a href="../types/XYZ.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>XYZ</a></li>
|
|
230
|
-
<li class="tsd-kind-variable"><a href="LanguageGeocoding.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>Language<wbr/>Geocoding</a></li>
|
|
231
|
-
<li class="tsd-kind-variable"><a href="config.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>config</a></li>
|
|
232
|
-
<li class="tsd-kind-variable"><a href="coordinates-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>coordinates</a></li>
|
|
233
|
-
<li class="tsd-kind-variable"><a href="data.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>data</a></li>
|
|
234
|
-
<li class="current tsd-kind-variable"><a href="geocoding.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>geocoding</a></li>
|
|
235
|
-
<li class="tsd-kind-variable"><a href="geolocation.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>geolocation</a></li>
|
|
236
|
-
<li class="tsd-kind-variable"><a href="staticMaps.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>static<wbr/>Maps</a></li></ul></nav></div></div>
|
|
212
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_geocoding.Coordinates.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Coordinates</a></li>
|
|
213
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_geocoding.FeatureHierarchy.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Feature<wbr/>Hierarchy</a></li>
|
|
214
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_geocoding.GeocodingFeature.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Geocoding<wbr/>Feature</a></li>
|
|
215
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_geocoding.GeocodingOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Geocoding<wbr/>Options</a></li>
|
|
216
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_geocoding.GeocodingSearchResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Geocoding<wbr/>Search<wbr/>Result</a></li>
|
|
217
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_geocoding.ReverseGeocodingOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Reverse<wbr/>Geocoding<wbr/>Options</a></li>
|
|
218
|
+
<li class="current tsd-kind-variable tsd-parent-kind-module"><a href="services_geocoding.geocoding.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>geocoding</a></li></ul></nav></div></div>
|
|
237
219
|
<div class="container tsd-generator">
|
|
238
220
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
239
221
|
<div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>geolocation | MapTiler Client - v1.1.0</title><meta name="description" content="Documentation for MapTiler Client - v1.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container">
|
|
3
|
+
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
+
<div class="field">
|
|
6
|
+
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
+
<ul class="results">
|
|
8
|
+
<li class="state loading">Preparing search index...</li>
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">MapTiler Client - v1.1.0</a></div>
|
|
10
|
+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
+
<div class="container container-main">
|
|
12
|
+
<div class="col-8 col-content">
|
|
13
|
+
<div class="tsd-page-title">
|
|
14
|
+
<ul class="tsd-breadcrumb">
|
|
15
|
+
<li><a href="../modules.html">MapTiler Client - v1.1.0</a></li>
|
|
16
|
+
<li><a href="../modules/services_geolocation.html">services/geolocation</a></li>
|
|
17
|
+
<li><a href="services_geolocation.geolocation.html">geolocation</a></li></ul>
|
|
18
|
+
<h1>Variable geolocation<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
|
|
19
|
+
<div class="tsd-signature">geolocation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../types/services_geolocation.GeolocationInfoOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeolocationInfoOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geolocation.GeolocationResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeolocationResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
20
|
+
<div class="tsd-comment tsd-typography"><p>The <strong>geolocation</strong> namespace contains an asynchronous function to call the <a href="https://docs.maptiler.com/cloud/api/geolocation/">MapTiler Geolocation API</a>.
|
|
21
|
+
The <strong>Geolocation API</strong> provides a way to retrieve the IP address as well as geographic informations of a machine performing the query (most likely: a user)</p>
|
|
22
|
+
</div>
|
|
23
|
+
<div class="tsd-type-declaration">
|
|
24
|
+
<h4>Type declaration</h4>
|
|
25
|
+
<ul class="tsd-parameters">
|
|
26
|
+
<li class="tsd-parameter">
|
|
27
|
+
<h5>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../types/services_geolocation.GeolocationInfoOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeolocationInfoOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geolocation.GeolocationResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeolocationResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5>
|
|
28
|
+
<ul class="tsd-parameters">
|
|
29
|
+
<li class="tsd-parameter-signature">
|
|
30
|
+
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
|
31
|
+
<li class="tsd-signature" id="__type.info.__type-1.__type-2"><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../types/services_geolocation.GeolocationInfoOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeolocationInfoOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geolocation.GeolocationResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeolocationResult</a><span class="tsd-signature-symbol">></span></li>
|
|
32
|
+
<li class="tsd-description">
|
|
33
|
+
<div class="tsd-comment tsd-typography"><p>Looks up geolocation details from IP address using MapTiler API.
|
|
34
|
+
Learn more on the MapTiler API reference page: <a href="https://docs.maptiler.com/cloud/api/geolocation/#ip-geolocation">https://docs.maptiler.com/cloud/api/geolocation/#ip-geolocation</a></p>
|
|
35
|
+
|
|
36
|
+
<h3>Returns</h3></div>
|
|
37
|
+
<div class="tsd-parameters">
|
|
38
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
39
|
+
<ul class="tsd-parameter-list">
|
|
40
|
+
<li>
|
|
41
|
+
<h5>options: <a href="../types/services_geolocation.GeolocationInfoOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeolocationInfoOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
|
|
42
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/services_geolocation.GeolocationResult.html" class="tsd-signature-type" data-tsd-kind="Type alias">GeolocationResult</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources">
|
|
43
|
+
<ul>
|
|
44
|
+
<li>Defined in <a href="https://github.com/maptiler/maptiler-client-js/blob/64f9493/src/services/geolocation.ts#L135">services/geolocation.ts:135</a></li></ul></aside></div>
|
|
45
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
46
|
+
<div class="tsd-navigation settings">
|
|
47
|
+
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
48
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
49
|
+
<div class="tsd-accordion-details">
|
|
50
|
+
<div class="tsd-filter-visibility">
|
|
51
|
+
<h4 class="uppercase">Member Visibility</h4><form>
|
|
52
|
+
<ul id="tsd-filter-options">
|
|
53
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div>
|
|
54
|
+
<div class="tsd-theme-toggle">
|
|
55
|
+
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
56
|
+
<nav class="tsd-navigation primary">
|
|
57
|
+
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
58
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
59
|
+
<div class="tsd-accordion-details">
|
|
60
|
+
<ul>
|
|
61
|
+
<li class="current"><a href="../modules.html">Map<wbr/>Tiler <wbr/>Client -<wbr/> v1.1.0</a>
|
|
62
|
+
<ul>
|
|
63
|
+
<li class="tsd-kind-module"><a href="../modules/config.html">config</a></li>
|
|
64
|
+
<li class="tsd-kind-module"><a href="../modules/language.html">language</a></li>
|
|
65
|
+
<li class="tsd-kind-module"><a href="../modules/services_ServiceError.html">services/<wbr/>Service<wbr/>Error</a></li>
|
|
66
|
+
<li class="tsd-kind-module"><a href="../modules/services_coordinates.html">services/coordinates</a></li>
|
|
67
|
+
<li class="tsd-kind-module"><a href="../modules/services_data.html">services/data</a></li>
|
|
68
|
+
<li class="tsd-kind-module"><a href="../modules/services_geocoding.html">services/geocoding</a></li>
|
|
69
|
+
<li class="current tsd-kind-module"><a href="../modules/services_geolocation.html">services/geolocation</a></li>
|
|
70
|
+
<li class="tsd-kind-module"><a href="../modules/services_simplify.html">services/simplify</a></li>
|
|
71
|
+
<li class="tsd-kind-module"><a href="../modules/services_staticMaps.html">services/static<wbr/>Maps</a></li></ul></li></ul></div></details></nav>
|
|
72
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
73
|
+
<ul>
|
|
74
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_geolocation.GeolocationInfoOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Geolocation<wbr/>Info<wbr/>Options</a></li>
|
|
75
|
+
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/services_geolocation.GeolocationResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Geolocation<wbr/>Result</a></li>
|
|
76
|
+
<li class="current tsd-kind-variable tsd-parent-kind-module"><a href="services_geolocation.geolocation.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>geolocation</a></li></ul></nav></div></div>
|
|
77
|
+
<div class="container tsd-generator">
|
|
78
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
79
|
+
<div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|