@rnmapbox/maps 10.0.0-beta.33 → 10.0.0-beta.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/.eslintrc.js +2 -2
  2. package/.nvmrc +1 -1
  3. package/README-v10.md +1 -1
  4. package/README.md +28 -23
  5. package/android/install.md +1 -1
  6. package/android/rctmgl/src/main/java-v10/com/mapbox/rctmgl/components/mapview/RCTMGLMapView.kt +5 -1
  7. package/android/rctmgl/src/main/java-v10/com/mapbox/rctmgl/components/styles/layers/RCTLayer.kt +5 -5
  8. package/docs/Annotation.md +8 -8
  9. package/docs/Annotations.md +14 -12
  10. package/docs/Atmosphere.md +76 -76
  11. package/docs/BackgroundLayer.md +44 -44
  12. package/docs/Callout.md +4 -4
  13. package/docs/Camera.md +124 -6
  14. package/docs/CircleLayer.md +129 -129
  15. package/docs/CustomHttpHeaders.md +12 -14
  16. package/docs/FillExtrusionLayer.md +120 -120
  17. package/docs/FillLayer.md +83 -83
  18. package/docs/HeadingIndicator.md +3 -3
  19. package/docs/HeatmapLayer.md +58 -58
  20. package/docs/ImageSource.md +4 -3
  21. package/docs/Images.md +3 -3
  22. package/docs/Light.md +45 -45
  23. package/docs/LineLayer.md +166 -166
  24. package/docs/Logger.md +8 -9
  25. package/docs/MapView.md +32 -32
  26. package/docs/MapboxGL.md +26 -27
  27. package/docs/MarkerView.md +11 -6
  28. package/docs/NativeUserLocation.md +3 -3
  29. package/docs/OfflineManager.md +35 -33
  30. package/docs/PointAnnotation.md +12 -6
  31. package/docs/RasterDemSource.md +3 -3
  32. package/docs/RasterLayer.md +99 -99
  33. package/docs/RasterSource.md +5 -3
  34. package/docs/ShapeSource.md +17 -16
  35. package/docs/SkyLayer.md +69 -69
  36. package/docs/Style.md +5 -3
  37. package/docs/StyleSheet.md +74 -278
  38. package/docs/SymbolLayer.md +454 -454
  39. package/docs/Terrain.md +6 -6
  40. package/docs/UserLocation.md +8 -8
  41. package/docs/VectorSource.md +9 -8
  42. package/docs/docs.json +196 -28
  43. package/docs/snapshotManager.md +7 -5
  44. package/index.d.ts +30 -26
  45. package/ios/RCTMGL-v10/RCTMGLCamera.swift +14 -5
  46. package/ios/RCTMGL-v10/RCTMGLMarkerView.swift +28 -14
  47. package/ios/RCTMGL-v10/RCTMGLMarkerViewWrapper.swift +24 -0
  48. package/ios/RCTMGL-v10/RCTMGLMarkerViewWrapperManager.m +8 -0
  49. package/ios/RCTMGL-v10/RCTMGLMarkerViewWrapperManager.swift +14 -0
  50. package/javascript/{utils/animated → classes}/AnimatedCoordinatesArray.js +1 -1
  51. package/javascript/{utils/animated → classes}/AnimatedExtractCoordinateFromArray.js +3 -1
  52. package/javascript/{utils/animated → classes}/AnimatedPoint.js +0 -0
  53. package/javascript/{utils/animated → classes}/AnimatedRouteCoordinatesArray.js +3 -1
  54. package/javascript/{utils/animated → classes}/AnimatedShape.js +9 -3
  55. package/javascript/classes/index.d.ts +5 -0
  56. package/javascript/classes/index.js +5 -0
  57. package/javascript/components/Callout.js +1 -1
  58. package/javascript/components/Camera.tsx +5 -1
  59. package/javascript/components/Images.js +1 -1
  60. package/javascript/components/MapView.js +3 -4
  61. package/javascript/components/MarkerView.tsx +125 -0
  62. package/javascript/components/PointAnnotation.d.ts +13 -0
  63. package/javascript/components/RasterDemSource.js +1 -1
  64. package/javascript/components/RasterSource.js +1 -1
  65. package/javascript/components/ShapeSource.js +4 -4
  66. package/javascript/components/Style.js +1 -1
  67. package/javascript/components/annotations/Annotation.js +3 -3
  68. package/javascript/index.js +27 -14
  69. package/javascript/types/index.ts +1 -1
  70. package/javascript/utils/BridgeValue.ts +89 -0
  71. package/javascript/utils/StyleValue.ts +22 -10
  72. package/javascript/utils/animated/Animated.js +0 -11
  73. package/javascript/utils/deprecation.js +0 -1
  74. package/javascript/utils/geoUtils.d.ts +10 -0
  75. package/javascript/utils/index.d.ts +6 -0
  76. package/package.json +16 -13
  77. package/plugin/build/withMapbox.js +0 -2
  78. package/plugin/install.md +13 -6
  79. package/scripts/autogenHelpers/DocJSONBuilder.js +43 -4
  80. package/scripts/autogenHelpers/globals.js +0 -2
  81. package/scripts/autogenerate.js +1 -2
  82. package/scripts/templates/component.md.ejs +25 -25
  83. package/tsconfig.json +1 -1
  84. package/javascript/components/MarkerView.js +0 -91
  85. package/javascript/utils/BridgeValue.js +0 -81
