@maptiler/client 1.6.0 → 1.8.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 (118) hide show
  1. package/.github/pull_request_template.md +11 -0
  2. package/.github/workflows/format-lint.yml +24 -0
  3. package/CHANGELOG.md +25 -0
  4. package/dist/maptiler-client.cjs +587 -332
  5. package/dist/maptiler-client.cjs.map +1 -1
  6. package/dist/maptiler-client.d.ts +291 -12
  7. package/dist/maptiler-client.min.mjs +1 -1
  8. package/dist/maptiler-client.mjs +580 -332
  9. package/dist/maptiler-client.mjs.map +1 -1
  10. package/package.json +29 -20
  11. package/readme.md +134 -2
  12. package/rollup.config.js +3 -3
  13. package/tsconfig.json +1 -1
  14. package/dist/maptiler-client.umd.js +0 -1368
  15. package/dist/maptiler-client.umd.js.map +0 -1
  16. package/dist/maptiler-client.umd.min.js +0 -1
  17. package/docs/.nojekyll +0 -1
  18. package/docs/assets/custom.css +0 -118
  19. package/docs/assets/highlight.css +0 -85
  20. package/docs/assets/main.js +0 -58
  21. package/docs/assets/search.js +0 -1
  22. package/docs/assets/style.css +0 -1280
  23. package/docs/classes/config.ClientConfig.html +0 -132
  24. package/docs/classes/services_ServiceError.ServiceError.html +0 -103
  25. package/docs/functions/language.getAutoLanguageGeocoding.html +0 -60
  26. package/docs/functions/services_simplify.default.html +0 -65
  27. package/docs/images/JS-logo.svg +0 -4
  28. package/docs/images/TS-logo.svg +0 -6
  29. package/docs/images/maptiler-client-logo.afdesign +0 -0
  30. package/docs/images/maptiler-client-logo.svg +0 -75
  31. package/docs/images/maptiler-logo-256.png +0 -0
  32. package/docs/images/maptiler-logo.svg +0 -23
  33. package/docs/images/screenshots/static-bounded-europe-1024.png +0 -0
  34. package/docs/images/screenshots/static-bounded-europe-2048.png +0 -0
  35. package/docs/images/screenshots/static-bounded-portugal-1024x2048.png +0 -0
  36. package/docs/images/screenshots/static-bounded-portugal-2048x2048.png +0 -0
  37. package/docs/images/screenshots/static-with-path.png +0 -0
  38. package/docs/index.html +0 -340
  39. package/docs/modules/config.html +0 -71
  40. package/docs/modules/language.html +0 -71
  41. package/docs/modules/services_ServiceError.html +0 -61
  42. package/docs/modules/services_coordinates.html +0 -84
  43. package/docs/modules/services_data.html +0 -66
  44. package/docs/modules/services_geocoding.html +0 -82
  45. package/docs/modules/services_geolocation.html +0 -68
  46. package/docs/modules/services_simplify.html +0 -61
  47. package/docs/modules/services_staticMaps.html +0 -74
  48. package/docs/modules.html +0 -59
  49. package/docs/types/config.FetchFunction.html +0 -71
  50. package/docs/types/language.LanguageGeocodingString.html +0 -58
  51. package/docs/types/services_coordinates.CoordinateExport.html +0 -71
  52. package/docs/types/services_coordinates.CoordinateGrid.html +0 -69
  53. package/docs/types/services_coordinates.CoordinateId.html +0 -71
  54. package/docs/types/services_coordinates.CoordinateSearch.html +0 -93
  55. package/docs/types/services_coordinates.CoordinateSearchResult.html +0 -75
  56. package/docs/types/services_coordinates.CoordinateTransformResult.html +0 -76
  57. package/docs/types/services_coordinates.CoordinateTransformation.html +0 -89
  58. package/docs/types/services_coordinates.CoordinatesSearchOptions.html +0 -83
  59. package/docs/types/services_coordinates.CoordinatesTransformOptions.html +0 -85
  60. package/docs/types/services_coordinates.XYZ.html +0 -73
  61. package/docs/types/services_data.GetDataOptions.html +0 -64
  62. package/docs/types/services_geocoding.ByIdGeocodingOptions.html +0 -63
  63. package/docs/types/services_geocoding.CommonForwardAndReverseGeocodingOptions.html +0 -63
  64. package/docs/types/services_geocoding.Coordinates.html +0 -63
  65. package/docs/types/services_geocoding.FeatureHierarchy.html +0 -63
  66. package/docs/types/services_geocoding.GeocodingFeature.html +0 -63
  67. package/docs/types/services_geocoding.GeocodingOptions.html +0 -63
  68. package/docs/types/services_geocoding.GeocodingSearchResult.html +0 -80
  69. package/docs/types/services_geocoding.LanguageGeocodingOptions.html +0 -70
  70. package/docs/types/services_geocoding.ReverseGeocodingOptions.html +0 -63
  71. package/docs/types/services_geolocation.GeolocationInfoOptions.html +0 -65
  72. package/docs/types/services_geolocation.GeolocationResult.html +0 -128
  73. package/docs/types/services_staticMaps.AutomaticStaticMapOptions.html +0 -61
  74. package/docs/types/services_staticMaps.BoundedStaticMapOptions.html +0 -61
  75. package/docs/types/services_staticMaps.CenteredStaticMapOptions.html +0 -61
  76. package/docs/types/services_staticMaps.StaticMapBaseOptions.html +0 -157
  77. package/docs/types/services_staticMaps.StaticMapMarker.html +0 -61
  78. package/docs/variables/config.config.html +0 -58
  79. package/docs/variables/language.LanguageGeocoding.html +0 -171
  80. package/docs/variables/services_coordinates.coordinates.html +0 -110
  81. package/docs/variables/services_data.data.html +0 -80
  82. package/docs/variables/services_geocoding.geocoding.html +0 -265
  83. package/docs/variables/services_geolocation.geolocation.html +0 -79
  84. package/docs/variables/services_staticMaps.staticMaps.html +0 -128
  85. package/docsmd/.nojekyll +0 -1
  86. package/docsmd/README.md +0 -873
  87. package/docsmd/assets/custom.css +0 -118
  88. package/docsmd/classes/ClientConfig.md +0 -90
  89. package/docsmd/classes/MapStyleVariant.md +0 -234
  90. package/docsmd/classes/ReferenceMapStyle.md +0 -169
  91. package/docsmd/classes/ServiceError.md +0 -52
  92. package/examples/test-browser-es.html +0 -103
  93. package/examples/test-browser-umd.html +0 -90
  94. package/examples/test-node.js +0 -52
  95. package/images/JS-logo.svg +0 -4
  96. package/images/TS-logo.svg +0 -6
  97. package/images/maptiler-client-logo.afdesign +0 -0
  98. package/images/maptiler-client-logo.svg +0 -75
  99. package/images/maptiler-logo-256.png +0 -0
  100. package/images/maptiler-logo.svg +0 -23
  101. package/images/screenshots/static-bounded-europe-1024.png +0 -0
  102. package/images/screenshots/static-bounded-europe-2048.png +0 -0
  103. package/images/screenshots/static-bounded-portugal-1024x2048.png +0 -0
  104. package/images/screenshots/static-bounded-portugal-2048x2048.png +0 -0
  105. package/images/screenshots/static-with-path.png +0 -0
  106. package/src/callFetch.ts +0 -18
  107. package/src/config.ts +0 -65
  108. package/src/defaults.ts +0 -11
  109. package/src/index.ts +0 -111
  110. package/src/language.ts +0 -87
  111. package/src/mapstyle.ts +0 -968
  112. package/src/services/ServiceError.ts +0 -10
  113. package/src/services/coordinates.ts +0 -258
  114. package/src/services/data.ts +0 -63
  115. package/src/services/geocoding.ts +0 -458
  116. package/src/services/geolocation.ts +0 -139
  117. package/src/services/simplify.ts +0 -87
  118. package/src/services/staticMaps.ts +0 -463
