@maptiler/client 1.1.3 → 1.3.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 (75) hide show
  1. package/dist/maptiler-client.cjs +84 -33
  2. package/dist/maptiler-client.cjs.map +1 -1
  3. package/dist/maptiler-client.d.ts +69 -28
  4. package/dist/maptiler-client.min.mjs +1 -1
  5. package/dist/maptiler-client.mjs +84 -33
  6. package/dist/maptiler-client.mjs.map +1 -1
  7. package/dist/maptiler-client.umd.js +84 -33
  8. package/dist/maptiler-client.umd.js.map +1 -1
  9. package/dist/maptiler-client.umd.min.js +1 -1
  10. package/docs/assets/search.js +1 -1
  11. package/docs/classes/config.ClientConfig.html +9 -9
  12. package/docs/classes/services_ServiceError.ServiceError.html +7 -7
  13. package/docs/functions/language.getAutoLanguageGeocoding.html +5 -5
  14. package/docs/functions/services_simplify.default.html +5 -5
  15. package/docs/index.html +4 -4
  16. package/docs/modules/config.html +5 -5
  17. package/docs/modules/language.html +5 -5
  18. package/docs/modules/services_ServiceError.html +5 -5
  19. package/docs/modules/services_coordinates.html +5 -5
  20. package/docs/modules/services_data.html +5 -5
  21. package/docs/modules/services_geocoding.html +12 -6
  22. package/docs/modules/services_geolocation.html +5 -5
  23. package/docs/modules/services_simplify.html +5 -5
  24. package/docs/modules/services_staticMaps.html +5 -5
  25. package/docs/modules.html +4 -4
  26. package/docs/types/config.FetchFunction.html +5 -5
  27. package/docs/types/language.LanguageGeocodingString.html +5 -5
  28. package/docs/types/services_coordinates.CoordinateExport.html +5 -5
  29. package/docs/types/services_coordinates.CoordinateGrid.html +5 -5
  30. package/docs/types/services_coordinates.CoordinateId.html +5 -5
  31. package/docs/types/services_coordinates.CoordinateSearch.html +5 -5
  32. package/docs/types/services_coordinates.CoordinateSearchResult.html +5 -5
  33. package/docs/types/services_coordinates.CoordinateTransformResult.html +5 -5
  34. package/docs/types/services_coordinates.CoordinateTransformation.html +5 -5
  35. package/docs/types/services_coordinates.CoordinatesSearchOptions.html +6 -6
  36. package/docs/types/services_coordinates.CoordinatesTransformOptions.html +6 -6
  37. package/docs/types/services_coordinates.XYZ.html +5 -5
  38. package/docs/types/services_data.GetDataOptions.html +6 -6
  39. package/docs/types/services_geocoding.ByIdGeocodingOptions.html +63 -0
  40. package/docs/types/services_geocoding.CommonForwardAndReverseGeocodingOptions.html +63 -0
  41. package/docs/types/services_geocoding.Coordinates.html +9 -6
  42. package/docs/types/services_geocoding.FeatureHierarchy.html +9 -6
  43. package/docs/types/services_geocoding.GeocodingFeature.html +9 -6
  44. package/docs/types/services_geocoding.GeocodingOptions.html +10 -26
  45. package/docs/types/services_geocoding.GeocodingSearchResult.html +9 -6
  46. package/docs/types/services_geocoding.LanguageGeocodingOptions.html +70 -0
  47. package/docs/types/services_geocoding.ReverseGeocodingOptions.html +10 -18
  48. package/docs/types/services_geolocation.GeolocationInfoOptions.html +6 -6
  49. package/docs/types/services_geolocation.GeolocationResult.html +5 -5
  50. package/docs/types/services_staticMaps.AutomaticStaticMapOptions.html +5 -5
  51. package/docs/types/services_staticMaps.BoundedStaticMapOptions.html +5 -5
  52. package/docs/types/services_staticMaps.CenteredStaticMapOptions.html +5 -5
  53. package/docs/types/services_staticMaps.StaticMapBaseOptions.html +6 -6
  54. package/docs/types/services_staticMaps.StaticMapMarker.html +5 -5
  55. package/docs/variables/config.config.html +5 -5
  56. package/docs/variables/language.LanguageGeocoding.html +5 -5
  57. package/docs/variables/services_coordinates.coordinates.html +5 -5
  58. package/docs/variables/services_data.data.html +5 -5
  59. package/docs/variables/services_geocoding.geocoding.html +36 -12
  60. package/docs/variables/services_geolocation.geolocation.html +5 -5
  61. package/docs/variables/services_staticMaps.staticMaps.html +5 -5
  62. package/docsmd/README.md +81 -68
  63. package/docsmd/classes/ClientConfig.md +5 -5
  64. package/docsmd/classes/MapStyleVariant.md +13 -13
  65. package/docsmd/classes/ReferenceMapStyle.md +9 -9
  66. package/docsmd/classes/ServiceError.md +3 -3
  67. package/examples/test-browser-umd.html +6 -6
  68. package/package.json +1 -1
  69. package/src/index.ts +4 -0
  70. package/src/mapstyle.ts +46 -1
  71. package/src/services/coordinates.ts +2 -2
  72. package/src/services/data.ts +1 -1
  73. package/src/services/geocoding.ts +152 -61
  74. package/src/services/geolocation.ts +1 -1
  75. package/src/services/staticMaps.ts +1 -1