@@ -1,8 +1,8 @@
1
1
  <!-- This file was autogenerated from RasterLayer.js do not modify -->
2
- ## <MapboxGL.RasterLayer />
3
- ###
2
+ # <MapboxGL.RasterLayer />
4
3
 
5
- ### props
4
+
5
+ ## props
6
6
  | Prop | Type | Default | Required | Description |
7
7
  | ---- | :--: | :-----: | :------: | :----------: |
8
8
  | id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
@@ -17,7 +17,7 @@
17
17
  | style | `union` | `none` | `false` | Customizable style attributes |
18
18
 
19
19
 
20
- ### styles
20
+ ## styles
21
21
 
22
22
  * <a href="#visibility">visibility</a><br/>
23
23
  * <a href="#rasteropacity">rasterOpacity</a><br/>
@@ -31,18 +31,18 @@
31
31
 
32
32
  ___
33
33
 
34
- #### visibility
34
+ ### visibility
35
35
  Name: `visibility`
36
36
 
37
- #### Description
37
+ ### Description
38
38
  Whether this layer is displayed.
39
39
 
40
- #### Type
40
+ ### Type
41
41
  `enum`
42
- #### Default Value
42
+ ### Default Value
43
43
  `visible`
44
44
 
45
- #### Supported Values
45
+ ### Supported Values
46
46
  **visible** - The layer is shown.<br />
47
47
  **none** - The layer is not shown.<br />
48
48
 
@@ -50,308 +50,308 @@ Whether this layer is displayed.
50
50
 
51
51
  ___
52
52
 
53
- #### rasterOpacity
53
+ ### rasterOpacity
54
54
  Name: `rasterOpacity`
55
55
 
56
- #### Description
56
+ ### Description
57
57
  The opacity at which the image will be drawn.
58
58
 
59
- #### Type
59
+ ### Type
60
60
  `number`
61
- #### Default Value
61
+ ### Default Value
62
62
  `1`
63
63
 
64
- #### Minimum
64
+ ### Minimum
65
65
  `0`
66
66
 
67
67
 
68
- #### Maximum
68
+ ### Maximum
69
69
  `1`
70
70
 
71
- #### Expression
71
+ ### Expression
72
72
 
73
73
  Parameters: `zoom`
74
74
  ___
75
75
 
76
- #### Name
76
+ ### Name
77
77
 
78
78
  `rasterOpacityTransition`
79
79
 
80
- #### Description
80
+ ### Description
81
81
 
82
- The transition affecting any changes to this layer’s rasterOpacity propery.
82
+ The transition affecting any changes to this layer’s rasterOpacity property.
83
83
 
84
- #### Type
84
+ ### Type
85
85
 
86
86
  `{ duration, delay }`
87
87
 
88
- #### Units
88
+ ### Units
89
89
  `milliseconds`
90
90
 
91
- #### Default Value
91
+ ### Default Value
92
92
  `{duration: 300, delay: 0}`
93
93
 
94
94
 
95
95
  ___
96
96
 
97
- #### rasterHueRotate
97
+ ### rasterHueRotate
98
98
  Name: `rasterHueRotate`
99
99
 
100
- #### Description
100
+ ### Description
101
101
  Rotates hues around the color wheel.
102
102
 
103
- #### Type
103
+ ### Type
104
104
  `number`
105
- #### Default Value
105
+ ### Default Value
106
106
  `0`
107
107
 
108
- #### Units
108
+ ### Units
109
109
  `degrees`
110
110
 
111
111
 
112
- #### Expression
112
+ ### Expression
113
113
 
114
114
  Parameters: `zoom`
115
115
  ___
116
116
 
117
- #### Name
117
+ ### Name
118
118
 
119
119
  `rasterHueRotateTransition`
