@maptiler/client 1.5.0 → 1.7.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.
Files changed (119) hide show
  1. package/dist/maptiler-client.cjs +482 -309
  2. package/dist/maptiler-client.cjs.map +1 -1
  3. package/dist/maptiler-client.d.ts +177 -13
  4. package/dist/maptiler-client.min.mjs +1 -1
  5. package/dist/maptiler-client.mjs +471 -309
  6. package/dist/maptiler-client.mjs.map +1 -1
  7. package/dist/maptiler-client.umd.js +483 -310
  8. package/dist/maptiler-client.umd.js.map +1 -1
  9. package/dist/maptiler-client.umd.min.js +1 -1
  10. package/examples/test-node.js +9 -9
  11. package/package.json +25 -18
  12. package/readme.md +1 -1
  13. package/rollup.config.js +3 -3
  14. package/src/callFetch.ts +2 -2
  15. package/src/config.ts +4 -1
  16. package/src/demProfiler/getElevation.ts +46 -0
  17. package/src/demProfiler/index.ts +240 -0
  18. package/src/demProfiler/tileCover.ts +96 -0
  19. package/src/geometry/area.ts +96 -0
  20. package/src/geometry/distance.ts +45 -0
  21. package/src/geometry/index.ts +3 -0
  22. package/src/geometry/util.ts +34 -0
  23. package/src/index.ts +3 -0
  24. package/src/language.ts +1 -1
  25. package/src/mapstyle.ts +5 -5
  26. package/src/services/ServiceError.ts +5 -2
  27. package/src/services/coordinates.ts +14 -9
  28. package/src/services/data.ts +3 -3
  29. package/src/services/geocoding.ts +113 -32
  30. package/src/services/geolocation.ts +2 -2
  31. package/src/services/simplify.ts +3 -3
  32. package/src/services/staticMaps.ts +9 -9
  33. package/tsconfig.json +1 -1
  34. package/docs/.nojekyll +0 -1
  35. package/docs/assets/custom.css +0 -118
  36. package/docs/assets/highlight.css +0 -85
  37. package/docs/assets/main.js +0 -58
  38. package/docs/assets/search.js +0 -1
  39. package/docs/assets/style.css +0 -1280
  40. package/docs/classes/config.ClientConfig.html +0 -132
  41. package/docs/classes/services_ServiceError.ServiceError.html +0 -103
  42. package/docs/functions/language.getAutoLanguageGeocoding.html +0 -60
  43. package/docs/functions/services_simplify.default.html +0 -65
  44. package/docs/images/JS-logo.svg +0 -4
  45. package/docs/images/TS-logo.svg +0 -6
  46. package/docs/images/maptiler-client-logo.afdesign +0 -0
  47. package/docs/images/maptiler-client-logo.svg +0 -75
  48. package/docs/images/maptiler-logo-256.png +0 -0
  49. package/docs/images/maptiler-logo.svg +0 -23
  50. package/docs/images/screenshots/static-bounded-europe-1024.png +0 -0
  51. package/docs/images/screenshots/static-bounded-europe-2048.png +0 -0
  52. package/docs/images/screenshots/static-bounded-portugal-1024x2048.png +0 -0
  53. package/docs/images/screenshots/static-bounded-portugal-2048x2048.png +0 -0
  54. package/docs/images/screenshots/static-with-path.png +0 -0
  55. package/docs/index.html +0 -340
  56. package/docs/modules/config.html +0 -71
  57. package/docs/modules/language.html +0 -71
  58. package/docs/modules/services_ServiceError.html +0 -61
  59. package/docs/modules/services_coordinates.html +0 -84
  60. package/docs/modules/services_data.html +0 -66
  61. package/docs/modules/services_geocoding.html +0 -82
  62. package/docs/modules/services_geolocation.html +0 -68
  63. package/docs/modules/services_simplify.html +0 -61
  64. package/docs/modules/services_staticMaps.html +0 -74
  65. package/docs/modules.html +0 -59
  66. package/docs/types/config.FetchFunction.html +0 -71
  67. package/docs/types/language.LanguageGeocodingString.html +0 -58
  68. package/docs/types/services_coordinates.CoordinateExport.html +0 -71
  69. package/docs/types/services_coordinates.CoordinateGrid.html +0 -69
  70. package/docs/types/services_coordinates.CoordinateId.html +0 -71
  71. package/docs/types/services_coordinates.CoordinateSearch.html +0 -93
  72. package/docs/types/services_coordinates.CoordinateSearchResult.html +0 -75
  73. package/docs/types/services_coordinates.CoordinateTransformResult.html +0 -76
  74. package/docs/types/services_coordinates.CoordinateTransformation.html +0 -89
  75. package/docs/types/services_coordinates.CoordinatesSearchOptions.html +0 -83
  76. package/docs/types/services_coordinates.CoordinatesTransformOptions.html +0 -85
  77. package/docs/types/services_coordinates.XYZ.html +0 -73
  78. package/docs/types/services_data.GetDataOptions.html +0 -64
  79. package/docs/types/services_geocoding.ByIdGeocodingOptions.html +0 -63
  80. package/docs/types/services_geocoding.CommonForwardAndReverseGeocodingOptions.html +0 -63
  81. package/docs/types/services_geocoding.Coordinates.html +0 -63
  82. package/docs/types/services_geocoding.FeatureHierarchy.html +0 -74
  83. package/docs/types/services_geocoding.GeocodingFeature.html +0 -63
  84. package/docs/types/services_geocoding.GeocodingOptions.html +0 -63
  85. package/docs/types/services_geocoding.GeocodingSearchResult.html +0 -80
  86. package/docs/types/services_geocoding.LanguageGeocodingOptions.html +0 -70
  87. package/docs/types/services_geocoding.ReverseGeocodingOptions.html +0 -63
  88. package/docs/types/services_geolocation.GeolocationInfoOptions.html +0 -65
  89. package/docs/types/services_geolocation.GeolocationResult.html +0 -128
  90. package/docs/types/services_staticMaps.AutomaticStaticMapOptions.html +0 -61
  91. package/docs/types/services_staticMaps.BoundedStaticMapOptions.html +0 -61
  92. package/docs/types/services_staticMaps.CenteredStaticMapOptions.html +0 -61
  93. package/docs/types/services_staticMaps.StaticMapBaseOptions.html +0 -157
  94. package/docs/types/services_staticMaps.StaticMapMarker.html +0 -61
  95. package/docs/variables/config.config.html +0 -58
  96. package/docs/variables/language.LanguageGeocoding.html +0 -171
  97. package/docs/variables/services_coordinates.coordinates.html +0 -110
  98. package/docs/variables/services_data.data.html +0 -80
  99. package/docs/variables/services_geocoding.geocoding.html +0 -265
  100. package/docs/variables/services_geolocation.geolocation.html +0 -79
  101. package/docs/variables/services_staticMaps.staticMaps.html +0 -128
  102. package/docsmd/.nojekyll +0 -1
  103. package/docsmd/README.md +0 -880
  104. package/docsmd/assets/custom.css +0 -118
  105. package/docsmd/classes/ClientConfig.md +0 -90
  106. package/docsmd/classes/MapStyleVariant.md +0 -234
  107. package/docsmd/classes/ReferenceMapStyle.md +0 -169
  108. package/docsmd/classes/ServiceError.md +0 -52
  109. package/images/JS-logo.svg +0 -4
  110. package/images/TS-logo.svg +0 -6
  111. package/images/maptiler-client-logo.afdesign +0 -0
  112. package/images/maptiler-client-logo.svg +0 -75
  113. package/images/maptiler-logo-256.png +0 -0
  114. package/images/maptiler-logo.svg +0 -23
  115. package/images/screenshots/static-bounded-europe-1024.png +0 -0
  116. package/images/screenshots/static-bounded-europe-2048.png +0 -0
  117. package/images/screenshots/static-bounded-portugal-1024x2048.png +0 -0
  118. package/images/screenshots/static-bounded-portugal-2048x2048.png +0 -0
  119. package/images/screenshots/static-with-path.png +0 -0
