@maplibre/maplibre-react-native 9.1.0 → 10.0.0-alpha.2
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/.eslintrc.js +10 -2
- package/.husky/pre-commit +5 -0
- package/.yarn/plugins/@yarnpkg/plugin-typescript.cjs +9 -0
- package/.yarn/sdks/eslint/bin/eslint.js +20 -0
- package/.yarn/sdks/eslint/lib/api.js +20 -0
- package/.yarn/sdks/eslint/package.json +6 -0
- package/.yarn/sdks/integrations.yml +5 -0
- package/.yarn/sdks/prettier/index.js +20 -0
- package/.yarn/sdks/prettier/package.json +6 -0
- package/.yarn/sdks/typescript/bin/tsc +20 -0
- package/.yarn/sdks/typescript/bin/tsserver +20 -0
- package/.yarn/sdks/typescript/lib/tsc.js +20 -0
- package/.yarn/sdks/typescript/lib/tsserver.js +225 -0
- package/.yarn/sdks/typescript/lib/tsserverlibrary.js +225 -0
- package/.yarn/sdks/typescript/lib/typescript.js +20 -0
- package/.yarn/sdks/typescript/package.json +6 -0
- package/CHANGELOG.md +18 -0
- package/android/rctmgl/build.gradle +7 -7
- package/android/rctmgl/src/main/java/com/mapbox/rctmgl/location/LocationManager.java +2 -2
- package/android/rctmgl/src/main/java/com/mapbox/rctmgl/modules/RCTMGLOfflineModule.java +21 -26
- package/docs/Annotation.md +8 -9
- package/docs/BackgroundLayer.md +2 -10
- package/docs/Callout.md +5 -5
- package/docs/Camera.md +18 -47
- package/docs/CircleLayer.md +2 -10
- package/docs/FillExtrusionLayer.md +2 -10
- package/docs/FillLayer.md +2 -10
- package/docs/HeatmapLayer.md +2 -10
- package/docs/ImageSource.md +3 -2
- package/docs/Images.md +5 -3
- package/docs/Light.md +1 -1
- package/docs/LineLayer.md +2 -10
- package/docs/MapView.md +53 -37
- package/docs/MarkerView.md +4 -2
- package/docs/NativeUserLocation.md +2 -2
- package/docs/PointAnnotation.md +5 -8
- package/docs/RasterLayer.md +2 -10
- package/docs/RasterSource.md +3 -2
- package/docs/ShapeSource.md +12 -7
- package/docs/Style.md +1 -1
- package/docs/SymbolLayer.md +3 -10
- package/docs/UserLocation.md +8 -10
- package/docs/VectorSource.md +6 -5
- package/docs/coordinates.md +6 -0
- package/docs/docs.json +518 -1272
- package/docs/location.md +6 -0
- package/docs/snapshotManager.md +3 -3
- package/javascript/@types/assets.d.ts +4 -0
- package/javascript/MGLModule.ts +37 -0
- package/javascript/Maplibre.ts +65 -0
- package/javascript/components/AbstractLayer.tsx +107 -0
- package/javascript/components/AbstractSource.tsx +27 -0
- package/javascript/components/BackgroundLayer.tsx +43 -0
- package/javascript/components/{Callout.js → Callout.tsx} +67 -65
- package/javascript/components/{Camera.js → Camera.tsx} +266 -251
- package/javascript/components/CircleLayer.tsx +46 -0
- package/javascript/components/FillExtrusionLayer.tsx +47 -0
- package/javascript/components/FillLayer.tsx +41 -0
- package/javascript/components/{HeadingIndicator.js → HeadingIndicator.tsx} +8 -8
- package/javascript/components/HeatmapLayer.tsx +44 -0
- package/javascript/components/ImageSource.tsx +78 -0
- package/javascript/components/Images.tsx +134 -0
- package/javascript/components/Light.tsx +67 -0
- package/javascript/components/LineLayer.tsx +42 -0
- package/javascript/components/{MapView.js → MapView.tsx} +365 -354
- package/javascript/components/MarkerView.tsx +104 -0
- package/javascript/components/{NativeBridgeComponent.js → NativeBridgeComponent.tsx} +44 -13
- package/javascript/components/NativeUserLocation.tsx +33 -0
- package/javascript/components/PointAnnotation.tsx +221 -0
- package/javascript/components/RasterLayer.tsx +41 -0
- package/javascript/components/RasterSource.tsx +117 -0
- package/javascript/components/ShapeSource.tsx +383 -0
- package/javascript/components/{Style.js → Style.tsx} +129 -38
- package/javascript/components/SymbolLayer.tsx +72 -0
- package/javascript/components/{UserLocation.js → UserLocation.tsx} +111 -110
- package/javascript/components/VectorSource.tsx +207 -0
- package/javascript/components/annotations/Annotation.tsx +134 -0
- package/javascript/index.ts +4 -0
- package/javascript/modules/location/{locationManager.js → locationManager.ts} +71 -10
- package/javascript/modules/offline/{OfflineCreatePackOptions.js → OfflineCreatePackOptions.ts} +20 -4
- package/javascript/modules/offline/{OfflinePack.js → OfflinePack.ts} +23 -7
- package/javascript/modules/offline/{offlineManager.js → offlineManager.ts} +81 -24
- package/javascript/modules/snapshot/{SnapshotOptions.js → SnapshotOptions.ts} +43 -6
- package/javascript/modules/snapshot/{snapshotManager.js → snapshotManager.ts} +5 -5
- package/javascript/requestAndroidLocationPermissions.ts +29 -0
- package/javascript/types/BaseProps.ts +5 -0
- package/javascript/types/OnPressEvent.ts +13 -0
- package/javascript/types/index.ts +7 -0
- package/javascript/utils/BridgeValue.ts +90 -0
- package/javascript/utils/{Logger.js → Logger.ts} +37 -18
- package/javascript/utils/MaplibreStyles.d.ts +1486 -0
- package/javascript/utils/StyleValue.ts +49 -0
- package/javascript/utils/animated/AbstractAnimatedCoordinates.ts +134 -0
- package/javascript/utils/animated/AnimatedCoordinatesArray.ts +112 -0
- package/javascript/utils/animated/{AnimatedExtractCoordinateFromArray.js → AnimatedExtractCoordinateFromArray.ts} +5 -5
- package/javascript/utils/animated/{AnimatedPoint.js → AnimatedPoint.ts} +20 -12
- package/javascript/utils/animated/{AnimatedRouteCoordinatesArray.js → AnimatedRouteCoordinatesArray.ts} +39 -14
- package/javascript/utils/animated/{AnimatedShape.js → AnimatedShape.ts} +31 -10
- package/javascript/utils/{deprecation.js → deprecation.ts} +9 -6
- package/javascript/utils/filterUtils.ts +9 -0
- package/javascript/utils/geoUtils.ts +79 -0
- package/javascript/utils/{index.js → index.ts} +44 -24
- package/javascript/utils/styleMap.ts +264 -0
- package/package.json +35 -27
- package/plugin/build/withMapLibre.js +18 -3
- package/scripts/autogenHelpers/globals.js +1 -1
- package/scripts/autogenerate.js +14 -6
- package/scripts/download-style-spec.sh +1 -1
- package/scripts/templates/MaplibreStyles.ts.ejs +99 -0
- package/scripts/templates/index.d.ts.ejs +71 -42
- package/scripts/templates/{styleMap.js.ejs → styleMap.ts.ejs} +3 -33
- package/setup-jest.js +1 -10
- package/tsconfig.json +20 -61
- package/index.d.ts +0 -955
- package/javascript/components/AbstractLayer.js +0 -75
- package/javascript/components/AbstractSource.js +0 -15
- package/javascript/components/BackgroundLayer.js +0 -97
- package/javascript/components/CircleLayer.js +0 -101
- package/javascript/components/FillExtrusionLayer.js +0 -98
- package/javascript/components/FillLayer.js +0 -94
- package/javascript/components/HeatmapLayer.js +0 -99
- package/javascript/components/ImageSource.js +0 -82
- package/javascript/components/Images.js +0 -119
- package/javascript/components/Light.js +0 -47
- package/javascript/components/LineLayer.js +0 -94
- package/javascript/components/MarkerView.js +0 -87
- package/javascript/components/NativeUserLocation.js +0 -41
- package/javascript/components/PointAnnotation.js +0 -216
- package/javascript/components/RasterLayer.js +0 -95
- package/javascript/components/RasterSource.js +0 -124
- package/javascript/components/ShapeSource.js +0 -372
- package/javascript/components/SymbolLayer.js +0 -120
- package/javascript/components/VectorSource.js +0 -200
- package/javascript/components/annotations/Annotation.js +0 -122
- package/javascript/index.js +0 -149
- package/javascript/utils/BridgeValue.js +0 -81
- package/javascript/utils/animated/AnimatedCoordinatesArray.js +0 -191
- package/javascript/utils/filterUtils.js +0 -7
- package/javascript/utils/geoUtils.js +0 -73
- package/javascript/utils/styleMap.js +0 -1932
- /package/javascript/utils/animated/{Animated.js → Animated.ts} +0 -0
package/docs/docs.json
CHANGED
|
@@ -7,8 +7,20 @@
|
|
|
7
7
|
"name": "onPress",
|
|
8
8
|
"docblock": null,
|
|
9
9
|
"modifiers": [],
|
|
10
|
-
"params": [
|
|
11
|
-
|
|
10
|
+
"params": [
|
|
11
|
+
{
|
|
12
|
+
"name": "event",
|
|
13
|
+
"optional": false,
|
|
14
|
+
"type": {
|
|
15
|
+
"name": "OnPressEvent"
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"returns": {
|
|
20
|
+
"type": {
|
|
21
|
+
"name": "void"
|
|
22
|
+
}
|
|
23
|
+
}
|
|
12
24
|
},
|
|
13
25
|
{
|
|
14
26
|
"name": "symbolStyle",
|
|
@@ -17,7 +29,20 @@
|
|
|
17
29
|
"get"
|
|
18
30
|
],
|
|
19
31
|
"params": [],
|
|
20
|
-
"returns":
|
|
32
|
+
"returns": {
|
|
33
|
+
"type": {
|
|
34
|
+
"name": "union",
|
|
35
|
+
"raw": "SymbolLayerStyleProps | undefined",
|
|
36
|
+
"elements": [
|
|
37
|
+
{
|
|
38
|
+
"name": "SymbolLayerStyleProps"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"name": "undefined"
|
|
42
|
+
}
|
|
43
|
+
]
|
|
44
|
+
}
|
|
45
|
+
}
|
|
21
46
|
}
|
|
22
47
|
],
|
|
23
48
|
"props": [
|
|
@@ -31,7 +56,7 @@
|
|
|
31
56
|
{
|
|
32
57
|
"name": "animated",
|
|
33
58
|
"required": false,
|
|
34
|
-
"type": "
|
|
59
|
+
"type": "boolean",
|
|
35
60
|
"default": "false",
|
|
36
61
|
"description": "FIX ME NO DESCRIPTION"
|
|
37
62
|
},
|
|
@@ -42,55 +67,43 @@
|
|
|
42
67
|
"default": "1000",
|
|
43
68
|
"description": "FIX ME NO DESCRIPTION"
|
|
44
69
|
},
|
|
45
|
-
{
|
|
46
|
-
"name": "animationEasingFunction",
|
|
47
|
-
"required": false,
|
|
48
|
-
"type": "func",
|
|
49
|
-
"default": "Easing.linear",
|
|
50
|
-
"description": "FIX ME NO DESCRIPTION"
|
|
51
|
-
},
|
|
52
70
|
{
|
|
53
71
|
"name": "coordinates",
|
|
54
72
|
"required": false,
|
|
55
|
-
"type":
|
|
56
|
-
"name": "array",
|
|
57
|
-
"value": {
|
|
58
|
-
"type": "number"
|
|
59
|
-
}
|
|
60
|
-
},
|
|
73
|
+
"type": "Array",
|
|
61
74
|
"default": "none",
|
|
62
75
|
"description": "FIX ME NO DESCRIPTION"
|
|
63
76
|
},
|
|
64
77
|
{
|
|
65
|
-
"name": "
|
|
78
|
+
"name": "children",
|
|
66
79
|
"required": false,
|
|
67
|
-
"type": "
|
|
80
|
+
"type": "ReactElement \\| ReactElement[]",
|
|
68
81
|
"default": "none",
|
|
69
82
|
"description": "FIX ME NO DESCRIPTION"
|
|
70
83
|
},
|
|
71
84
|
{
|
|
72
|
-
"name": "
|
|
85
|
+
"name": "style",
|
|
73
86
|
"required": false,
|
|
74
|
-
"type": "
|
|
87
|
+
"type": "object",
|
|
75
88
|
"default": "none",
|
|
76
89
|
"description": "FIX ME NO DESCRIPTION"
|
|
77
90
|
},
|
|
78
91
|
{
|
|
79
|
-
"name": "
|
|
92
|
+
"name": "icon",
|
|
80
93
|
"required": false,
|
|
81
|
-
"type": "
|
|
94
|
+
"type": "string \\| number \\| object",
|
|
82
95
|
"default": "none",
|
|
83
96
|
"description": "FIX ME NO DESCRIPTION"
|
|
84
97
|
},
|
|
85
98
|
{
|
|
86
|
-
"name": "
|
|
99
|
+
"name": "animationEasingFunction",
|
|
87
100
|
"required": false,
|
|
88
|
-
"type": "
|
|
89
|
-
"default": "
|
|
101
|
+
"type": "FIX ME UNKNOWN TYPE",
|
|
102
|
+
"default": "Easing.linear",
|
|
90
103
|
"description": "FIX ME NO DESCRIPTION"
|
|
91
104
|
}
|
|
92
105
|
],
|
|
93
|
-
"fileNameWithExt": "Annotation.
|
|
106
|
+
"fileNameWithExt": "Annotation.tsx",
|
|
94
107
|
"name": "Annotation"
|
|
95
108
|
},
|
|
96
109
|
"BackgroundLayer": {
|
|
@@ -99,80 +112,25 @@
|
|
|
99
112
|
"methods": [],
|
|
100
113
|
"props": [
|
|
101
114
|
{
|
|
102
|
-
"name": "
|
|
103
|
-
"required":
|
|
104
|
-
"type": "
|
|
115
|
+
"name": "style",
|
|
116
|
+
"required": false,
|
|
117
|
+
"type": "BackgroundLayerStyleProps",
|
|
105
118
|
"default": "none",
|
|
106
|
-
"description": "
|
|
119
|
+
"description": "Customizable style attributes"
|
|
107
120
|
},
|
|
108
121
|
{
|
|
109
122
|
"name": "sourceID",
|
|
110
123
|
"required": false,
|
|
111
|
-
"type": "
|
|
124
|
+
"type": "FIX ME UNKNOWN TYPE",
|
|
112
125
|
"default": "MapLibreGL.StyleSource.DefaultSourceID",
|
|
113
|
-
"description": "
|
|
114
|
-
},
|
|
115
|
-
{
|
|
116
|
-
"name": "sourceLayerID",
|
|
117
|
-
"required": false,
|
|
118
|
-
"type": "string",
|
|
119
|
-
"default": "none",
|
|
120
|
-
"description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style."
|
|
121
|
-
},
|
|
122
|
-
{
|
|
123
|
-
"name": "aboveLayerID",
|
|
124
|
-
"required": false,
|
|
125
|
-
"type": "string",
|
|
126
|
-
"default": "none",
|
|
127
|
-
"description": "Inserts a layer above aboveLayerID."
|
|
128
|
-
},
|
|
129
|
-
{
|
|
130
|
-
"name": "belowLayerID",
|
|
131
|
-
"required": false,
|
|
132
|
-
"type": "string",
|
|
133
|
-
"default": "none",
|
|
134
|
-
"description": "Inserts a layer below belowLayerID"
|
|
135
|
-
},
|
|
136
|
-
{
|
|
137
|
-
"name": "layerIndex",
|
|
138
|
-
"required": false,
|
|
139
|
-
"type": "number",
|
|
140
|
-
"default": "none",
|
|
141
|
-
"description": "Inserts a layer at a specified index"
|
|
142
|
-
},
|
|
143
|
-
{
|
|
144
|
-
"name": "filter",
|
|
145
|
-
"required": false,
|
|
146
|
-
"type": "array",
|
|
147
|
-
"default": "none",
|
|
148
|
-
"description": "Filter only the features in the source layer that satisfy a condition that you define"
|
|
149
|
-
},
|
|
150
|
-
{
|
|
151
|
-
"name": "minZoomLevel",
|
|
152
|
-
"required": false,
|
|
153
|
-
"type": "number",
|
|
154
|
-
"default": "none",
|
|
155
|
-
"description": "The minimum zoom level at which the layer gets parsed and appears."
|
|
156
|
-
},
|
|
157
|
-
{
|
|
158
|
-
"name": "maxZoomLevel",
|
|
159
|
-
"required": false,
|
|
160
|
-
"type": "number",
|
|
161
|
-
"default": "none",
|
|
162
|
-
"description": "The maximum zoom level at which the layer gets parsed and appears."
|
|
163
|
-
},
|
|
164
|
-
{
|
|
165
|
-
"name": "style",
|
|
166
|
-
"required": false,
|
|
167
|
-
"type": "union",
|
|
168
|
-
"default": "none",
|
|
169
|
-
"description": "Customizable style attributes"
|
|
126
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
170
127
|
}
|
|
171
128
|
],
|
|
172
129
|
"composes": [
|
|
173
|
-
"
|
|
130
|
+
"BaseProps",
|
|
131
|
+
"BaseLayerProps"
|
|
174
132
|
],
|
|
175
|
-
"fileNameWithExt": "BackgroundLayer.
|
|
133
|
+
"fileNameWithExt": "BackgroundLayer.tsx",
|
|
176
134
|
"name": "BackgroundLayer",
|
|
177
135
|
"styles": [
|
|
178
136
|
{
|
|
@@ -265,43 +223,43 @@
|
|
|
265
223
|
{
|
|
266
224
|
"name": "style",
|
|
267
225
|
"required": false,
|
|
268
|
-
"type": "
|
|
226
|
+
"type": "ViewStyle",
|
|
269
227
|
"default": "none",
|
|
270
228
|
"description": "Style property for the Animated.View wrapper, apply animations to this"
|
|
271
229
|
},
|
|
272
230
|
{
|
|
273
231
|
"name": "containerStyle",
|
|
274
232
|
"required": false,
|
|
275
|
-
"type": "
|
|
233
|
+
"type": "ViewStyle",
|
|
276
234
|
"default": "none",
|
|
277
235
|
"description": "Style property for the native RCTMGLCallout container, set at your own risk."
|
|
278
236
|
},
|
|
279
237
|
{
|
|
280
238
|
"name": "contentStyle",
|
|
281
239
|
"required": false,
|
|
282
|
-
"type": "
|
|
240
|
+
"type": "ViewStyle",
|
|
283
241
|
"default": "none",
|
|
284
242
|
"description": "Style property for the content bubble."
|
|
285
243
|
},
|
|
286
244
|
{
|
|
287
245
|
"name": "tipStyle",
|
|
288
246
|
"required": false,
|
|
289
|
-
"type": "
|
|
247
|
+
"type": "ViewStyle",
|
|
290
248
|
"default": "none",
|
|
291
249
|
"description": "Style property for the triangle tip under the content."
|
|
292
250
|
},
|
|
293
251
|
{
|
|
294
252
|
"name": "textStyle",
|
|
295
253
|
"required": false,
|
|
296
|
-
"type": "
|
|
254
|
+
"type": "ViewStyle",
|
|
297
255
|
"default": "none",
|
|
298
256
|
"description": "Style property for the title in the content bubble."
|
|
299
257
|
}
|
|
300
258
|
],
|
|
301
259
|
"composes": [
|
|
302
|
-
"
|
|
260
|
+
"Omit"
|
|
303
261
|
],
|
|
304
|
-
"fileNameWithExt": "Callout.
|
|
262
|
+
"fileNameWithExt": "Callout.tsx",
|
|
305
263
|
"name": "Callout"
|
|
306
264
|
},
|
|
307
265
|
"Camera": {
|
|
@@ -366,7 +324,7 @@
|
|
|
366
324
|
"name": "coordinates",
|
|
367
325
|
"description": "Coordinates that map camera will jump too",
|
|
368
326
|
"type": {
|
|
369
|
-
"name": "
|
|
327
|
+
"name": "GeoJSON.Position"
|
|
370
328
|
},
|
|
371
329
|
"optional": false
|
|
372
330
|
},
|
|
@@ -399,7 +357,7 @@
|
|
|
399
357
|
"name": "coordinates",
|
|
400
358
|
"description": "Coordinates that map camera will move too",
|
|
401
359
|
"type": {
|
|
402
|
-
"name": "
|
|
360
|
+
"name": "GeoJSON.Position"
|
|
403
361
|
},
|
|
404
362
|
"optional": false
|
|
405
363
|
},
|
|
@@ -432,7 +390,7 @@
|
|
|
432
390
|
"name": "zoomLevel",
|
|
433
391
|
"description": "Zoom level that the map camera will animate too",
|
|
434
392
|
"type": {
|
|
435
|
-
"name": "
|
|
393
|
+
"name": "number"
|
|
436
394
|
},
|
|
437
395
|
"optional": false
|
|
438
396
|
},
|
|
@@ -470,7 +428,11 @@
|
|
|
470
428
|
"optional": true
|
|
471
429
|
}
|
|
472
430
|
],
|
|
473
|
-
"returns":
|
|
431
|
+
"returns": {
|
|
432
|
+
"type": {
|
|
433
|
+
"name": "void"
|
|
434
|
+
}
|
|
435
|
+
},
|
|
474
436
|
"description": "Map camera will perform updates based on provided config. Advanced use only!",
|
|
475
437
|
"examples": [
|
|
476
438
|
"\nthis.camera.setCamera({\n centerCoordinate: [lng, lat],\n zoomLevel: 16,\n animationDuration: 2000,\n})\n\nthis.camera.setCamera({\n stops: [\n { pitch: 45, animationDuration: 200 },\n { heading: 180, animationDuration: 300 },\n ]\n})\n\n "
|
|
@@ -479,320 +441,74 @@
|
|
|
479
441
|
],
|
|
480
442
|
"props": [
|
|
481
443
|
{
|
|
482
|
-
"name": "
|
|
483
|
-
"required": false,
|
|
484
|
-
"type": "bool",
|
|
485
|
-
"default": "true",
|
|
486
|
-
"description": "If false, the camera will not send any props to the native module. Intended to be used to prevent unnecessary tile fetching and improve performance when the map is not visible. Defaults to true."
|
|
487
|
-
},
|
|
488
|
-
{
|
|
489
|
-
"name": "animationDuration",
|
|
444
|
+
"name": "centerCoordinate",
|
|
490
445
|
"required": false,
|
|
491
|
-
"type": "
|
|
492
|
-
"default": "
|
|
493
|
-
"description": "The
|
|
446
|
+
"type": "GeoJSON.Position",
|
|
447
|
+
"default": "none",
|
|
448
|
+
"description": "The location on which the map should center."
|
|
494
449
|
},
|
|
495
450
|
{
|
|
496
|
-
"name": "
|
|
451
|
+
"name": "bounds",
|
|
497
452
|
"required": false,
|
|
498
|
-
"type": "
|
|
499
|
-
"default": "
|
|
500
|
-
"description": "The
|
|
453
|
+
"type": "CameraBoundsWithPadding",
|
|
454
|
+
"default": "none",
|
|
455
|
+
"description": "The corners of a box around which the map should bound. Contains padding props for backwards\ncompatibility; the root `padding` prop should be used instead."
|
|
501
456
|
},
|
|
502
457
|
{
|
|
503
|
-
"name": "
|
|
458
|
+
"name": "heading",
|
|
504
459
|
"required": false,
|
|
505
|
-
"type":
|
|
506
|
-
"name": "shape",
|
|
507
|
-
"value": [
|
|
508
|
-
{
|
|
509
|
-
"name": "centerCoordinate",
|
|
510
|
-
"required": false,
|
|
511
|
-
"type": {
|
|
512
|
-
"name": "array",
|
|
513
|
-
"value": {
|
|
514
|
-
"type": "number"
|
|
515
|
-
}
|
|
516
|
-
},
|
|
517
|
-
"default": "none",
|
|
518
|
-
"description": "Center coordinate on map [lng, lat]"
|
|
519
|
-
},
|
|
520
|
-
{
|
|
521
|
-
"name": "padding",
|
|
522
|
-
"required": false,
|
|
523
|
-
"type": {
|
|
524
|
-
"name": "shape",
|
|
525
|
-
"value": [
|
|
526
|
-
{
|
|
527
|
-
"name": "paddingLeft",
|
|
528
|
-
"required": false,
|
|
529
|
-
"type": "number",
|
|
530
|
-
"default": "none",
|
|
531
|
-
"description": "Left padding in points"
|
|
532
|
-
},
|
|
533
|
-
{
|
|
534
|
-
"name": "paddingRight",
|
|
535
|
-
"required": false,
|
|
536
|
-
"type": "number",
|
|
537
|
-
"default": "none",
|
|
538
|
-
"description": "Right padding in points"
|
|
539
|
-
},
|
|
540
|
-
{
|
|
541
|
-
"name": "paddingTop",
|
|
542
|
-
"required": false,
|
|
543
|
-
"type": "number",
|
|
544
|
-
"default": "none",
|
|
545
|
-
"description": "Top padding in points"
|
|
546
|
-
},
|
|
547
|
-
{
|
|
548
|
-
"name": "paddingBottom",
|
|
549
|
-
"required": false,
|
|
550
|
-
"type": "number",
|
|
551
|
-
"default": "none",
|
|
552
|
-
"description": "Bottom padding in points"
|
|
553
|
-
}
|
|
554
|
-
]
|
|
555
|
-
},
|
|
556
|
-
"default": "none",
|
|
557
|
-
"description": "Padding around edges of map in points"
|
|
558
|
-
},
|
|
559
|
-
{
|
|
560
|
-
"name": "heading",
|
|
561
|
-
"required": false,
|
|
562
|
-
"type": "number",
|
|
563
|
-
"default": "none",
|
|
564
|
-
"description": "Heading on map"
|
|
565
|
-
},
|
|
566
|
-
{
|
|
567
|
-
"name": "pitch",
|
|
568
|
-
"required": false,
|
|
569
|
-
"type": "number",
|
|
570
|
-
"default": "none",
|
|
571
|
-
"description": "Pitch on map"
|
|
572
|
-
},
|
|
573
|
-
{
|
|
574
|
-
"name": "bounds",
|
|
575
|
-
"required": false,
|
|
576
|
-
"type": {
|
|
577
|
-
"name": "shape",
|
|
578
|
-
"value": [
|
|
579
|
-
{
|
|
580
|
-
"name": "ne",
|
|
581
|
-
"required": true,
|
|
582
|
-
"type": {
|
|
583
|
-
"name": "array",
|
|
584
|
-
"value": {
|
|
585
|
-
"type": "number"
|
|
586
|
-
}
|
|
587
|
-
},
|
|
588
|
-
"default": "none",
|
|
589
|
-
"description": "North east coordinate of bound"
|
|
590
|
-
},
|
|
591
|
-
{
|
|
592
|
-
"name": "sw",
|
|
593
|
-
"required": true,
|
|
594
|
-
"type": {
|
|
595
|
-
"name": "array",
|
|
596
|
-
"value": {
|
|
597
|
-
"type": "number"
|
|
598
|
-
}
|
|
599
|
-
},
|
|
600
|
-
"default": "none",
|
|
601
|
-
"description": "South west coordinate of bound"
|
|
602
|
-
},
|
|
603
|
-
{
|
|
604
|
-
"name": "paddingLeft",
|
|
605
|
-
"required": false,
|
|
606
|
-
"type": "number",
|
|
607
|
-
"default": "none",
|
|
608
|
-
"description": "Left padding in points (deprecated; use root `padding` property instead)"
|
|
609
|
-
},
|
|
610
|
-
{
|
|
611
|
-
"name": "paddingRight",
|
|
612
|
-
"required": false,
|
|
613
|
-
"type": "number",
|
|
614
|
-
"default": "none",
|
|
615
|
-
"description": "Right padding in points (deprecated; use root `padding` property instead)"
|
|
616
|
-
},
|
|
617
|
-
{
|
|
618
|
-
"name": "paddingTop",
|
|
619
|
-
"required": false,
|
|
620
|
-
"type": "number",
|
|
621
|
-
"default": "none",
|
|
622
|
-
"description": "Top padding in points (deprecated; use root `padding` property instead)"
|
|
623
|
-
},
|
|
624
|
-
{
|
|
625
|
-
"name": "paddingBottom",
|
|
626
|
-
"required": false,
|
|
627
|
-
"type": "number",
|
|
628
|
-
"default": "none",
|
|
629
|
-
"description": "Bottom padding in points (deprecated; use root `padding` property instead)"
|
|
630
|
-
}
|
|
631
|
-
]
|
|
632
|
-
},
|
|
633
|
-
"default": "none",
|
|
634
|
-
"description": "Represents a rectangle in geographical coordinates marking the visible area of the map.\nThe `bounds.padding*` properties are deprecated; use root `padding` property instead."
|
|
635
|
-
},
|
|
636
|
-
{
|
|
637
|
-
"name": "onUserTrackingModeChange",
|
|
638
|
-
"required": false,
|
|
639
|
-
"type": "func",
|
|
640
|
-
"default": "none",
|
|
641
|
-
"description": "Callback that is triggered on user tracking mode changes"
|
|
642
|
-
},
|
|
643
|
-
{
|
|
644
|
-
"name": "zoomLevel",
|
|
645
|
-
"required": false,
|
|
646
|
-
"type": "number",
|
|
647
|
-
"default": "none",
|
|
648
|
-
"description": "Zoom level of the map"
|
|
649
|
-
}
|
|
650
|
-
]
|
|
651
|
-
},
|
|
460
|
+
"type": "number",
|
|
652
461
|
"default": "none",
|
|
653
|
-
"description": "
|
|
462
|
+
"description": "The heading (orientation) of the map."
|
|
654
463
|
},
|
|
655
464
|
{
|
|
656
|
-
"name": "
|
|
465
|
+
"name": "pitch",
|
|
657
466
|
"required": false,
|
|
658
|
-
"type":
|
|
659
|
-
"name": "array",
|
|
660
|
-
"value": {
|
|
661
|
-
"type": "number"
|
|
662
|
-
}
|
|
663
|
-
},
|
|
467
|
+
"type": "number",
|
|
664
468
|
"default": "none",
|
|
665
|
-
"description": "
|
|
469
|
+
"description": "The pitch of the map."
|
|
666
470
|
},
|
|
667
471
|
{
|
|
668
|
-
"name": "
|
|
472
|
+
"name": "zoomLevel",
|
|
669
473
|
"required": false,
|
|
670
|
-
"type":
|
|
671
|
-
"name": "shape",
|
|
672
|
-
"value": [
|
|
673
|
-
{
|
|
674
|
-
"name": "paddingLeft",
|
|
675
|
-
"required": false,
|
|
676
|
-
"type": "number",
|
|
677
|
-
"default": "none",
|
|
678
|
-
"description": "Left padding in points"
|
|
679
|
-
},
|
|
680
|
-
{
|
|
681
|
-
"name": "paddingRight",
|
|
682
|
-
"required": false,
|
|
683
|
-
"type": "number",
|
|
684
|
-
"default": "none",
|
|
685
|
-
"description": "Right padding in points"
|
|
686
|
-
},
|
|
687
|
-
{
|
|
688
|
-
"name": "paddingTop",
|
|
689
|
-
"required": false,
|
|
690
|
-
"type": "number",
|
|
691
|
-
"default": "none",
|
|
692
|
-
"description": "Top padding in points"
|
|
693
|
-
},
|
|
694
|
-
{
|
|
695
|
-
"name": "paddingBottom",
|
|
696
|
-
"required": false,
|
|
697
|
-
"type": "number",
|
|
698
|
-
"default": "none",
|
|
699
|
-
"description": "Bottom padding in points"
|
|
700
|
-
}
|
|
701
|
-
]
|
|
702
|
-
},
|
|
474
|
+
"type": "number",
|
|
703
475
|
"default": "none",
|
|
704
|
-
"description": "
|
|
476
|
+
"description": "The zoom level of the map."
|
|
705
477
|
},
|
|
706
478
|
{
|
|
707
|
-
"name": "
|
|
479
|
+
"name": "padding",
|
|
708
480
|
"required": false,
|
|
709
|
-
"type": "
|
|
481
|
+
"type": "CameraPadding",
|
|
710
482
|
"default": "none",
|
|
711
|
-
"description": "
|
|
483
|
+
"description": "The viewport padding in points."
|
|
712
484
|
},
|
|
713
485
|
{
|
|
714
|
-
"name": "
|
|
486
|
+
"name": "animationDuration",
|
|
715
487
|
"required": false,
|
|
716
488
|
"type": "number",
|
|
717
|
-
"default": "
|
|
718
|
-
"description": "
|
|
489
|
+
"default": "2000",
|
|
490
|
+
"description": "The duration the map takes to animate to a new configuration."
|
|
719
491
|
},
|
|
720
492
|
{
|
|
721
|
-
"name": "
|
|
493
|
+
"name": "animationMode",
|
|
722
494
|
"required": false,
|
|
723
|
-
"type":
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
{
|
|
727
|
-
"name": "ne",
|
|
728
|
-
"required": true,
|
|
729
|
-
"type": {
|
|
730
|
-
"name": "array",
|
|
731
|
-
"value": {
|
|
732
|
-
"type": "number"
|
|
733
|
-
}
|
|
734
|
-
},
|
|
735
|
-
"default": "none",
|
|
736
|
-
"description": "North east coordinate of bound"
|
|
737
|
-
},
|
|
738
|
-
{
|
|
739
|
-
"name": "sw",
|
|
740
|
-
"required": true,
|
|
741
|
-
"type": {
|
|
742
|
-
"name": "array",
|
|
743
|
-
"value": {
|
|
744
|
-
"type": "number"
|
|
745
|
-
}
|
|
746
|
-
},
|
|
747
|
-
"default": "none",
|
|
748
|
-
"description": "South west coordinate of bound"
|
|
749
|
-
},
|
|
750
|
-
{
|
|
751
|
-
"name": "paddingLeft",
|
|
752
|
-
"required": false,
|
|
753
|
-
"type": "number",
|
|
754
|
-
"default": "none",
|
|
755
|
-
"description": "Left padding in points (deprecated; use root `padding` property instead)"
|
|
756
|
-
},
|
|
757
|
-
{
|
|
758
|
-
"name": "paddingRight",
|
|
759
|
-
"required": false,
|
|
760
|
-
"type": "number",
|
|
761
|
-
"default": "none",
|
|
762
|
-
"description": "Right padding in points (deprecated; use root `padding` property instead)"
|
|
763
|
-
},
|
|
764
|
-
{
|
|
765
|
-
"name": "paddingTop",
|
|
766
|
-
"required": false,
|
|
767
|
-
"type": "number",
|
|
768
|
-
"default": "none",
|
|
769
|
-
"description": "Top padding in points (deprecated; use root `padding` property instead)"
|
|
770
|
-
},
|
|
771
|
-
{
|
|
772
|
-
"name": "paddingBottom",
|
|
773
|
-
"required": false,
|
|
774
|
-
"type": "number",
|
|
775
|
-
"default": "none",
|
|
776
|
-
"description": "Bottom padding in points (deprecated; use root `padding` property instead)"
|
|
777
|
-
}
|
|
778
|
-
]
|
|
779
|
-
},
|
|
780
|
-
"default": "none",
|
|
781
|
-
"description": "Represents a rectangle in geographical coordinates marking the visible area of the map.\nThe `bounds.padding*` properties are deprecated; use root `padding` property instead."
|
|
495
|
+
"type": "'flyTo' \\| 'easeTo' \\| 'linearTo' \\| 'moveTo'",
|
|
496
|
+
"default": "'easeTo'",
|
|
497
|
+
"description": "The easing or path the camera uses to animate to a new configuration."
|
|
782
498
|
},
|
|
783
499
|
{
|
|
784
|
-
"name": "
|
|
500
|
+
"name": "allowUpdates",
|
|
785
501
|
"required": false,
|
|
786
|
-
"type": "
|
|
787
|
-
"default": "
|
|
788
|
-
"description": "
|
|
502
|
+
"type": "boolean",
|
|
503
|
+
"default": "true",
|
|
504
|
+
"description": "If false, the camera will not send any props to the native module. Intended to be used to prevent unnecessary tile fetching and improve performance when the map is not visible. Defaults to true."
|
|
789
505
|
},
|
|
790
506
|
{
|
|
791
|
-
"name": "
|
|
507
|
+
"name": "defaultSettings",
|
|
792
508
|
"required": false,
|
|
793
|
-
"type": "
|
|
509
|
+
"type": "CameraStop",
|
|
794
510
|
"default": "none",
|
|
795
|
-
"description": "
|
|
511
|
+
"description": "Default view settings applied on camera"
|
|
796
512
|
},
|
|
797
513
|
{
|
|
798
514
|
"name": "minZoomLevel",
|
|
@@ -811,49 +527,21 @@
|
|
|
811
527
|
{
|
|
812
528
|
"name": "maxBounds",
|
|
813
529
|
"required": false,
|
|
814
|
-
"type":
|
|
815
|
-
"name": "shape",
|
|
816
|
-
"value": [
|
|
817
|
-
{
|
|
818
|
-
"name": "ne",
|
|
819
|
-
"required": true,
|
|
820
|
-
"type": {
|
|
821
|
-
"name": "array",
|
|
822
|
-
"value": {
|
|
823
|
-
"type": "number"
|
|
824
|
-
}
|
|
825
|
-
},
|
|
826
|
-
"default": "none",
|
|
827
|
-
"description": "northEastCoordinates - North east coordinate of bound"
|
|
828
|
-
},
|
|
829
|
-
{
|
|
830
|
-
"name": "sw",
|
|
831
|
-
"required": true,
|
|
832
|
-
"type": {
|
|
833
|
-
"name": "array",
|
|
834
|
-
"value": {
|
|
835
|
-
"type": "number"
|
|
836
|
-
}
|
|
837
|
-
},
|
|
838
|
-
"default": "none",
|
|
839
|
-
"description": "southWestCoordinates - South west coordinate of bound"
|
|
840
|
-
}
|
|
841
|
-
]
|
|
842
|
-
},
|
|
530
|
+
"type": "CameraBounds",
|
|
843
531
|
"default": "none",
|
|
844
532
|
"description": "Restrict map panning so that the center is within these bounds"
|
|
845
533
|
},
|
|
846
534
|
{
|
|
847
535
|
"name": "followUserLocation",
|
|
848
536
|
"required": false,
|
|
849
|
-
"type": "
|
|
537
|
+
"type": "boolean",
|
|
850
538
|
"default": "none",
|
|
851
539
|
"description": "Should the map orientation follow the user's."
|
|
852
540
|
},
|
|
853
541
|
{
|
|
854
542
|
"name": "followUserMode",
|
|
855
543
|
"required": false,
|
|
856
|
-
"type": "
|
|
544
|
+
"type": "UserTrackingMode",
|
|
857
545
|
"default": "none",
|
|
858
546
|
"description": "The mode used to track the user location on the map. One of; \"normal\", \"compass\", \"course\". Each mode string is also available as a member on the `MapLibreGL.UserTrackingModes` object. `Follow` (normal), `FollowWithHeading` (compass), `FollowWithCourse` (course). NOTE: `followUserLocation` must be set to `true` for any of the modes to take effect. [Example](../example/src/examples/Camera/SetUserTrackingModes.js)"
|
|
859
547
|
},
|
|
@@ -881,15 +569,25 @@
|
|
|
881
569
|
{
|
|
882
570
|
"name": "triggerKey",
|
|
883
571
|
"required": false,
|
|
884
|
-
"type": "
|
|
572
|
+
"type": "string \\| number",
|
|
885
573
|
"default": "none",
|
|
886
574
|
"description": "Manually update the camera - helpful for when props did not update, however you still want the camera to move"
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
"name": "onUserTrackingModeChange",
|
|
578
|
+
"required": false,
|
|
579
|
+
"type": {
|
|
580
|
+
"name": "func",
|
|
581
|
+
"funcSignature": "(event:MaplibreGLEvent) => void"
|
|
582
|
+
},
|
|
583
|
+
"default": "none",
|
|
584
|
+
"description": "FIX ME NO DESCRIPTION\n*signature:*`(event:MaplibreGLEvent) => void`"
|
|
887
585
|
}
|
|
888
586
|
],
|
|
889
587
|
"composes": [
|
|
890
|
-
"
|
|
588
|
+
"Omit"
|
|
891
589
|
],
|
|
892
|
-
"fileNameWithExt": "Camera.
|
|
590
|
+
"fileNameWithExt": "Camera.tsx",
|
|
893
591
|
"name": "Camera"
|
|
894
592
|
},
|
|
895
593
|
"CircleLayer": {
|
|
@@ -898,80 +596,25 @@
|
|
|
898
596
|
"methods": [],
|
|
899
597
|
"props": [
|
|
900
598
|
{
|
|
901
|
-
"name": "
|
|
902
|
-
"required":
|
|
903
|
-
"type": "
|
|
599
|
+
"name": "style",
|
|
600
|
+
"required": false,
|
|
601
|
+
"type": "CircleLayerStyleProps",
|
|
904
602
|
"default": "none",
|
|
905
|
-
"description": "
|
|
603
|
+
"description": "Customizable style attributes"
|
|
906
604
|
},
|
|
907
605
|
{
|
|
908
606
|
"name": "sourceID",
|
|
909
607
|
"required": false,
|
|
910
|
-
"type": "
|
|
608
|
+
"type": "FIX ME UNKNOWN TYPE",
|
|
911
609
|
"default": "MapLibreGL.StyleSource.DefaultSourceID",
|
|
912
|
-
"description": "
|
|
913
|
-
},
|
|
914
|
-
{
|
|
915
|
-
"name": "sourceLayerID",
|
|
916
|
-
"required": false,
|
|
917
|
-
"type": "string",
|
|
918
|
-
"default": "none",
|
|
919
|
-
"description": "Identifier of the layer within the source identified by the sourceID property\nfrom which the receiver obtains the data to style."
|
|
920
|
-
},
|
|
921
|
-
{
|
|
922
|
-
"name": "aboveLayerID",
|
|
923
|
-
"required": false,
|
|
924
|
-
"type": "string",
|
|
925
|
-
"default": "none",
|
|
926
|
-
"description": "Inserts a layer above aboveLayerID."
|
|
927
|
-
},
|
|
928
|
-
{
|
|
929
|
-
"name": "belowLayerID",
|
|
930
|
-
"required": false,
|
|
931
|
-
"type": "string",
|
|
932
|
-
"default": "none",
|
|
933
|
-
"description": "Inserts a layer below belowLayerID"
|
|
934
|
-
},
|
|
935
|
-
{
|
|
936
|
-
"name": "layerIndex",
|
|
937
|
-
"required": false,
|
|
938
|
-
"type": "number",
|
|
939
|
-
"default": "none",
|
|
940
|
-
"description": "Inserts a layer at a specified index"
|
|
941
|
-
},
|
|
942
|
-
{
|
|
943
|
-
"name": "filter",
|
|
944
|
-
"required": false,
|
|
945
|
-
"type": "array",
|
|
946
|
-
"default": "none",
|
|
947
|
-
"description": "Filter only the features in the source layer that satisfy a condition that you define"
|
|
948
|
-
},
|
|
949
|
-
{
|
|
950
|
-
"name": "minZoomLevel",
|
|
951
|
-
"required": false,
|
|
952
|
-
"type": "number",
|
|
953
|
-
"default": "none",
|
|
954
|
-
"description": "The minimum zoom level at which the layer gets parsed and appears."
|
|
955
|
-
},
|
|
956
|
-
{
|
|
957
|
-
"name": "maxZoomLevel",
|
|
958
|
-
"required": false,
|
|
959
|
-
"type": "number",
|
|
960
|
-
"default": "none",
|
|
961
|
-
"description": "The maximum zoom level at which the layer gets parsed and appears."
|
|
962
|
-
},
|
|
963
|
-
{
|
|
964
|
-
"name": "style",
|
|
965
|
-
"required": false,
|
|
966
|
-
"type": "union",
|
|
967
|
-
"default": "none",
|
|
968
|
-
"description": "Customizable style attributes"
|
|
610
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
969
611
|
}
|
|
970
612
|
],
|
|
971
613
|
"composes": [
|
|
972
|
-
"
|
|
614
|
+
"BaseProps",
|
|
615
|
+
"BaseLayerProps"
|
|
973
616
|
],
|
|
974
|
-
"fileNameWithExt": "CircleLayer.
|
|
617
|
+
"fileNameWithExt": "CircleLayer.tsx",
|
|
975
618
|
"name": "CircleLayer",
|
|
976
619
|
"styles": [
|
|
977
620
|
{
|
|
@@ -1256,80 +899,25 @@
|
|
|
1256
899
|
"methods": [],
|
|
1257
900
|
"props": [
|
|
1258
901
|
{
|
|
1259
|
-
"name": "
|
|
1260
|
-
"required":
|
|
1261
|
-
"type": "
|
|
902
|
+
"name": "style",
|
|
903
|
+
"required": false,
|
|
904
|
+
"type": "FillExtrusionLayerStyleProps",
|
|
1262
905
|
"default": "none",
|
|
1263
|
-
"description": "
|
|
906
|
+
"description": "Customizable style attributes"
|
|
1264
907
|
},
|
|
1265
908
|
{
|
|
1266
909
|
"name": "sourceID",
|
|
1267
910
|
"required": false,
|
|
1268
|
-
"type": "
|
|
911
|
+
"type": "FIX ME UNKNOWN TYPE",
|
|
1269
912
|
"default": "MapLibreGL.StyleSource.DefaultSourceID",
|
|
1270
|
-
"description": "
|
|
1271
|
-
},
|
|
1272
|
-
{
|
|
1273
|
-
"name": "sourceLayerID",
|
|
1274
|
-
"required": false,
|
|
1275
|
-
"type": "string",
|
|
1276
|
-
"default": "none",
|
|
1277
|
-
"description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style."
|
|
1278
|
-
},
|
|
1279
|
-
{
|
|
1280
|
-
"name": "aboveLayerID",
|
|
1281
|
-
"required": false,
|
|
1282
|
-
"type": "string",
|
|
1283
|
-
"default": "none",
|
|
1284
|
-
"description": "Inserts a layer above aboveLayerID."
|
|
1285
|
-
},
|
|
1286
|
-
{
|
|
1287
|
-
"name": "belowLayerID",
|
|
1288
|
-
"required": false,
|
|
1289
|
-
"type": "string",
|
|
1290
|
-
"default": "none",
|
|
1291
|
-
"description": "Inserts a layer below belowLayerID"
|
|
1292
|
-
},
|
|
1293
|
-
{
|
|
1294
|
-
"name": "layerIndex",
|
|
1295
|
-
"required": false,
|
|
1296
|
-
"type": "number",
|
|
1297
|
-
"default": "none",
|
|
1298
|
-
"description": "Inserts a layer at a specified index"
|
|
1299
|
-
},
|
|
1300
|
-
{
|
|
1301
|
-
"name": "filter",
|
|
1302
|
-
"required": false,
|
|
1303
|
-
"type": "array",
|
|
1304
|
-
"default": "none",
|
|
1305
|
-
"description": "Filter only the features in the source layer that satisfy a condition that you define"
|
|
1306
|
-
},
|
|
1307
|
-
{
|
|
1308
|
-
"name": "minZoomLevel",
|
|
1309
|
-
"required": false,
|
|
1310
|
-
"type": "number",
|
|
1311
|
-
"default": "none",
|
|
1312
|
-
"description": "The minimum zoom level at which the layer gets parsed and appears."
|
|
1313
|
-
},
|
|
1314
|
-
{
|
|
1315
|
-
"name": "maxZoomLevel",
|
|
1316
|
-
"required": false,
|
|
1317
|
-
"type": "number",
|
|
1318
|
-
"default": "none",
|
|
1319
|
-
"description": "The maximum zoom level at which the layer gets parsed and appears."
|
|
1320
|
-
},
|
|
1321
|
-
{
|
|
1322
|
-
"name": "style",
|
|
1323
|
-
"required": false,
|
|
1324
|
-
"type": "union",
|
|
1325
|
-
"default": "none",
|
|
1326
|
-
"description": "Customizable style attributes"
|
|
913
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
1327
914
|
}
|
|
1328
915
|
],
|
|
1329
916
|
"composes": [
|
|
1330
|
-
"
|
|
917
|
+
"BaseProps",
|
|
918
|
+
"BaseLayerProps"
|
|
1331
919
|
],
|
|
1332
|
-
"fileNameWithExt": "FillExtrusionLayer.
|
|
920
|
+
"fileNameWithExt": "FillExtrusionLayer.tsx",
|
|
1333
921
|
"name": "FillExtrusionLayer",
|
|
1334
922
|
"styles": [
|
|
1335
923
|
{
|
|
@@ -1508,80 +1096,25 @@
|
|
|
1508
1096
|
"methods": [],
|
|
1509
1097
|
"props": [
|
|
1510
1098
|
{
|
|
1511
|
-
"name": "
|
|
1512
|
-
"required":
|
|
1513
|
-
"type": "
|
|
1099
|
+
"name": "style",
|
|
1100
|
+
"required": false,
|
|
1101
|
+
"type": "FillLayerStyleProps",
|
|
1514
1102
|
"default": "none",
|
|
1515
|
-
"description": "
|
|
1103
|
+
"description": "Customizable style attributes"
|
|
1516
1104
|
},
|
|
1517
1105
|
{
|
|
1518
1106
|
"name": "sourceID",
|
|
1519
1107
|
"required": false,
|
|
1520
|
-
"type": "
|
|
1108
|
+
"type": "FIX ME UNKNOWN TYPE",
|
|
1521
1109
|
"default": "MapLibreGL.StyleSource.DefaultSourceID",
|
|
1522
|
-
"description": "
|
|
1523
|
-
},
|
|
1524
|
-
{
|
|
1525
|
-
"name": "sourceLayerID",
|
|
1526
|
-
"required": false,
|
|
1527
|
-
"type": "string",
|
|
1528
|
-
"default": "none",
|
|
1529
|
-
"description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style."
|
|
1530
|
-
},
|
|
1531
|
-
{
|
|
1532
|
-
"name": "aboveLayerID",
|
|
1533
|
-
"required": false,
|
|
1534
|
-
"type": "string",
|
|
1535
|
-
"default": "none",
|
|
1536
|
-
"description": "Inserts a layer above aboveLayerID."
|
|
1537
|
-
},
|
|
1538
|
-
{
|
|
1539
|
-
"name": "belowLayerID",
|
|
1540
|
-
"required": false,
|
|
1541
|
-
"type": "string",
|
|
1542
|
-
"default": "none",
|
|
1543
|
-
"description": "Inserts a layer below belowLayerID"
|
|
1544
|
-
},
|
|
1545
|
-
{
|
|
1546
|
-
"name": "layerIndex",
|
|
1547
|
-
"required": false,
|
|
1548
|
-
"type": "number",
|
|
1549
|
-
"default": "none",
|
|
1550
|
-
"description": "Inserts a layer at a specified index"
|
|
1551
|
-
},
|
|
1552
|
-
{
|
|
1553
|
-
"name": "filter",
|
|
1554
|
-
"required": false,
|
|
1555
|
-
"type": "array",
|
|
1556
|
-
"default": "none",
|
|
1557
|
-
"description": "Filter only the features in the source layer that satisfy a condition that you define"
|
|
1558
|
-
},
|
|
1559
|
-
{
|
|
1560
|
-
"name": "minZoomLevel",
|
|
1561
|
-
"required": false,
|
|
1562
|
-
"type": "number",
|
|
1563
|
-
"default": "none",
|
|
1564
|
-
"description": "The minimum zoom level at which the layer gets parsed and appears."
|
|
1565
|
-
},
|
|
1566
|
-
{
|
|
1567
|
-
"name": "maxZoomLevel",
|
|
1568
|
-
"required": false,
|
|
1569
|
-
"type": "number",
|
|
1570
|
-
"default": "none",
|
|
1571
|
-
"description": "The maximum zoom level at which the layer gets parsed and appears."
|
|
1572
|
-
},
|
|
1573
|
-
{
|
|
1574
|
-
"name": "style",
|
|
1575
|
-
"required": false,
|
|
1576
|
-
"type": "union",
|
|
1577
|
-
"default": "none",
|
|
1578
|
-
"description": "Customizable style attributes"
|
|
1110
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
1579
1111
|
}
|
|
1580
1112
|
],
|
|
1581
1113
|
"composes": [
|
|
1582
|
-
"
|
|
1114
|
+
"BaseProps",
|
|
1115
|
+
"BaseLayerProps"
|
|
1583
1116
|
],
|
|
1584
|
-
"fileNameWithExt": "FillLayer.
|
|
1117
|
+
"fileNameWithExt": "FillLayer.tsx",
|
|
1585
1118
|
"name": "FillLayer",
|
|
1586
1119
|
"styles": [
|
|
1587
1120
|
{
|
|
@@ -1777,7 +1310,10 @@
|
|
|
1777
1310
|
"description": "FIX ME NO DESCRIPTION"
|
|
1778
1311
|
}
|
|
1779
1312
|
],
|
|
1780
|
-
"
|
|
1313
|
+
"composes": [
|
|
1314
|
+
"BaseProps"
|
|
1315
|
+
],
|
|
1316
|
+
"fileNameWithExt": "HeadingIndicator.tsx",
|
|
1781
1317
|
"name": "HeadingIndicator"
|
|
1782
1318
|
},
|
|
1783
1319
|
"HeatmapLayer": {
|
|
@@ -1786,80 +1322,25 @@
|
|
|
1786
1322
|
"methods": [],
|
|
1787
1323
|
"props": [
|
|
1788
1324
|
{
|
|
1789
|
-
"name": "
|
|
1790
|
-
"required":
|
|
1791
|
-
"type": "
|
|
1325
|
+
"name": "style",
|
|
1326
|
+
"required": false,
|
|
1327
|
+
"type": "HeatmapLayerStyleProps",
|
|
1792
1328
|
"default": "none",
|
|
1793
|
-
"description": "
|
|
1329
|
+
"description": "Customizable style attributes"
|
|
1794
1330
|
},
|
|
1795
1331
|
{
|
|
1796
1332
|
"name": "sourceID",
|
|
1797
1333
|
"required": false,
|
|
1798
|
-
"type": "
|
|
1334
|
+
"type": "FIX ME UNKNOWN TYPE",
|
|
1799
1335
|
"default": "MapLibreGL.StyleSource.DefaultSourceID",
|
|
1800
|
-
"description": "
|
|
1801
|
-
},
|
|
1802
|
-
{
|
|
1803
|
-
"name": "sourceLayerID",
|
|
1804
|
-
"required": false,
|
|
1805
|
-
"type": "string",
|
|
1806
|
-
"default": "none",
|
|
1807
|
-
"description": "Identifier of the layer within the source identified by the sourceID property\nfrom which the receiver obtains the data to style."
|
|
1808
|
-
},
|
|
1809
|
-
{
|
|
1810
|
-
"name": "aboveLayerID",
|
|
1811
|
-
"required": false,
|
|
1812
|
-
"type": "string",
|
|
1813
|
-
"default": "none",
|
|
1814
|
-
"description": "Inserts a layer above aboveLayerID."
|
|
1815
|
-
},
|
|
1816
|
-
{
|
|
1817
|
-
"name": "belowLayerID",
|
|
1818
|
-
"required": false,
|
|
1819
|
-
"type": "string",
|
|
1820
|
-
"default": "none",
|
|
1821
|
-
"description": "Inserts a layer below belowLayerID"
|
|
1822
|
-
},
|
|
1823
|
-
{
|
|
1824
|
-
"name": "layerIndex",
|
|
1825
|
-
"required": false,
|
|
1826
|
-
"type": "number",
|
|
1827
|
-
"default": "none",
|
|
1828
|
-
"description": "Inserts a layer at a specified index"
|
|
1829
|
-
},
|
|
1830
|
-
{
|
|
1831
|
-
"name": "filter",
|
|
1832
|
-
"required": false,
|
|
1833
|
-
"type": "array",
|
|
1834
|
-
"default": "none",
|
|
1835
|
-
"description": "Filter only the features in the source layer that satisfy a condition that you define"
|
|
1836
|
-
},
|
|
1837
|
-
{
|
|
1838
|
-
"name": "minZoomLevel",
|
|
1839
|
-
"required": false,
|
|
1840
|
-
"type": "number",
|
|
1841
|
-
"default": "none",
|
|
1842
|
-
"description": "The minimum zoom level at which the layer gets parsed and appears."
|
|
1843
|
-
},
|
|
1844
|
-
{
|
|
1845
|
-
"name": "maxZoomLevel",
|
|
1846
|
-
"required": false,
|
|
1847
|
-
"type": "number",
|
|
1848
|
-
"default": "none",
|
|
1849
|
-
"description": "The maximum zoom level at which the layer gets parsed and appears."
|
|
1850
|
-
},
|
|
1851
|
-
{
|
|
1852
|
-
"name": "style",
|
|
1853
|
-
"required": false,
|
|
1854
|
-
"type": "union",
|
|
1855
|
-
"default": "none",
|
|
1856
|
-
"description": "Customizable style attributes"
|
|
1336
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
1857
1337
|
}
|
|
1858
1338
|
],
|
|
1859
1339
|
"composes": [
|
|
1860
|
-
"
|
|
1340
|
+
"BaseProps",
|
|
1341
|
+
"BaseLayerProps"
|
|
1861
1342
|
],
|
|
1862
|
-
"fileNameWithExt": "HeatmapLayer.
|
|
1343
|
+
"fileNameWithExt": "HeatmapLayer.tsx",
|
|
1863
1344
|
"name": "HeatmapLayer",
|
|
1864
1345
|
"styles": [
|
|
1865
1346
|
{
|
|
@@ -2013,32 +1494,29 @@
|
|
|
2013
1494
|
{
|
|
2014
1495
|
"name": "url",
|
|
2015
1496
|
"required": false,
|
|
2016
|
-
"type": "
|
|
1497
|
+
"type": "number \\| string",
|
|
2017
1498
|
"default": "none",
|
|
2018
1499
|
"description": "An HTTP(S) URL, absolute file URL, or local file URL to the source image.\nGifs are currently not supported."
|
|
2019
1500
|
},
|
|
2020
1501
|
{
|
|
2021
1502
|
"name": "coordinates",
|
|
2022
|
-
"required":
|
|
2023
|
-
"type":
|
|
2024
|
-
"name": "array",
|
|
2025
|
-
"value": {
|
|
2026
|
-
"type": {
|
|
2027
|
-
"name": "array",
|
|
2028
|
-
"value": {
|
|
2029
|
-
"type": "number"
|
|
2030
|
-
}
|
|
2031
|
-
}
|
|
2032
|
-
}
|
|
2033
|
-
},
|
|
1503
|
+
"required": false,
|
|
1504
|
+
"type": "tuple",
|
|
2034
1505
|
"default": "none",
|
|
2035
1506
|
"description": "The top left, top right, bottom right, and bottom left coordinates for the image."
|
|
1507
|
+
},
|
|
1508
|
+
{
|
|
1509
|
+
"name": "children",
|
|
1510
|
+
"required": false,
|
|
1511
|
+
"type": "ReactElement \\| ReactElement[]",
|
|
1512
|
+
"default": "none",
|
|
1513
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
2036
1514
|
}
|
|
2037
1515
|
],
|
|
2038
1516
|
"composes": [
|
|
2039
|
-
"
|
|
1517
|
+
"BaseProps"
|
|
2040
1518
|
],
|
|
2041
|
-
"fileNameWithExt": "ImageSource.
|
|
1519
|
+
"fileNameWithExt": "ImageSource.tsx",
|
|
2042
1520
|
"name": "ImageSource"
|
|
2043
1521
|
},
|
|
2044
1522
|
"Images": {
|
|
@@ -2049,34 +1527,49 @@
|
|
|
2049
1527
|
{
|
|
2050
1528
|
"name": "images",
|
|
2051
1529
|
"required": false,
|
|
2052
|
-
"type":
|
|
1530
|
+
"type": {
|
|
1531
|
+
"name": "shape",
|
|
1532
|
+
"value": [
|
|
1533
|
+
{
|
|
1534
|
+
"name": {
|
|
1535
|
+
"name": "string"
|
|
1536
|
+
},
|
|
1537
|
+
"required": true,
|
|
1538
|
+
"type": "union",
|
|
1539
|
+
"default": "none",
|
|
1540
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
1541
|
+
}
|
|
1542
|
+
]
|
|
1543
|
+
},
|
|
2053
1544
|
"default": "none",
|
|
2054
1545
|
"description": "Specifies the external images in key-value pairs required for the shape source.\nKeys are names - see iconImage expressions, values can be either urls-s objects\nwith format {uri: 'http://...'}` or `require('image.png')` or `import 'image.png'`"
|
|
2055
1546
|
},
|
|
2056
1547
|
{
|
|
2057
1548
|
"name": "nativeAssetImages",
|
|
2058
1549
|
"required": false,
|
|
2059
|
-
"type":
|
|
2060
|
-
"name": "array",
|
|
2061
|
-
"value": {
|
|
2062
|
-
"type": "string"
|
|
2063
|
-
}
|
|
2064
|
-
},
|
|
1550
|
+
"type": "Array",
|
|
2065
1551
|
"default": "none",
|
|
2066
1552
|
"description": "If you have an asset under Image.xcassets on iOS and the drawables directory on android\nyou can specify an array of string names with assets as the key `['pin']`."
|
|
2067
1553
|
},
|
|
2068
1554
|
{
|
|
2069
|
-
"name": "
|
|
1555
|
+
"name": "id",
|
|
2070
1556
|
"required": false,
|
|
2071
|
-
"type": "
|
|
1557
|
+
"type": "string",
|
|
1558
|
+
"default": "none",
|
|
1559
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
1560
|
+
},
|
|
1561
|
+
{
|
|
1562
|
+
"name": "children",
|
|
1563
|
+
"required": true,
|
|
1564
|
+
"type": "ReactElement",
|
|
2072
1565
|
"default": "none",
|
|
2073
|
-
"description": "
|
|
1566
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
2074
1567
|
}
|
|
2075
1568
|
],
|
|
2076
1569
|
"composes": [
|
|
2077
|
-
"
|
|
1570
|
+
"BaseProps"
|
|
2078
1571
|
],
|
|
2079
|
-
"fileNameWithExt": "Images.
|
|
1572
|
+
"fileNameWithExt": "Images.tsx",
|
|
2080
1573
|
"name": "Images"
|
|
2081
1574
|
},
|
|
2082
1575
|
"Light": {
|
|
@@ -2087,15 +1580,15 @@
|
|
|
2087
1580
|
{
|
|
2088
1581
|
"name": "style",
|
|
2089
1582
|
"required": false,
|
|
2090
|
-
"type": "
|
|
1583
|
+
"type": "LightLayerStyleProps",
|
|
2091
1584
|
"default": "none",
|
|
2092
1585
|
"description": "Customizable style attributes"
|
|
2093
1586
|
}
|
|
2094
1587
|
],
|
|
2095
1588
|
"composes": [
|
|
2096
|
-
"
|
|
1589
|
+
"BaseProps"
|
|
2097
1590
|
],
|
|
2098
|
-
"fileNameWithExt": "Light.
|
|
1591
|
+
"fileNameWithExt": "Light.tsx",
|
|
2099
1592
|
"name": "Light",
|
|
2100
1593
|
"styles": [
|
|
2101
1594
|
{
|
|
@@ -2189,80 +1682,25 @@
|
|
|
2189
1682
|
"methods": [],
|
|
2190
1683
|
"props": [
|
|
2191
1684
|
{
|
|
2192
|
-
"name": "
|
|
2193
|
-
"required":
|
|
2194
|
-
"type": "
|
|
1685
|
+
"name": "style",
|
|
1686
|
+
"required": false,
|
|
1687
|
+
"type": "LineLayerStyleProps",
|
|
2195
1688
|
"default": "none",
|
|
2196
|
-
"description": "
|
|
1689
|
+
"description": "Customizable style attributes"
|
|
2197
1690
|
},
|
|
2198
1691
|
{
|
|
2199
1692
|
"name": "sourceID",
|
|
2200
1693
|
"required": false,
|
|
2201
|
-
"type": "
|
|
1694
|
+
"type": "FIX ME UNKNOWN TYPE",
|
|
2202
1695
|
"default": "MapLibreGL.StyleSource.DefaultSourceID",
|
|
2203
|
-
"description": "
|
|
2204
|
-
},
|
|
2205
|
-
{
|
|
2206
|
-
"name": "sourceLayerID",
|
|
2207
|
-
"required": false,
|
|
2208
|
-
"type": "string",
|
|
2209
|
-
"default": "none",
|
|
2210
|
-
"description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style."
|
|
2211
|
-
},
|
|
2212
|
-
{
|
|
2213
|
-
"name": "aboveLayerID",
|
|
2214
|
-
"required": false,
|
|
2215
|
-
"type": "string",
|
|
2216
|
-
"default": "none",
|
|
2217
|
-
"description": "Inserts a layer above aboveLayerID."
|
|
2218
|
-
},
|
|
2219
|
-
{
|
|
2220
|
-
"name": "belowLayerID",
|
|
2221
|
-
"required": false,
|
|
2222
|
-
"type": "string",
|
|
2223
|
-
"default": "none",
|
|
2224
|
-
"description": "Inserts a layer below belowLayerID"
|
|
2225
|
-
},
|
|
2226
|
-
{
|
|
2227
|
-
"name": "layerIndex",
|
|
2228
|
-
"required": false,
|
|
2229
|
-
"type": "number",
|
|
2230
|
-
"default": "none",
|
|
2231
|
-
"description": "Inserts a layer at a specified index"
|
|
2232
|
-
},
|
|
2233
|
-
{
|
|
2234
|
-
"name": "filter",
|
|
2235
|
-
"required": false,
|
|
2236
|
-
"type": "array",
|
|
2237
|
-
"default": "none",
|
|
2238
|
-
"description": "Filter only the features in the source layer that satisfy a condition that you define"
|
|
2239
|
-
},
|
|
2240
|
-
{
|
|
2241
|
-
"name": "minZoomLevel",
|
|
2242
|
-
"required": false,
|
|
2243
|
-
"type": "number",
|
|
2244
|
-
"default": "none",
|
|
2245
|
-
"description": "The minimum zoom level at which the layer gets parsed and appears."
|
|
2246
|
-
},
|
|
2247
|
-
{
|
|
2248
|
-
"name": "maxZoomLevel",
|
|
2249
|
-
"required": false,
|
|
2250
|
-
"type": "number",
|
|
2251
|
-
"default": "none",
|
|
2252
|
-
"description": "The maximum zoom level at which the layer gets parsed and appears."
|
|
2253
|
-
},
|
|
2254
|
-
{
|
|
2255
|
-
"name": "style",
|
|
2256
|
-
"required": false,
|
|
2257
|
-
"type": "union",
|
|
2258
|
-
"default": "none",
|
|
2259
|
-
"description": "Customizable style attributes"
|
|
1696
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
2260
1697
|
}
|
|
2261
1698
|
],
|
|
2262
1699
|
"composes": [
|
|
2263
|
-
"
|
|
1700
|
+
"BaseProps",
|
|
1701
|
+
"BaseLayerProps"
|
|
2264
1702
|
],
|
|
2265
|
-
"fileNameWithExt": "LineLayer.
|
|
1703
|
+
"fileNameWithExt": "LineLayer.tsx",
|
|
2266
1704
|
"name": "LineLayer",
|
|
2267
1705
|
"styles": [
|
|
2268
1706
|
{
|
|
@@ -2641,7 +2079,7 @@
|
|
|
2641
2079
|
"name": "coordinate",
|
|
2642
2080
|
"description": "A point expressed in the map view's coordinate system.",
|
|
2643
2081
|
"type": {
|
|
2644
|
-
"name": "
|
|
2082
|
+
"name": "GeoJSON.Position"
|
|
2645
2083
|
},
|
|
2646
2084
|
"optional": false
|
|
2647
2085
|
}
|
|
@@ -2649,7 +2087,13 @@
|
|
|
2649
2087
|
"returns": {
|
|
2650
2088
|
"description": null,
|
|
2651
2089
|
"type": {
|
|
2652
|
-
"name": "
|
|
2090
|
+
"name": "Promise",
|
|
2091
|
+
"elements": [
|
|
2092
|
+
{
|
|
2093
|
+
"name": "GeoJSON.Point"
|
|
2094
|
+
}
|
|
2095
|
+
],
|
|
2096
|
+
"raw": "Promise<GeoJSON.Point>"
|
|
2653
2097
|
}
|
|
2654
2098
|
},
|
|
2655
2099
|
"description": "Converts a geographic coordinate to a point in the given view’s coordinate system.",
|
|
@@ -2676,7 +2120,13 @@
|
|
|
2676
2120
|
"returns": {
|
|
2677
2121
|
"description": null,
|
|
2678
2122
|
"type": {
|
|
2679
|
-
"name": "
|
|
2123
|
+
"name": "Promise",
|
|
2124
|
+
"elements": [
|
|
2125
|
+
{
|
|
2126
|
+
"name": "GeoJSON.Position"
|
|
2127
|
+
}
|
|
2128
|
+
],
|
|
2129
|
+
"raw": "Promise<GeoJSON.Position>"
|
|
2680
2130
|
}
|
|
2681
2131
|
},
|
|
2682
2132
|
"description": "Converts a point in the given view’s coordinate system to a geographic coordinate.",
|
|
@@ -2694,7 +2144,13 @@
|
|
|
2694
2144
|
"returns": {
|
|
2695
2145
|
"description": null,
|
|
2696
2146
|
"type": {
|
|
2697
|
-
"name": "
|
|
2147
|
+
"name": "Promise",
|
|
2148
|
+
"elements": [
|
|
2149
|
+
{
|
|
2150
|
+
"name": "Bounds"
|
|
2151
|
+
}
|
|
2152
|
+
],
|
|
2153
|
+
"raw": "Promise<Bounds>"
|
|
2698
2154
|
}
|
|
2699
2155
|
},
|
|
2700
2156
|
"description": "The coordinate bounds(ne, sw) visible in the users’s viewport.",
|
|
@@ -2704,7 +2160,7 @@
|
|
|
2704
2160
|
},
|
|
2705
2161
|
{
|
|
2706
2162
|
"name": "queryRenderedFeaturesAtPoint",
|
|
2707
|
-
"docblock": "Returns an array of rendered map features that intersect with a given point.\n\n@example\nthis._map.queryRenderedFeaturesAtPoint([30, 40], ['==', 'type', 'Point'], ['id1', 'id2'])\n\n@param {Array<Number>} coordinate - A point expressed in the map view’s coordinate system.\n@param {Array=} filter - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.\n@param {Array=} layerIDs - A array of layer id's to filter the features by\n@return {FeatureCollection}",
|
|
2163
|
+
"docblock": "Returns an array of rendered map features that intersect with a given point.\n\n@example\nthis._map.queryRenderedFeaturesAtPoint([30, 40], ['==', 'type', 'Point'], ['id1', 'id2'])\n\n@param {Array<Number>} coordinate - A point expressed in the map view’s coordinate system.\n@param {Array=} filter - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.\n@param {Array=} layerIDs - A array of layer id's to filter the features by\n@return {GeoJSON.FeatureCollection}",
|
|
2708
2164
|
"modifiers": [
|
|
2709
2165
|
"async"
|
|
2710
2166
|
],
|
|
@@ -2713,7 +2169,7 @@
|
|
|
2713
2169
|
"name": "coordinate",
|
|
2714
2170
|
"description": "A point expressed in the map view’s coordinate system.",
|
|
2715
2171
|
"type": {
|
|
2716
|
-
"name": "
|
|
2172
|
+
"name": "GeoJSON.Position"
|
|
2717
2173
|
},
|
|
2718
2174
|
"optional": false
|
|
2719
2175
|
},
|
|
@@ -2721,7 +2177,7 @@
|
|
|
2721
2177
|
"name": "filter",
|
|
2722
2178
|
"description": "A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.",
|
|
2723
2179
|
"type": {
|
|
2724
|
-
"name": "
|
|
2180
|
+
"name": "FilterExpression"
|
|
2725
2181
|
},
|
|
2726
2182
|
"optional": true
|
|
2727
2183
|
},
|
|
@@ -2737,7 +2193,13 @@
|
|
|
2737
2193
|
"returns": {
|
|
2738
2194
|
"description": null,
|
|
2739
2195
|
"type": {
|
|
2740
|
-
"name": "
|
|
2196
|
+
"name": "Promise",
|
|
2197
|
+
"elements": [
|
|
2198
|
+
{
|
|
2199
|
+
"name": "GeoJSON.FeatureCollection"
|
|
2200
|
+
}
|
|
2201
|
+
],
|
|
2202
|
+
"raw": "Promise<GeoJSON.FeatureCollection>"
|
|
2741
2203
|
}
|
|
2742
2204
|
},
|
|
2743
2205
|
"description": "Returns an array of rendered map features that intersect with a given point.",
|
|
@@ -2747,7 +2209,7 @@
|
|
|
2747
2209
|
},
|
|
2748
2210
|
{
|
|
2749
2211
|
"name": "queryRenderedFeaturesInRect",
|
|
2750
|
-
"docblock": "Returns an array of rendered map features that intersect with the given rectangle,\nrestricted to the given style layers and filtered by the given predicate.\n\n@example\nthis._map.queryRenderedFeaturesInRect([30, 40, 20, 10], ['==', 'type', 'Point'], ['id1', 'id2'])\n\n@param {Array<Number>} bbox - A rectangle expressed in the map view’s coordinate system.\n@param {Array=} filter - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.\n@param {Array=} layerIDs - A array of layer id's to filter the features by\n@return {FeatureCollection}",
|
|
2212
|
+
"docblock": "Returns an array of rendered map features that intersect with the given rectangle,\nrestricted to the given style layers and filtered by the given predicate.\n\n@example\nthis._map.queryRenderedFeaturesInRect([30, 40, 20, 10], ['==', 'type', 'Point'], ['id1', 'id2'])\n\n@param {Array<Number>} bbox - A rectangle expressed in the map view’s coordinate system.\n@param {Array=} filter - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.\n@param {Array=} layerIDs - A array of layer id's to filter the features by\n@return {GeoJSON.FeatureCollection}",
|
|
2751
2213
|
"modifiers": [
|
|
2752
2214
|
"async"
|
|
2753
2215
|
],
|
|
@@ -2756,7 +2218,7 @@
|
|
|
2756
2218
|
"name": "bbox",
|
|
2757
2219
|
"description": "A rectangle expressed in the map view’s coordinate system.",
|
|
2758
2220
|
"type": {
|
|
2759
|
-
"name": "
|
|
2221
|
+
"name": "GeoJSON.BBox"
|
|
2760
2222
|
},
|
|
2761
2223
|
"optional": false
|
|
2762
2224
|
},
|
|
@@ -2764,7 +2226,7 @@
|
|
|
2764
2226
|
"name": "filter",
|
|
2765
2227
|
"description": "A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.",
|
|
2766
2228
|
"type": {
|
|
2767
|
-
"name": "
|
|
2229
|
+
"name": "FilterExpression"
|
|
2768
2230
|
},
|
|
2769
2231
|
"optional": true
|
|
2770
2232
|
},
|
|
@@ -2780,7 +2242,13 @@
|
|
|
2780
2242
|
"returns": {
|
|
2781
2243
|
"description": null,
|
|
2782
2244
|
"type": {
|
|
2783
|
-
"name": "
|
|
2245
|
+
"name": "Promise",
|
|
2246
|
+
"elements": [
|
|
2247
|
+
{
|
|
2248
|
+
"name": "GeoJSON.FeatureCollection"
|
|
2249
|
+
}
|
|
2250
|
+
],
|
|
2251
|
+
"raw": "Promise<GeoJSON.FeatureCollection>"
|
|
2784
2252
|
}
|
|
2785
2253
|
},
|
|
2786
2254
|
"description": "Returns an array of rendered map features that intersect with the given rectangle,\nrestricted to the given style layers and filtered by the given predicate.",
|
|
@@ -2793,7 +2261,11 @@
|
|
|
2793
2261
|
"docblock": "Map camera will perform updates based on provided config. Deprecated use Camera#setCamera.",
|
|
2794
2262
|
"modifiers": [],
|
|
2795
2263
|
"params": [],
|
|
2796
|
-
"returns":
|
|
2264
|
+
"returns": {
|
|
2265
|
+
"type": {
|
|
2266
|
+
"name": "void"
|
|
2267
|
+
}
|
|
2268
|
+
},
|
|
2797
2269
|
"description": "Map camera will perform updates based on provided config. Deprecated use Camera#setCamera.",
|
|
2798
2270
|
"examples": []
|
|
2799
2271
|
},
|
|
@@ -2816,7 +2288,13 @@
|
|
|
2816
2288
|
"returns": {
|
|
2817
2289
|
"description": null,
|
|
2818
2290
|
"type": {
|
|
2819
|
-
"name": "
|
|
2291
|
+
"name": "Promise",
|
|
2292
|
+
"elements": [
|
|
2293
|
+
{
|
|
2294
|
+
"name": "string"
|
|
2295
|
+
}
|
|
2296
|
+
],
|
|
2297
|
+
"raw": "Promise<string>"
|
|
2820
2298
|
}
|
|
2821
2299
|
},
|
|
2822
2300
|
"description": "Takes snapshot of map with current tiles and returns a URI to the image",
|
|
@@ -2832,7 +2310,13 @@
|
|
|
2832
2310
|
"returns": {
|
|
2833
2311
|
"description": null,
|
|
2834
2312
|
"type": {
|
|
2835
|
-
"name": "
|
|
2313
|
+
"name": "Promise",
|
|
2314
|
+
"elements": [
|
|
2315
|
+
{
|
|
2316
|
+
"name": "number"
|
|
2317
|
+
}
|
|
2318
|
+
],
|
|
2319
|
+
"raw": "Promise<number>"
|
|
2836
2320
|
}
|
|
2837
2321
|
},
|
|
2838
2322
|
"description": "Returns the current zoom of the map view.",
|
|
@@ -2850,12 +2334,13 @@
|
|
|
2850
2334
|
"returns": {
|
|
2851
2335
|
"description": "Coordinates",
|
|
2852
2336
|
"type": {
|
|
2853
|
-
"name": "
|
|
2337
|
+
"name": "Promise",
|
|
2854
2338
|
"elements": [
|
|
2855
2339
|
{
|
|
2856
|
-
"name": "
|
|
2340
|
+
"name": "GeoJSON.Position"
|
|
2857
2341
|
}
|
|
2858
|
-
]
|
|
2342
|
+
],
|
|
2343
|
+
"raw": "Promise<GeoJSON.Position>"
|
|
2859
2344
|
}
|
|
2860
2345
|
},
|
|
2861
2346
|
"description": "Returns the map's geographical centerpoint",
|
|
@@ -2880,7 +2365,7 @@
|
|
|
2880
2365
|
"name": "sourceId",
|
|
2881
2366
|
"description": "Identifier of the target source (e.g. 'composite')",
|
|
2882
2367
|
"type": {
|
|
2883
|
-
"name": "
|
|
2368
|
+
"name": "string"
|
|
2884
2369
|
},
|
|
2885
2370
|
"optional": false
|
|
2886
2371
|
},
|
|
@@ -2893,7 +2378,11 @@
|
|
|
2893
2378
|
"optional": true
|
|
2894
2379
|
}
|
|
2895
2380
|
],
|
|
2896
|
-
"returns":
|
|
2381
|
+
"returns": {
|
|
2382
|
+
"type": {
|
|
2383
|
+
"name": "void"
|
|
2384
|
+
}
|
|
2385
|
+
},
|
|
2897
2386
|
"description": "Sets the visibility of all the layers referencing the specified `sourceLayerId` and/or `sourceId`",
|
|
2898
2387
|
"examples": [
|
|
2899
2388
|
"\nawait this._map.setSourceVisibility(false, 'composite', 'building')\n\n"
|
|
@@ -2902,9 +2391,21 @@
|
|
|
2902
2391
|
{
|
|
2903
2392
|
"name": "showAttribution",
|
|
2904
2393
|
"docblock": "Show the attribution and telemetry action sheet.\nIf you implement a custom attribution button, you should add this action to the button.",
|
|
2905
|
-
"modifiers": [
|
|
2394
|
+
"modifiers": [
|
|
2395
|
+
"async"
|
|
2396
|
+
],
|
|
2906
2397
|
"params": [],
|
|
2907
|
-
"returns":
|
|
2398
|
+
"returns": {
|
|
2399
|
+
"type": {
|
|
2400
|
+
"name": "Promise",
|
|
2401
|
+
"elements": [
|
|
2402
|
+
{
|
|
2403
|
+
"name": "void"
|
|
2404
|
+
}
|
|
2405
|
+
],
|
|
2406
|
+
"raw": "Promise<void>"
|
|
2407
|
+
}
|
|
2408
|
+
},
|
|
2908
2409
|
"description": "Show the attribution and telemetry action sheet.\nIf you implement a custom attribution button, you should add this action to the button.",
|
|
2909
2410
|
"examples": []
|
|
2910
2411
|
}
|
|
@@ -2913,14 +2414,14 @@
|
|
|
2913
2414
|
{
|
|
2914
2415
|
"name": "contentInset",
|
|
2915
2416
|
"required": false,
|
|
2916
|
-
"type": "
|
|
2417
|
+
"type": "number[] \\| number",
|
|
2917
2418
|
"default": "none",
|
|
2918
2419
|
"description": "The distance from the edges of the map view’s frame to the edges of the map view’s logical viewport."
|
|
2919
2420
|
},
|
|
2920
2421
|
{
|
|
2921
2422
|
"name": "style",
|
|
2922
2423
|
"required": false,
|
|
2923
|
-
"type": "
|
|
2424
|
+
"type": "ViewProps['style']",
|
|
2924
2425
|
"default": "none",
|
|
2925
2426
|
"description": "Style for wrapping React Native View"
|
|
2926
2427
|
},
|
|
@@ -2929,7 +2430,7 @@
|
|
|
2929
2430
|
"required": false,
|
|
2930
2431
|
"type": "string",
|
|
2931
2432
|
"default": "none",
|
|
2932
|
-
"description": "Style URL for map - notice, if non is set it _will_ default to `MapLibreGL.StyleURL.
|
|
2433
|
+
"description": "Style URL for map - notice, if non is set it _will_ default to `MapLibreGL.StyleURL.Default`"
|
|
2933
2434
|
},
|
|
2934
2435
|
{
|
|
2935
2436
|
"name": "styleJSON",
|
|
@@ -2948,77 +2449,77 @@
|
|
|
2948
2449
|
{
|
|
2949
2450
|
"name": "localizeLabels",
|
|
2950
2451
|
"required": false,
|
|
2951
|
-
"type": "
|
|
2452
|
+
"type": "boolean",
|
|
2952
2453
|
"default": "false",
|
|
2953
2454
|
"description": "Automatically change the language of the map labels to the system’s preferred language,\nthis is not something that can be toggled on/off"
|
|
2954
2455
|
},
|
|
2955
2456
|
{
|
|
2956
2457
|
"name": "zoomEnabled",
|
|
2957
2458
|
"required": false,
|
|
2958
|
-
"type": "
|
|
2459
|
+
"type": "boolean",
|
|
2959
2460
|
"default": "none",
|
|
2960
2461
|
"description": "Enable/Disable zoom on the map"
|
|
2961
2462
|
},
|
|
2962
2463
|
{
|
|
2963
2464
|
"name": "scrollEnabled",
|
|
2964
2465
|
"required": false,
|
|
2965
|
-
"type": "
|
|
2466
|
+
"type": "boolean",
|
|
2966
2467
|
"default": "true",
|
|
2967
2468
|
"description": "Enable/Disable scroll on the map"
|
|
2968
2469
|
},
|
|
2969
2470
|
{
|
|
2970
2471
|
"name": "pitchEnabled",
|
|
2971
2472
|
"required": false,
|
|
2972
|
-
"type": "
|
|
2473
|
+
"type": "boolean",
|
|
2973
2474
|
"default": "true",
|
|
2974
2475
|
"description": "Enable/Disable pitch on map"
|
|
2975
2476
|
},
|
|
2976
2477
|
{
|
|
2977
2478
|
"name": "rotateEnabled",
|
|
2978
2479
|
"required": false,
|
|
2979
|
-
"type": "
|
|
2480
|
+
"type": "boolean",
|
|
2980
2481
|
"default": "true",
|
|
2981
2482
|
"description": "Enable/Disable rotation on map"
|
|
2982
2483
|
},
|
|
2983
2484
|
{
|
|
2984
2485
|
"name": "attributionEnabled",
|
|
2985
2486
|
"required": false,
|
|
2986
|
-
"type": "
|
|
2487
|
+
"type": "boolean",
|
|
2987
2488
|
"default": "true",
|
|
2988
2489
|
"description": "Enable/Disable attribution on map.\n\nThis must be enabled for Mapbox-hosted tiles and styles. Please refer to the Mapbox Terms of Service.\nOther providers do not require this."
|
|
2989
2490
|
},
|
|
2990
2491
|
{
|
|
2991
2492
|
"name": "attributionPosition",
|
|
2992
2493
|
"required": false,
|
|
2993
|
-
"type": "
|
|
2494
|
+
"type": "\\| {\n top?: number;\n left?: number;\n }\n\\| {\n top?: number;\n right?: number;\n }\n\\| {\n bottom?: number;\n left?: number;\n }\n\\| {\n bottom?: number;\n right?: number;\n }",
|
|
2994
2495
|
"default": "none",
|
|
2995
2496
|
"description": "Adds attribution offset, e.g. `{top: 8, left: 8}` will put attribution button in top-left corner of the map"
|
|
2996
2497
|
},
|
|
2997
2498
|
{
|
|
2998
2499
|
"name": "tintColor",
|
|
2999
2500
|
"required": false,
|
|
3000
|
-
"type": "
|
|
2501
|
+
"type": "string \\| unknown[]",
|
|
3001
2502
|
"default": "none",
|
|
3002
2503
|
"description": "MapView's tintColor"
|
|
3003
2504
|
},
|
|
3004
2505
|
{
|
|
3005
2506
|
"name": "logoEnabled",
|
|
3006
2507
|
"required": false,
|
|
3007
|
-
"type": "
|
|
2508
|
+
"type": "boolean",
|
|
3008
2509
|
"default": "false",
|
|
3009
2510
|
"description": "Enable/Disable the logo on the map."
|
|
3010
2511
|
},
|
|
3011
2512
|
{
|
|
3012
2513
|
"name": "logoPosition",
|
|
3013
2514
|
"required": false,
|
|
3014
|
-
"type": "
|
|
2515
|
+
"type": "\\| {\n top?: number;\n left?: number;\n }\n\\| {\n top?: number;\n right?: number;\n }\n\\| {\n bottom?: number;\n left?: number;\n }\n\\| {\n bottom?: number;\n right?: number;\n }",
|
|
3015
2516
|
"default": "none",
|
|
3016
2517
|
"description": "Adds logo offset, e.g. `{top: 8, left: 8}` will put the logo in top-left corner of the map"
|
|
3017
2518
|
},
|
|
3018
2519
|
{
|
|
3019
2520
|
"name": "compassEnabled",
|
|
3020
2521
|
"required": false,
|
|
3021
|
-
"type": "
|
|
2522
|
+
"type": "boolean",
|
|
3022
2523
|
"default": "none",
|
|
3023
2524
|
"description": "Enable/Disable the compass from appearing on the map"
|
|
3024
2525
|
},
|
|
@@ -3039,151 +2540,19 @@
|
|
|
3039
2540
|
{
|
|
3040
2541
|
"name": "surfaceView",
|
|
3041
2542
|
"required": false,
|
|
3042
|
-
"type": "
|
|
2543
|
+
"type": "boolean",
|
|
3043
2544
|
"default": "false",
|
|
3044
2545
|
"description": "[Android only] Enable/Disable use of GLSurfaceView insted of TextureView."
|
|
3045
2546
|
},
|
|
3046
|
-
{
|
|
3047
|
-
"name": "onPress",
|
|
3048
|
-
"required": false,
|
|
3049
|
-
"type": "func",
|
|
3050
|
-
"default": "none",
|
|
3051
|
-
"description": "Map press listener, gets called when a user presses the map"
|
|
3052
|
-
},
|
|
3053
|
-
{
|
|
3054
|
-
"name": "onLongPress",
|
|
3055
|
-
"required": false,
|
|
3056
|
-
"type": "func",
|
|
3057
|
-
"default": "none",
|
|
3058
|
-
"description": "Map long press listener, gets called when a user long presses the map"
|
|
3059
|
-
},
|
|
3060
|
-
{
|
|
3061
|
-
"name": "onRegionWillChange",
|
|
3062
|
-
"required": false,
|
|
3063
|
-
"type": "func",
|
|
3064
|
-
"default": "none",
|
|
3065
|
-
"description": "This event is triggered whenever the currently displayed map region is about to change.",
|
|
3066
|
-
"params": [
|
|
3067
|
-
{
|
|
3068
|
-
"name": "feature",
|
|
3069
|
-
"description": "The geojson point feature at the camera center, properties contains zoomLevel, visibleBounds",
|
|
3070
|
-
"type": {
|
|
3071
|
-
"name": "PointFeature"
|
|
3072
|
-
},
|
|
3073
|
-
"optional": false
|
|
3074
|
-
}
|
|
3075
|
-
]
|
|
3076
|
-
},
|
|
3077
|
-
{
|
|
3078
|
-
"name": "onRegionIsChanging",
|
|
3079
|
-
"required": false,
|
|
3080
|
-
"type": "func",
|
|
3081
|
-
"default": "none",
|
|
3082
|
-
"description": "This event is triggered whenever the currently displayed map region is changing.",
|
|
3083
|
-
"params": [
|
|
3084
|
-
{
|
|
3085
|
-
"name": "feature",
|
|
3086
|
-
"description": "The geojson point feature at the camera center, properties contains zoomLevel, visibleBounds",
|
|
3087
|
-
"type": {
|
|
3088
|
-
"name": "PointFeature"
|
|
3089
|
-
},
|
|
3090
|
-
"optional": false
|
|
3091
|
-
}
|
|
3092
|
-
]
|
|
3093
|
-
},
|
|
3094
|
-
{
|
|
3095
|
-
"name": "onRegionDidChange",
|
|
3096
|
-
"required": false,
|
|
3097
|
-
"type": "func",
|
|
3098
|
-
"default": "none",
|
|
3099
|
-
"description": "This event is triggered whenever the currently displayed map region finished changing",
|
|
3100
|
-
"params": [
|
|
3101
|
-
{
|
|
3102
|
-
"name": "feature",
|
|
3103
|
-
"description": "The geojson point feature at the camera center, properties contains zoomLevel, visibleBounds",
|
|
3104
|
-
"type": {
|
|
3105
|
-
"name": "PointFeature"
|
|
3106
|
-
},
|
|
3107
|
-
"optional": false
|
|
3108
|
-
}
|
|
3109
|
-
]
|
|
3110
|
-
},
|
|
3111
|
-
{
|
|
3112
|
-
"name": "onWillStartLoadingMap",
|
|
3113
|
-
"required": false,
|
|
3114
|
-
"type": "func",
|
|
3115
|
-
"default": "none",
|
|
3116
|
-
"description": "This event is triggered when the map is about to start loading a new map style."
|
|
3117
|
-
},
|
|
3118
|
-
{
|
|
3119
|
-
"name": "onDidFinishLoadingMap",
|
|
3120
|
-
"required": false,
|
|
3121
|
-
"type": "func",
|
|
3122
|
-
"default": "none",
|
|
3123
|
-
"description": "This is triggered when the map has successfully loaded a new map style."
|
|
3124
|
-
},
|
|
3125
|
-
{
|
|
3126
|
-
"name": "onDidFailLoadingMap",
|
|
3127
|
-
"required": false,
|
|
3128
|
-
"type": "func",
|
|
3129
|
-
"default": "none",
|
|
3130
|
-
"description": "This event is triggered when the map has failed to load a new map style."
|
|
3131
|
-
},
|
|
3132
|
-
{
|
|
3133
|
-
"name": "onWillStartRenderingFrame",
|
|
3134
|
-
"required": false,
|
|
3135
|
-
"type": "func",
|
|
3136
|
-
"default": "none",
|
|
3137
|
-
"description": "This event is triggered when the map will start rendering a frame."
|
|
3138
|
-
},
|
|
3139
|
-
{
|
|
3140
|
-
"name": "onDidFinishRenderingFrame",
|
|
3141
|
-
"required": false,
|
|
3142
|
-
"type": "func",
|
|
3143
|
-
"default": "none",
|
|
3144
|
-
"description": "This event is triggered when the map finished rendering a frame."
|
|
3145
|
-
},
|
|
3146
|
-
{
|
|
3147
|
-
"name": "onDidFinishRenderingFrameFully",
|
|
3148
|
-
"required": false,
|
|
3149
|
-
"type": "func",
|
|
3150
|
-
"default": "none",
|
|
3151
|
-
"description": "This event is triggered when the map fully finished rendering a frame."
|
|
3152
|
-
},
|
|
3153
|
-
{
|
|
3154
|
-
"name": "onWillStartRenderingMap",
|
|
3155
|
-
"required": false,
|
|
3156
|
-
"type": "func",
|
|
3157
|
-
"default": "none",
|
|
3158
|
-
"description": "This event is triggered when the map will start rendering the map."
|
|
3159
|
-
},
|
|
3160
|
-
{
|
|
3161
|
-
"name": "onDidFinishRenderingMap",
|
|
3162
|
-
"required": false,
|
|
3163
|
-
"type": "func",
|
|
3164
|
-
"default": "none",
|
|
3165
|
-
"description": "This event is triggered when the map finished rendering the map."
|
|
3166
|
-
},
|
|
3167
|
-
{
|
|
3168
|
-
"name": "onDidFinishRenderingMapFully",
|
|
3169
|
-
"required": false,
|
|
3170
|
-
"type": "func",
|
|
3171
|
-
"default": "none",
|
|
3172
|
-
"description": "This event is triggered when the map fully finished rendering the map."
|
|
3173
|
-
},
|
|
3174
2547
|
{
|
|
3175
2548
|
"name": "onUserLocationUpdate",
|
|
3176
2549
|
"required": false,
|
|
3177
|
-
"type":
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
{
|
|
3182
|
-
"name": "onDidFinishLoadingStyle",
|
|
3183
|
-
"required": false,
|
|
3184
|
-
"type": "func",
|
|
2550
|
+
"type": {
|
|
2551
|
+
"name": "func",
|
|
2552
|
+
"funcSignature": "(location:Location) => void"
|
|
2553
|
+
},
|
|
3185
2554
|
"default": "none",
|
|
3186
|
-
"description": "This event is triggered when
|
|
2555
|
+
"description": "This event is triggered when the user location is updated.\n*signature:*`(location:Location) => void`"
|
|
3187
2556
|
},
|
|
3188
2557
|
{
|
|
3189
2558
|
"name": "regionWillChangeDebounceTime",
|
|
@@ -3198,12 +2567,19 @@
|
|
|
3198
2567
|
"type": "number",
|
|
3199
2568
|
"default": "500",
|
|
3200
2569
|
"description": "The emitted frequency of regiondidchange events"
|
|
2570
|
+
},
|
|
2571
|
+
{
|
|
2572
|
+
"name": "children",
|
|
2573
|
+
"required": true,
|
|
2574
|
+
"type": "ReactNode",
|
|
2575
|
+
"default": "none",
|
|
2576
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
3201
2577
|
}
|
|
3202
2578
|
],
|
|
3203
2579
|
"composes": [
|
|
3204
|
-
"
|
|
2580
|
+
"BaseProps"
|
|
3205
2581
|
],
|
|
3206
|
-
"fileNameWithExt": "MapView.
|
|
2582
|
+
"fileNameWithExt": "MapView.tsx",
|
|
3207
2583
|
"name": "MapView"
|
|
3208
2584
|
},
|
|
3209
2585
|
"MarkerView": {
|
|
@@ -3214,12 +2590,7 @@
|
|
|
3214
2590
|
{
|
|
3215
2591
|
"name": "coordinate",
|
|
3216
2592
|
"required": true,
|
|
3217
|
-
"type":
|
|
3218
|
-
"name": "array",
|
|
3219
|
-
"value": {
|
|
3220
|
-
"type": "number"
|
|
3221
|
-
}
|
|
3222
|
-
},
|
|
2593
|
+
"type": "Array",
|
|
3223
2594
|
"default": "none",
|
|
3224
2595
|
"description": "The center point (specified as a map coordinate) of the marker.\nSee also #anchor."
|
|
3225
2596
|
},
|
|
@@ -3248,18 +2619,32 @@
|
|
|
3248
2619
|
"default": "{x: 0.5, y: 0.5}",
|
|
3249
2620
|
"description": "Specifies the anchor being set on a particular point of the annotation.\nThe anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],\nwhere (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.\nNote this is only for custom annotations not the default pin view.\nDefaults to the center of the view."
|
|
3250
2621
|
},
|
|
2622
|
+
{
|
|
2623
|
+
"name": "allowOverlap",
|
|
2624
|
+
"required": false,
|
|
2625
|
+
"type": "boolean",
|
|
2626
|
+
"default": "false",
|
|
2627
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
2628
|
+
},
|
|
2629
|
+
{
|
|
2630
|
+
"name": "isSelected",
|
|
2631
|
+
"required": false,
|
|
2632
|
+
"type": "boolean",
|
|
2633
|
+
"default": "false",
|
|
2634
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
2635
|
+
},
|
|
3251
2636
|
{
|
|
3252
2637
|
"name": "children",
|
|
3253
2638
|
"required": true,
|
|
3254
|
-
"type": "
|
|
2639
|
+
"type": "ReactReactElement",
|
|
3255
2640
|
"default": "none",
|
|
3256
2641
|
"description": "Expects one child - can be container with multiple elements"
|
|
3257
2642
|
}
|
|
3258
2643
|
],
|
|
3259
2644
|
"composes": [
|
|
3260
|
-
"
|
|
2645
|
+
"ViewProps"
|
|
3261
2646
|
],
|
|
3262
|
-
"fileNameWithExt": "MarkerView.
|
|
2647
|
+
"fileNameWithExt": "MarkerView.tsx",
|
|
3263
2648
|
"name": "MarkerView"
|
|
3264
2649
|
},
|
|
3265
2650
|
"NativeUserLocation": {
|
|
@@ -3270,19 +2655,19 @@
|
|
|
3270
2655
|
{
|
|
3271
2656
|
"name": "androidRenderMode",
|
|
3272
2657
|
"required": false,
|
|
3273
|
-
"type": "
|
|
2658
|
+
"type": "'normal' \\| 'compass' \\| 'gps'",
|
|
3274
2659
|
"default": "none",
|
|
3275
2660
|
"description": "Android render mode.\n\n - normal: just a circle\n - compass: triangle with heading\n - gps: large arrow\n\n@platform android"
|
|
3276
2661
|
},
|
|
3277
2662
|
{
|
|
3278
2663
|
"name": "iosShowsUserHeadingIndicator",
|
|
3279
2664
|
"required": false,
|
|
3280
|
-
"type": "
|
|
2665
|
+
"type": "boolean",
|
|
3281
2666
|
"default": "none",
|
|
3282
2667
|
"description": "iOS only. A Boolean value indicating whether the user location annotation may display a permanent heading indicator.\n\n@platform ios"
|
|
3283
2668
|
}
|
|
3284
2669
|
],
|
|
3285
|
-
"fileNameWithExt": "NativeUserLocation.
|
|
2670
|
+
"fileNameWithExt": "NativeUserLocation.tsx",
|
|
3286
2671
|
"name": "NativeUserLocation"
|
|
3287
2672
|
},
|
|
3288
2673
|
"PointAnnotation": {
|
|
@@ -3294,7 +2679,11 @@
|
|
|
3294
2679
|
"docblock": "On android point annotation is rendered offscreen with a canvas into an image.\nTo rerender the image from the current state of the view call refresh.\nCall this for example from Image#onLoad.",
|
|
3295
2680
|
"modifiers": [],
|
|
3296
2681
|
"params": [],
|
|
3297
|
-
"returns":
|
|
2682
|
+
"returns": {
|
|
2683
|
+
"type": {
|
|
2684
|
+
"name": "void"
|
|
2685
|
+
}
|
|
2686
|
+
},
|
|
3298
2687
|
"description": "On android point annotation is rendered offscreen with a canvas into an image.\nTo rerender the image from the current state of the view call refresh.\nCall this for example from Image#onLoad.",
|
|
3299
2688
|
"examples": []
|
|
3300
2689
|
}
|
|
@@ -3324,26 +2713,21 @@
|
|
|
3324
2713
|
{
|
|
3325
2714
|
"name": "selected",
|
|
3326
2715
|
"required": false,
|
|
3327
|
-
"type": "
|
|
2716
|
+
"type": "boolean",
|
|
3328
2717
|
"default": "none",
|
|
3329
2718
|
"description": "Manually selects/deselects annotation\n@type {[type]}"
|
|
3330
2719
|
},
|
|
3331
2720
|
{
|
|
3332
2721
|
"name": "draggable",
|
|
3333
2722
|
"required": false,
|
|
3334
|
-
"type": "
|
|
2723
|
+
"type": "boolean",
|
|
3335
2724
|
"default": "false",
|
|
3336
2725
|
"description": "Enable or disable dragging. Defaults to false."
|
|
3337
2726
|
},
|
|
3338
2727
|
{
|
|
3339
2728
|
"name": "coordinate",
|
|
3340
2729
|
"required": true,
|
|
3341
|
-
"type":
|
|
3342
|
-
"name": "array",
|
|
3343
|
-
"value": {
|
|
3344
|
-
"type": "number"
|
|
3345
|
-
}
|
|
3346
|
-
},
|
|
2730
|
+
"type": "Array",
|
|
3347
2731
|
"default": "none",
|
|
3348
2732
|
"description": "The center point (specified as a map coordinate) of the annotation."
|
|
3349
2733
|
},
|
|
@@ -3373,45 +2757,21 @@
|
|
|
3373
2757
|
"description": "Specifies the anchor being set on a particular point of the annotation.\nThe anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],\nwhere (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.\nNote this is only for custom annotations not the default pin view.\nDefaults to the center of the view."
|
|
3374
2758
|
},
|
|
3375
2759
|
{
|
|
3376
|
-
"name": "
|
|
3377
|
-
"required":
|
|
3378
|
-
"type": "
|
|
3379
|
-
"default": "none",
|
|
3380
|
-
"description": "This callback is fired once this annotation is selected. Returns a Feature as the first param."
|
|
3381
|
-
},
|
|
3382
|
-
{
|
|
3383
|
-
"name": "onDeselected",
|
|
3384
|
-
"required": false,
|
|
3385
|
-
"type": "func",
|
|
3386
|
-
"default": "none",
|
|
3387
|
-
"description": "This callback is fired once this annotation is deselected."
|
|
3388
|
-
},
|
|
3389
|
-
{
|
|
3390
|
-
"name": "onDragStart",
|
|
3391
|
-
"required": false,
|
|
3392
|
-
"type": "func",
|
|
3393
|
-
"default": "none",
|
|
3394
|
-
"description": "This callback is fired once this annotation has started being dragged."
|
|
3395
|
-
},
|
|
3396
|
-
{
|
|
3397
|
-
"name": "onDragEnd",
|
|
3398
|
-
"required": false,
|
|
3399
|
-
"type": "func",
|
|
2760
|
+
"name": "children",
|
|
2761
|
+
"required": true,
|
|
2762
|
+
"type": "React.ReactElement \\| [React.ReactElement, React.ReactElement]",
|
|
3400
2763
|
"default": "none",
|
|
3401
|
-
"description": "
|
|
2764
|
+
"description": "Expects one child, and an optional callout can be added as well"
|
|
3402
2765
|
},
|
|
3403
2766
|
{
|
|
3404
|
-
"name": "
|
|
2767
|
+
"name": "style",
|
|
3405
2768
|
"required": false,
|
|
3406
|
-
"type": "
|
|
2769
|
+
"type": "ViewProps['style']",
|
|
3407
2770
|
"default": "none",
|
|
3408
|
-
"description": "
|
|
2771
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
3409
2772
|
}
|
|
3410
2773
|
],
|
|
3411
|
-
"
|
|
3412
|
-
"../utils"
|
|
3413
|
-
],
|
|
3414
|
-
"fileNameWithExt": "PointAnnotation.js",
|
|
2774
|
+
"fileNameWithExt": "PointAnnotation.tsx",
|
|
3415
2775
|
"name": "PointAnnotation"
|
|
3416
2776
|
},
|
|
3417
2777
|
"RasterLayer": {
|
|
@@ -3420,80 +2780,25 @@
|
|
|
3420
2780
|
"methods": [],
|
|
3421
2781
|
"props": [
|
|
3422
2782
|
{
|
|
3423
|
-
"name": "
|
|
3424
|
-
"required":
|
|
3425
|
-
"type": "
|
|
2783
|
+
"name": "style",
|
|
2784
|
+
"required": false,
|
|
2785
|
+
"type": "RasterLayerStyleProps",
|
|
3426
2786
|
"default": "none",
|
|
3427
|
-
"description": "
|
|
2787
|
+
"description": "Customizable style attributes"
|
|
3428
2788
|
},
|
|
3429
2789
|
{
|
|
3430
2790
|
"name": "sourceID",
|
|
3431
2791
|
"required": false,
|
|
3432
|
-
"type": "
|
|
2792
|
+
"type": "FIX ME UNKNOWN TYPE",
|
|
3433
2793
|
"default": "MapLibreGL.StyleSource.DefaultSourceID",
|
|
3434
|
-
"description": "
|
|
3435
|
-
},
|
|
3436
|
-
{
|
|
3437
|
-
"name": "sourceLayerID",
|
|
3438
|
-
"required": false,
|
|
3439
|
-
"type": "string",
|
|
3440
|
-
"default": "none",
|
|
3441
|
-
"description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style."
|
|
3442
|
-
},
|
|
3443
|
-
{
|
|
3444
|
-
"name": "aboveLayerID",
|
|
3445
|
-
"required": false,
|
|
3446
|
-
"type": "string",
|
|
3447
|
-
"default": "none",
|
|
3448
|
-
"description": "Inserts a layer above aboveLayerID."
|
|
3449
|
-
},
|
|
3450
|
-
{
|
|
3451
|
-
"name": "belowLayerID",
|
|
3452
|
-
"required": false,
|
|
3453
|
-
"type": "string",
|
|
3454
|
-
"default": "none",
|
|
3455
|
-
"description": "Inserts a layer below belowLayerID"
|
|
3456
|
-
},
|
|
3457
|
-
{
|
|
3458
|
-
"name": "layerIndex",
|
|
3459
|
-
"required": false,
|
|
3460
|
-
"type": "number",
|
|
3461
|
-
"default": "none",
|
|
3462
|
-
"description": "Inserts a layer at a specified index"
|
|
3463
|
-
},
|
|
3464
|
-
{
|
|
3465
|
-
"name": "filter",
|
|
3466
|
-
"required": false,
|
|
3467
|
-
"type": "array",
|
|
3468
|
-
"default": "none",
|
|
3469
|
-
"description": "Filter only the features in the source layer that satisfy a condition that you define"
|
|
3470
|
-
},
|
|
3471
|
-
{
|
|
3472
|
-
"name": "minZoomLevel",
|
|
3473
|
-
"required": false,
|
|
3474
|
-
"type": "number",
|
|
3475
|
-
"default": "none",
|
|
3476
|
-
"description": "The minimum zoom level at which the layer gets parsed and appears."
|
|
3477
|
-
},
|
|
3478
|
-
{
|
|
3479
|
-
"name": "maxZoomLevel",
|
|
3480
|
-
"required": false,
|
|
3481
|
-
"type": "number",
|
|
3482
|
-
"default": "none",
|
|
3483
|
-
"description": "The maximum zoom level at which the layer gets parsed and appears."
|
|
3484
|
-
},
|
|
3485
|
-
{
|
|
3486
|
-
"name": "style",
|
|
3487
|
-
"required": false,
|
|
3488
|
-
"type": "union",
|
|
3489
|
-
"default": "none",
|
|
3490
|
-
"description": "Customizable style attributes"
|
|
2794
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
3491
2795
|
}
|
|
3492
2796
|
],
|
|
3493
2797
|
"composes": [
|
|
3494
|
-
"
|
|
2798
|
+
"BaseProps",
|
|
2799
|
+
"BaseLayerProps"
|
|
3495
2800
|
],
|
|
3496
|
-
"fileNameWithExt": "RasterLayer.
|
|
2801
|
+
"fileNameWithExt": "RasterLayer.tsx",
|
|
3497
2802
|
"name": "RasterLayer",
|
|
3498
2803
|
"styles": [
|
|
3499
2804
|
{
|
|
@@ -3696,12 +3001,7 @@
|
|
|
3696
3001
|
{
|
|
3697
3002
|
"name": "tileUrlTemplates",
|
|
3698
3003
|
"required": false,
|
|
3699
|
-
"type":
|
|
3700
|
-
"name": "array",
|
|
3701
|
-
"value": {
|
|
3702
|
-
"type": "string"
|
|
3703
|
-
}
|
|
3704
|
-
},
|
|
3004
|
+
"type": "Array",
|
|
3705
3005
|
"default": "none",
|
|
3706
3006
|
"description": "An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints.\nExample: https://example.com/raster-tiles/{z}/{x}/{y}.png"
|
|
3707
3007
|
},
|
|
@@ -3729,7 +3029,7 @@
|
|
|
3729
3029
|
{
|
|
3730
3030
|
"name": "tms",
|
|
3731
3031
|
"required": false,
|
|
3732
|
-
"type": "
|
|
3032
|
+
"type": "boolean",
|
|
3733
3033
|
"default": "none",
|
|
3734
3034
|
"description": "Influences the y direction of the tile coordinates. (tms inverts y axis)"
|
|
3735
3035
|
},
|
|
@@ -3739,12 +3039,19 @@
|
|
|
3739
3039
|
"type": "string",
|
|
3740
3040
|
"default": "none",
|
|
3741
3041
|
"description": "An HTML or literal text string defining the buttons to be displayed in an action sheet when the\nsource is part of a map view’s style and the map view’s attribution button is pressed."
|
|
3042
|
+
},
|
|
3043
|
+
{
|
|
3044
|
+
"name": "children",
|
|
3045
|
+
"required": false,
|
|
3046
|
+
"type": "React.ReactElement \\| React.ReactElement[]",
|
|
3047
|
+
"default": "none",
|
|
3048
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
3742
3049
|
}
|
|
3743
3050
|
],
|
|
3744
3051
|
"composes": [
|
|
3745
|
-
"
|
|
3052
|
+
"BaseProps"
|
|
3746
3053
|
],
|
|
3747
|
-
"fileNameWithExt": "RasterSource.
|
|
3054
|
+
"fileNameWithExt": "RasterSource.tsx",
|
|
3748
3055
|
"name": "RasterSource"
|
|
3749
3056
|
},
|
|
3750
3057
|
"ShapeSource": {
|
|
@@ -3762,7 +3069,7 @@
|
|
|
3762
3069
|
"name": "filter",
|
|
3763
3070
|
"description": "an optional filter statement to filter the returned Features.",
|
|
3764
3071
|
"type": {
|
|
3765
|
-
"name": "
|
|
3072
|
+
"name": "FilterExpression"
|
|
3766
3073
|
},
|
|
3767
3074
|
"optional": true
|
|
3768
3075
|
}
|
|
@@ -3770,7 +3077,13 @@
|
|
|
3770
3077
|
"returns": {
|
|
3771
3078
|
"description": null,
|
|
3772
3079
|
"type": {
|
|
3773
|
-
"name": "
|
|
3080
|
+
"name": "Promise",
|
|
3081
|
+
"elements": [
|
|
3082
|
+
{
|
|
3083
|
+
"name": "FeatureCollection"
|
|
3084
|
+
}
|
|
3085
|
+
],
|
|
3086
|
+
"raw": "Promise<FeatureCollection>"
|
|
3774
3087
|
}
|
|
3775
3088
|
},
|
|
3776
3089
|
"description": "Returns all features from the source that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map.",
|
|
@@ -3797,7 +3110,13 @@
|
|
|
3797
3110
|
"returns": {
|
|
3798
3111
|
"description": null,
|
|
3799
3112
|
"type": {
|
|
3800
|
-
"name": "
|
|
3113
|
+
"name": "Promise",
|
|
3114
|
+
"elements": [
|
|
3115
|
+
{
|
|
3116
|
+
"name": "number"
|
|
3117
|
+
}
|
|
3118
|
+
],
|
|
3119
|
+
"raw": "Promise<number>"
|
|
3801
3120
|
}
|
|
3802
3121
|
},
|
|
3803
3122
|
"description": "Returns the zoom needed to expand the cluster.",
|
|
@@ -3840,7 +3159,13 @@
|
|
|
3840
3159
|
"returns": {
|
|
3841
3160
|
"description": null,
|
|
3842
3161
|
"type": {
|
|
3843
|
-
"name": "
|
|
3162
|
+
"name": "Promise",
|
|
3163
|
+
"elements": [
|
|
3164
|
+
{
|
|
3165
|
+
"name": "FeatureCollection"
|
|
3166
|
+
}
|
|
3167
|
+
],
|
|
3168
|
+
"raw": "Promise<FeatureCollection>"
|
|
3844
3169
|
}
|
|
3845
3170
|
},
|
|
3846
3171
|
"description": "Returns the FeatureCollection from the cluster.",
|
|
@@ -3867,7 +3192,13 @@
|
|
|
3867
3192
|
"returns": {
|
|
3868
3193
|
"description": null,
|
|
3869
3194
|
"type": {
|
|
3870
|
-
"name": "
|
|
3195
|
+
"name": "Promise",
|
|
3196
|
+
"elements": [
|
|
3197
|
+
{
|
|
3198
|
+
"name": "FeatureCollection"
|
|
3199
|
+
}
|
|
3200
|
+
],
|
|
3201
|
+
"raw": "Promise<FeatureCollection>"
|
|
3871
3202
|
}
|
|
3872
3203
|
},
|
|
3873
3204
|
"description": "Returns the FeatureCollection from the cluster (on the next zoom level).",
|
|
@@ -3884,11 +3215,15 @@
|
|
|
3884
3215
|
"name": "event",
|
|
3885
3216
|
"optional": false,
|
|
3886
3217
|
"type": {
|
|
3887
|
-
"name":
|
|
3218
|
+
"name": "NativeSyntheticEvent"
|
|
3888
3219
|
}
|
|
3889
3220
|
}
|
|
3890
3221
|
],
|
|
3891
|
-
"returns":
|
|
3222
|
+
"returns": {
|
|
3223
|
+
"type": {
|
|
3224
|
+
"name": "void"
|
|
3225
|
+
}
|
|
3226
|
+
}
|
|
3892
3227
|
}
|
|
3893
3228
|
],
|
|
3894
3229
|
"props": [
|
|
@@ -3909,14 +3244,14 @@
|
|
|
3909
3244
|
{
|
|
3910
3245
|
"name": "shape",
|
|
3911
3246
|
"required": false,
|
|
3912
|
-
"type": "
|
|
3247
|
+
"type": "\\| GeoJSON.GeometryCollection\n\\| GeoJSON.Feature\n\\| GeoJSON.FeatureCollection\n\\| GeoJSON.Geometry",
|
|
3913
3248
|
"default": "none",
|
|
3914
3249
|
"description": "The contents of the source. A shape can represent a GeoJSON geometry, a feature, or a feature colllection."
|
|
3915
3250
|
},
|
|
3916
3251
|
{
|
|
3917
3252
|
"name": "cluster",
|
|
3918
3253
|
"required": false,
|
|
3919
|
-
"type": "
|
|
3254
|
+
"type": "boolean",
|
|
3920
3255
|
"default": "none",
|
|
3921
3256
|
"description": "Enables clustering on the source for point shapes."
|
|
3922
3257
|
},
|
|
@@ -3937,7 +3272,20 @@
|
|
|
3937
3272
|
{
|
|
3938
3273
|
"name": "clusterProperties",
|
|
3939
3274
|
"required": false,
|
|
3940
|
-
"type":
|
|
3275
|
+
"type": {
|
|
3276
|
+
"name": "shape",
|
|
3277
|
+
"value": [
|
|
3278
|
+
{
|
|
3279
|
+
"name": {
|
|
3280
|
+
"name": "string"
|
|
3281
|
+
},
|
|
3282
|
+
"required": true,
|
|
3283
|
+
"type": "ExpressionField",
|
|
3284
|
+
"default": "none",
|
|
3285
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
3286
|
+
}
|
|
3287
|
+
]
|
|
3288
|
+
},
|
|
3941
3289
|
"default": "none",
|
|
3942
3290
|
"description": "Specifies custom properties on the generated clusters if clustering\nis enabled, aggregating values from clustered points.\n\nHas the form `{ \"property_name\": [operator, map_expression]}`, where\n `operator` is a custom reduce expression that references a special `[\"accumulated\"]` value -\n it accumulates the property value from clusters/points the cluster contains\n `map_expression` produces the value of a single point\n\nExample: `{ \"resultingSum\": [[\"+\", [\"accumulated\"], [\"get\", \"resultingSum\"]], [\"get\", \"scalerank\"]] }`"
|
|
3943
3291
|
},
|
|
@@ -3965,59 +3313,19 @@
|
|
|
3965
3313
|
{
|
|
3966
3314
|
"name": "lineMetrics",
|
|
3967
3315
|
"required": false,
|
|
3968
|
-
"type": "
|
|
3316
|
+
"type": "boolean",
|
|
3969
3317
|
"default": "none",
|
|
3970
3318
|
"description": "Whether to calculate line distance metrics.\nThis is required for line layers that specify lineGradient values.\nThe default value is false."
|
|
3971
3319
|
},
|
|
3972
3320
|
{
|
|
3973
3321
|
"name": "onPress",
|
|
3974
3322
|
"required": false,
|
|
3975
|
-
"type":
|
|
3323
|
+
"type": {
|
|
3324
|
+
"name": "func",
|
|
3325
|
+
"funcSignature": "(event:OnPressEvent) => void"
|
|
3326
|
+
},
|
|
3976
3327
|
"default": "none",
|
|
3977
|
-
"description": "Source press listener, gets called when a user presses one of the children layers only\nif that layer has a higher z-index than another source layers"
|
|
3978
|
-
"params": [
|
|
3979
|
-
{
|
|
3980
|
-
"name": "event",
|
|
3981
|
-
"description": null,
|
|
3982
|
-
"type": {
|
|
3983
|
-
"name": "Object"
|
|
3984
|
-
},
|
|
3985
|
-
"optional": false
|
|
3986
|
-
},
|
|
3987
|
-
{
|
|
3988
|
-
"name": "event.features",
|
|
3989
|
-
"description": "the geojson features that have hit by the press (might be multiple)",
|
|
3990
|
-
"type": {
|
|
3991
|
-
"name": "Array",
|
|
3992
|
-
"elements": [
|
|
3993
|
-
{
|
|
3994
|
-
"name": "Object"
|
|
3995
|
-
}
|
|
3996
|
-
]
|
|
3997
|
-
},
|
|
3998
|
-
"optional": false
|
|
3999
|
-
},
|
|
4000
|
-
{
|
|
4001
|
-
"name": "event.coordinates",
|
|
4002
|
-
"description": "the coordinates of the click",
|
|
4003
|
-
"type": {
|
|
4004
|
-
"name": "Object"
|
|
4005
|
-
},
|
|
4006
|
-
"optional": false
|
|
4007
|
-
},
|
|
4008
|
-
{
|
|
4009
|
-
"name": "event.point",
|
|
4010
|
-
"description": "the point of the click",
|
|
4011
|
-
"type": {
|
|
4012
|
-
"name": "Object"
|
|
4013
|
-
},
|
|
4014
|
-
"optional": false
|
|
4015
|
-
}
|
|
4016
|
-
],
|
|
4017
|
-
"returns": {
|
|
4018
|
-
"description": "void",
|
|
4019
|
-
"type": null
|
|
4020
|
-
}
|
|
3328
|
+
"description": "Source press listener, gets called when a user presses one of the children layers only\nif that layer has a higher z-index than another source layers\n\n@param {Object} event\n@param {Object[]} event.features - the geojson features that have hit by the press (might be multiple)\n@param {Object} event.coordinates - the coordinates of the click\n@param {Object} event.point - the point of the click\n@return void\n*signature:*`(event:OnPressEvent) => void`"
|
|
4021
3329
|
},
|
|
4022
3330
|
{
|
|
4023
3331
|
"name": "hitbox",
|
|
@@ -4043,12 +3351,19 @@
|
|
|
4043
3351
|
},
|
|
4044
3352
|
"default": "none",
|
|
4045
3353
|
"description": "Overrides the default touch hitbox(44x44 pixels) for the source layers"
|
|
3354
|
+
},
|
|
3355
|
+
{
|
|
3356
|
+
"name": "children",
|
|
3357
|
+
"required": false,
|
|
3358
|
+
"type": "ReactElement \\| ReactElement[]",
|
|
3359
|
+
"default": "none",
|
|
3360
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
4046
3361
|
}
|
|
4047
3362
|
],
|
|
4048
3363
|
"composes": [
|
|
4049
|
-
"
|
|
3364
|
+
"BaseProps"
|
|
4050
3365
|
],
|
|
4051
|
-
"fileNameWithExt": "ShapeSource.
|
|
3366
|
+
"fileNameWithExt": "ShapeSource.tsx",
|
|
4052
3367
|
"name": "ShapeSource"
|
|
4053
3368
|
},
|
|
4054
3369
|
"Style": {
|
|
@@ -4059,12 +3374,12 @@
|
|
|
4059
3374
|
{
|
|
4060
3375
|
"name": "json",
|
|
4061
3376
|
"required": false,
|
|
4062
|
-
"type": "
|
|
3377
|
+
"type": "MaplibreJSON \\| URL",
|
|
4063
3378
|
"default": "none",
|
|
4064
3379
|
"description": "A JSON object conforming to the schema described in the MapLibre Style Specification, or a URL to such JSON."
|
|
4065
3380
|
}
|
|
4066
3381
|
],
|
|
4067
|
-
"fileNameWithExt": "Style.
|
|
3382
|
+
"fileNameWithExt": "Style.tsx",
|
|
4068
3383
|
"name": "Style"
|
|
4069
3384
|
},
|
|
4070
3385
|
"SymbolLayer": {
|
|
@@ -4073,80 +3388,32 @@
|
|
|
4073
3388
|
"methods": [],
|
|
4074
3389
|
"props": [
|
|
4075
3390
|
{
|
|
4076
|
-
"name": "
|
|
4077
|
-
"required": true,
|
|
4078
|
-
"type": "string",
|
|
4079
|
-
"default": "none",
|
|
4080
|
-
"description": "A string that uniquely identifies the source in the style to which it is added."
|
|
4081
|
-
},
|
|
4082
|
-
{
|
|
4083
|
-
"name": "sourceID",
|
|
4084
|
-
"required": false,
|
|
4085
|
-
"type": "string",
|
|
4086
|
-
"default": "MapLibreGL.StyleSource.DefaultSourceID",
|
|
4087
|
-
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it."
|
|
4088
|
-
},
|
|
4089
|
-
{
|
|
4090
|
-
"name": "sourceLayerID",
|
|
4091
|
-
"required": false,
|
|
4092
|
-
"type": "string",
|
|
4093
|
-
"default": "none",
|
|
4094
|
-
"description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style."
|
|
4095
|
-
},
|
|
4096
|
-
{
|
|
4097
|
-
"name": "aboveLayerID",
|
|
4098
|
-
"required": false,
|
|
4099
|
-
"type": "string",
|
|
4100
|
-
"default": "none",
|
|
4101
|
-
"description": "Inserts a layer above aboveLayerID."
|
|
4102
|
-
},
|
|
4103
|
-
{
|
|
4104
|
-
"name": "belowLayerID",
|
|
4105
|
-
"required": false,
|
|
4106
|
-
"type": "string",
|
|
4107
|
-
"default": "none",
|
|
4108
|
-
"description": "Inserts a layer below belowLayerID"
|
|
4109
|
-
},
|
|
4110
|
-
{
|
|
4111
|
-
"name": "layerIndex",
|
|
4112
|
-
"required": false,
|
|
4113
|
-
"type": "number",
|
|
4114
|
-
"default": "none",
|
|
4115
|
-
"description": "Inserts a layer at a specified index"
|
|
4116
|
-
},
|
|
4117
|
-
{
|
|
4118
|
-
"name": "filter",
|
|
4119
|
-
"required": false,
|
|
4120
|
-
"type": "array",
|
|
4121
|
-
"default": "none",
|
|
4122
|
-
"description": "Filter only the features in the source layer that satisfy a condition that you define"
|
|
4123
|
-
},
|
|
4124
|
-
{
|
|
4125
|
-
"name": "minZoomLevel",
|
|
3391
|
+
"name": "style",
|
|
4126
3392
|
"required": false,
|
|
4127
|
-
"type": "
|
|
3393
|
+
"type": "SymbolLayerStyleProps",
|
|
4128
3394
|
"default": "none",
|
|
4129
|
-
"description": "
|
|
3395
|
+
"description": "Customizable style attributes"
|
|
4130
3396
|
},
|
|
4131
3397
|
{
|
|
4132
|
-
"name": "
|
|
3398
|
+
"name": "children",
|
|
4133
3399
|
"required": false,
|
|
4134
|
-
"type": "
|
|
3400
|
+
"type": "ReactElement \\| ReactElement[]",
|
|
4135
3401
|
"default": "none",
|
|
4136
|
-
"description": "
|
|
3402
|
+
"description": "@deprecated passed children used to create an image with id of symbol in style and also set the iconImageName property accordingly.\nThis is now deprecated, use Image component instead."
|
|
4137
3403
|
},
|
|
4138
3404
|
{
|
|
4139
|
-
"name": "
|
|
3405
|
+
"name": "sourceID",
|
|
4140
3406
|
"required": false,
|
|
4141
|
-
"type": "
|
|
4142
|
-
"default": "
|
|
4143
|
-
"description": "
|
|
3407
|
+
"type": "FIX ME UNKNOWN TYPE",
|
|
3408
|
+
"default": "MapLibreGL.StyleSource.DefaultSourceID",
|
|
3409
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
4144
3410
|
}
|
|
4145
3411
|
],
|
|
4146
3412
|
"composes": [
|
|
4147
|
-
"
|
|
3413
|
+
"BaseProps",
|
|
3414
|
+
"BaseLayerProps"
|
|
4148
3415
|
],
|
|
4149
|
-
"fileNameWithExt": "SymbolLayer.
|
|
3416
|
+
"fileNameWithExt": "SymbolLayer.tsx",
|
|
4150
3417
|
"name": "SymbolLayer",
|
|
4151
3418
|
"styles": [
|
|
4152
3419
|
{
|
|
@@ -5502,10 +4769,10 @@
|
|
|
5502
4769
|
],
|
|
5503
4770
|
"params": [
|
|
5504
4771
|
{
|
|
5505
|
-
"name": "{running}",
|
|
4772
|
+
"name": "{running}: {running: boolean}",
|
|
5506
4773
|
"optional": false,
|
|
5507
4774
|
"type": {
|
|
5508
|
-
"name":
|
|
4775
|
+
"name": "{running:boolean}"
|
|
5509
4776
|
}
|
|
5510
4777
|
}
|
|
5511
4778
|
],
|
|
@@ -5517,7 +4784,8 @@
|
|
|
5517
4784
|
{
|
|
5518
4785
|
"name": "void"
|
|
5519
4786
|
}
|
|
5520
|
-
]
|
|
4787
|
+
],
|
|
4788
|
+
"raw": "Promise<void>"
|
|
5521
4789
|
}
|
|
5522
4790
|
},
|
|
5523
4791
|
"description": "Whether to start or stop listening to the locationManager\n\nNotice, that listening will start automatically when\neither `onUpdate` or `visible` are set",
|
|
@@ -5542,49 +4810,35 @@
|
|
|
5542
4810
|
{
|
|
5543
4811
|
"name": "animated",
|
|
5544
4812
|
"required": false,
|
|
5545
|
-
"type": "
|
|
4813
|
+
"type": "boolean",
|
|
5546
4814
|
"default": "true",
|
|
5547
4815
|
"description": "Whether location icon is animated between updates"
|
|
5548
4816
|
},
|
|
5549
4817
|
{
|
|
5550
4818
|
"name": "renderMode",
|
|
5551
4819
|
"required": false,
|
|
5552
|
-
"type": "
|
|
4820
|
+
"type": "'normal' \\| 'native'",
|
|
5553
4821
|
"default": "'normal'",
|
|
5554
4822
|
"description": "Which render mode to use.\nCan either be `normal` or `native`"
|
|
5555
4823
|
},
|
|
5556
4824
|
{
|
|
5557
4825
|
"name": "androidRenderMode",
|
|
5558
4826
|
"required": false,
|
|
5559
|
-
"type": "
|
|
4827
|
+
"type": "'normal' \\| 'compass' \\| 'gps'",
|
|
5560
4828
|
"default": "none",
|
|
5561
4829
|
"description": "native/android only render mode\n\n - normal: just a circle\n - compass: triangle with heading\n - gps: large arrow\n\n@platform android"
|
|
5562
4830
|
},
|
|
5563
4831
|
{
|
|
5564
4832
|
"name": "visible",
|
|
5565
4833
|
"required": false,
|
|
5566
|
-
"type": "
|
|
4834
|
+
"type": "boolean",
|
|
5567
4835
|
"default": "true",
|
|
5568
4836
|
"description": "Whether location icon is visible"
|
|
5569
4837
|
},
|
|
5570
|
-
{
|
|
5571
|
-
"name": "onPress",
|
|
5572
|
-
"required": false,
|
|
5573
|
-
"type": "func",
|
|
5574
|
-
"default": "none",
|
|
5575
|
-
"description": "Callback that is triggered on location icon press"
|
|
5576
|
-
},
|
|
5577
|
-
{
|
|
5578
|
-
"name": "onUpdate",
|
|
5579
|
-
"required": false,
|
|
5580
|
-
"type": "func",
|
|
5581
|
-
"default": "none",
|
|
5582
|
-
"description": "Callback that is triggered on location update"
|
|
5583
|
-
},
|
|
5584
4838
|
{
|
|
5585
4839
|
"name": "showsUserHeadingIndicator",
|
|
5586
4840
|
"required": false,
|
|
5587
|
-
"type": "
|
|
4841
|
+
"type": "boolean",
|
|
5588
4842
|
"default": "false",
|
|
5589
4843
|
"description": "Show or hide small arrow which indicates direction the device is pointing relative to north."
|
|
5590
4844
|
},
|
|
@@ -5598,12 +4852,12 @@
|
|
|
5598
4852
|
{
|
|
5599
4853
|
"name": "children",
|
|
5600
4854
|
"required": false,
|
|
5601
|
-
"type": "
|
|
4855
|
+
"type": "ReactElement \\| ReactElement[]",
|
|
5602
4856
|
"default": "none",
|
|
5603
4857
|
"description": "Custom location icon of type mapbox-gl-native components\n\nNOTE: Forking maintainer does not understand the above comment."
|
|
5604
4858
|
}
|
|
5605
4859
|
],
|
|
5606
|
-
"fileNameWithExt": "UserLocation.
|
|
4860
|
+
"fileNameWithExt": "UserLocation.tsx",
|
|
5607
4861
|
"name": "UserLocation"
|
|
5608
4862
|
},
|
|
5609
4863
|
"VectorSource": {
|
|
@@ -5612,7 +4866,7 @@
|
|
|
5612
4866
|
"methods": [
|
|
5613
4867
|
{
|
|
5614
4868
|
"name": "features",
|
|
5615
|
-
"docblock": "Returns all features that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map. The domain of the query includes all currently-loaded vector tiles\nand GeoJSON source tiles. This function does not check tiles outside of the visible viewport.\n\n@example\nvectorSource.features(['id1', 'id2'])\n\n@param {Array=} layerIDs - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.\n@param {Array=} filter - an optional filter statement to filter the returned Features.\n@return {FeatureCollection}",
|
|
4869
|
+
"docblock": "Returns all features that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map. The domain of the query includes all currently-loaded vector tiles\nand GeoJSON source tiles. This function does not check tiles outside of the visible viewport.\n\n@example\nvectorSource.features(['id1', 'id2'])\n\n@param {Array=} layerIDs - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.\n@param {Array=} filter - an optional filter statement to filter the returned Features.\n@return {GeoJSON.FeatureCollection}",
|
|
5616
4870
|
"modifiers": [
|
|
5617
4871
|
"async"
|
|
5618
4872
|
],
|
|
@@ -5629,7 +4883,7 @@
|
|
|
5629
4883
|
"name": "filter",
|
|
5630
4884
|
"description": "an optional filter statement to filter the returned Features.",
|
|
5631
4885
|
"type": {
|
|
5632
|
-
"name": "
|
|
4886
|
+
"name": "FilterExpression"
|
|
5633
4887
|
},
|
|
5634
4888
|
"optional": true
|
|
5635
4889
|
}
|
|
@@ -5637,7 +4891,13 @@
|
|
|
5637
4891
|
"returns": {
|
|
5638
4892
|
"description": null,
|
|
5639
4893
|
"type": {
|
|
5640
|
-
"name": "
|
|
4894
|
+
"name": "Promise",
|
|
4895
|
+
"elements": [
|
|
4896
|
+
{
|
|
4897
|
+
"name": "GeoJSON.FeatureCollection"
|
|
4898
|
+
}
|
|
4899
|
+
],
|
|
4900
|
+
"raw": "Promise<GeoJSON.FeatureCollection>"
|
|
5641
4901
|
}
|
|
5642
4902
|
},
|
|
5643
4903
|
"description": "Returns all features that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map. The domain of the query includes all currently-loaded vector tiles\nand GeoJSON source tiles. This function does not check tiles outside of the visible viewport.",
|
|
@@ -5654,11 +4914,15 @@
|
|
|
5654
4914
|
"name": "event",
|
|
5655
4915
|
"optional": false,
|
|
5656
4916
|
"type": {
|
|
5657
|
-
"name":
|
|
4917
|
+
"name": "NativeSyntheticEvent"
|
|
5658
4918
|
}
|
|
5659
4919
|
}
|
|
5660
4920
|
],
|
|
5661
|
-
"returns":
|
|
4921
|
+
"returns": {
|
|
4922
|
+
"type": {
|
|
4923
|
+
"name": "void"
|
|
4924
|
+
}
|
|
4925
|
+
}
|
|
5662
4926
|
}
|
|
5663
4927
|
],
|
|
5664
4928
|
"props": [
|
|
@@ -5679,12 +4943,7 @@
|
|
|
5679
4943
|
{
|
|
5680
4944
|
"name": "tileUrlTemplates",
|
|
5681
4945
|
"required": false,
|
|
5682
|
-
"type":
|
|
5683
|
-
"name": "array",
|
|
5684
|
-
"value": {
|
|
5685
|
-
"type": "string"
|
|
5686
|
-
}
|
|
5687
|
-
},
|
|
4946
|
+
"type": "Array",
|
|
5688
4947
|
"default": "none",
|
|
5689
4948
|
"description": "An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints.\nExample: https://example.com/vector-tiles/{z}/{x}/{y}.pbf"
|
|
5690
4949
|
},
|
|
@@ -5705,7 +4964,7 @@
|
|
|
5705
4964
|
{
|
|
5706
4965
|
"name": "tms",
|
|
5707
4966
|
"required": false,
|
|
5708
|
-
"type": "
|
|
4967
|
+
"type": "boolean",
|
|
5709
4968
|
"default": "none",
|
|
5710
4969
|
"description": "Influences the y direction of the tile coordinates. (tms inverts y axis)"
|
|
5711
4970
|
},
|
|
@@ -5719,48 +4978,12 @@
|
|
|
5719
4978
|
{
|
|
5720
4979
|
"name": "onPress",
|
|
5721
4980
|
"required": false,
|
|
5722
|
-
"type":
|
|
4981
|
+
"type": {
|
|
4982
|
+
"name": "func",
|
|
4983
|
+
"funcSignature": "(event:OnPressEvent) => void"
|
|
4984
|
+
},
|
|
5723
4985
|
"default": "none",
|
|
5724
|
-
"description": "Source press listener, gets called when a user presses one of the children layers only\nif that layer has a higher z-index than another source layers"
|
|
5725
|
-
"params": [
|
|
5726
|
-
{
|
|
5727
|
-
"name": "event",
|
|
5728
|
-
"description": null,
|
|
5729
|
-
"type": {
|
|
5730
|
-
"name": "Object"
|
|
5731
|
-
},
|
|
5732
|
-
"optional": false
|
|
5733
|
-
},
|
|
5734
|
-
{
|
|
5735
|
-
"name": "event.features",
|
|
5736
|
-
"description": "the geojson features that have hit by the press (might be multiple)",
|
|
5737
|
-
"type": {
|
|
5738
|
-
"name": "Array",
|
|
5739
|
-
"elements": [
|
|
5740
|
-
{
|
|
5741
|
-
"name": "Object"
|
|
5742
|
-
}
|
|
5743
|
-
]
|
|
5744
|
-
},
|
|
5745
|
-
"optional": false
|
|
5746
|
-
},
|
|
5747
|
-
{
|
|
5748
|
-
"name": "event.coordinates",
|
|
5749
|
-
"description": "the coordinates of the click",
|
|
5750
|
-
"type": {
|
|
5751
|
-
"name": "Object"
|
|
5752
|
-
},
|
|
5753
|
-
"optional": false
|
|
5754
|
-
},
|
|
5755
|
-
{
|
|
5756
|
-
"name": "event.point",
|
|
5757
|
-
"description": "the point of the click",
|
|
5758
|
-
"type": {
|
|
5759
|
-
"name": "Object"
|
|
5760
|
-
},
|
|
5761
|
-
"optional": false
|
|
5762
|
-
}
|
|
5763
|
-
]
|
|
4986
|
+
"description": "Source press listener, gets called when a user presses one of the children layers only\nif that layer has a higher z-index than another source layers\n\n@param {Object} event\n@param {Object[]} event.features - the geojson features that have hit by the press (might be multiple)\n@param {Object} event.coordinates - the coordinates of the click\n@param {Object} event.point - the point of the click\n*signature:*`(event:OnPressEvent) => void`"
|
|
5764
4987
|
},
|
|
5765
4988
|
{
|
|
5766
4989
|
"name": "hitbox",
|
|
@@ -5786,17 +5009,40 @@
|
|
|
5786
5009
|
},
|
|
5787
5010
|
"default": "none",
|
|
5788
5011
|
"description": "Overrides the default touch hitbox(44x44 pixels) for the source layers"
|
|
5012
|
+
},
|
|
5013
|
+
{
|
|
5014
|
+
"name": "children",
|
|
5015
|
+
"required": false,
|
|
5016
|
+
"type": "React.ReactElement \\| React.ReactElement[]",
|
|
5017
|
+
"default": "none",
|
|
5018
|
+
"description": "FIX ME NO DESCRIPTION"
|
|
5789
5019
|
}
|
|
5790
5020
|
],
|
|
5791
5021
|
"composes": [
|
|
5792
|
-
"
|
|
5022
|
+
"BaseProps"
|
|
5793
5023
|
],
|
|
5794
|
-
"fileNameWithExt": "VectorSource.
|
|
5024
|
+
"fileNameWithExt": "VectorSource.tsx",
|
|
5795
5025
|
"name": "VectorSource"
|
|
5796
5026
|
},
|
|
5027
|
+
"coordinates": {
|
|
5028
|
+
"name": "coordinates",
|
|
5029
|
+
"fileNameWithExt": "locationManager.ts",
|
|
5030
|
+
"description": "Coorinates sent by locationManager",
|
|
5031
|
+
"props": [],
|
|
5032
|
+
"styles": [],
|
|
5033
|
+
"methods": []
|
|
5034
|
+
},
|
|
5035
|
+
"location": {
|
|
5036
|
+
"name": "location",
|
|
5037
|
+
"fileNameWithExt": "locationManager.ts",
|
|
5038
|
+
"description": "Location sent by locationManager",
|
|
5039
|
+
"props": [],
|
|
5040
|
+
"styles": [],
|
|
5041
|
+
"methods": []
|
|
5042
|
+
},
|
|
5797
5043
|
"offlineManager": {
|
|
5798
5044
|
"name": "offlineManager",
|
|
5799
|
-
"fileNameWithExt": "offlineManager.
|
|
5045
|
+
"fileNameWithExt": "offlineManager.ts",
|
|
5800
5046
|
"description": "OfflineManager implements a singleton (shared object) that manages offline packs.\nAll of this class’s instance methods are asynchronous, reflecting the fact that offline resources are stored in a database.\nThe shared object maintains a canonical collection of offline packs.",
|
|
5801
5047
|
"props": [],
|
|
5802
5048
|
"styles": [],
|
|
@@ -6123,7 +5369,7 @@
|
|
|
6123
5369
|
},
|
|
6124
5370
|
"snapshotManager": {
|
|
6125
5371
|
"name": "snapshotManager",
|
|
6126
|
-
"fileNameWithExt": "snapshotManager.
|
|
5372
|
+
"fileNameWithExt": "snapshotManager.ts",
|
|
6127
5373
|
"description": "The snapshotManager generates static raster images of the map.\nEach snapshot image depicts a portion of a map defined by an SnapshotOptions object you provide.\nThe snapshotter generates the snapshot asynchronous.",
|
|
6128
5374
|
"props": [],
|
|
6129
5375
|
"styles": [],
|
|
@@ -6142,7 +5388,7 @@
|
|
|
6142
5388
|
}
|
|
6143
5389
|
],
|
|
6144
5390
|
"examples": [
|
|
6145
|
-
"// creates a temp file png of base map\nconst uri = await MapLibreGL.snapshotManager.takeSnap({\n centerCoordinate: [-74.126410, 40.797968],\n width: width,\n height: height,\n zoomLevel: 12,\n pitch: 30,\n heading: 20,\n styleURL: MapLibreGL.StyleURL.
|
|
5391
|
+
"// creates a temp file png of base map\nconst uri = await MapLibreGL.snapshotManager.takeSnap({\n centerCoordinate: [-74.126410, 40.797968],\n width: width,\n height: height,\n zoomLevel: 12,\n pitch: 30,\n heading: 20,\n styleURL: MapLibreGL.StyleURL.Default,\n writeToDisk: true, // Create a temporary file\n});\n\n// creates base64 png of base map without logo\nconst uri = await MapLibreGL.snapshotManager.takeSnap({\n centerCoordinate: [-74.126410, 40.797968],\n width: width,\n height: height,\n zoomLevel: 12,\n pitch: 30,\n heading: 20,\n styleURL: MapLibreGL.StyleURL.Default,\n withLogo: false, // Disable Mapbox logo (Android only)\n});\n\n// creates snapshot with bounds\nconst uri = await MapLibreGL.snapshotManager.takeSnap({\n bounds: [[-74.126410, 40.797968], [-74.143727, 40.772177]],\n width: width,\n height: height,\n styleURL: MapLibreGL.StyleURL.Default,\n});"
|
|
6146
5392
|
],
|
|
6147
5393
|
"returns": {
|
|
6148
5394
|
"description": "",
|