120
120
 
121
- #### Description
121
+ ### Description
122
122
 
123
- The transition affecting any changes to this layer’s rasterHueRotate propery.
123
+ The transition affecting any changes to this layer’s rasterHueRotate property.
124
124
 
125
- #### Type
125
+ ### Type
126
126
 
127
127
  `{ duration, delay }`
128
128
 
129
- #### Units
129
+ ### Units
130
130
  `milliseconds`
131
131
 
132
- #### Default Value
132
+ ### Default Value
133
133
  `{duration: 300, delay: 0}`
134
134
 
135
135
 
136
136
  ___
137
137
 
138
- #### rasterBrightnessMin
138
+ ### rasterBrightnessMin
139
139
  Name: `rasterBrightnessMin`
140
140
 
141
- #### Description
141
+ ### Description
142
142
  Increase or reduce the brightness of the image. The value is the minimum brightness.
143
143
 
144
- #### Type
144
+ ### Type
145
145
  `number`
146
- #### Default Value
146
+ ### Default Value
147
147
  `0`
148
148
 
149
- #### Minimum
149
+ ### Minimum
150
150
  `0`
151
151
 
152
152
 
153
- #### Maximum
153
+ ### Maximum
154
154
  `1`
155
155
 
156
- #### Expression
156
+ ### Expression
157
157
 
158
158
  Parameters: `zoom`
159
159
  ___
160
160
 
161
- #### Name
161
+ ### Name
162
162
 
163
163
  `rasterBrightnessMinTransition`
164
164
 
165
- #### Description
165
+ ### Description
166
166
 
167
- The transition affecting any changes to this layer’s rasterBrightnessMin propery.
167
+ The transition affecting any changes to this layer’s rasterBrightnessMin property.
168
168
 
169
- #### Type
169
+ ### Type
170
170
 
171
171
  `{ duration, delay }`
172
172
 
173
- #### Units
173
+ ### Units
174
174
  `milliseconds`
175
175
 
176
- #### Default Value
176
+ ### Default Value
177
177
  `{duration: 300, delay: 0}`
178
178
 
179
179
 
180
180
  ___
181
181
 
182
- #### rasterBrightnessMax
182
+ ### rasterBrightnessMax
183
183
  Name: `rasterBrightnessMax`
184
184
 
185
- #### Description
185
+ ### Description
186
186
  Increase or reduce the brightness of the image. The value is the maximum brightness.
187
187
 
188
- #### Type
188
+ ### Type
189
189
  `number`
190
- #### Default Value
190
+ ### Default Value
191
191
  `1`
192
192
 
193
- #### Minimum
193
+ ### Minimum
194
194
  `0`
195
195
 
196
196
 
197
- #### Maximum
197
+ ### Maximum
198
198
  `1`
199
199
 
200
- #### Expression
200
+ ### Expression
201
201
 
202
202
  Parameters: `zoom`
203
203
  ___
204
204
 
205
- #### Name
205
+ ### Name
206
206
 
207
207
  `rasterBrightnessMaxTransition`
208
208
 
209
- #### Description
209
+ ### Description
210
210
 
211
- The transition affecting any changes to this layer’s rasterBrightnessMax propery.
211
+ The transition affecting any changes to this layer’s rasterBrightnessMax property.
212
212
 
213
- #### Type
213
+ ### Type
214
214
 
215
215
  `{ duration, delay }`
216
216
 
217
- #### Units
217
+ ### Units
218
218
  `milliseconds`
219
219
 
220
- #### Default Value
220
+ ### Default Value
221
221
  `{duration: 300, delay: 0}`
222
222
 
223
223
 
224
224
  ___
225
225
 
226
- #### rasterSaturation
226
+ ### rasterSaturation
227
227
  Name: `rasterSaturation`
228
228
 
229
- #### Description
229
+ ### Description
230
230
  Increase or reduce the saturation of the image.
231
231
 
232
- #### Type
232
+ ### Type
233
233
  `number`
234
- #### Default Value
234
+ ### Default Value
235
235
  `0`
236
236
 
237
- #### Minimum
237
+ ### Minimum
238
238
  `-1`
239
239
 
240
240
 
241
- #### Maximum
241
+ ### Maximum
242
242
  `1`
243
243
 
244
- #### Expression
244
+ ### Expression
245
245
 
246
246
  Parameters: `zoom`
247
247
  ___
248
248
 
249
- #### Name
249
+ ### Name
250
250
 
251
251
  `rasterSaturationTransition`
252
252
 
253
- #### Description
253
+ ### Description
254
254
 
