@maptiler/client 1.3.0 → 1.4.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/dist/maptiler-client.cjs +42 -16
- package/dist/maptiler-client.cjs.map +1 -1
- package/dist/maptiler-client.d.ts +10 -0
- package/dist/maptiler-client.min.mjs +1 -1
- package/dist/maptiler-client.mjs +42 -16
- package/dist/maptiler-client.mjs.map +1 -1
- package/dist/maptiler-client.umd.js +42 -16
- package/dist/maptiler-client.umd.js.map +1 -1
- package/dist/maptiler-client.umd.min.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/config.ClientConfig.html +9 -9
- package/docs/classes/services_ServiceError.ServiceError.html +7 -7
- package/docs/functions/language.getAutoLanguageGeocoding.html +5 -5
- package/docs/functions/services_simplify.default.html +5 -5
- package/docs/index.html +4 -4
- package/docs/modules/config.html +5 -5
- package/docs/modules/language.html +5 -5
- package/docs/modules/services_ServiceError.html +5 -5
- package/docs/modules/services_coordinates.html +5 -5
- package/docs/modules/services_data.html +5 -5
- package/docs/modules/services_geocoding.html +5 -5
- package/docs/modules/services_geolocation.html +5 -5
- package/docs/modules/services_simplify.html +5 -5
- package/docs/modules/services_staticMaps.html +5 -5
- package/docs/modules.html +4 -4
- package/docs/types/config.FetchFunction.html +5 -5
- package/docs/types/language.LanguageGeocodingString.html +5 -5
- package/docs/types/services_coordinates.CoordinateExport.html +5 -5
- package/docs/types/services_coordinates.CoordinateGrid.html +5 -5
- package/docs/types/services_coordinates.CoordinateId.html +5 -5
- package/docs/types/services_coordinates.CoordinateSearch.html +5 -5
- package/docs/types/services_coordinates.CoordinateSearchResult.html +5 -5
- package/docs/types/services_coordinates.CoordinateTransformResult.html +5 -5
- package/docs/types/services_coordinates.CoordinateTransformation.html +5 -5
- package/docs/types/services_coordinates.CoordinatesSearchOptions.html +5 -5
- package/docs/types/services_coordinates.CoordinatesTransformOptions.html +5 -5
- package/docs/types/services_coordinates.XYZ.html +5 -5
- package/docs/types/services_data.GetDataOptions.html +5 -5
- package/docs/types/services_geocoding.ByIdGeocodingOptions.html +5 -5
- package/docs/types/services_geocoding.CommonForwardAndReverseGeocodingOptions.html +5 -5
- package/docs/types/services_geocoding.Coordinates.html +5 -5
- package/docs/types/services_geocoding.FeatureHierarchy.html +5 -5
- package/docs/types/services_geocoding.GeocodingFeature.html +5 -5
- package/docs/types/services_geocoding.GeocodingOptions.html +5 -5
- package/docs/types/services_geocoding.GeocodingSearchResult.html +5 -5
- package/docs/types/services_geocoding.LanguageGeocodingOptions.html +5 -5
- package/docs/types/services_geocoding.ReverseGeocodingOptions.html +5 -5
- package/docs/types/services_geolocation.GeolocationInfoOptions.html +5 -5
- package/docs/types/services_geolocation.GeolocationResult.html +5 -5
- package/docs/types/services_staticMaps.AutomaticStaticMapOptions.html +5 -5
- package/docs/types/services_staticMaps.BoundedStaticMapOptions.html +5 -5
- package/docs/types/services_staticMaps.CenteredStaticMapOptions.html +5 -5
- package/docs/types/services_staticMaps.StaticMapBaseOptions.html +5 -5
- package/docs/types/services_staticMaps.StaticMapMarker.html +5 -5
- package/docs/variables/config.config.html +5 -5
- package/docs/variables/language.LanguageGeocoding.html +5 -5
- package/docs/variables/services_coordinates.coordinates.html +5 -5
- package/docs/variables/services_data.data.html +5 -5
- package/docs/variables/services_geocoding.geocoding.html +29 -9
- package/docs/variables/services_geolocation.geolocation.html +5 -5
- package/docs/variables/services_staticMaps.staticMaps.html +5 -5
- package/docsmd/README.md +43 -42
- package/docsmd/classes/ClientConfig.md +5 -5
- package/docsmd/classes/MapStyleVariant.md +13 -13
- package/docsmd/classes/ReferenceMapStyle.md +9 -9
- package/docsmd/classes/ServiceError.md +3 -3
- package/package.json +3 -1
- package/src/services/geocoding.ts +71 -21
package/docsmd/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
MapTiler Client - v1.
|
|
1
|
+
MapTiler Client - v1.4.0
|
|
2
2
|
|
|
3
|
-
# MapTiler Client - v1.
|
|
3
|
+
# MapTiler Client - v1.4.0
|
|
4
4
|
|
|
5
5
|
## Table of contents
|
|
6
6
|
|
|
@@ -70,7 +70,7 @@ Options that can be provided to automatic static maps
|
|
|
70
70
|
|
|
71
71
|
#### Defined in
|
|
72
72
|
|
|
73
|
-
[services/staticMaps.ts:141](https://github.com/maptiler/maptiler-client-js/blob/
|
|
73
|
+
[services/staticMaps.ts:141](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/staticMaps.ts#L141)
|
|
74
74
|
|
|
75
75
|
___
|
|
76
76
|
|
|
@@ -82,7 +82,7 @@ Options that can be provided to bounded static maps
|
|
|
82
82
|
|
|
83
83
|
#### Defined in
|
|
84
84
|
|
|
85
|
-
[services/staticMaps.ts:130](https://github.com/maptiler/maptiler-client-js/blob/
|
|
85
|
+
[services/staticMaps.ts:130](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/staticMaps.ts#L130)
|
|
86
86
|
|
|
87
87
|
___
|
|
88
88
|
|
|
@@ -94,7 +94,7 @@ Options that can be provided to centered static maps
|
|
|
94
94
|
|
|
95
95
|
#### Defined in
|
|
96
96
|
|
|
97
|
-
[services/staticMaps.ts:125](https://github.com/maptiler/maptiler-client-js/blob/
|
|
97
|
+
[services/staticMaps.ts:125](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/staticMaps.ts#L125)
|
|
98
98
|
|
|
99
99
|
___
|
|
100
100
|
|
|
@@ -104,7 +104,7 @@ ___
|
|
|
104
104
|
|
|
105
105
|
#### Defined in
|
|
106
106
|
|
|
107
|
-
[services/geocoding.ts:25](https://github.com/maptiler/maptiler-client-js/blob/
|
|
107
|
+
[services/geocoding.ts:25](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geocoding.ts#L25)
|
|
108
108
|
|
|
109
109
|
___
|
|
110
110
|
|
|
@@ -121,7 +121,7 @@ ___
|
|
|
121
121
|
|
|
122
122
|
#### Defined in
|
|
123
123
|
|
|
124
|
-
[services/coordinates.ts:38](https://github.com/maptiler/maptiler-client-js/blob/
|
|
124
|
+
[services/coordinates.ts:38](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L38)
|
|
125
125
|
|
|
126
126
|
___
|
|
127
127
|
|
|
@@ -137,7 +137,7 @@ ___
|
|
|
137
137
|
|
|
138
138
|
#### Defined in
|
|
139
139
|
|
|
140
|
-
[services/coordinates.ts:43](https://github.com/maptiler/maptiler-client-js/blob/
|
|
140
|
+
[services/coordinates.ts:43](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L43)
|
|
141
141
|
|
|
142
142
|
___
|
|
143
143
|
|
|
@@ -154,7 +154,7 @@ ___
|
|
|
154
154
|
|
|
155
155
|
#### Defined in
|
|
156
156
|
|
|
157
|
-
[services/coordinates.ts:33](https://github.com/maptiler/maptiler-client-js/blob/
|
|
157
|
+
[services/coordinates.ts:33](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L33)
|
|
158
158
|
|
|
159
159
|
___
|
|
160
160
|
|
|
@@ -180,7 +180,7 @@ ___
|
|
|
180
180
|
|
|
181
181
|
#### Defined in
|
|
182
182
|
|
|
183
|
-
[services/coordinates.ts:61](https://github.com/maptiler/maptiler-client-js/blob/
|
|
183
|
+
[services/coordinates.ts:61](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L61)
|
|
184
184
|
|
|
185
185
|
___
|
|
186
186
|
|
|
@@ -197,7 +197,7 @@ ___
|
|
|
197
197
|
|
|
198
198
|
#### Defined in
|
|
199
199
|
|
|
200
|
-
[services/coordinates.ts:91](https://github.com/maptiler/maptiler-client-js/blob/
|
|
200
|
+
[services/coordinates.ts:91](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L91)
|
|
201
201
|
|
|
202
202
|
___
|
|
203
203
|
|
|
@@ -214,7 +214,7 @@ ___
|
|
|
214
214
|
|
|
215
215
|
#### Defined in
|
|
216
216
|
|
|
217
|
-
[services/coordinates.ts:159](https://github.com/maptiler/maptiler-client-js/blob/
|
|
217
|
+
[services/coordinates.ts:159](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L159)
|
|
218
218
|
|
|
219
219
|
___
|
|
220
220
|
|
|
@@ -240,7 +240,7 @@ ___
|
|
|
240
240
|
|
|
241
241
|
#### Defined in
|
|
242
242
|
|
|
243
|
-
[services/coordinates.ts:47](https://github.com/maptiler/maptiler-client-js/blob/
|
|
243
|
+
[services/coordinates.ts:47](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L47)
|
|
244
244
|
|
|
245
245
|
___
|
|
246
246
|
|
|
@@ -250,7 +250,7 @@ ___
|
|
|
250
250
|
|
|
251
251
|
#### Defined in
|
|
252
252
|
|
|
253
|
-
[services/geocoding.ts:89](https://github.com/maptiler/maptiler-client-js/blob/
|
|
253
|
+
[services/geocoding.ts:89](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geocoding.ts#L89)
|
|
254
254
|
|
|
255
255
|
___
|
|
256
256
|
|
|
@@ -269,7 +269,7 @@ ___
|
|
|
269
269
|
|
|
270
270
|
#### Defined in
|
|
271
271
|
|
|
272
|
-
[services/coordinates.ts:11](https://github.com/maptiler/maptiler-client-js/blob/
|
|
272
|
+
[services/coordinates.ts:11](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L11)
|
|
273
273
|
|
|
274
274
|
___
|
|
275
275
|
|
|
@@ -290,7 +290,7 @@ Options that can be provided when transforming a coordinate from one CRS to anot
|
|
|
290
290
|
|
|
291
291
|
#### Defined in
|
|
292
292
|
|
|
293
|
-
[services/coordinates.ts:174](https://github.com/maptiler/maptiler-client-js/blob/
|
|
293
|
+
[services/coordinates.ts:174](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L174)
|
|
294
294
|
|
|
295
295
|
___
|
|
296
296
|
|
|
@@ -307,7 +307,7 @@ ___
|
|
|
307
307
|
|
|
308
308
|
#### Defined in
|
|
309
309
|
|
|
310
|
-
[services/geocoding.ts:91](https://github.com/maptiler/maptiler-client-js/blob/
|
|
310
|
+
[services/geocoding.ts:91](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geocoding.ts#L91)
|
|
311
311
|
|
|
312
312
|
___
|
|
313
313
|
|
|
@@ -332,7 +332,7 @@ ___
|
|
|
332
332
|
|
|
333
333
|
#### Defined in
|
|
334
334
|
|
|
335
|
-
[config.ts:1](https://github.com/maptiler/maptiler-client-js/blob/
|
|
335
|
+
[config.ts:1](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/config.ts#L1)
|
|
336
336
|
|
|
337
337
|
___
|
|
338
338
|
|
|
@@ -342,7 +342,7 @@ ___
|
|
|
342
342
|
|
|
343
343
|
#### Defined in
|
|
344
344
|
|
|
345
|
-
[services/geocoding.ts:103](https://github.com/maptiler/maptiler-client-js/blob/
|
|
345
|
+
[services/geocoding.ts:103](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geocoding.ts#L103)
|
|
346
346
|
|
|
347
347
|
___
|
|
348
348
|
|
|
@@ -352,7 +352,7 @@ ___
|
|
|
352
352
|
|
|
353
353
|
#### Defined in
|
|
354
354
|
|
|
355
|
-
[services/geocoding.ts:57](https://github.com/maptiler/maptiler-client-js/blob/
|
|
355
|
+
[services/geocoding.ts:57](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geocoding.ts#L57)
|
|
356
356
|
|
|
357
357
|
___
|
|
358
358
|
|
|
@@ -371,7 +371,7 @@ ___
|
|
|
371
371
|
|
|
372
372
|
#### Defined in
|
|
373
373
|
|
|
374
|
-
[services/geocoding.ts:135](https://github.com/maptiler/maptiler-client-js/blob/
|
|
374
|
+
[services/geocoding.ts:135](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geocoding.ts#L135)
|
|
375
375
|
|
|
376
376
|
___
|
|
377
377
|
|
|
@@ -389,7 +389,7 @@ Options that can be provided to get user data.
|
|
|
389
389
|
|
|
390
390
|
#### Defined in
|
|
391
391
|
|
|
392
|
-
[services/geolocation.ts:14](https://github.com/maptiler/maptiler-client-js/blob/
|
|
392
|
+
[services/geolocation.ts:14](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geolocation.ts#L14)
|
|
393
393
|
|
|
394
394
|
___
|
|
395
395
|
|
|
@@ -418,7 +418,7 @@ ___
|
|
|
418
418
|
|
|
419
419
|
#### Defined in
|
|
420
420
|
|
|
421
|
-
[services/geolocation.ts:21](https://github.com/maptiler/maptiler-client-js/blob/
|
|
421
|
+
[services/geolocation.ts:21](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geolocation.ts#L21)
|
|
422
422
|
|
|
423
423
|
___
|
|
424
424
|
|
|
@@ -436,7 +436,7 @@ Options that can be provided to get user data.
|
|
|
436
436
|
|
|
437
437
|
#### Defined in
|
|
438
438
|
|
|
439
|
-
[services/data.ts:14](https://github.com/maptiler/maptiler-client-js/blob/
|
|
439
|
+
[services/data.ts:14](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/data.ts#L14)
|
|
440
440
|
|
|
441
441
|
___
|
|
442
442
|
|
|
@@ -452,7 +452,7 @@ ___
|
|
|
452
452
|
|
|
453
453
|
#### Defined in
|
|
454
454
|
|
|
455
|
-
[services/geocoding.ts:18](https://github.com/maptiler/maptiler-client-js/blob/
|
|
455
|
+
[services/geocoding.ts:18](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geocoding.ts#L18)
|
|
456
456
|
|
|
457
457
|
___
|
|
458
458
|
|
|
@@ -464,7 +464,7 @@ Built-in languages values as strings
|
|
|
464
464
|
|
|
465
465
|
#### Defined in
|
|
466
466
|
|
|
467
|
-
[language.ts:69](https://github.com/maptiler/maptiler-client-js/blob/
|
|
467
|
+
[language.ts:69](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/language.ts#L69)
|
|
468
468
|
|
|
469
469
|
___
|
|
470
470
|
|
|
@@ -485,7 +485,7 @@ Type for object containing style details
|
|
|
485
485
|
|
|
486
486
|
#### Defined in
|
|
487
487
|
|
|
488
|
-
[mapstyle.ts:29](https://github.com/maptiler/maptiler-client-js/blob/
|
|
488
|
+
[mapstyle.ts:29](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L29)
|
|
489
489
|
|
|
490
490
|
___
|
|
491
491
|
|
|
@@ -515,7 +515,7 @@ All the styles and variants maintained by MapTiler.
|
|
|
515
515
|
|
|
516
516
|
#### Defined in
|
|
517
517
|
|
|
518
|
-
[mapstyle.ts:258](https://github.com/maptiler/maptiler-client-js/blob/
|
|
518
|
+
[mapstyle.ts:258](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L258)
|
|
519
519
|
|
|
520
520
|
___
|
|
521
521
|
|
|
@@ -525,7 +525,7 @@ ___
|
|
|
525
525
|
|
|
526
526
|
#### Defined in
|
|
527
527
|
|
|
528
|
-
[services/geocoding.ts:85](https://github.com/maptiler/maptiler-client-js/blob/
|
|
528
|
+
[services/geocoding.ts:85](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geocoding.ts#L85)
|
|
529
529
|
|
|
530
530
|
___
|
|
531
531
|
|
|
@@ -556,7 +556,7 @@ Base set of options that can be provided to all the types of static maps
|
|
|
556
556
|
|
|
557
557
|
#### Defined in
|
|
558
558
|
|
|
559
|
-
[services/staticMaps.ts:10](https://github.com/maptiler/maptiler-client-js/blob/
|
|
559
|
+
[services/staticMaps.ts:10](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/staticMaps.ts#L10)
|
|
560
560
|
|
|
561
561
|
___
|
|
562
562
|
|
|
@@ -568,7 +568,7 @@ Definition of a maker to show on a static map
|
|
|
568
568
|
|
|
569
569
|
#### Defined in
|
|
570
570
|
|
|
571
|
-
[services/staticMaps.ts:146](https://github.com/maptiler/maptiler-client-js/blob/
|
|
571
|
+
[services/staticMaps.ts:146](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/staticMaps.ts#L146)
|
|
572
572
|
|
|
573
573
|
___
|
|
574
574
|
|
|
@@ -586,7 +586,7 @@ ___
|
|
|
586
586
|
|
|
587
587
|
#### Defined in
|
|
588
588
|
|
|
589
|
-
[services/coordinates.ts:153](https://github.com/maptiler/maptiler-client-js/blob/
|
|
589
|
+
[services/coordinates.ts:153](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L153)
|
|
590
590
|
|
|
591
591
|
## Variables
|
|
592
592
|
|
|
@@ -658,7 +658,7 @@ Languages. Note that not all the languages of this list are available but the co
|
|
|
658
658
|
|
|
659
659
|
#### Defined in
|
|
660
660
|
|
|
661
|
-
[language.ts:4](https://github.com/maptiler/maptiler-client-js/blob/
|
|
661
|
+
[language.ts:4](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/language.ts#L4)
|
|
662
662
|
|
|
663
663
|
___
|
|
664
664
|
|
|
@@ -674,7 +674,7 @@ For example, `MapStyle.STREETS` and the variants:
|
|
|
674
674
|
|
|
675
675
|
#### Defined in
|
|
676
676
|
|
|
677
|
-
[mapstyle.ts:919](https://github.com/maptiler/maptiler-client-js/blob/
|
|
677
|
+
[mapstyle.ts:919](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L919)
|
|
678
678
|
|
|
679
679
|
___
|
|
680
680
|
|
|
@@ -686,7 +686,7 @@ Configuration object
|
|
|
686
686
|
|
|
687
687
|
#### Defined in
|
|
688
688
|
|
|
689
|
-
[config.ts:63](https://github.com/maptiler/maptiler-client-js/blob/
|
|
689
|
+
[config.ts:63](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/config.ts#L63)
|
|
690
690
|
|
|
691
691
|
___
|
|
692
692
|
|
|
@@ -706,7 +706,7 @@ The goal of the **Coordinate API* is query information about spatial coordinate
|
|
|
706
706
|
|
|
707
707
|
#### Defined in
|
|
708
708
|
|
|
709
|
-
[services/coordinates.ts:253](https://github.com/maptiler/maptiler-client-js/blob/
|
|
709
|
+
[services/coordinates.ts:253](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/coordinates.ts#L253)
|
|
710
710
|
|
|
711
711
|
___
|
|
712
712
|
|
|
@@ -725,7 +725,7 @@ The **Data API** provides a way to retrieve user data in GeoJSON format.
|
|
|
725
725
|
|
|
726
726
|
#### Defined in
|
|
727
727
|
|
|
728
|
-
[services/data.ts:59](https://github.com/maptiler/maptiler-client-js/blob/
|
|
728
|
+
[services/data.ts:59](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/data.ts#L59)
|
|
729
729
|
|
|
730
730
|
___
|
|
731
731
|
|
|
@@ -741,6 +741,7 @@ and to get the location details (country, city, street, etc.) from a geographic
|
|
|
741
741
|
|
|
742
742
|
| Name | Type |
|
|
743
743
|
| :------ | :------ |
|
|
744
|
+
| `batch` | (`queries`: `string`[], `options`: [`GeocodingOptions`](README.md#geocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)[]\> |
|
|
744
745
|
| `byId` | (`id`: `string`, `options`: [`LanguageGeocodingOptions`](README.md#languagegeocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
|
|
745
746
|
| `forward` | (`query`: `string`, `options`: [`GeocodingOptions`](README.md#geocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
|
|
746
747
|
| `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" } |
|
|
@@ -803,7 +804,7 @@ and to get the location details (country, city, street, etc.) from a geographic
|
|
|
803
804
|
|
|
804
805
|
#### Defined in
|
|
805
806
|
|
|
806
|
-
[services/geocoding.ts:
|
|
807
|
+
[services/geocoding.ts:372](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geocoding.ts#L372)
|
|
807
808
|
|
|
808
809
|
___
|
|
809
810
|
|
|
@@ -822,7 +823,7 @@ The **Geolocation API** provides a way to retrieve the IP address as well as geo
|
|
|
822
823
|
|
|
823
824
|
#### Defined in
|
|
824
825
|
|
|
825
|
-
[services/geolocation.ts:135](https://github.com/maptiler/maptiler-client-js/blob/
|
|
826
|
+
[services/geolocation.ts:135](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/geolocation.ts#L135)
|
|
826
827
|
|
|
827
828
|
___
|
|
828
829
|
|
|
@@ -832,7 +833,7 @@ ___
|
|
|
832
833
|
|
|
833
834
|
#### Defined in
|
|
834
835
|
|
|
835
|
-
[mapstyle.ts:483](https://github.com/maptiler/maptiler-client-js/blob/
|
|
836
|
+
[mapstyle.ts:483](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L483)
|
|
836
837
|
|
|
837
838
|
___
|
|
838
839
|
|
|
@@ -853,7 +854,7 @@ The URL of static maps can then be used within a `<img />` markup element, as th
|
|
|
853
854
|
|
|
854
855
|
#### Defined in
|
|
855
856
|
|
|
856
|
-
[services/staticMaps.ts:457](https://github.com/maptiler/maptiler-client-js/blob/
|
|
857
|
+
[services/staticMaps.ts:457](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/staticMaps.ts#L457)
|
|
857
858
|
|
|
858
859
|
## Functions
|
|
859
860
|
|
|
@@ -875,4 +876,4 @@ Expand the map style provided as argument of the Map constructor
|
|
|
875
876
|
|
|
876
877
|
#### Defined in
|
|
877
878
|
|
|
878
|
-
[mapstyle.ts:6](https://github.com/maptiler/maptiler-client-js/blob/
|
|
879
|
+
[mapstyle.ts:6](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L6)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[MapTiler Client - v1.
|
|
1
|
+
[MapTiler Client - v1.4.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/
|
|
38
|
+
[config.ts:41](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
56
|
+
[config.ts:34](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
72
|
+
[config.ts:55](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
90
|
+
[config.ts:48](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/config.ts#L48)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[MapTiler Client - v1.
|
|
1
|
+
[MapTiler Client - v1.4.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/
|
|
46
|
+
[mapstyle.ts:46](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
62
|
+
[mapstyle.ts:109](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
78
|
+
[mapstyle.ts:161](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
92
|
+
[mapstyle.ts:86](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
108
|
+
[mapstyle.ts:102](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
124
|
+
[mapstyle.ts:153](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
140
|
+
[mapstyle.ts:82](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
156
|
+
[mapstyle.ts:117](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
172
|
+
[mapstyle.ts:94](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
195
|
+
[mapstyle.ts:137](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
211
|
+
[mapstyle.ts:145](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/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/
|
|
234
|
+
[mapstyle.ts:127](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L127)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[MapTiler Client - v1.
|
|
1
|
+
[MapTiler Client - v1.4.0](../README.md) / ReferenceMapStyle
|
|
2
2
|
|
|
3
3
|
# Class: ReferenceMapStyle
|
|
4
4
|
|
|
@@ -35,7 +35,7 @@ An instance of reference style contains a list of StyleVariants ordered by relev
|
|
|
35
35
|
|
|
36
36
|
#### Defined in
|
|
37
37
|
|
|
38
|
-
[mapstyle.ts:180](https://github.com/maptiler/maptiler-client-js/blob/
|
|
38
|
+
[mapstyle.ts:180](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L180)
|
|
39
39
|
|
|
40
40
|
## Methods
|
|
41
41
|
|
|
@@ -57,7 +57,7 @@ Add a variant to _this_ reference style
|
|
|
57
57
|
|
|
58
58
|
#### Defined in
|
|
59
59
|
|
|
60
|
-
[mapstyle.ts:212](https://github.com/maptiler/maptiler-client-js/blob/
|
|
60
|
+
[mapstyle.ts:212](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L212)
|
|
61
61
|
|
|
62
62
|
___
|
|
63
63
|
|
|
@@ -73,7 +73,7 @@ Get the defualt variant for this reference style
|
|
|
73
73
|
|
|
74
74
|
#### Defined in
|
|
75
75
|
|
|
76
|
-
[mapstyle.ts:250](https://github.com/maptiler/maptiler-client-js/blob/
|
|
76
|
+
[mapstyle.ts:250](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L250)
|
|
77
77
|
|
|
78
78
|
___
|
|
79
79
|
|
|
@@ -89,7 +89,7 @@ Get the id of _this_ reference style
|
|
|
89
89
|
|
|
90
90
|
#### Defined in
|
|
91
91
|
|
|
92
|
-
[mapstyle.ts:204](https://github.com/maptiler/maptiler-client-js/blob/
|
|
92
|
+
[mapstyle.ts:204](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L204)
|
|
93
93
|
|
|
94
94
|
___
|
|
95
95
|
|
|
@@ -105,7 +105,7 @@ Get the human-friendly name of this reference style
|
|
|
105
105
|
|
|
106
106
|
#### Defined in
|
|
107
107
|
|
|
108
|
-
[mapstyle.ts:196](https://github.com/maptiler/maptiler-client-js/blob/
|
|
108
|
+
[mapstyle.ts:196](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L196)
|
|
109
109
|
|
|
110
110
|
___
|
|
111
111
|
|
|
@@ -128,7 +128,7 @@ then the most relevant default variant is returned instead
|
|
|
128
128
|
|
|
129
129
|
#### Defined in
|
|
130
130
|
|
|
131
|
-
[mapstyle.ts:232](https://github.com/maptiler/maptiler-client-js/blob/
|
|
131
|
+
[mapstyle.ts:232](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L232)
|
|
132
132
|
|
|
133
133
|
___
|
|
134
134
|
|
|
@@ -144,7 +144,7 @@ Get the list of variants for this reference style
|
|
|
144
144
|
|
|
145
145
|
#### Defined in
|
|
146
146
|
|
|
147
|
-
[mapstyle.ts:242](https://github.com/maptiler/maptiler-client-js/blob/
|
|
147
|
+
[mapstyle.ts:242](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L242)
|
|
148
148
|
|
|
149
149
|
___
|
|
150
150
|
|
|
@@ -166,4 +166,4 @@ Check if a given variant type exists for this reference style
|
|
|
166
166
|
|
|
167
167
|
#### Defined in
|
|
168
168
|
|
|
169
|
-
[mapstyle.ts:222](https://github.com/maptiler/maptiler-client-js/blob/
|
|
169
|
+
[mapstyle.ts:222](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/mapstyle.ts#L222)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[MapTiler Client - v1.
|
|
1
|
+
[MapTiler Client - v1.4.0](../README.md) / ServiceError
|
|
2
2
|
|
|
3
3
|
# Class: ServiceError
|
|
4
4
|
|
|
@@ -39,7 +39,7 @@ Error.constructor
|
|
|
39
39
|
|
|
40
40
|
#### Defined in
|
|
41
41
|
|
|
42
|
-
[services/ServiceError.ts:5](https://github.com/maptiler/maptiler-client-js/blob/
|
|
42
|
+
[services/ServiceError.ts:5](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/ServiceError.ts#L5)
|
|
43
43
|
|
|
44
44
|
## Properties
|
|
45
45
|
|
|
@@ -49,4 +49,4 @@ Error.constructor
|
|
|
49
49
|
|
|
50
50
|
#### Defined in
|
|
51
51
|
|
|
52
|
-
[services/ServiceError.ts:5](https://github.com/maptiler/maptiler-client-js/blob/
|
|
52
|
+
[services/ServiceError.ts:5](https://github.com/maptiler/maptiler-client-js/blob/8bd7bfc/src/services/ServiceError.ts#L5)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@maptiler/client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"description": "Javascript & Typescript wrapper to MapTiler Cloud API",
|
|
5
5
|
"module": "dist/maptiler-client.mjs",
|
|
6
6
|
"types": "dist/maptiler-client.d.ts",
|
|
@@ -17,7 +17,9 @@
|
|
|
17
17
|
},
|
|
18
18
|
"keywords": [
|
|
19
19
|
"geocoding",
|
|
20
|
+
"forward geocoding",
|
|
20
21
|
"reverse geocoding",
|
|
22
|
+
"batch geocoding",
|
|
21
23
|
"coordinates",
|
|
22
24
|
"CRS",
|
|
23
25
|
"geolocation",
|