package/docsmd/README.md DELETED
@@ -1,880 +0,0 @@
1
- MapTiler Client - v1.5.0
2
-
3
- # MapTiler Client - v1.5.0
4
-
5
- ## Table of contents
6
-
7
- ### Classes
8
-
9
- - [ClientConfig](classes/ClientConfig.md)
10
- - [MapStyleVariant](classes/MapStyleVariant.md)
11
- - [ReferenceMapStyle](classes/ReferenceMapStyle.md)
12
- - [ServiceError](classes/ServiceError.md)
13
-
14
- ### Type Aliases
15
-
16
- - [AutomaticStaticMapOptions](README.md#automaticstaticmapoptions)
17
- - [BoundedStaticMapOptions](README.md#boundedstaticmapoptions)
18
- - [CenteredStaticMapOptions](README.md#centeredstaticmapoptions)
19
- - [CommonForwardAndReverseGeocodingOptions](README.md#commonforwardandreversegeocodingoptions)
20
- - [CoordinateExport](README.md#coordinateexport)
21
- - [CoordinateGrid](README.md#coordinategrid)
22
- - [CoordinateId](README.md#coordinateid)
23
- - [CoordinateSearch](README.md#coordinatesearch)
24
- - [CoordinateSearchResult](README.md#coordinatesearchresult)
25
- - [CoordinateTransformResult](README.md#coordinatetransformresult)
26
- - [CoordinateTransformation](README.md#coordinatetransformation)
27
- - [Coordinates](README.md#coordinates)
28
- - [CoordinatesSearchOptions](README.md#coordinatessearchoptions)
29
- - [CoordinatesTransformOptions](README.md#coordinatestransformoptions)
30
- - [FeatureHierarchy](README.md#featurehierarchy)
31
- - [FetchFunction](README.md#fetchfunction)
32
- - [GeocodingFeature](README.md#geocodingfeature)
33
- - [GeocodingOptions](README.md#geocodingoptions)
34
- - [GeocodingSearchResult](README.md#geocodingsearchresult)
35
- - [GeolocationInfoOptions](README.md#geolocationinfooptions)
36
- - [GeolocationResult](README.md#geolocationresult)
37
- - [GetDataOptions](README.md#getdataoptions)
38
- - [LanguageGeocodingOptions](README.md#languagegeocodingoptions)
39
- - [LanguageGeocodingString](README.md#languagegeocodingstring)
40
- - [MapStylePreset](README.md#mapstylepreset)
41
- - [MapStyleType](README.md#mapstyletype)
42
- - [ReverseGeocodingOptions](README.md#reversegeocodingoptions)
43
- - [StaticMapBaseOptions](README.md#staticmapbaseoptions)
44
- - [StaticMapMarker](README.md#staticmapmarker)
45
- - [XYZ](README.md#xyz)
46
-
47
- ### Variables
48
-
49
- - [LanguageGeocoding](README.md#languagegeocoding)
50
- - [MapStyle](README.md#mapstyle)
51
- - [config](README.md#config)
52
- - [coordinates](README.md#coordinates-1)
53
- - [data](README.md#data)
54
- - [geocoding](README.md#geocoding)
55
- - [geolocation](README.md#geolocation)
56
- - [mapStylePresetList](README.md#mapstylepresetlist)
57
- - [staticMaps](README.md#staticmaps)
58
-
59
- ### Functions
60
-
61
- - [expandMapStyle](README.md#expandmapstyle)
62
-
63
- ## Type Aliases
64
-
65
- ### AutomaticStaticMapOptions
66
-
67
- Ƭ **AutomaticStaticMapOptions**: [`BoundedStaticMapOptions`](README.md#boundedstaticmapoptions)
68
-
69
- Options that can be provided to automatic static maps
70
-
71
- #### Defined in
72
-
73
- [services/staticMaps.ts:141](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/staticMaps.ts#L141)
74
-
75
- ___
76
-
77
- ### BoundedStaticMapOptions
78
-
79
- Ƭ **BoundedStaticMapOptions**: [`StaticMapBaseOptions`](README.md#staticmapbaseoptions) & { `padding?`: `number` }
80
-
81
- Options that can be provided to bounded static maps
82
-
83
- #### Defined in
84
-
85
- [services/staticMaps.ts:130](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/staticMaps.ts#L130)
86
-
87
- ___
88
-
89
- ### CenteredStaticMapOptions
90
-
91
- Ƭ **CenteredStaticMapOptions**: [`StaticMapBaseOptions`](README.md#staticmapbaseoptions)
92
-
93
- Options that can be provided to centered static maps
94
-
95
- #### Defined in
96
-
97
- [services/staticMaps.ts:125](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/staticMaps.ts#L125)
98
-
99
- ___
100
-
101
- ### CommonForwardAndReverseGeocodingOptions
102
-
103
- Ƭ **CommonForwardAndReverseGeocodingOptions**: [`LanguageGeocodingOptions`](README.md#languagegeocodingoptions) & { `apiKey?`: `string` ; `limit?`: `number` ; `types?`: (``"country"`` \| ``"region"`` \| ``"subregion"`` \| ``"county"`` \| ``"joint_municipality"`` \| ``"joint_submunicipality"`` \| ``"municipality"`` \| ``"municipal_district"`` \| ``"locality"`` \| ``"neighbourhood"`` \| ``"place"`` \| ``"postal_code"`` \| ``"address"``)[] }
104
-
105
- #### Defined in
106
-
107
- [services/geocoding.ts:25](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geocoding.ts#L25)
108
-
109
- ___
110
-
111
- ### CoordinateExport
112
-
113
- Ƭ **CoordinateExport**: `Object`
114
-
115
- #### Type declaration
116
-
117
- | Name | Type |
118
- | :------ | :------ |
119
- | `proj4` | `string` |
120
- | `wkt` | `string` |
121
-
122
- #### Defined in
123
-
124
- [services/coordinates.ts:38](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L38)
125
-
126
- ___
127
-
128
- ### CoordinateGrid
129
-
130
- Ƭ **CoordinateGrid**: `Object`
131
-
132
- #### Type declaration
133
-
134
- | Name | Type |
135
- | :------ | :------ |
136
- | `path` | `string` |
137
-
138
- #### Defined in
139
-
140
- [services/coordinates.ts:43](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L43)
141
-
142
- ___
143
-
144
- ### CoordinateId
145
-
146
- Ƭ **CoordinateId**: `Object`
147
-
148
- #### Type declaration
149
-
150
- | Name | Type |
151
- | :------ | :------ |
152
- | `authority` | `string` |
153
- | `code` | `BigInteger` |
154
-
155
- #### Defined in
156
-
157
- [services/coordinates.ts:33](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L33)
158
-
159
- ___
160
-
161
- ### CoordinateSearch
162
-
163
- Ƭ **CoordinateSearch**: `Object`
164
-
165
- #### Type declaration
166
-
167
- | Name | Type | Description |
168
- | :------ | :------ | :------ |
169
- | `accuracy?` | `number` | - |
170
- | `area?` | `string` | - |
171
- | `bbox?` | `BBox` | Bounding box of the resource in [min_lon, min_lat, max_lon, max_lat] order. |
172
- | `default_transformation?` | `any` | Most suitable transformation for this CRS. |
173
- | `deprecated` | `boolean` | - |
174
- | `exports` | [`CoordinateExport`](README.md#coordinateexport) | - |
175
- | `id` | [`CoordinateId`](README.md#coordinateid) | - |
176
- | `kind` | `string` | - |
177
- | `name` | `string` | - |
178
- | `transformations?` | ([`CoordinateTransformation`](README.md#coordinatetransformation) \| `number`)[] | - |
179
- | `unit?` | `string` | - |
180
-
181
- #### Defined in
182
-
183
- [services/coordinates.ts:61](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L61)
184
-
185
- ___
186
-
187
- ### CoordinateSearchResult
188
-
189
- Ƭ **CoordinateSearchResult**: `Object`
190
-
191
- #### Type declaration
192
-
193
- | Name | Type | Description |
194
- | :------ | :------ | :------ |
195
- | `results` | [`CoordinateSearch`](README.md#coordinatesearch)[] | The coordinate search results |
196
- | `total` | `number` | The number of results |
197
-
198
- #### Defined in
199
-
200
- [services/coordinates.ts:91](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L91)
201
-
202
- ___
203
-
204
- ### CoordinateTransformResult
205
-
206
- Ƭ **CoordinateTransformResult**: `Object`
207
-
208
- #### Type declaration
209
-
210
- | Name | Type | Description |
211
- | :------ | :------ | :------ |
212
- | `results` | [`XYZ`](README.md#xyz)[] | - |
213
- | `transformer_selection_strategy` | `string` | Transformations are selected using given ops parameter. If no parameter is given, auto strategy is used. If given, it may try to use a listed transformation, then fallback to towgs84 patching, and finally boundcrs. |
214
-
215
- #### Defined in
216
-
217
- [services/coordinates.ts:159](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L159)
218
-
219
- ___
220
-
221
- ### CoordinateTransformation
222
-
223
- Ƭ **CoordinateTransformation**: `Object`
224
-
225
- #### Type declaration
226
-
227
- | Name | Type |
228
- | :------ | :------ |
229
- | `accuracy?` | `number` |
230
- | `area?` | `string` |
231
- | `bbox?` | `BBox` |
232
- | `deprecated` | `boolean` |
233
- | `grids` | [`CoordinateGrid`](README.md#coordinategrid)[] |
234
- | `id` | [`CoordinateId`](README.md#coordinateid) |
235
- | `name` | `string` |
236
- | `reversible` | `boolean` |
237
- | `target_crs?` | [`CoordinateId`](README.md#coordinateid) |
238
- | `unit?` | `string` |
239
- | `usable` | `boolean` |
240
-
241
- #### Defined in
242
-
243
- [services/coordinates.ts:47](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L47)
244
-
245
- ___
246
-
247
- ### Coordinates
248
-
249
- Ƭ **Coordinates**: `Position`
250
-
251
- #### Defined in
252
-
253
- [services/geocoding.ts:89](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geocoding.ts#L89)
254
-
255
- ___
256
-
257
- ### CoordinatesSearchOptions
258
-
259
- Ƭ **CoordinatesSearchOptions**: `Object`
260
-
261
- #### Type declaration
262
-
263
- | Name | Type | Description |
264
- | :------ | :------ | :------ |
265
- | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
266
- | `exports?` | `boolean` | Show exports in WKT and Proj4 notations (default: false) |
267
- | `limit?` | `number` | Maximum number of results returned (default: 10) |
268
- | `transformations?` | `boolean` | Show detailed transformations for each CRS (default: false) |
269
-
270
- #### Defined in
271
-
272
- [services/coordinates.ts:11](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L11)
273
-
274
- ___
275
-
276
- ### CoordinatesTransformOptions
277
-
278
- Ƭ **CoordinatesTransformOptions**: `Object`
279
-
280
- Options that can be provided when transforming a coordinate from one CRS to another.
281
-
282
- #### Type declaration
283
-
284
- | Name | Type | Description |
285
- | :------ | :------ | :------ |
286
- | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
287
- | `operations?` | `number` \| `number`[] | List of codes of operations |
288
- | `sourceCrs?` | `number` | Source coordinate reference system (default: 4326) |
289
- | `targetCrs?` | `number` | Target coordinate reference system (default: 4326) |
290
-
291
- #### Defined in
292
-
293
- [services/coordinates.ts:174](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L174)
294
-
295
- ___
296
-
297
- ### FeatureHierarchy
298
-
299
- Ƭ **FeatureHierarchy**: `Object`
300
-
301
- #### Type declaration
302
-
303
- | Name | Type | Description |
304
- | :------ | :------ | :------ |
305
- | `id` | `string` | Unique feature ID |
306
- | `text` | `string` | Localized feature name |
307
-
308
- #### Defined in
309
-
310
- [services/geocoding.ts:91](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geocoding.ts#L91)
311
-
312
- ___
313
-
314
- ### FetchFunction
315
-
316
- Ƭ **FetchFunction**: (`url`: `string`, `options`: `object`) => `Promise`<`any`\>
317
-
318
- #### Type declaration
319
-
320
- ▸ (`url`, `options`): `Promise`<`any`\>
321
-
322
- ##### Parameters
323
-
324
- | Name | Type |
325
- | :------ | :------ |
326
- | `url` | `string` |
327
- | `options` | `object` |
328
-
329
- ##### Returns
330
-
331
- `Promise`<`any`\>
332
-
333
- #### Defined in
334
-
335
- [config.ts:1](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/config.ts#L1)
336
-
337
- ___
338
-
339
- ### GeocodingFeature
340
-
341
- Ƭ **GeocodingFeature**: `Feature` & { `address?`: `string` ; `bbox`: `BBox` ; `center`: [`Coordinates`](README.md#coordinates) ; `context?`: [`FeatureHierarchy`](README.md#featurehierarchy)[] ; `place_name`: `string` ; `text`: `string` }
342
-
343
- #### Defined in
344
-
345
- [services/geocoding.ts:103](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geocoding.ts#L103)
346
-
347
- ___
348
-
349
- ### GeocodingOptions
350
-
351
- Ƭ **GeocodingOptions**: [`CommonForwardAndReverseGeocodingOptions`](README.md#commonforwardandreversegeocodingoptions) & { `autocomplete?`: `boolean` ; `bbox?`: `BBox` ; `country?`: `string`[] ; `fuzzyMatch?`: `boolean` ; `proximity?`: `Position` }
352
-
353
- #### Defined in
354
-
355
- [services/geocoding.ts:57](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geocoding.ts#L57)
356
-
357
- ___
358
-
359
- ### GeocodingSearchResult
360
-
361
- Ƭ **GeocodingSearchResult**: `Object`
362
-
363
- #### Type declaration
364
-
365
- | Name | Type | Description |
366
- | :------ | :------ | :------ |
367
- | `attribution` | `string` | Attribution of the result |
368
- | `features` | [`GeocodingFeature`](README.md#geocodingfeature)[] | Array of features found |
369
- | `query` | `string`[] | Tokenized search query |
370
- | `type` | ``"FeatureCollection"`` | - |
371
-
372
- #### Defined in
373
-
374
- [services/geocoding.ts:135](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geocoding.ts#L135)
375
-
376
- ___
377
-
378
- ### GeolocationInfoOptions
379
-
380
- Ƭ **GeolocationInfoOptions**: `Object`
381
-
382
- Options that can be provided to get user data.
383
-
384
- #### Type declaration
385
-
386
- | Name | Type | Description |
387
- | :------ | :------ | :------ |
388
- | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
389
-
390
- #### Defined in
391
-
392
- [services/geolocation.ts:14](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geolocation.ts#L14)
393
-
394
- ___
395
-
396
- ### GeolocationResult
397
-
398
- Ƭ **GeolocationResult**: `Object`
399
-
400
- #### Type declaration
401
-
402
- | Name | Type | Description |
403
- | :------ | :------ | :------ |
404
- | `city?` | `string` | Name of the city Example: Zurich |
405
- | `continent?` | `string` | Name of the continent Example: Europe |
406
- | `continent_code?` | `string` | Two-letter code of the continent Example: EU |
407
- | `country?` | `string` | Name of the country Example: Switzerland |
408
- | `country_bounds?` | `BBox` | Bounds of the country in WGS84 degrees [west, south, east, north]. Example: [5.95538,45.818852,10.490936,47.809357] |
409
- | `country_code?` | `string` | Two-letter code of the country ISO 3166-1 alpha-2 codes Example: CH |
410
- | `country_languages?` | `string`[] | Official country languages in ISO 639-1 format. ISO 639-1 codes Example: ["de","fr","it"] |
411
- | `eu?` | `boolean` | Indicated whether the country is part of the European Union. |
412
- | `latitude?` | `number` | Latitude of the location Example: 47.36667 |
413
- | `longitude?` | `number` | Longitude of the location Example: 8.55 |
414
- | `postal?` | `string` | Postal code Example: 8000 |
415
- | `region?` | `string` | If known, the ISO 3166-2 name for the first level region. ISO 3166-2 codes Example: Zurich |
416
- | `region_code?` | `string` | If known, the ISO 3166-2 code for the first level region. ISO 3166-2 codes Example: ZH |
417
- | `timezone?` | `string` | Name of the timezone Example: Europe/Zurich |
418
-
419
- #### Defined in
420
-
421
- [services/geolocation.ts:21](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geolocation.ts#L21)
422
-
423
- ___
424
-
425
- ### GetDataOptions
426
-
427
- Ƭ **GetDataOptions**: `Object`
428
-
429
- Options that can be provided to get user data.
430
-
431
- #### Type declaration
432
-
433
- | Name | Type | Description |
434
- | :------ | :------ | :------ |
435
- | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
436
-
437
- #### Defined in
438
-
439
- [services/data.ts:14](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/data.ts#L14)
440
-
441
- ___
442
-
443
- ### LanguageGeocodingOptions
444
-
445
- Ƭ **LanguageGeocodingOptions**: `Object`
446
-
447
- #### Type declaration
448
-
449
- | Name | Type | Description |
450
- | :------ | :------ | :------ |
451
- | `language?` | [`LanguageGeocodingString`](README.md#languagegeocodingstring) \| [`LanguageGeocodingString`](README.md#languagegeocodingstring)[] | Prefer results in specific language. It’s possible to specify multiple values. |
452
-
453
- #### Defined in
454
-
455
- [services/geocoding.ts:18](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geocoding.ts#L18)
456
-
457
- ___
458
-
459
- ### LanguageGeocodingString
460
-
461
- Ƭ **LanguageGeocodingString**: `Values`<typeof [`LanguageGeocoding`](README.md#languagegeocoding)\>
462
-
463
- Built-in languages values as strings
464
-
465
- #### Defined in
466
-
467
- [language.ts:69](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/language.ts#L69)
468
-
469
- ___
470
-
471
- ### MapStylePreset
472
-
473
- Ƭ **MapStylePreset**: `Object`
474
-
475
- Type for object containing style details
476
-
477
- #### Type declaration
478
-
479
- | Name | Type |
480
- | :------ | :------ |
481
- | `description` | `string` |
482
- | `name` | `string` |
483
- | `referenceStyleID` | `string` |
484
- | `variants` | { `description`: `string` ; `id`: `string` ; `imageURL`: `string` ; `name`: `string` ; `variantType`: `string` }[] |
485
-
486
- #### Defined in
487
-
488
- [mapstyle.ts:29](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/mapstyle.ts#L29)
489
-
490
- ___
491
-
492
- ### MapStyleType
493
-
494
- Ƭ **MapStyleType**: `Object`
495
-
496
- All the styles and variants maintained by MapTiler.
497
-
498
- #### Type declaration
499
-
500
- | Name | Type | Description |
501
- | :------ | :------ | :------ |
502
- | `BACKDROP` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Neutral greyscale style with hillshading suitable for colorful terrain-aware visualization |
503
- | `BASIC` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A minimalist street-oriented style without POI |
504
- | `BRIGHT` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `PASTEL`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A bright street-oriented style, a nice alternative to `streets` |
505
- | `DATAVIZ` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Minimalist style, perfect for data visualization |
506
- | `HYBRID` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | High resolution imagery with labels, political borders and roads. |
507
- | `OCEAN` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Explore deep see trenches and mountains, with isolines and depth labels |
508
- | `OPENSTREETMAP` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Classic OpenStreetMap style |
509
- | `OUTDOOR` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitable for outdoor activities. With elevation isolines and hillshading. |
510
- | `SATELLITE` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | High resolution imagery only, without any label. |
511
- | `STREETS` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `NIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `PASTEL`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitable for navigation, with high level of detail on urban areas, plenty of POIs and 3D buildings |
512
- | `TONER` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `BACKGROUND`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LINES`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LITE`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A bold very high contrast black and white (no gray!) style for the city |
513
- | `TOPO` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `PASTEL`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `SHINY`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `TOPOGRAPHIQUE`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A nice high-contrast, yet less saturated alternative to the `outdoor` style, with hillshading, 3D buildings and fairly high street details |
514
- | `VOYAGER` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `VINTAGE`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | A nice alternative to `streets` with a soft color palette |
515
- | `WINTER` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitabe for winter outdoor activities. With ski tracks, elevation isolines and hillshading. |
516
-
517
- #### Defined in
518
-
519
- [mapstyle.ts:258](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/mapstyle.ts#L258)
520
-
521
- ___
522
-
523
- ### ReverseGeocodingOptions
524
-
525
- Ƭ **ReverseGeocodingOptions**: [`CommonForwardAndReverseGeocodingOptions`](README.md#commonforwardandreversegeocodingoptions)
526
-
527
- #### Defined in
528
-
529
- [services/geocoding.ts:85](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geocoding.ts#L85)
530
-
531
- ___
532
-
533
- ### StaticMapBaseOptions
534
-
535
- Ƭ **StaticMapBaseOptions**: `Object`
536
-
537
- Base set of options that can be provided to all the types of static maps
538
-
539
- #### Type declaration
540
-
541
- | Name | Type | Description |
542
- | :------ | :------ | :------ |
543
- | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
544
- | `attribution?` | ``"bottomright"`` \| ``"bottomleft"`` \| ``"topleft"`` \| ``"topright"`` \| ``false`` | Placement of the attribution. Can also be set to `false` to not show attribution. Default: `"bottomright"` |
545
- | `format?` | ``"png"`` \| ``"jpg"`` \| ``"webp"`` | Image format. Default: `"png"` |
546
- | `height?` | `number` | Height of the output image. Maximum value: `2048`. Default: `1024` |
547
- | `hiDPI?` | `boolean` | Double the size of the static map image to support hiDPI/Retina monitors. Default: `false` |
548
- | `markerAnchor?` | ``"top"`` \| ``"left"`` \| ``"bottom"`` \| ``"right"`` \| ``"center"`` \| ``"topleft"`` \| ``"bottomleft"`` \| ``"topright"`` \| ``"bottomright"`` | Position of the marker regarding its coordinates. Applies only: - with a custom icon provided with `markerIcon` - if one or multiple markers positions are provided. Default: `"bottom"` |
549
- | `markerIcon?` | `string` | URL of the marker image. Applies only if one or multiple markers positions are provided. Default: none provided |
550
- | `markers?` | [`StaticMapMarker`](README.md#staticmapmarker) \| [`StaticMapMarker`](README.md#staticmapmarker)[] | A marker or list of markers to show on the map Default: none provided |
551
- | `path?` | `Position`[] | Draw a path or polygon on top of the map. If the path is too long it will be simplified, yet remaining accurate. Default: none provided |
552
- | `pathFillColor?` | `string` | Color of the filling, also works if the polygon is not closed. The color must be CSS compatible. Examples: - long form hex without transparency `"#FF0000"` (red) - short form hex without transparency `"#F00"` (red) - long form hex with transparency `"#FF000008"` (red, half opacity) - short form hex with transparency `"#F008"` (red, half opacity) - CSS color shorthands: `"red"`, `"chartreuse"`, etc. - decimal RGB values without transparency: `"rgb(128, 100, 255)"` - decimal RGB values with transparency: `"rgb(128, 100, 255, 0.5)"` Default: none (transparent filling) |
553
- | `pathStrokeColor?` | `string` | Color of the path line. The color must be CSS compatible. Examples: - long form hex without transparency `"#FF0000"` (red) - short form hex without transparency `"#F00"` (red) - long form hex with transparency `"#FF000008"` (red, half opacity) - short form hex with transparency `"#F008"` (red, half opacity) - CSS color shorthands: `"red"`, `"chartreuse"`, etc. - decimal RGB values without transparency: `"rgb(128, 100, 255)"` - decimal RGB values with transparency: `"rgb(128, 100, 255, 0.5)"` Default: `"blue"` |
554
- | `pathWidth?` | `number` | Width of the path line in pixel. It can be floating point precision (ex: `0.5`) Default: `1` if `hiDPI` is `false` and `2` if `hiDPI` is `true`. |
555
- | `style?` | `string` \| [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) \| [`MapStyleVariant`](classes/MapStyleVariant.md) | Style of the map (not full style URL). Example: "winter", "streets-v2". Default: `"streets-v2"` |
556
- | `width?` | `number` | Width of the output image. Maximum value: `2048`. Default: `1024` |
557
-
558
- #### Defined in
559
-
560
- [services/staticMaps.ts:10](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/staticMaps.ts#L10)
561
-
562
- ___
563
-
564
- ### StaticMapMarker
565
-
566
- Ƭ **StaticMapMarker**: [`number`, `number`, `string`]
567
-
568
- Definition of a maker to show on a static map
569
-
570
- #### Defined in
571
-
572
- [services/staticMaps.ts:146](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/staticMaps.ts#L146)
573
-
574
- ___
575
-
576
- ### XYZ
577
-
578
- Ƭ **XYZ**: `Object`
579
-
580
- #### Type declaration
581
-
582
- | Name | Type |
583
- | :------ | :------ |
584
- | `x?` | `number` |
585
- | `y?` | `number` |
586
- | `z?` | `number` |
587
-
588
- #### Defined in
589
-
590
- [services/coordinates.ts:153](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L153)
591
-
592
- ## Variables
593
-
594
- ### LanguageGeocoding
595
-
596
- • `Const` **LanguageGeocoding**: `Object`
597
-
598
- Languages. Note that not all the languages of this list are available but the compatibility list may be expanded in the future.
599
-
600
- #### Type declaration
601
-
602
- | Name | Type |
603
- | :------ | :------ |
604
- | `ALBANIAN` | `string` |
605
- | `ARABIC` | `string` |
606
- | `ARMENIAN` | `string` |
607
- | `AUTO` | `string` |
608
- | `AZERBAIJANI` | `string` |
609
- | `BELORUSSIAN` | `string` |
610
- | `BOSNIAN` | `string` |
611
- | `BRETON` | `string` |
612
- | `BULGARIAN` | `string` |
613
- | `CATALAN` | `string` |
614
- | `CHINESE` | `string` |
615
- | `CROATIAN` | `string` |
616
- | `CZECH` | `string` |
617
- | `DANISH` | `string` |
618
- | `DUTCH` | `string` |
619
- | `ENGLISH` | `string` |
620
- | `ESPERANTO` | `string` |
621
- | `ESTONIAN` | `string` |
622
- | `FINNISH` | `string` |
623
- | `FRENCH` | `string` |
624
- | `FRISIAN` | `string` |
625
- | `GEORGIAN` | `string` |
626
- | `GERMAN` | `string` |
627
- | `GREEK` | `string` |
628
- | `HEBREW` | `string` |
629
- | `HUNGARIAN` | `string` |
630
- | `ICELANDIC` | `string` |
631
- | `IRISH` | `string` |
632
- | `ITALIAN` | `string` |
633
- | `JAPANESE` | `string` |
634
- | `KANNADA` | `string` |
635
- | `KAZAKH` | `string` |
636
- | `KOREAN` | `string` |
637
- | `LATVIAN` | `string` |
638
- | `LITHUANIAN` | `string` |
639
- | `LUXEMBOURGISH` | `string` |
640
- | `MACEDONIAN` | `string` |
641
- | `MALTESE` | `string` |
642
- | `NORWEGIAN` | `string` |
643
- | `POLISH` | `string` |
644
- | `PORTUGUESE` | `string` |
645
- | `ROMANIAN` | `string` |
646
- | `ROMANSH` | `string` |
647
- | `ROMAN_LATIN` | `string` |
648
- | `RUSSIAN` | `string` |
649
- | `SCOTTISH_GAELIC` | `string` |
650
- | `SERBIAN_CYRILLIC` | `string` |
651
- | `SLOVAK` | `string` |
652
- | `SLOVENE` | `string` |
653
- | `SPANISH` | `string` |
654
- | `SWEDISH` | `string` |
655
- | `THAI` | `string` |
656
- | `TURKISH` | `string` |
657
- | `UKRAINIAN` | `string` |
658
- | `WELSH` | `string` |
659
-
660
- #### Defined in
661
-
662
- [language.ts:4](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/language.ts#L4)
663
-
664
- ___
665
-
666
- ### MapStyle
667
-
668
- • `Const` **MapStyle**: [`MapStyleType`](README.md#mapstyletype)
669
-
670
- Contains all the reference map style created by MapTiler team as well as all the variants.
671
- For example, `MapStyle.STREETS` and the variants:
672
- - `MapStyle.STREETS.DARK`
673
- - `MapStyle.STREETS.LIGHT`
674
- - `MapStyle.STREETS.PASTEL`
675
-
676
- #### Defined in
677
-
678
- [mapstyle.ts:968](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/mapstyle.ts#L968)
679
-
680
- ___
681
-
682
- ### config
683
-
684
- • `Const` **config**: [`ClientConfig`](classes/ClientConfig.md)
685
-
686
- Configuration object
687
-
688
- #### Defined in
689
-
690
- [config.ts:63](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/config.ts#L63)
691
-
692
- ___
693
-
694
- ### coordinates
695
-
696
- • `Const` **coordinates**: `Object`
697
-
698
- The **coordinate** namespace contains asynchronous functions to call the [MapTiler Coordinate API](https://docs.maptiler.com/cloud/api/coordinates/).
699
- The goal of the **Coordinate API* is query information about spatial coordinate reference system (CRS) as well as to transform coordinates from one CRS to another.
700
-
701
- #### Type declaration
702
-
703
- | Name | Type |
704
- | :------ | :------ |
705
- | `search` | (`query`: `string`, `options`: [`CoordinatesSearchOptions`](README.md#coordinatessearchoptions)) => `Promise`<[`CoordinateSearchResult`](README.md#coordinatesearchresult)\> |
706
- | `transform` | (`positions`: `Position` \| `Position`[], `options`: [`CoordinatesTransformOptions`](README.md#coordinatestransformoptions)) => `Promise`<[`CoordinateTransformResult`](README.md#coordinatetransformresult)\> |
707
-
708
- #### Defined in
709
-
710
- [services/coordinates.ts:253](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/coordinates.ts#L253)
711
-
712
- ___
713
-
714
- ### data
715
-
716
- • `Const` **data**: `Object`
717
-
718
- The **data** namespace contains an asynchronous function to call the [MapTiler Data API](https://docs.maptiler.com/cloud/api/data/).
719
- The **Data API** provides a way to retrieve user data in GeoJSON format.
720
-
721
- #### Type declaration
722
-
723
- | Name | Type |
724
- | :------ | :------ |
725
- | `get` | (`dataId`: `string`, `options`: [`GetDataOptions`](README.md#getdataoptions)) => `Promise`<`FeatureCollection`\> |
726
-
727
- #### Defined in
728
-
729
- [services/data.ts:59](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/data.ts#L59)
730
-
731
- ___
732
-
733
- ### geocoding
734
-
735
- • `Const` **geocoding**: `Object`
736
-
737
- The **geocoding** namespace contains asynchronous functions to call the [MapTiler Geocoding API](https://docs.maptiler.com/cloud/api/geocoding/).
738
- The **Geocoding API** provides ways to get geographic coordinates from a human-readable search query of a place (forward geocoding)
739
- and to get the location details (country, city, street, etc.) from a geographic coordinate (reverse geocoding);
740
-
741
- #### Type declaration
742
-
743
- | Name | Type |
744
- | :------ | :------ |
745
- | `batch` | (`queries`: `string`[], `options`: [`GeocodingOptions`](README.md#geocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)[]\> |
746
- | `byId` | (`id`: `string`, `options`: [`LanguageGeocodingOptions`](README.md#languagegeocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
747
- | `forward` | (`query`: `string`, `options`: [`GeocodingOptions`](README.md#geocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
748
- | `language` | { `ALBANIAN`: `string` = "sq"; `ARABIC`: `string` = "ar"; `ARMENIAN`: `string` = "hy"; `AUTO`: `string` = "auto"; `AZERBAIJANI`: `string` = "az"; `BELORUSSIAN`: `string` = "be"; `BOSNIAN`: `string` = "bs"; `BRETON`: `string` = "br"; `BULGARIAN`: `string` = "bg"; `CATALAN`: `string` = "ca"; `CHINESE`: `string` = "zh"; `CROATIAN`: `string` = "hr"; `CZECH`: `string` = "cs"; `DANISH`: `string` = "da"; `DUTCH`: `string` = "nl"; `ENGLISH`: `string` = "en"; `ESPERANTO`: `string` = "eo"; `ESTONIAN`: `string` = "et"; `FINNISH`: `string` = "fi"; `FRENCH`: `string` = "fr"; `FRISIAN`: `string` = "fy"; `GEORGIAN`: `string` = "ka"; `GERMAN`: `string` = "de"; `GREEK`: `string` = "el"; `HEBREW`: `string` = "he"; `HUNGARIAN`: `string` = "hu"; `ICELANDIC`: `string` = "is"; `IRISH`: `string` = "ga"; `ITALIAN`: `string` = "it"; `JAPANESE`: `string` = "ja"; `KANNADA`: `string` = "kn"; `KAZAKH`: `string` = "kk"; `KOREAN`: `string` = "ko"; `LATVIAN`: `string` = "lv"; `LITHUANIAN`: `string` = "lt"; `LUXEMBOURGISH`: `string` = "lb"; `MACEDONIAN`: `string` = "mk"; `MALTESE`: `string` = "mt"; `NORWEGIAN`: `string` = "no"; `POLISH`: `string` = "pl"; `PORTUGUESE`: `string` = "pt"; `ROMANIAN`: `string` = "ro"; `ROMANSH`: `string` = "rm"; `ROMAN_LATIN`: `string` = "la"; `RUSSIAN`: `string` = "ru"; `SCOTTISH_GAELIC`: `string` = "gd"; `SERBIAN_CYRILLIC`: `string` = "sr"; `SLOVAK`: `string` = "sk"; `SLOVENE`: `string` = "sl"; `SPANISH`: `string` = "es"; `SWEDISH`: `string` = "sv"; `THAI`: `string` = "th"; `TURKISH`: `string` = "tr"; `UKRAINIAN`: `string` = "uk"; `WELSH`: `string` = "cy" } |
749
- | `language.ALBANIAN` | `string` |
750
- | `language.ARABIC` | `string` |
751
- | `language.ARMENIAN` | `string` |
752
- | `language.AUTO` | `string` |
753
- | `language.AZERBAIJANI` | `string` |
754
- | `language.BELORUSSIAN` | `string` |
755
- | `language.BOSNIAN` | `string` |
756
- | `language.BRETON` | `string` |
757
- | `language.BULGARIAN` | `string` |
758
- | `language.CATALAN` | `string` |
759
- | `language.CHINESE` | `string` |
760
- | `language.CROATIAN` | `string` |
761
- | `language.CZECH` | `string` |
762
- | `language.DANISH` | `string` |
763
- | `language.DUTCH` | `string` |
764
- | `language.ENGLISH` | `string` |
765
- | `language.ESPERANTO` | `string` |
766
- | `language.ESTONIAN` | `string` |
767
- | `language.FINNISH` | `string` |
768
- | `language.FRENCH` | `string` |
769
- | `language.FRISIAN` | `string` |
770
- | `language.GEORGIAN` | `string` |
771
- | `language.GERMAN` | `string` |
772
- | `language.GREEK` | `string` |
773
- | `language.HEBREW` | `string` |
774
- | `language.HUNGARIAN` | `string` |
775
- | `language.ICELANDIC` | `string` |
776
- | `language.IRISH` | `string` |
777
- | `language.ITALIAN` | `string` |
778
- | `language.JAPANESE` | `string` |
779
- | `language.KANNADA` | `string` |
780
- | `language.KAZAKH` | `string` |
781
- | `language.KOREAN` | `string` |
782
- | `language.LATVIAN` | `string` |
783
- | `language.LITHUANIAN` | `string` |
784
- | `language.LUXEMBOURGISH` | `string` |
785
- | `language.MACEDONIAN` | `string` |
786
- | `language.MALTESE` | `string` |
787
- | `language.NORWEGIAN` | `string` |
788
- | `language.POLISH` | `string` |
789
- | `language.PORTUGUESE` | `string` |
790
- | `language.ROMANIAN` | `string` |
791
- | `language.ROMANSH` | `string` |
792
- | `language.ROMAN_LATIN` | `string` |
793
- | `language.RUSSIAN` | `string` |
794
- | `language.SCOTTISH_GAELIC` | `string` |
795
- | `language.SERBIAN_CYRILLIC` | `string` |
796
- | `language.SLOVAK` | `string` |
797
- | `language.SLOVENE` | `string` |
798
- | `language.SPANISH` | `string` |
799
- | `language.SWEDISH` | `string` |
800
- | `language.THAI` | `string` |
801
- | `language.TURKISH` | `string` |
802
- | `language.UKRAINIAN` | `string` |
803
- | `language.WELSH` | `string` |
804
- | `reverse` | (`position`: `Position`, `options`: [`CommonForwardAndReverseGeocodingOptions`](README.md#commonforwardandreversegeocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
805
-
806
- #### Defined in
807
-
808
- [services/geocoding.ts:372](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geocoding.ts#L372)
809
-
810
- ___
811
-
812
- ### geolocation
813
-
814
- • `Const` **geolocation**: `Object`
815
-
816
- The **geolocation** namespace contains an asynchronous function to call the [MapTiler Geolocation API](https://docs.maptiler.com/cloud/api/geolocation/).
817
- The **Geolocation API** provides a way to retrieve the IP address as well as geographic informations of a machine performing the query (most likely: a user)
818
-
819
- #### Type declaration
820
-
821
- | Name | Type |
822
- | :------ | :------ |
823
- | `info` | (`options`: [`GeolocationInfoOptions`](README.md#geolocationinfooptions)) => `Promise`<[`GeolocationResult`](README.md#geolocationresult)\> |
824
-
825
- #### Defined in
826
-
827
- [services/geolocation.ts:135](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/geolocation.ts#L135)
828
-
829
- ___
830
-
831
- ### mapStylePresetList
832
-
833
- • `Const` **mapStylePresetList**: [`MapStylePreset`](README.md#mapstylepreset)[]
834
-
835
- #### Defined in
836
-
837
- [mapstyle.ts:503](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/mapstyle.ts#L503)
838
-
839
- ___
840
-
841
- ### staticMaps
842
-
843
- • `Const` **staticMaps**: `Object`
844
-
845
- The **staticMaps** namespace contains an synchronous function build image URL of static map, as specified by the [MapTiler Static Map API](https://docs.maptiler.com/cloud/api/static-maps/).
846
- The URL of static maps can then be used within a `<img />` markup element, as the `src` property value.
847
-
848
- #### Type declaration
849
-
850
- | Name | Type |
851
- | :------ | :------ |
852
- | `automatic` | (`options`: [`BoundedStaticMapOptions`](README.md#boundedstaticmapoptions)) => `string` |
853
- | `bounded` | (`boundingBox`: `BBox`, `options`: [`BoundedStaticMapOptions`](README.md#boundedstaticmapoptions)) => `string` |
854
- | `centered` | (`center`: `Position`, `zoom`: `number`, `options`: [`StaticMapBaseOptions`](README.md#staticmapbaseoptions)) => `string` |
855
-
856
- #### Defined in
857
-
858
- [services/staticMaps.ts:457](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/services/staticMaps.ts#L457)
859
-
860
- ## Functions
861
-
862
- ### expandMapStyle
863
-
864
- ▸ **expandMapStyle**(`style`): `string`
865
-
866
- Expand the map style provided as argument of the Map constructor
867
-
868
- #### Parameters
869
-
870
- | Name | Type |
871
- | :------ | :------ |
872
- | `style` | `any` |
873
-
874
- #### Returns
875
-
876
- `string`
877
-
878
- #### Defined in
879
-
880
- [mapstyle.ts:6](https://github.com/maptiler/maptiler-client-js/blob/4f27abf/src/mapstyle.ts#L6)