255
- The transition affecting any changes to this layer’s rasterSaturation propery.
255
+ The transition affecting any changes to this layer’s rasterSaturation property.
256
256
 
257
- #### Type
257
+ ### Type
258
258
 
259
259
  `{ duration, delay }`
260
260
 
261
- #### Units
261
+ ### Units
262
262
  `milliseconds`
263
263
 
264
- #### Default Value
264
+ ### Default Value
265
265
  `{duration: 300, delay: 0}`
266
266
 
267
267
 
268
268
  ___
269
269
 
270
- #### rasterContrast
270
+ ### rasterContrast
271
271
  Name: `rasterContrast`
272
272
 
273
- #### Description
273
+ ### Description
274
274
  Increase or reduce the contrast of the image.
275
275
 
276
- #### Type
276
+ ### Type
277
277
  `number`
278
- #### Default Value
278
+ ### Default Value
279
279
  `0`
280
280
 
281
- #### Minimum
281
+ ### Minimum
282
282
  `-1`
283
283
 
284
284
 
285
- #### Maximum
285
+ ### Maximum
286
286
  `1`
287
287
 
288
- #### Expression
288
+ ### Expression
289
289
 
290
290
  Parameters: `zoom`
291
291
  ___
292
292
 
293
- #### Name
293
+ ### Name
294
294
 
295
295
  `rasterContrastTransition`
296
296
 
297
- #### Description
297
+ ### Description
298
298
 
299
- The transition affecting any changes to this layer’s rasterContrast propery.
299
+ The transition affecting any changes to this layer’s rasterContrast property.
300
300
 
301
- #### Type
301
+ ### Type
302
302
 
303
303
  `{ duration, delay }`
304
304
 
305
- #### Units
305
+ ### Units
306
306
  `milliseconds`
307
307
 
308
- #### Default Value
308
+ ### Default Value
309
309
  `{duration: 300, delay: 0}`
310
310
 
311
311
 
312
312
  ___
313
313
 
314
- #### rasterResampling
314
+ ### rasterResampling
315
315
  Name: `rasterResampling`
316
316
 
317
- #### Description
317
+ ### Description
318
318
  The resampling/interpolation method to use for overscaling, also known as texture magnification filter
319
319
 
320
- #### Type
320
+ ### Type
321
321
  `enum`
322
- #### Default Value
322
+ ### Default Value
323
323
  `linear`
324
324
 