package/docsmd/README.md CHANGED
@@ -1,6 +1,6 @@
1
- MapTiler Client - v1.1.3
1
+ MapTiler Client - v1.3.0
2
2
 
3
- # MapTiler Client - v1.1.3
3
+ # MapTiler Client - v1.3.0
4
4
 
5
5
  ## Table of contents
6
6
 
@@ -16,6 +16,7 @@ MapTiler Client - v1.1.3
16
16
  - [AutomaticStaticMapOptions](README.md#automaticstaticmapoptions)
17
17
  - [BoundedStaticMapOptions](README.md#boundedstaticmapoptions)
18
18
  - [CenteredStaticMapOptions](README.md#centeredstaticmapoptions)
19
+ - [CommonForwardAndReverseGeocodingOptions](README.md#commonforwardandreversegeocodingoptions)
19
20
  - [CoordinateExport](README.md#coordinateexport)
20
21
  - [CoordinateGrid](README.md#coordinategrid)
21
22
  - [CoordinateId](README.md#coordinateid)
@@ -34,6 +35,7 @@ MapTiler Client - v1.1.3
34
35
  - [GeolocationInfoOptions](README.md#geolocationinfooptions)
35
36
  - [GeolocationResult](README.md#geolocationresult)
36
37
  - [GetDataOptions](README.md#getdataoptions)
38
+ - [LanguageGeocodingOptions](README.md#languagegeocodingoptions)
37
39
  - [LanguageGeocodingString](README.md#languagegeocodingstring)
38
40
  - [MapStylePreset](README.md#mapstylepreset)
39
41
  - [MapStyleType](README.md#mapstyletype)
@@ -68,7 +70,7 @@ Options that can be provided to automatic static maps
68
70
 
69
71
  #### Defined in
70
72
 
71
- [services/staticMaps.ts:141](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/staticMaps.ts#L141)
73
+ [services/staticMaps.ts:141](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/staticMaps.ts#L141)
72
74
 
73
75
  ___
74
76
 
@@ -80,7 +82,7 @@ Options that can be provided to bounded static maps
80
82
 
81
83
  #### Defined in
82
84
 
83
- [services/staticMaps.ts:130](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/staticMaps.ts#L130)
85
+ [services/staticMaps.ts:130](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/staticMaps.ts#L130)
84
86
 
85
87
  ___
86
88
 
@@ -92,7 +94,17 @@ Options that can be provided to centered static maps
92
94
 
93
95
  #### Defined in
94
96
 
95
- [services/staticMaps.ts:125](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/staticMaps.ts#L125)
97
+ [services/staticMaps.ts:125](https://github.com/maptiler/maptiler-client-js/blob/46295fc/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/46295fc/src/services/geocoding.ts#L25)
96
108
 
97
109
  ___
98
110
 
@@ -109,7 +121,7 @@ ___
109
121
 
110
122
  #### Defined in
111
123
 
112
- [services/coordinates.ts:38](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L38)
124
+ [services/coordinates.ts:38](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L38)
113
125
 
114
126
  ___
115
127
 
@@ -125,7 +137,7 @@ ___
125
137
 
126
138
  #### Defined in
127
139
 
128
- [services/coordinates.ts:43](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L43)
140
+ [services/coordinates.ts:43](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L43)
129
141
 
130
142
  ___
131
143
 
@@ -142,7 +154,7 @@ ___
142
154
 
143
155
  #### Defined in
144
156
 
145
- [services/coordinates.ts:33](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L33)
157
+ [services/coordinates.ts:33](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L33)
146
158
 
147
159
  ___
148
160
 
@@ -168,7 +180,7 @@ ___
168
180
 
169
181
  #### Defined in
170
182
 
171
- [services/coordinates.ts:61](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L61)
183
+ [services/coordinates.ts:61](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L61)
172
184
 
173
185
  ___
174
186
 
@@ -185,7 +197,7 @@ ___
185
197
 
186
198
  #### Defined in
187
199
 
188
- [services/coordinates.ts:91](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L91)
200
+ [services/coordinates.ts:91](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L91)
189
201
 
190
202
  ___
191
203
 
@@ -202,7 +214,7 @@ ___
202
214
 
203
215
  #### Defined in
204
216
 
205
- [services/coordinates.ts:159](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L159)
217
+ [services/coordinates.ts:159](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L159)
206
218
 
207
219
  ___
208
220
 
@@ -228,7 +240,7 @@ ___
228
240
 
229
241
  #### Defined in
230
242
 
231
- [services/coordinates.ts:47](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L47)
243
+ [services/coordinates.ts:47](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L47)
232
244
 
233
245
  ___
234
246
 
@@ -238,7 +250,7 @@ ___
238
250
 
239
251
  #### Defined in
240
252
 
241
- [services/geocoding.ts:40](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geocoding.ts#L40)
253
+ [services/geocoding.ts:89](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geocoding.ts#L89)
242
254
 
243
255
  ___
244
256
 
@@ -250,14 +262,14 @@ ___
250
262
 
251
263
  | Name | Type | Description |
252
264
  | :------ | :------ | :------ |
253
- | `apiKey?` | `string` | Custom mapTiler Cloud API key to use instead of the one in global `config` |
265
+ | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
254
266
  | `exports?` | `boolean` | Show exports in WKT and Proj4 notations (default: false) |
255
267
  | `limit?` | `number` | Maximum number of results returned (default: 10) |
256
268
  | `transformations?` | `boolean` | Show detailed transformations for each CRS (default: false) |
257
269
 
258
270
  #### Defined in
259
271
 
260
- [services/coordinates.ts:11](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L11)
272
+ [services/coordinates.ts:11](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L11)
261
273
 
262
274
  ___
263
275
 
@@ -271,14 +283,14 @@ Options that can be provided when transforming a coordinate from one CRS to anot
271
283
 
272
284
  | Name | Type | Description |
273
285
  | :------ | :------ | :------ |
274
- | `apiKey?` | `string` | Custom mapTiler Cloud API key to use instead of the one in global `config` |
286
+ | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
275
287
  | `operations?` | `number` \| `number`[] | List of codes of operations |
276
288
  | `sourceCrs?` | `number` | Source coordinate reference system (default: 4326) |
277
289
  | `targetCrs?` | `number` | Target coordinate reference system (default: 4326) |
278
290
 
279
291
  #### Defined in
280
292
 
281
- [services/coordinates.ts:174](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L174)
293
+ [services/coordinates.ts:174](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L174)
282
294
 
283
295
  ___
284
296
 
@@ -295,7 +307,7 @@ ___
295
307
 
296
308
  #### Defined in
297
309
 
298
- [services/geocoding.ts:42](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geocoding.ts#L42)
310
+ [services/geocoding.ts:91](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geocoding.ts#L91)
299
311
 
300
312
  ___
301
313
 
@@ -320,7 +332,7 @@ ___
320
332
 
321
333
  #### Defined in
322
334
 
323
- [config.ts:1](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/config.ts#L1)
335
+ [config.ts:1](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/config.ts#L1)
324
336
 
325
337
  ___
326
338
 
@@ -330,26 +342,17 @@ ___
330
342
 
331
343
  #### Defined in
332
344
 
333
- [services/geocoding.ts:54](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geocoding.ts#L54)
345
+ [services/geocoding.ts:103](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geocoding.ts#L103)
334
346
 
335
347
  ___
336
348
 
337
349
  ### GeocodingOptions
338
350
 
339
- Ƭ **GeocodingOptions**: `Object`
340
-
341
- #### Type declaration
342
-
343
- | Name | Type | Description |
344
- | :------ | :------ | :------ |
345
- | `apiKey?` | `string` | Custom mapTiler Cloud API key to use instead of the one in global `config` |
346
- | `bbox?` | `BBox` | Only search for results in the specified area. |
347
- | `language?` | [`LanguageGeocodingString`](README.md#languagegeocodingstring) \| [`LanguageGeocodingString`](README.md#languagegeocodingstring)[] | Prefer results in specific language. It’s possible to specify multiple values. |
348
- | `proximity?` | `Position` | Prefer results close to a specific location. |
351
+ Ƭ **GeocodingOptions**: [`CommonForwardAndReverseGeocodingOptions`](README.md#commonforwardandreversegeocodingoptions) & { `autocomplete?`: `boolean` ; `bbox?`: `BBox` ; `country?`: `string`[] ; `fuzzyMatch?`: `boolean` ; `proximity?`: `Position` }
349
352
 
350
353
  #### Defined in
351
354
 
352
- [services/geocoding.ts:18](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geocoding.ts#L18)
355
+ [services/geocoding.ts:57](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geocoding.ts#L57)
353
356
 
354
357
  ___
355
358
 
@@ -368,7 +371,7 @@ ___
368
371
 
369
372
  #### Defined in
370
373
 
371
- [services/geocoding.ts:86](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geocoding.ts#L86)
374
+ [services/geocoding.ts:135](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geocoding.ts#L135)
372
375
 
373
376
  ___
374
377
 
@@ -382,11 +385,11 @@ Options that can be provided to get user data.
382
385
 
383
386
  | Name | Type | Description |
384
387
  | :------ | :------ | :------ |
385
- | `apiKey?` | `string` | Custom mapTiler Cloud API key to use instead of the one in global `config` |
388
+ | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
386
389
 
387
390
  #### Defined in
388
391
 
389
- [services/geolocation.ts:14](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geolocation.ts#L14)
392
+ [services/geolocation.ts:14](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geolocation.ts#L14)
390
393
 
391
394
  ___
392
395
 
@@ -415,7 +418,7 @@ ___
415
418
 
416
419
  #### Defined in
417
420
 
418
- [services/geolocation.ts:21](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geolocation.ts#L21)
421
+ [services/geolocation.ts:21](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geolocation.ts#L21)
419
422
 
420
423
  ___
421
424
 
@@ -429,11 +432,27 @@ Options that can be provided to get user data.
429
432
 
430
433
  | Name | Type | Description |
431
434
  | :------ | :------ | :------ |
432
- | `apiKey?` | `string` | Custom mapTiler Cloud API key to use instead of the one in global `config` |
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/46295fc/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. |
433
452
 
434
453
  #### Defined in
435
454
 
436
- [services/data.ts:14](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/data.ts#L14)
455
+ [services/geocoding.ts:18](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geocoding.ts#L18)
437
456
 
438
457
  ___
439
458
 
@@ -445,7 +464,7 @@ Built-in languages values as strings
445
464
 
446
465
  #### Defined in
447
466
 
448
- [language.ts:69](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/language.ts#L69)
467
+ [language.ts:69](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/language.ts#L69)
449
468
 
450
469
  ___
451
470
 
@@ -466,7 +485,7 @@ Type for object containing style details
466
485
 
467
486
  #### Defined in
468
487
 
469
- [mapstyle.ts:29](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L29)
488
+ [mapstyle.ts:29](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L29)
470
489
 
471
490
  ___
472
491
 
@@ -486,34 +505,27 @@ All the styles and variants maintained by MapTiler.
486
505
  | `HYBRID` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | High resolution imagery with labels, political borders and roads. |
487
506
  | `OCEAN` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Explore deep see trenches and mountains, with isolines and depth labels |
488
507
  | `OPENSTREETMAP` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Classic OpenStreetMap style |
489
- | `OUTDOOR` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitable for outdoor activities. With elevation isolines and hillshading. |
508
+ | `OUTDOOR` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitable for outdoor activities. With elevation isolines and hillshading. |
490
509
  | `SATELLITE` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | High resolution imagery only, without any label. |
491
- | `STREETS` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `LIGHT`: [`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 |
510
+ | `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 |
492
511
  | `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 |
493
- | `TOPO` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.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 |
512
+ | `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 |
494
513
  | `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 |
495
- | `WINTER` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitabe for winter outdoor activities. With ski tracks, elevation isolines and hillshading. |
514
+ | `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. |
496
515
 
497
516
  #### Defined in
498
517
 
499
- [mapstyle.ts:258](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L258)
518
+ [mapstyle.ts:258](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L258)
500
519
 
501
520
  ___
502
521
 
503
522
  ### ReverseGeocodingOptions
504
523
 
505
- Ƭ **ReverseGeocodingOptions**: `Object`
506
-
507
- #### Type declaration
508
-
509
- | Name | Type | Description |
510
- | :------ | :------ | :------ |
511
- | `apiKey?` | `string` | Custom mapTiler Cloud API key to use instead of the one in global `config` |
512
- | `language?` | [`LanguageGeocodingString`](README.md#languagegeocodingstring) \| [`LanguageGeocodingString`](README.md#languagegeocodingstring)[] | Prefer results in specific language. It’s possible to specify multiple values. |
524
+ Ƭ **ReverseGeocodingOptions**: [`CommonForwardAndReverseGeocodingOptions`](README.md#commonforwardandreversegeocodingoptions)
513
525
 
514
526
  #### Defined in
515
527
 
516
- [services/geocoding.ts:165](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geocoding.ts#L165)
528
+ [services/geocoding.ts:85](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geocoding.ts#L85)
517
529
 
518
530
  ___
519
531
 
@@ -527,7 +539,7 @@ Base set of options that can be provided to all the types of static maps
527
539
 
528
540
  | Name | Type | Description |
529
541
  | :------ | :------ | :------ |
530
- | `apiKey?` | `string` | Custom mapTiler Cloud API key to use instead of the one in global `config` |
542
+ | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
531
543
  | `attribution?` | ``"bottomright"`` \| ``"bottomleft"`` \| ``"topleft"`` \| ``"topright"`` \| ``false`` | Placement of the attribution. Can also be set to `false` to not show attribution. Default: `"bottomright"` |
532
544
  | `format?` | ``"png"`` \| ``"jpg"`` \| ``"webp"`` | Image format. Default: `"png"` |
533
545
  | `height?` | `number` | Height of the output image. Maximum value: `2048`. Default: `1024` |
@@ -544,7 +556,7 @@ Base set of options that can be provided to all the types of static maps
544
556
 
545
557
  #### Defined in
546
558
 
547
- [services/staticMaps.ts:10](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/staticMaps.ts#L10)
559
+ [services/staticMaps.ts:10](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/staticMaps.ts#L10)
548
560
 
549
561
  ___
550
562
 
@@ -556,7 +568,7 @@ Definition of a maker to show on a static map
556
568
 
557
569
  #### Defined in
558
570
 
559
- [services/staticMaps.ts:146](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/staticMaps.ts#L146)
571
+ [services/staticMaps.ts:146](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/staticMaps.ts#L146)
560
572
 
561
573
  ___
562
574
 
@@ -574,7 +586,7 @@ ___
574
586
 
575
587
  #### Defined in
576
588
 
577
- [services/coordinates.ts:153](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L153)
589
+ [services/coordinates.ts:153](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L153)
578
590
 
579
591
  ## Variables
580
592
 
@@ -646,7 +658,7 @@ Languages. Note that not all the languages of this list are available but the co
646
658
 
647
659
  #### Defined in
648
660
 
649
- [language.ts:4](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/language.ts#L4)
661
+ [language.ts:4](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/language.ts#L4)
650
662
 
651
663
  ___
652
664
 
@@ -662,7 +674,7 @@ For example, `MapStyle.STREETS` and the variants:
662
674
 
663
675
  #### Defined in
664
676
 
665
- [mapstyle.ts:874](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L874)
677
+ [mapstyle.ts:919](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L919)
666
678
 
667
679
  ___
668
680
 
@@ -674,7 +686,7 @@ Configuration object
674
686
 
675
687
  #### Defined in
676
688
 
677
- [config.ts:63](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/config.ts#L63)
689
+ [config.ts:63](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/config.ts#L63)
678
690
 
679
691
  ___
680
692
 
@@ -694,7 +706,7 @@ The goal of the **Coordinate API* is query information about spatial coordinate
694
706
 
695
707
  #### Defined in
696
708
 
697
- [services/coordinates.ts:253](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/coordinates.ts#L253)
709
+ [services/coordinates.ts:253](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/coordinates.ts#L253)
698
710
 
699
711
  ___
700
712
 
@@ -713,7 +725,7 @@ The **Data API** provides a way to retrieve user data in GeoJSON format.
713
725
 
714
726
  #### Defined in
715
727
 
716
- [services/data.ts:59](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/data.ts#L59)
728
+ [services/data.ts:59](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/data.ts#L59)
717
729
 
718
730
  ___
719
731
 
@@ -729,6 +741,7 @@ and to get the location details (country, city, street, etc.) from a geographic
729
741
 
730
742
  | Name | Type |
731
743
  | :------ | :------ |
744
+ | `byId` | (`id`: `string`, `options`: [`LanguageGeocodingOptions`](README.md#languagegeocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
732
745
  | `forward` | (`query`: `string`, `options`: [`GeocodingOptions`](README.md#geocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
733
746
  | `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" } |
734
747
  | `language.ALBANIAN` | `string` |
@@ -786,11 +799,11 @@ and to get the location details (country, city, street, etc.) from a geographic
786
799
  | `language.TURKISH` | `string` |
787
800
  | `language.UKRAINIAN` | `string` |
788
801
  | `language.WELSH` | `string` |
789
- | `reverse` | (`position`: `Position`, `options`: [`ReverseGeocodingOptions`](README.md#reversegeocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
802
+ | `reverse` | (`position`: `Position`, `options`: [`CommonForwardAndReverseGeocodingOptions`](README.md#commonforwardandreversegeocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
790
803
 
791
804
  #### Defined in
792
805
 
793
- [services/geocoding.ts:233](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geocoding.ts#L233)
806
+ [services/geocoding.ts:323](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geocoding.ts#L323)
794
807
 
795
808
  ___
796
809
 
@@ -809,7 +822,7 @@ The **Geolocation API** provides a way to retrieve the IP address as well as geo
809
822
 
810
823
  #### Defined in
811
824
 
812
- [services/geolocation.ts:135](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/geolocation.ts#L135)
825
+ [services/geolocation.ts:135](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/geolocation.ts#L135)
813
826
 
814
827
  ___
815
828
 
@@ -819,7 +832,7 @@ ___
819
832
 
820
833
  #### Defined in
821
834
 
822
- [mapstyle.ts:466](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L466)
835
+ [mapstyle.ts:483](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L483)
823
836
 
824
837
  ___
825
838
 
@@ -840,7 +853,7 @@ The URL of static maps can then be used within a `<img />` markup element, as th
840
853
 
841
854
  #### Defined in
842
855
 
843
- [services/staticMaps.ts:457](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/services/staticMaps.ts#L457)
856
+ [services/staticMaps.ts:457](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/services/staticMaps.ts#L457)
844
857
 
845
858
  ## Functions
846
859
 
@@ -862,4 +875,4 @@ Expand the map style provided as argument of the Map constructor
862
875
 
863
876
  #### Defined in
864
877
 
865
- [mapstyle.ts:6](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L6)
878
+ [mapstyle.ts:6](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L6)
@@ -1,4 +1,4 @@
1
- [MapTiler Client - v1.1.3](../README.md) / ClientConfig
1
+ [MapTiler Client - v1.3.0](../README.md) / ClientConfig
2
2
 
3
3
  # Class: ClientConfig
4
4
 
@@ -35,7 +35,7 @@ Get the MapTiler Cloud API key
35
35
 
36
36
  #### Defined in
37
37
 
38
- [config.ts:41](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/config.ts#L41)
38
+ [config.ts:41](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/config.ts#L41)
39
39
 
40
40
  • `set` **apiKey**(`k`): `void`
41
41
 
@@ -53,7 +53,7 @@ Set the MapTiler Cloud API key
53
53
 
54
54
  #### Defined in
55
55
 
56
- [config.ts:34](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/config.ts#L34)
56
+ [config.ts:34](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/config.ts#L34)
57
57
 
58
58
  ___
59
59
 
@@ -69,7 +69,7 @@ Get the fetch fucntion
69
69
 
70
70
  #### Defined in
71
71
 
72
- [config.ts:55](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/config.ts#L55)
72
+ [config.ts:55](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/config.ts#L55)
73
73
 
74
74
  • `set` **fetch**(`f`): `void`
75
75
 
@@ -87,4 +87,4 @@ Set a the custom fetch function to replace the default one
87
87
 
88
88
  #### Defined in
89
89
 
90
- [config.ts:48](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/config.ts#L48)
90
+ [config.ts:48](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/config.ts#L48)
@@ -1,4 +1,4 @@
1
- [MapTiler Client - v1.1.3](../README.md) / MapStyleVariant
1
+ [MapTiler Client - v1.3.0](../README.md) / MapStyleVariant
2
2
 
3
3
  # Class: MapStyleVariant
4
4
 
@@ -43,7 +43,7 @@ An instance of MapStyleVariant contains information about a style to use that be
43
43
 
44
44
  #### Defined in
45
45
 
46
- [mapstyle.ts:46](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L46)
46
+ [mapstyle.ts:46](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L46)
47
47
 
48
48
  ## Methods
49
49
 
@@ -59,7 +59,7 @@ Get the human-friendly description
59
59
 
60
60
  #### Defined in
61
61
 
62
- [mapstyle.ts:109](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L109)
62
+ [mapstyle.ts:109](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L109)
63
63
 
64
64
  ___
65
65
 
@@ -75,7 +75,7 @@ Get the style as usable by MapLibre, a string (URL) or a plain style description
75
75
 
76
76
  #### Defined in
77
77
 
78
- [mapstyle.ts:161](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L161)
78
+ [mapstyle.ts:161](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L161)
79
79
 
80
80
  ___
81
81
 
@@ -89,7 +89,7 @@ ___
89
89
 
90
90
  #### Defined in
91
91
 
92
- [mapstyle.ts:86](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L86)
92
+ [mapstyle.ts:86](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L86)
93
93
 
94
94
  ___
95
95
 
@@ -105,7 +105,7 @@ Get the MapTiler Cloud id
105
105
 
106
106
  #### Defined in
107
107
 
108
- [mapstyle.ts:102](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L102)
108
+ [mapstyle.ts:102](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L102)
109
109
 
110
110
  ___
111
111
 
@@ -121,7 +121,7 @@ Get the image URL that represent _this_ variant
121
121
 
122
122
  #### Defined in
123
123
 
124
- [mapstyle.ts:153](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L153)
124
+ [mapstyle.ts:153](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L153)
125
125
 
126
126
  ___
127
127
 
@@ -137,7 +137,7 @@ Get the human-friendly name
137
137
 
138
138
  #### Defined in
139
139
 
140
- [mapstyle.ts:82](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L82)
140
+ [mapstyle.ts:82](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L82)
141
141
 
142
142
  ___
143
143
 
@@ -153,7 +153,7 @@ Get the reference style this variant belongs to
153
153
 
154
154
  #### Defined in
155
155
 
156
- [mapstyle.ts:117](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L117)
156
+ [mapstyle.ts:117](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L117)
157
157
 
158
158
  ___
159
159
 
@@ -169,7 +169,7 @@ Get the variant type (eg. "DEFAULT", "DARK", "PASTEL", etc.)
169
169
 
170
170
  #### Defined in
171
171
 
172
- [mapstyle.ts:94](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L94)
172
+ [mapstyle.ts:94](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L94)
173
173
 
174
174
  ___
175
175
 
@@ -192,7 +192,7 @@ Retrieve the variant of a given type. If not found, will return the "DEFAULT" va
192
192
 
193
193
  #### Defined in
194
194
 
195
- [mapstyle.ts:137](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L137)
195
+ [mapstyle.ts:137](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L137)
196
196
 
197
197
  ___
198
198
 
@@ -208,7 +208,7 @@ Get all the variants for _this_ variants, except _this_ current one
208
208
 
209
209
  #### Defined in
210
210
 
211
- [mapstyle.ts:145](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L145)
211
+ [mapstyle.ts:145](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L145)
212
212
 
213
213
  ___
214
214
 
@@ -231,4 +231,4 @@ Check if a variant of a given type exists for _this_ variants
231
231
 
232
232
  #### Defined in
233
233
 
234
- [mapstyle.ts:127](https://github.com/maptiler/maptiler-client-js/blob/ba8c80a/src/mapstyle.ts#L127)
234
+ [mapstyle.ts:127](https://github.com/maptiler/maptiler-client-js/blob/46295fc/src/mapstyle.ts#L127)