package/docsmd/README.md DELETED
@@ -1,873 +0,0 @@
1
- MapTiler Client - v1.6.0
2
-
3
- # MapTiler Client - v1.6.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/6f9a8fe/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/6f9a8fe/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/6f9a8fe/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"`` \| ``"poi"``)[] }
104
-
105
- #### Defined in
106
-
107
- [services/geocoding.ts:25](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/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/6f9a8fe/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/6f9a8fe/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/6f9a8fe/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/6f9a8fe/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/6f9a8fe/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/6f9a8fe/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/6f9a8fe/src/services/coordinates.ts#L47)
244
-
245
- ___
246
-
247
- ### Coordinates
248
-
249
- Ƭ **Coordinates**: `Position`
250
-
251
- #### Defined in
252
-
253
- [services/geocoding.ts:90](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geocoding.ts#L90)
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/6f9a8fe/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/6f9a8fe/src/services/coordinates.ts#L174)
294
-
295
- ___
296
-
297
- ### FeatureHierarchy
298
-
299
- Ƭ **FeatureHierarchy**: `FeatureProperties` & `FeatureBase`
300
-
301
- #### Defined in
302
-
303
- [services/geocoding.ts:159](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geocoding.ts#L159)
304
-
305
- ___
306
-
307
- ### FetchFunction
308
-
309
- Ƭ **FetchFunction**: (`url`: `string`, `options`: `object`) => `Promise`<`any`\>
310
-
311
- #### Type declaration
312
-
313
- ▸ (`url`, `options`): `Promise`<`any`\>
314
-
315
- ##### Parameters
316
-
317
- | Name | Type |
318
- | :------ | :------ |
319
- | `url` | `string` |
320
- | `options` | `object` |
321
-
322
- ##### Returns
323
-
324
- `Promise`<`any`\>
325
-
326
- #### Defined in
327
-
328
- [config.ts:1](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/config.ts#L1)
329
-
330
- ___
331
-
332
- ### GeocodingFeature
333
-
334
- Ƭ **GeocodingFeature**: `Feature`<`Geometry`, `FeatureProperties`\> & `FeatureBase` & { `[key: `place_name_${string}`]`: `string`; `address?`: `string` ; `bbox`: `BBox` ; `center`: [`Coordinates`](README.md#coordinates) ; `context?`: [`FeatureHierarchy`](README.md#featurehierarchy)[] ; `place_name`: `string` ; `place_type`: `string`[] ; `place_type_name`: `string`[] ; `relevance`: `number` }
335
-
336
- #### Defined in
337
-
338
- [services/geocoding.ts:161](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geocoding.ts#L161)
339
-
340
- ___
341
-
342
- ### GeocodingOptions
343
-
344
- Ƭ **GeocodingOptions**: [`CommonForwardAndReverseGeocodingOptions`](README.md#commonforwardandreversegeocodingoptions) & { `autocomplete?`: `boolean` ; `bbox?`: `BBox` ; `country?`: `string`[] ; `fuzzyMatch?`: `boolean` ; `proximity?`: `Position` }
345
-
346
- #### Defined in
347
-
348
- [services/geocoding.ts:58](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geocoding.ts#L58)
349
-
350
- ___
351
-
352
- ### GeocodingSearchResult
353
-
354
- Ƭ **GeocodingSearchResult**: `Object`
355
-
356
- #### Type declaration
357
-
358
- | Name | Type | Description |
359
- | :------ | :------ | :------ |
360
- | `attribution` | `string` | Attribution of the result |
361
- | `features` | [`GeocodingFeature`](README.md#geocodingfeature)[] | Array of features found |
362
- | `query` | `string`[] | Tokenized search query |
363
- | `type` | ``"FeatureCollection"`` | - |
364
-
365
- #### Defined in
366
-
367
- [services/geocoding.ts:213](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geocoding.ts#L213)
368
-
369
- ___
370
-
371
- ### GeolocationInfoOptions
372
-
373
- Ƭ **GeolocationInfoOptions**: `Object`
374
-
375
- Options that can be provided to get user data.
376
-
377
- #### Type declaration
378
-
379
- | Name | Type | Description |
380
- | :------ | :------ | :------ |
381
- | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
382
-
383
- #### Defined in
384
-
385
- [services/geolocation.ts:14](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geolocation.ts#L14)
386
-
387
- ___
388
-
389
- ### GeolocationResult
390
-
391
- Ƭ **GeolocationResult**: `Object`
392
-
393
- #### Type declaration
394
-
395
- | Name | Type | Description |
396
- | :------ | :------ | :------ |
397
- | `city?` | `string` | Name of the city Example: Zurich |
398
- | `continent?` | `string` | Name of the continent Example: Europe |
399
- | `continent_code?` | `string` | Two-letter code of the continent Example: EU |
400
- | `country?` | `string` | Name of the country Example: Switzerland |
401
- | `country_bounds?` | `BBox` | Bounds of the country in WGS84 degrees [west, south, east, north]. Example: [5.95538,45.818852,10.490936,47.809357] |
402
- | `country_code?` | `string` | Two-letter code of the country ISO 3166-1 alpha-2 codes Example: CH |
403
- | `country_languages?` | `string`[] | Official country languages in ISO 639-1 format. ISO 639-1 codes Example: ["de","fr","it"] |
404
- | `eu?` | `boolean` | Indicated whether the country is part of the European Union. |
405
- | `latitude?` | `number` | Latitude of the location Example: 47.36667 |
406
- | `longitude?` | `number` | Longitude of the location Example: 8.55 |
407
- | `postal?` | `string` | Postal code Example: 8000 |
408
- | `region?` | `string` | If known, the ISO 3166-2 name for the first level region. ISO 3166-2 codes Example: Zurich |
409
- | `region_code?` | `string` | If known, the ISO 3166-2 code for the first level region. ISO 3166-2 codes Example: ZH |
410
- | `timezone?` | `string` | Name of the timezone Example: Europe/Zurich |
411
-
412
- #### Defined in
413
-
414
- [services/geolocation.ts:21](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geolocation.ts#L21)
415
-
416
- ___
417
-
418
- ### GetDataOptions
419
-
420
- Ƭ **GetDataOptions**: `Object`
421
-
422
- Options that can be provided to get user data.
423
-
424
- #### Type declaration
425
-
426
- | Name | Type | Description |
427
- | :------ | :------ | :------ |
428
- | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
429
-
430
- #### Defined in
431
-
432
- [services/data.ts:14](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/data.ts#L14)
433
-
434
- ___
435
-
436
- ### LanguageGeocodingOptions
437
-
438
- Ƭ **LanguageGeocodingOptions**: `Object`
439
-
440
- #### Type declaration
441
-
442
- | Name | Type | Description |
443
- | :------ | :------ | :------ |
444
- | `language?` | [`LanguageGeocodingString`](README.md#languagegeocodingstring) \| [`LanguageGeocodingString`](README.md#languagegeocodingstring)[] | Prefer results in specific language. It’s possible to specify multiple values. |
445
-
446
- #### Defined in
447
-
448
- [services/geocoding.ts:18](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geocoding.ts#L18)
449
-
450
- ___
451
-
452
- ### LanguageGeocodingString
453
-
454
- Ƭ **LanguageGeocodingString**: `Values`<typeof [`LanguageGeocoding`](README.md#languagegeocoding)\>
455
-
456
- Built-in languages values as strings
457
-
458
- #### Defined in
459
-
460
- [language.ts:69](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/language.ts#L69)
461
-
462
- ___
463
-
464
- ### MapStylePreset
465
-
466
- Ƭ **MapStylePreset**: `Object`
467
-
468
- Type for object containing style details
469
-
470
- #### Type declaration
471
-
472
- | Name | Type |
473
- | :------ | :------ |
474
- | `description` | `string` |
475
- | `name` | `string` |
476
- | `referenceStyleID` | `string` |
477
- | `variants` | { `description`: `string` ; `id`: `string` ; `imageURL`: `string` ; `name`: `string` ; `variantType`: `string` }[] |
478
-
479
- #### Defined in
480
-
481
- [mapstyle.ts:29](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/mapstyle.ts#L29)
482
-
483
- ___
484
-
485
- ### MapStyleType
486
-
487
- Ƭ **MapStyleType**: `Object`
488
-
489
- All the styles and variants maintained by MapTiler.
490
-
491
- #### Type declaration
492
-
493
- | Name | Type | Description |
494
- | :------ | :------ | :------ |
495
- | `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 |
496
- | `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 |
497
- | `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` |
498
- | `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 |
499
- | `HYBRID` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | High resolution imagery with labels, political borders and roads. |
500
- | `OCEAN` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Explore deep see trenches and mountains, with isolines and depth labels |
501
- | `OPENSTREETMAP` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Classic OpenStreetMap style |
502
- | `OUTDOOR` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DARK`: [`MapStyleVariant`](classes/MapStyleVariant.md) ; `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | Suitable for outdoor activities. With elevation isolines and hillshading. |
503
- | `SATELLITE` | [`ReferenceMapStyle`](classes/ReferenceMapStyle.md) & { `DEFAULT`: [`MapStyleVariant`](classes/MapStyleVariant.md) } | High resolution imagery only, without any label. |
504
- | `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 |
505
- | `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 |
506
- | `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 |
507
- | `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 |
508
- | `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. |
509
-
510
- #### Defined in
511
-
512
- [mapstyle.ts:258](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/mapstyle.ts#L258)
513
-
514
- ___
515
-
516
- ### ReverseGeocodingOptions
517
-
518
- Ƭ **ReverseGeocodingOptions**: [`CommonForwardAndReverseGeocodingOptions`](README.md#commonforwardandreversegeocodingoptions)
519
-
520
- #### Defined in
521
-
522
- [services/geocoding.ts:86](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geocoding.ts#L86)
523
-
524
- ___
525
-
526
- ### StaticMapBaseOptions
527
-
528
- Ƭ **StaticMapBaseOptions**: `Object`
529
-
530
- Base set of options that can be provided to all the types of static maps
531
-
532
- #### Type declaration
533
-
534
- | Name | Type | Description |
535
- | :------ | :------ | :------ |
536
- | `apiKey?` | `string` | Custom MapTiler Cloud API key to use instead of the one in global `config` |
537
- | `attribution?` | ``"bottomright"`` \| ``"bottomleft"`` \| ``"topleft"`` \| ``"topright"`` \| ``false`` | Placement of the attribution. Can also be set to `false` to not show attribution. Default: `"bottomright"` |
538
- | `format?` | ``"png"`` \| ``"jpg"`` \| ``"webp"`` | Image format. Default: `"png"` |
539
- | `height?` | `number` | Height of the output image. Maximum value: `2048`. Default: `1024` |
540
- | `hiDPI?` | `boolean` | Double the size of the static map image to support hiDPI/Retina monitors. Default: `false` |
541
- | `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"` |
542
- | `markerIcon?` | `string` | URL of the marker image. Applies only if one or multiple markers positions are provided. Default: none provided |
543
- | `markers?` | [`StaticMapMarker`](README.md#staticmapmarker) \| [`StaticMapMarker`](README.md#staticmapmarker)[] | A marker or list of markers to show on the map Default: none provided |
544
- | `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 |
545
- | `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) |
546
- | `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"` |
547
- | `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`. |
548
- | `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"` |
549
- | `width?` | `number` | Width of the output image. Maximum value: `2048`. Default: `1024` |
550
-
551
- #### Defined in
552
-
553
- [services/staticMaps.ts:10](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/staticMaps.ts#L10)
554
-
555
- ___
556
-
557
- ### StaticMapMarker
558
-
559
- Ƭ **StaticMapMarker**: [`number`, `number`, `string`]
560
-
561
- Definition of a maker to show on a static map
562
-
563
- #### Defined in
564
-
565
- [services/staticMaps.ts:146](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/staticMaps.ts#L146)
566
-
567
- ___
568
-
569
- ### XYZ
570
-
571
- Ƭ **XYZ**: `Object`
572
-
573
- #### Type declaration
574
-
575
- | Name | Type |
576
- | :------ | :------ |
577
- | `x?` | `number` |
578
- | `y?` | `number` |
579
- | `z?` | `number` |
580
-
581
- #### Defined in
582
-
583
- [services/coordinates.ts:153](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/coordinates.ts#L153)
584
-
585
- ## Variables
586
-
587
- ### LanguageGeocoding
588
-
589
- • `Const` **LanguageGeocoding**: `Object`
590
-
591
- Languages. Note that not all the languages of this list are available but the compatibility list may be expanded in the future.
592
-
593
- #### Type declaration
594
-
595
- | Name | Type |
596
- | :------ | :------ |
597
- | `ALBANIAN` | `string` |
598
- | `ARABIC` | `string` |
599
- | `ARMENIAN` | `string` |
600
- | `AUTO` | `string` |
601
- | `AZERBAIJANI` | `string` |
602
- | `BELORUSSIAN` | `string` |
603
- | `BOSNIAN` | `string` |
604
- | `BRETON` | `string` |
605
- | `BULGARIAN` | `string` |
606
- | `CATALAN` | `string` |
607
- | `CHINESE` | `string` |
608
- | `CROATIAN` | `string` |
609
- | `CZECH` | `string` |
610
- | `DANISH` | `string` |
611
- | `DUTCH` | `string` |
612
- | `ENGLISH` | `string` |
613
- | `ESPERANTO` | `string` |
614
- | `ESTONIAN` | `string` |
615
- | `FINNISH` | `string` |
616
- | `FRENCH` | `string` |
617
- | `FRISIAN` | `string` |
618
- | `GEORGIAN` | `string` |
619
- | `GERMAN` | `string` |
620
- | `GREEK` | `string` |
621
- | `HEBREW` | `string` |
622
- | `HUNGARIAN` | `string` |
623
- | `ICELANDIC` | `string` |
624
- | `IRISH` | `string` |
625
- | `ITALIAN` | `string` |
626
- | `JAPANESE` | `string` |
627
- | `KANNADA` | `string` |
628
- | `KAZAKH` | `string` |
629
- | `KOREAN` | `string` |
630
- | `LATVIAN` | `string` |
631
- | `LITHUANIAN` | `string` |
632
- | `LUXEMBOURGISH` | `string` |
633
- | `MACEDONIAN` | `string` |
634
- | `MALTESE` | `string` |
635
- | `NORWEGIAN` | `string` |
636
- | `POLISH` | `string` |
637
- | `PORTUGUESE` | `string` |
638
- | `ROMANIAN` | `string` |
639
- | `ROMANSH` | `string` |
640
- | `ROMAN_LATIN` | `string` |
641
- | `RUSSIAN` | `string` |
642
- | `SCOTTISH_GAELIC` | `string` |
643
- | `SERBIAN_CYRILLIC` | `string` |
644
- | `SLOVAK` | `string` |
645
- | `SLOVENE` | `string` |
646
- | `SPANISH` | `string` |
647
- | `SWEDISH` | `string` |
648
- | `THAI` | `string` |
649
- | `TURKISH` | `string` |
650
- | `UKRAINIAN` | `string` |
651
- | `WELSH` | `string` |
652
-
653
- #### Defined in
654
-
655
- [language.ts:4](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/language.ts#L4)
656
-
657
- ___
658
-
659
- ### MapStyle
660
-
661
- • `Const` **MapStyle**: [`MapStyleType`](README.md#mapstyletype)
662
-
663
- Contains all the reference map style created by MapTiler team as well as all the variants.
664
- For example, `MapStyle.STREETS` and the variants:
665
- - `MapStyle.STREETS.DARK`
666
- - `MapStyle.STREETS.LIGHT`
667
- - `MapStyle.STREETS.PASTEL`
668
-
669
- #### Defined in
670
-
671
- [mapstyle.ts:968](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/mapstyle.ts#L968)
672
-
673
- ___
674
-
675
- ### config
676
-
677
- • `Const` **config**: [`ClientConfig`](classes/ClientConfig.md)
678
-
679
- Configuration object
680
-
681
- #### Defined in
682
-
683
- [config.ts:63](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/config.ts#L63)
684
-
685
- ___
686
-
687
- ### coordinates
688
-
689
- • `Const` **coordinates**: `Object`
690
-
691
- The **coordinate** namespace contains asynchronous functions to call the [MapTiler Coordinate API](https://docs.maptiler.com/cloud/api/coordinates/).
692
- 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.
693
-
694
- #### Type declaration
695
-
696
- | Name | Type |
697
- | :------ | :------ |
698
- | `search` | (`query`: `string`, `options`: [`CoordinatesSearchOptions`](README.md#coordinatessearchoptions)) => `Promise`<[`CoordinateSearchResult`](README.md#coordinatesearchresult)\> |
699
- | `transform` | (`positions`: `Position` \| `Position`[], `options`: [`CoordinatesTransformOptions`](README.md#coordinatestransformoptions)) => `Promise`<[`CoordinateTransformResult`](README.md#coordinatetransformresult)\> |
700
-
701
- #### Defined in
702
-
703
- [services/coordinates.ts:253](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/coordinates.ts#L253)
704
-
705
- ___
706
-
707
- ### data
708
-
709
- • `Const` **data**: `Object`
710
-
711
- The **data** namespace contains an asynchronous function to call the [MapTiler Data API](https://docs.maptiler.com/cloud/api/data/).
712
- The **Data API** provides a way to retrieve user data in GeoJSON format.
713
-
714
- #### Type declaration
715
-
716
- | Name | Type |
717
- | :------ | :------ |
718
- | `get` | (`dataId`: `string`, `options`: [`GetDataOptions`](README.md#getdataoptions)) => `Promise`<`FeatureCollection`\> |
719
-
720
- #### Defined in
721
-
722
- [services/data.ts:59](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/data.ts#L59)
723
-
724
- ___
725
-
726
- ### geocoding
727
-
728
- • `Const` **geocoding**: `Object`
729
-
730
- The **geocoding** namespace contains asynchronous functions to call the [MapTiler Geocoding API](https://docs.maptiler.com/cloud/api/geocoding/).
731
- The **Geocoding API** provides ways to get geographic coordinates from a human-readable search query of a place (forward geocoding)
732
- and to get the location details (country, city, street, etc.) from a geographic coordinate (reverse geocoding);
733
-
734
- #### Type declaration
735
-
736
- | Name | Type |
737
- | :------ | :------ |
738
- | `batch` | (`queries`: `string`[], `options`: [`GeocodingOptions`](README.md#geocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)[]\> |
739
- | `byId` | (`id`: `string`, `options`: [`LanguageGeocodingOptions`](README.md#languagegeocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
740
- | `forward` | (`query`: `string`, `options`: [`GeocodingOptions`](README.md#geocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
741
- | `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" } |
742
- | `language.ALBANIAN` | `string` |
743
- | `language.ARABIC` | `string` |
744
- | `language.ARMENIAN` | `string` |
745
- | `language.AUTO` | `string` |
746
- | `language.AZERBAIJANI` | `string` |
747
- | `language.BELORUSSIAN` | `string` |
748
- | `language.BOSNIAN` | `string` |
749
- | `language.BRETON` | `string` |
750
- | `language.BULGARIAN` | `string` |
751
- | `language.CATALAN` | `string` |
752
- | `language.CHINESE` | `string` |
753
- | `language.CROATIAN` | `string` |
754
- | `language.CZECH` | `string` |
755
- | `language.DANISH` | `string` |
756
- | `language.DUTCH` | `string` |
757
- | `language.ENGLISH` | `string` |
758
- | `language.ESPERANTO` | `string` |
759
- | `language.ESTONIAN` | `string` |
760
- | `language.FINNISH` | `string` |
761
- | `language.FRENCH` | `string` |
762
- | `language.FRISIAN` | `string` |
763
- | `language.GEORGIAN` | `string` |
764
- | `language.GERMAN` | `string` |
765
- | `language.GREEK` | `string` |
766
- | `language.HEBREW` | `string` |
767
- | `language.HUNGARIAN` | `string` |
768
- | `language.ICELANDIC` | `string` |
769
- | `language.IRISH` | `string` |
770
- | `language.ITALIAN` | `string` |
771
- | `language.JAPANESE` | `string` |
772
- | `language.KANNADA` | `string` |
773
- | `language.KAZAKH` | `string` |
774
- | `language.KOREAN` | `string` |
775
- | `language.LATVIAN` | `string` |
776
- | `language.LITHUANIAN` | `string` |
777
- | `language.LUXEMBOURGISH` | `string` |
778
- | `language.MACEDONIAN` | `string` |
779
- | `language.MALTESE` | `string` |
780
- | `language.NORWEGIAN` | `string` |
781
- | `language.POLISH` | `string` |
782
- | `language.PORTUGUESE` | `string` |
783
- | `language.ROMANIAN` | `string` |
784
- | `language.ROMANSH` | `string` |
785
- | `language.ROMAN_LATIN` | `string` |
786
- | `language.RUSSIAN` | `string` |
787
- | `language.SCOTTISH_GAELIC` | `string` |
788
- | `language.SERBIAN_CYRILLIC` | `string` |
789
- | `language.SLOVAK` | `string` |
790
- | `language.SLOVENE` | `string` |
791
- | `language.SPANISH` | `string` |
792
- | `language.SWEDISH` | `string` |
793
- | `language.THAI` | `string` |
794
- | `language.TURKISH` | `string` |
795
- | `language.UKRAINIAN` | `string` |
796
- | `language.WELSH` | `string` |
797
- | `reverse` | (`position`: `Position`, `options`: [`CommonForwardAndReverseGeocodingOptions`](README.md#commonforwardandreversegeocodingoptions)) => `Promise`<[`GeocodingSearchResult`](README.md#geocodingsearchresult)\> |
798
-
799
- #### Defined in
800
-
801
- [services/geocoding.ts:450](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geocoding.ts#L450)
802
-
803
- ___
804
-
805
- ### geolocation
806
-
807
- • `Const` **geolocation**: `Object`
808
-
809
- The **geolocation** namespace contains an asynchronous function to call the [MapTiler Geolocation API](https://docs.maptiler.com/cloud/api/geolocation/).
810
- 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)
811
-
812
- #### Type declaration
813
-
814
- | Name | Type |
815
- | :------ | :------ |
816
- | `info` | (`options`: [`GeolocationInfoOptions`](README.md#geolocationinfooptions)) => `Promise`<[`GeolocationResult`](README.md#geolocationresult)\> |
817
-
818
- #### Defined in
819
-
820
- [services/geolocation.ts:135](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/geolocation.ts#L135)
821
-
822
- ___
823
-
824
- ### mapStylePresetList
825
-
826
- • `Const` **mapStylePresetList**: [`MapStylePreset`](README.md#mapstylepreset)[]
827
-
828
- #### Defined in
829
-
830
- [mapstyle.ts:503](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/mapstyle.ts#L503)
831
-
832
- ___
833
-
834
- ### staticMaps
835
-
836
- • `Const` **staticMaps**: `Object`
837
-
838
- 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/).
839
- The URL of static maps can then be used within a `<img />` markup element, as the `src` property value.
840
-
841
- #### Type declaration
842
-
843
- | Name | Type |
844
- | :------ | :------ |
845
- | `automatic` | (`options`: [`BoundedStaticMapOptions`](README.md#boundedstaticmapoptions)) => `string` |
846
- | `bounded` | (`boundingBox`: `BBox`, `options`: [`BoundedStaticMapOptions`](README.md#boundedstaticmapoptions)) => `string` |
847
- | `centered` | (`center`: `Position`, `zoom`: `number`, `options`: [`StaticMapBaseOptions`](README.md#staticmapbaseoptions)) => `string` |
848
-
849
- #### Defined in
850
-
851
- [services/staticMaps.ts:457](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/services/staticMaps.ts#L457)
852
-
853
- ## Functions
854
-
855
- ### expandMapStyle
856
-
857
- ▸ **expandMapStyle**(`style`): `string`
858
-
859
- Expand the map style provided as argument of the Map constructor
860
-
861
- #### Parameters
862
-
863
- | Name | Type |
864
- | :------ | :------ |
865
- | `style` | `any` |
866
-
867
- #### Returns
868
-
869
- `string`
870
-
871
- #### Defined in
872
-
873
- [mapstyle.ts:6](https://github.com/maptiler/maptiler-client-js/blob/6f9a8fe/src/mapstyle.ts#L6)