325
- #### Supported Values
325
+ ### Supported Values
326
326
  **linear** - (Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled<br />
327
327
  **nearest** - Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled<br />
328
328
 
329
329
 
330
- #### Expression
330
+ ### Expression
331
331
 
332
332
  Parameters: `zoom`
333
333
 
334
334
  ___
335
335
 
336
- #### rasterFadeDuration
336
+ ### rasterFadeDuration
337
337
  Name: `rasterFadeDuration`
338
338
 
339
- #### Description
339
+ ### Description
340
340
  Fade duration when a new tile is added.
341
341
 
342
- #### Type
342
+ ### Type
343
343
  `number`
344
- #### Default Value
344
+ ### Default Value
345
345
  `300`
346
346
 
347
- #### Units
347
+ ### Units
348
348
  `milliseconds`
349
349
 
350
- #### Minimum
350
+ ### Minimum
351
351
  `0`
352
352
 
353
353
 
354
- #### Expression
354
+ ### Expression
355
355
 
356
356
  Parameters: `zoom`
357
357
 
@@ -1,8 +1,10 @@
1
1
  <!-- This file was autogenerated from RasterSource.js do not modify -->
2
- ## <MapboxGL.RasterSource />
3
- ### RasterSource is a map content source that supplies raster image tiles to be shown on the map.<br/>The location of and metadata about the tiles are defined either by an option dictionary<br/>or by an external file that conforms to the TileJSON specification.
2
+ # <MapboxGL.RasterSource />
3
+ RasterSource is a map content source that supplies raster image tiles to be shown on the map.
4
+ The location of and metadata about the tiles are defined either by an option dictionary
5
+ or by an external file that conforms to the TileJSON specification.
4
6
 
5
- ### props
7
+ ## props
6
8
  | Prop | Type | Default | Required | Description |
7
9
  | ---- | :--: | :-----: | :------: | :----------: |
8
10
  | id | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | A string that uniquely identifies the source. |
@@ -1,13 +1,14 @@
1
1
  <!-- This file was autogenerated from ShapeSource.js do not modify -->
2
- ## <MapboxGL.ShapeSource />
3
- ### ShapeSource is a map content source that supplies vector shapes to be shown on the map.<br/>The shape may be a url or a GeoJSON object
2
+ # <MapboxGL.ShapeSource />
3
+ ShapeSource is a map content source that supplies vector shapes to be shown on the map.
4
+ The shape may be an url or a GeoJSON object
4
5
 
5
- ### props
6
+ ## props
6
7
  | Prop | Type | Default | Required | Description |
7
8
  | ---- | :--: | :-----: | :------: | :----------: |
8
9
  | id | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | A string that uniquely identifies the source. |
9
10
  | url | `string` | `none` | `false` | An HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle. |
10
- | shape | `object` | `none` | `false` | The contents of the source. A shape can represent a GeoJSON geometry, a feature, or a feature colllection. |
11
+ | shape | `object` | `none` | `false` | The contents of the source. A shape can represent a GeoJSON geometry, a feature, or a feature collection. |
11
12
  | cluster | `bool` | `none` | `false` | Enables clustering on the source for point shapes. |
12
13
  | clusterRadius | `number` | `none` | `false` | Specifies the radius of each cluster if clustering is enabled.<br/>A value of 512 produces a radius equal to the width of a tile.<br/>The default value is 50. |
13
14
  | clusterMaxZoomLevel | `number` | `none` | `false` | Specifies the maximum zoom level at which to cluster points if clustering is enabled.<br/>Defaults to one zoom level less than the value of maxZoomLevel so that, at the maximum zoom level,<br/>the shapes are not clustered. |
@@ -21,12 +22,12 @@
21
22
  | &nbsp;&nbsp;width | `number` | `none` | `true` | `width` of hitbox |
22
23
  | &nbsp;&nbsp;height | `number` | `none` | `true` | `height` of hitbox |
23
24
 
24
- ### methods
25
- #### features([filter])
25
+ ## methods
26
+ ### features([filter])
26
27
 
27
- Returns all features from the source that match the query parameters regardless of whether or not the feature is<br/>currently rendered on the map.
28
+ Returns all features from the source that match the query parameters whether the feature is currently<br/>rendered on the map.
28
29
 
29
- ##### arguments
30
+ #### arguments
30
31
  | Name | Type | Required | Description |
31
32
  | ---- | :--: | :------: | :----------: |
32
33
  | `filter` | `Array` | `No` | an optional filter statement to filter the returned Features. |
@@ -38,11 +39,11 @@ shapeSource.features()
38
39
  ```
39
40
 
40
41
 
41
- #### getClusterExpansionZoom(feature)
42
+ ### getClusterExpansionZoom(feature)
42
43
 
43
44
  Returns the zoom needed to expand the cluster.
44
45
 
45
- ##### arguments
46
+ #### arguments
46
47
  | Name | Type | Required | Description |
47
48
  | ---- | :--: | :------: | :----------: |
48
49
  | `feature` | `Feature` | `Yes` | The feature cluster to expand. |
@@ -54,11 +55,11 @@ const zoom = await shapeSource.getClusterExpansionZoom(clusterId);
54
55
  ```
55
56
 
56
57
 
57
- #### getClusterLeaves(feature, limit, offset)
58
+ ### getClusterLeaves(feature, limit, offset)
58
59
 
59
60
  Returns the FeatureCollection from the cluster.
60
61
 
61
- ##### arguments
62
+ #### arguments
62
63
  | Name | Type | Required | Description |
63
64
  | ---- | :--: | :------: | :----------: |
64
65
  | `feature` | `Feature` | `Yes` | The feature cluster to expand. |
@@ -72,11 +73,11 @@ const collection = await shapeSource.getClusterLeaves(clusterId, limit, offset);
72
73
  ```
73
74
 
74
75
 
75
- #### getClusterChildren(feature)
76
+ ### getClusterChildren(feature)
76
77
 
77
78
  Returns the FeatureCollection from the cluster (on the next zoom level).
78
79
 
79
- ##### arguments
80
+ #### arguments
80
81
  | Name | Type | Required | Description |
81
82
  | ---- | :--: | :------: | :----------: |
82
83
  | `feature` | `Feature` | `Yes` | The feature cluster to expand. |
@@ -88,11 +89,11 @@ const collection = await shapeSource.getClusterChildren(clusterId);
88
89
  ```
89
90
 
90
91
 
91
- #### onPress(event)
92
+ ### onPress(event)
92
93
 
93
94
 
94
95
 
95
- ##### arguments
96
+ #### arguments
96
97
  | Name | Type | Required | Description |
97
98
  | ---- | :--: | :------: | :----------: |
98
99
  | `event` | `n/a` | `Yes` | undefined |