@rnmapbox/maps 10.0.0-beta.31 → 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.
- package/.eslintrc.js +2 -2
- package/.github/ISSUE_TEMPLATE/bug_report.yml +112 -0
- package/.husky/pre-commit +5 -0
- package/.nvmrc +1 -1
- package/README-v10.md +1 -1
- package/README.md +28 -23
- package/android/install.md +1 -1
- package/android/rctmgl/src/main/java-v10/com/mapbox/rctmgl/components/camera/CameraStop.kt +27 -31
- package/android/rctmgl/src/main/java-v10/com/mapbox/rctmgl/components/mapview/RCTMGLMapView.kt +53 -48
- package/android/rctmgl/src/main/java-v10/com/mapbox/rctmgl/components/styles/layers/RCTLayer.kt +5 -5
- package/docs/Annotation.md +8 -8
- package/docs/Annotations.md +14 -12
- package/docs/Atmosphere.md +76 -76
- package/docs/BackgroundLayer.md +44 -44
- package/docs/Callout.md +4 -4
- package/docs/Camera.md +124 -6
- package/docs/CircleLayer.md +129 -129
- package/docs/CustomHttpHeaders.md +15 -13
- package/docs/FillExtrusionLayer.md +120 -120
- package/docs/FillLayer.md +83 -83
- package/docs/HeadingIndicator.md +3 -3
- package/docs/HeatmapLayer.md +58 -58
- package/docs/ImageSource.md +4 -3
- package/docs/Images.md +3 -3
- package/docs/Light.md +45 -45
- package/docs/LineLayer.md +166 -166
- package/docs/Logger.md +8 -9
- package/docs/MapView.md +32 -32
- package/docs/MapboxGL.md +26 -27
- package/docs/MarkerView.md +11 -6
- package/docs/NativeUserLocation.md +3 -3
- package/docs/OfflineManager.md +35 -33
- package/docs/PointAnnotation.md +12 -6
- package/docs/RasterDemSource.md +3 -3
- package/docs/RasterLayer.md +99 -99
- package/docs/RasterSource.md +5 -3
- package/docs/ShapeSource.md +17 -16
- package/docs/SkyLayer.md +69 -69
- package/docs/Style.md +5 -3
- package/docs/StyleSheet.md +74 -278
- package/docs/SymbolLayer.md +454 -454
- package/docs/Terrain.md +6 -6
- package/docs/UserLocation.md +8 -8
- package/docs/VectorSource.md +9 -8
- package/docs/docs.json +196 -28
- package/docs/snapshotManager.md +7 -5
- package/index.d.ts +41 -26
- package/ios/RCTMGL-v10/CustomHttpHeaders.swift +39 -0
- package/ios/RCTMGL-v10/MGLModule.m +3 -0
- package/ios/RCTMGL-v10/MGLModule.swift +8 -0
- package/ios/RCTMGL-v10/RCTMGLCamera.swift +14 -5
- package/ios/RCTMGL-v10/RCTMGLMarkerView.swift +28 -14
- package/ios/RCTMGL-v10/RCTMGLMarkerViewWrapper.swift +24 -0
- package/ios/RCTMGL-v10/RCTMGLMarkerViewWrapperManager.m +8 -0
- package/ios/RCTMGL-v10/RCTMGLMarkerViewWrapperManager.swift +14 -0
- package/ios/RCTMGL-v10/RCTMGLOfflineModule.swift +10 -12
- package/javascript/{utils/animated → classes}/AnimatedCoordinatesArray.js +1 -1
- package/javascript/{utils/animated → classes}/AnimatedExtractCoordinateFromArray.js +3 -1
- package/javascript/{utils/animated → classes}/AnimatedPoint.js +0 -0
- package/javascript/{utils/animated → classes}/AnimatedRouteCoordinatesArray.js +3 -1
- package/javascript/{utils/animated → classes}/AnimatedShape.js +9 -3
- package/javascript/classes/index.d.ts +5 -0
- package/javascript/classes/index.js +5 -0
- package/javascript/components/Callout.js +1 -1
- package/javascript/components/Camera.tsx +5 -1
- package/javascript/components/Images.js +1 -1
- package/javascript/components/MapView.js +3 -4
- package/javascript/components/MarkerView.tsx +125 -0
- package/javascript/components/PointAnnotation.d.ts +13 -0
- package/javascript/components/RasterDemSource.js +1 -1
- package/javascript/components/RasterSource.js +1 -1
- package/javascript/components/ShapeSource.js +4 -4
- package/javascript/components/Style.js +1 -1
- package/javascript/components/annotations/Annotation.js +3 -3
- package/javascript/index.js +27 -14
- package/javascript/types/index.ts +14 -0
- package/javascript/utils/BridgeValue.ts +89 -0
- package/javascript/utils/StyleValue.ts +22 -10
- package/javascript/utils/animated/Animated.js +0 -11
- package/javascript/utils/deprecation.js +0 -1
- package/javascript/utils/geoUtils.d.ts +10 -0
- package/javascript/utils/index.d.ts +6 -0
- package/javascript/utils/{styleMap.js → styleMap.ts} +110 -354
- package/javascript/web/MapContext.ts +6 -0
- package/javascript/web/components/Camera.tsx +39 -0
- package/javascript/web/components/MapView.tsx +51 -0
- package/package.json +21 -20
- package/plugin/build/withMapbox.js +0 -2
- package/plugin/install.md +13 -6
- package/scripts/autogenHelpers/DocJSONBuilder.js +43 -4
- package/scripts/autogenHelpers/globals.js +0 -2
- package/scripts/autogenerate.js +3 -4
- package/scripts/templates/component.md.ejs +25 -25
- package/scripts/templates/{styleMap.js.ejs → styleMap.ts.ejs} +7 -4
- package/tsconfig.json +1 -1
- package/.github/ISSUE_TEMPLATE/bug_report.md +0 -75
- package/javascript/components/MarkerView.js +0 -91
- package/javascript/utils/BridgeValue.js +0 -81
- package/javascript/utils/resolveAssetSource.d.ts +0 -5
- package/javascript/web/MapContext.js +0 -5
package/docs/SymbolLayer.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
<!-- This file was autogenerated from SymbolLayer.js do not modify -->
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
# <MapboxGL.SymbolLayer />
|
|
3
|
+
SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map.
|
|
4
4
|
|
|
5
|
-
|
|
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
|
-
|
|
20
|
+
## styles
|
|
21
21
|
|
|
22
22
|
* <a href="#symbolplacement">symbolPlacement</a><br/>
|
|
23
23
|
* <a href="#symbolspacing">symbolSpacing</a><br/>
|
|
@@ -78,398 +78,398 @@
|
|
|
78
78
|
|
|
79
79
|
___
|
|
80
80
|
|
|
81
|
-
|
|
81
|
+
### symbolPlacement
|
|
82
82
|
Name: `symbolPlacement`
|
|
83
83
|
|
|
84
|
-
|
|
84
|
+
### Description
|
|
85
85
|
Label placement relative to its geometry.
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
### Type
|
|
88
88
|
`enum`
|
|
89
|
-
|
|
89
|
+
### Default Value
|
|
90
90
|
`point`
|
|
91
91
|
|
|
92
|
-
|
|
92
|
+
### Supported Values
|
|
93
93
|
**point** - The label is placed at the point where the geometry is located.<br />
|
|
94
94
|
**line** - The label is placed along the line of the geometry. Can only be used on `LineString` and `Polygon` geometries.<br />
|
|
95
95
|
**line-center** - The label is placed at the center of the line of the geometry. Can only be used on `LineString` and `Polygon` geometries. Note that a single feature in a vector tile may contain multiple line geometries.<br />
|
|
96
96
|
|
|
97
97
|
|
|
98
|
-
|
|
98
|
+
### Expression
|
|
99
99
|
|
|
100
100
|
Parameters: `zoom`
|
|
101
101
|
|
|
102
102
|
___
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
### symbolSpacing
|
|
105
105
|
Name: `symbolSpacing`
|
|
106
106
|
|
|
107
|
-
|
|
107
|
+
### Description
|
|
108
108
|
Distance between two symbol anchors.
|
|
109
109
|
|
|
110
|
-
|
|
110
|
+
### Type
|
|
111
111
|
`number`
|
|
112
|
-
|
|
112
|
+
### Default Value
|
|
113
113
|
`250`
|
|
114
114
|
|
|
115
|
-
|
|
115
|
+
### Units
|
|
116
116
|
`pixels`
|
|
117
117
|
|
|
118
|
-
|
|
118
|
+
### Minimum
|
|
119
119
|
`1`
|
|
120
120
|
|
|
121
121
|
|
|
122
|
-
|
|
122
|
+
### Expression
|
|
123
123
|
|
|
124
124
|
Parameters: `zoom`
|
|
125
125
|
|
|
126
126
|
___
|
|
127
127
|
|
|
128
|
-
|
|
128
|
+
### symbolAvoidEdges
|
|
129
129
|
Name: `symbolAvoidEdges`
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
### Description
|
|
132
132
|
If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
|
|
133
133
|
|
|
134
|
-
|
|
134
|
+
### Type
|
|
135
135
|
`boolean`
|
|
136
|
-
|
|
136
|
+
### Default Value
|
|
137
137
|
`false`
|
|
138
138
|
|
|
139
139
|
|
|
140
|
-
|
|
140
|
+
### Expression
|
|
141
141
|
|
|
142
142
|
Parameters: `zoom`
|
|
143
143
|
|
|
144
144
|
___
|
|
145
145
|
|
|
146
|
-
|
|
146
|
+
### symbolSortKey
|
|
147
147
|
Name: `symbolSortKey`
|
|
148
148
|
|
|
149
|
-
|
|
149
|
+
### Description
|
|
150
150
|
Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When `iconAllowOverlap` or `textAllowOverlap` is `false`, features with a lower sort key will have priority during placement. When `iconAllowOverlap` or `textAllowOverlap` is set to `true`, features with a higher sort key will overlap over features with a lower sort key.
|
|
151
151
|
|
|
152
|
-
|
|
152
|
+
### Type
|
|
153
153
|
`number`
|
|
154
154
|
|
|
155
155
|
|
|
156
|
-
|
|
156
|
+
### Expression
|
|
157
157
|
|
|
158
158
|
Parameters: `zoom, feature`
|
|
159
159
|
|
|
160
160
|
___
|
|
161
161
|
|
|
162
|
-
|
|
162
|
+
### symbolZOrder
|
|
163
163
|
Name: `symbolZOrder`
|
|
164
164
|
|
|
165
|
-
|
|
165
|
+
### Description
|
|
166
166
|
Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their yPosition relative to the viewport. To control the order and prioritization of symbols otherwise, use `symbolSortKey`.
|
|
167
167
|
|
|
168
|
-
|
|
168
|
+
### Type
|
|
169
169
|
`enum`
|
|
170
|
-
|
|
170
|
+
### Default Value
|
|
171
171
|
`auto`
|
|
172
172
|
|
|
173
|
-
|
|
173
|
+
### Supported Values
|
|
174
174
|
**auto** - Sorts symbols by `symbol-sort-key` if set. Otherwise, sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`.<br />
|
|
175
175
|
**viewport-y** - Sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`.<br />
|
|
176
176
|
**source** - Sorts symbols by `symbol-sort-key` if set. Otherwise, no sorting is applied; symbols are rendered in the same order as the source data.<br />
|
|
177
177
|
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
### Expression
|
|
180
180
|
|
|
181
181
|
Parameters: `zoom`
|
|
182
182
|
|
|
183
183
|
___
|
|
184
184
|
|
|
185
|
-
|
|
185
|
+
### iconAllowOverlap
|
|
186
186
|
Name: `iconAllowOverlap`
|
|
187
187
|
|
|
188
|
-
|
|
188
|
+
### Description
|
|
189
189
|
If true, the icon will be visible even if it collides with other previously drawn symbols.
|
|
190
190
|
|
|
191
|
-
|
|
191
|
+
### Type
|
|
192
192
|
`boolean`
|
|
193
|
-
|
|
193
|
+
### Default Value
|
|
194
194
|
`false`
|
|
195
195
|
|
|
196
196
|
|
|
197
|
-
|
|
197
|
+
### Requires
|
|
198
198
|
`iconImage`
|
|
199
199
|
|
|
200
|
-
|
|
200
|
+
### Expression
|
|
201
201
|
|
|
202
202
|
Parameters: `zoom`
|
|
203
203
|
|
|
204
204
|
___
|
|
205
205
|
|
|
206
|
-
|
|
206
|
+
### iconIgnorePlacement
|
|
207
207
|
Name: `iconIgnorePlacement`
|
|
208
208
|
|
|
209
|
-
|
|
209
|
+
### Description
|
|
210
210
|
If true, other symbols can be visible even if they collide with the icon.
|
|
211
211
|
|
|
212
|
-
|
|
212
|
+
### Type
|
|
213
213
|
`boolean`
|
|
214
|
-
|
|
214
|
+
### Default Value
|
|
215
215
|
`false`
|
|
216
216
|
|
|
217
217
|
|
|
218
|
-
|
|
218
|
+
### Requires
|
|
219
219
|
`iconImage`
|
|
220
220
|
|
|
221
|
-
|
|
221
|
+
### Expression
|
|
222
222
|
|
|
223
223
|
Parameters: `zoom`
|
|
224
224
|
|
|
225
225
|
___
|
|
226
226
|
|
|
227
|
-
|
|
227
|
+
### iconOptional
|
|
228
228
|
Name: `iconOptional`
|
|
229
229
|
|
|
230
|
-
|
|
230
|
+
### Description
|
|
231
231
|
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
|
|
232
232
|
|
|
233
|
-
|
|
233
|
+
### Type
|
|
234
234
|
`boolean`
|
|
235
|
-
|
|
235
|
+
### Default Value
|
|
236
236
|
`false`
|
|
237
237
|
|
|
238
238
|
|
|
239
|
-
|
|
239
|
+
### Requires
|
|
240
240
|
`iconImage, textField`
|
|
241
241
|
|
|
242
|
-
|
|
242
|
+
### Expression
|
|
243
243
|
|
|
244
244
|
Parameters: `zoom`
|
|
245
245
|
|
|
246
246
|
___
|
|
247
247
|
|
|
248
|
-
|
|
248
|
+
### iconRotationAlignment
|
|
249
249
|
Name: `iconRotationAlignment`
|
|
250
250
|
|
|
251
|
-
|
|
251
|
+
### Description
|
|
252
252
|
In combination with `symbolPlacement`, determines the rotation behavior of icons.
|
|
253
253
|
|
|
254
|
-
|
|
254
|
+
### Type
|
|
255
255
|
`enum`
|
|
256
|
-
|
|
256
|
+
### Default Value
|
|
257
257
|
`auto`
|
|
258
258
|
|
|
259
|
-
|
|
259
|
+
### Supported Values
|
|
260
260
|
**map** - When `symbol-placement` is set to `point`, aligns icons east-west. When `symbol-placement` is set to `line` or `line-center`, aligns icon x-axes with the line.<br />
|
|
261
261
|
**viewport** - Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.<br />
|
|
262
262
|
**auto** - When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`.<br />
|
|
263
263
|
|
|
264
264
|
|
|
265
|
-
|
|
265
|
+
### Requires
|
|
266
266
|
`iconImage`
|
|
267
267
|
|
|
268
|
-
|
|
268
|
+
### Expression
|
|
269
269
|
|
|
270
270
|
Parameters: `zoom`
|
|
271
271
|
|
|
272
272
|
___
|
|
273
273
|
|
|
274
|
-
|
|
274
|
+
### iconSize
|
|
275
275
|
Name: `iconSize`
|
|
276
276
|
|
|
277
|
-
|
|
277
|
+
### Description
|
|
278
278
|
Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by `iconSize`. 1 is the original size; 3 triples the size of the image.
|
|
279
279
|
|
|
280
|
-
|
|
280
|
+
### Type
|
|
281
281
|
`number`
|
|
282
|
-
|
|
282
|
+
### Default Value
|
|
283
283
|
`1`
|
|
284
284
|
|
|
285
|
-
|
|
285
|
+
### Units
|
|
286
286
|
`factor of the original icon size`
|
|
287
287
|
|
|
288
|
-
|
|
288
|
+
### Minimum
|
|
289
289
|
`0`
|
|
290
290
|
|
|
291
291
|
|
|
292
|
-
|
|
292
|
+
### Requires
|
|
293
293
|
`iconImage`
|
|
294
294
|
|
|
295
|
-
|
|
295
|
+
### Expression
|
|
296
296
|
|
|
297
297
|
Parameters: `zoom, feature`
|
|
298
298
|
|
|
299
299
|
___
|
|
300
300
|
|
|
301
|
-
|
|
301
|
+
### iconTextFit
|
|
302
302
|
Name: `iconTextFit`
|
|
303
303
|
|
|
304
|
-
|
|
304
|
+
### Description
|
|
305
305
|
Scales the icon to fit around the associated text.
|
|
306
306
|
|
|
307
|
-
|
|
307
|
+
### Type
|
|
308
308
|
`enum`
|
|
309
|
-
|
|
309
|
+
### Default Value
|
|
310
310
|
`none`
|
|
311
311
|
|
|
312
|
-
|
|
312
|
+
### Supported Values
|
|
313
313
|
**none** - The icon is displayed at its intrinsic aspect ratio.<br />
|
|
314
314
|
**width** - The icon is scaled in the x-dimension to fit the width of the text.<br />
|
|
315
315
|
**height** - The icon is scaled in the y-dimension to fit the height of the text.<br />
|
|
316
316
|
**both** - The icon is scaled in both x- and y-dimensions.<br />
|
|
317
317
|
|
|
318
318
|
|
|
319
|
-
|
|
319
|
+
### Requires
|
|
320
320
|
`iconImage, textField`
|
|
321
321
|
|
|
322
|
-
|
|
322
|
+
### Expression
|
|
323
323
|
|
|
324
324
|
Parameters: `zoom`
|
|
325
325
|
|
|
326
326
|
___
|
|
327
327
|
|
|
328
|
-
|
|
328
|
+
### iconTextFitPadding
|
|
329
329
|
Name: `iconTextFitPadding`
|
|
330
330
|
|
|
331
|
-
|
|
331
|
+
### Description
|
|
332
332
|
Size of the additional area added to dimensions determined by `iconTextFit`, in clockwise order: top, right, bottom, left.
|
|
333
333
|
|
|
334
|
-
|
|
334
|
+
### Type
|
|
335
335
|
`array<number>`
|
|
336
|
-
|
|
336
|
+
### Default Value
|
|
337
337
|
`[0,0,0,0]`
|
|
338
338
|
|
|
339
|
-
|
|
339
|
+
### Units
|
|
340
340
|
`pixels`
|
|
341
341
|
|
|
342
342
|
|
|
343
|
-
|
|
343
|
+
### Requires
|
|
344
344
|
`iconImage, textField`
|
|
345
345
|
|
|
346
|
-
|
|
346
|
+
### Expression
|
|
347
347
|
|
|
348
348
|
Parameters: `zoom`
|
|
349
349
|
|
|
350
350
|
___
|
|
351
351
|
|
|
352
|
-
|
|
352
|
+
### iconImage
|
|
353
353
|
Name: `iconImage`
|
|
354
354
|
|
|
355
|
-
|
|
355
|
+
### Description
|
|
356
356
|
Name of image in sprite to use for drawing an image background.
|
|
357
357
|
|
|
358
|
-
|
|
358
|
+
### Type
|
|
359
359
|
`resolvedImage`
|
|
360
360
|
|
|
361
361
|
|
|
362
|
-
|
|
362
|
+
### Expression
|
|
363
363
|
|
|
364
364
|
Parameters: `zoom, feature`
|
|
365
365
|
|
|
366
366
|
___
|
|
367
367
|
|
|
368
|
-
|
|
368
|
+
### iconRotate
|
|
369
369
|
Name: `iconRotate`
|
|
370
370
|
|
|
371
|
-
|
|
371
|
+
### Description
|
|
372
372
|
Rotates the icon clockwise.
|
|
373
373
|
|
|
374
|
-
|
|
374
|
+
### Type
|
|
375
375
|
`number`
|
|
376
|
-
|
|
376
|
+
### Default Value
|
|
377
377
|
`0`
|
|
378
378
|
|
|
379
|
-
|
|
379
|
+
### Units
|
|
380
380
|
`degrees`
|
|
381
381
|
|
|
382
382
|
|
|
383
|
-
|
|
383
|
+
### Requires
|
|
384
384
|
`iconImage`
|
|
385
385
|
|
|
386
|
-
|
|
386
|
+
### Expression
|
|
387
387
|
|
|
388
388
|
Parameters: `zoom, feature`
|
|
389
389
|
|
|
390
390
|
___
|
|
391
391
|
|
|
392
|
-
|
|
392
|
+
### iconPadding
|
|
393
393
|
Name: `iconPadding`
|
|
394
394
|
|
|
395
|
-
|
|
395
|
+
### Description
|
|
396
396
|
Size of the additional area around the icon bounding box used for detecting symbol collisions.
|
|
397
397
|
|
|
398
|
-
|
|
398
|
+
### Type
|
|
399
399
|
`number`
|
|
400
|
-
|
|
400
|
+
### Default Value
|
|
401
401
|
`2`
|
|
402
402
|
|
|
403
|
-
|
|
403
|
+
### Units
|
|
404
404
|
`pixels`
|
|
405
405
|
|
|
406
|
-
|
|
406
|
+
### Minimum
|
|
407
407
|
`0`
|
|
408
408
|
|
|
409
409
|
|
|
410
|
-
|
|
410
|
+
### Requires
|
|
411
411
|
`iconImage`
|
|
412
412
|
|
|
413
|
-
|
|
413
|
+
### Expression
|
|
414
414
|
|
|
415
415
|
Parameters: `zoom`
|
|
416
416
|
|
|
417
417
|
___
|
|
418
418
|
|
|
419
|
-
|
|
419
|
+
### iconKeepUpright
|
|
420
420
|
Name: `iconKeepUpright`
|
|
421
421
|
|
|
422
|
-
|
|
422
|
+
### Description
|
|
423
423
|
If true, the icon may be flipped to prevent it from being rendered upsideDown.
|
|
424
424
|
|
|
425
|
-
|
|
425
|
+
### Type
|
|
426
426
|
`boolean`
|
|
427
|
-
|
|
427
|
+
### Default Value
|
|
428
428
|
`false`
|
|
429
429
|
|
|
430
430
|
|
|
431
|
-
|
|
431
|
+
### Requires
|
|
432
432
|
`iconImage`
|
|
433
433
|
|
|
434
|
-
|
|
434
|
+
### Expression
|
|
435
435
|
|
|
436
436
|
Parameters: `zoom`
|
|
437
437
|
|
|
438
438
|
___
|
|
439
439
|
|
|
440
|
-
|
|
440
|
+
### iconOffset
|
|
441
441
|
Name: `iconOffset`
|
|
442
442
|
|
|
443
|
-
|
|
443
|
+
### Description
|
|
444
444
|
Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of `iconSize` to obtain the final offset in pixels. When combined with `iconRotate` the offset will be as if the rotated direction was up.
|
|
445
445
|
|
|
446
|
-
|
|
446
|
+
### Type
|
|
447
447
|
`array<number>`
|
|
448
|
-
|
|
448
|
+
### Default Value
|
|
449
449
|
`[0,0]`
|
|
450
450
|
|
|
451
451
|
|
|
452
|
-
|
|
452
|
+
### Requires
|
|
453
453
|
`iconImage`
|
|
454
454
|
|
|
455
|
-
|
|
455
|
+
### Expression
|
|
456
456
|
|
|
457
457
|
Parameters: `zoom, feature`
|
|
458
458
|
|
|
459
459
|
___
|
|
460
460
|
|
|
461
|
-
|
|
461
|
+
### iconAnchor
|
|
462
462
|
Name: `iconAnchor`
|
|
463
463
|
|
|
464
|
-
|
|
464
|
+
### Description
|
|
465
465
|
Part of the icon placed closest to the anchor.
|
|
466
466
|
|
|
467
|
-
|
|
467
|
+
### Type
|
|
468
468
|
`enum`
|
|
469
|
-
|
|
469
|
+
### Default Value
|
|
470
470
|
`center`
|
|
471
471
|
|
|
472
|
-
|
|
472
|
+
### Supported Values
|
|
473
473
|
**center** - The center of the icon is placed closest to the anchor.<br />
|
|
474
474
|
**left** - The left side of the icon is placed closest to the anchor.<br />
|
|
475
475
|
**right** - The right side of the icon is placed closest to the anchor.<br />
|
|
@@ -481,324 +481,324 @@ Part of the icon placed closest to the anchor.
|
|
|
481
481
|
**bottom-right** - The bottom right corner of the icon is placed closest to the anchor.<br />
|
|
482
482
|
|
|
483
483
|
|
|
484
|
-
|
|
484
|
+
### Requires
|
|
485
485
|
`iconImage`
|
|
486
486
|
|
|
487
|
-
|
|
487
|
+
### Expression
|
|
488
488
|
|
|
489
489
|
Parameters: `zoom, feature`
|
|
490
490
|
|
|
491
491
|
___
|
|
492
492
|
|
|
493
|
-
|
|
493
|
+
### iconPitchAlignment
|
|
494
494
|
Name: `iconPitchAlignment`
|
|
495
495
|
|
|
496
|
-
|
|
496
|
+
### Description
|
|
497
497
|
Orientation of icon when map is pitched.
|
|
498
498
|
|
|
499
|
-
|
|
499
|
+
### Type
|
|
500
500
|
`enum`
|
|
501
|
-
|
|
501
|
+
### Default Value
|
|
502
502
|
`auto`
|
|
503
503
|
|
|
504
|
-
|
|
504
|
+
### Supported Values
|
|
505
505
|
**map** - The icon is aligned to the plane of the map.<br />
|
|
506
506
|
**viewport** - The icon is aligned to the plane of the viewport.<br />
|
|
507
507
|
**auto** - Automatically matches the value of `icon-rotation-alignment`.<br />
|
|
508
508
|
|
|
509
509
|
|
|
510
|
-
|
|
510
|
+
### Requires
|
|
511
511
|
`iconImage`
|
|
512
512
|
|
|
513
|
-
|
|
513
|
+
### Expression
|
|
514
514
|
|
|
515
515
|
Parameters: `zoom`
|
|
516
516
|
|
|
517
517
|
___
|
|
518
518
|
|
|
519
|
-
|
|
519
|
+
### textPitchAlignment
|
|
520
520
|
Name: `textPitchAlignment`
|
|
521
521
|
|
|
522
|
-
|
|
522
|
+
### Description
|
|
523
523
|
Orientation of text when map is pitched.
|
|
524
524
|
|
|
525
|
-
|
|
525
|
+
### Type
|
|
526
526
|
`enum`
|
|
527
|
-
|
|
527
|
+
### Default Value
|
|
528
528
|
`auto`
|
|
529
529
|
|
|
530
|
-
|
|
530
|
+
### Supported Values
|
|
531
531
|
**map** - The text is aligned to the plane of the map.<br />
|
|
532
532
|
**viewport** - The text is aligned to the plane of the viewport.<br />
|
|
533
533
|
**auto** - Automatically matches the value of `text-rotation-alignment`.<br />
|
|
534
534
|
|
|
535
535
|
|
|
536
|
-
|
|
536
|
+
### Requires
|
|
537
537
|
`textField`
|
|
538
538
|
|
|
539
|
-
|
|
539
|
+
### Expression
|
|
540
540
|
|
|
541
541
|
Parameters: `zoom`
|
|
542
542
|
|
|
543
543
|
___
|
|
544
544
|
|
|
545
|
-
|
|
545
|
+
### textRotationAlignment
|
|
546
546
|
Name: `textRotationAlignment`
|
|
547
547
|
|
|
548
|
-
|
|
548
|
+
### Description
|
|
549
549
|
In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text.
|
|
550
550
|
|
|
551
|
-
|
|
551
|
+
### Type
|
|
552
552
|
`enum`
|
|
553
|
-
|
|
553
|
+
### Default Value
|
|
554
554
|
`auto`
|
|
555
555
|
|
|
556
|
-
|
|
556
|
+
### Supported Values
|
|
557
557
|
**map** - When `symbol-placement` is set to `point`, aligns text east-west. When `symbol-placement` is set to `line` or `line-center`, aligns text x-axes with the line.<br />
|
|
558
558
|
**viewport** - Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.<br />
|
|
559
559
|
**auto** - When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`.<br />
|
|
560
560
|
|
|
561
561
|
|
|
562
|
-
|
|
562
|
+
### Requires
|
|
563
563
|
`textField`
|
|
564
564
|
|
|
565
|
-
|
|
565
|
+
### Expression
|
|
566
566
|
|
|
567
567
|
Parameters: `zoom`
|
|
568
568
|
|
|
569
569
|
___
|
|
570
570
|
|
|
571
|
-
|
|
571
|
+
### textField
|
|
572
572
|
Name: `textField`
|
|
573
573
|
|
|
574
|
-
|
|
574
|
+
### Description
|
|
575
575
|
Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options. SDF images are not supported in formatted text and will be ignored.
|
|
576
576
|
|
|
577
|
-
|
|
577
|
+
### Type
|
|
578
578
|
`formatted`
|
|
579
|
-
|
|
579
|
+
### Default Value
|
|
580
580
|
``
|
|
581
581
|
|
|
582
582
|
|
|
583
|
-
|
|
583
|
+
### Expression
|
|
584
584
|
|
|
585
585
|
Parameters: `zoom, feature`
|
|
586
586
|
|
|
587
587
|
___
|
|
588
588
|
|
|
589
|
-
|
|
589
|
+
### textFont
|
|
590
590
|
Name: `textFont`
|
|
591
591
|
|
|
592
|
-
|
|
592
|
+
### Description
|
|
593
593
|
Font stack to use for displaying text.
|
|
594
594
|
|
|
595
|
-
|
|
595
|
+
### Type
|
|
596
596
|
`array<string>`
|
|
597
|
-
|
|
597
|
+
### Default Value
|
|
598
598
|
`[Open Sans Regular,Arial Unicode MS Regular]`
|
|
599
599
|
|
|
600
600
|
|
|
601
|
-
|
|
601
|
+
### Requires
|
|
602
602
|
`textField`
|
|
603
603
|
|
|
604
|
-
|
|
604
|
+
### Supported Style Functions
|
|
605
605
|
`camera`
|
|
606
|
-
|
|
606
|
+
### Expression
|
|
607
607
|
|
|
608
608
|
Parameters: `zoom, feature`
|
|
609
609
|
|
|
610
610
|
___
|
|
611
611
|
|
|
612
|
-
|
|
612
|
+
### textSize
|
|
613
613
|
Name: `textSize`
|
|
614
614
|
|
|
615
|
-
|
|
615
|
+
### Description
|
|
616
616
|
Font size.
|
|
617
617
|
|
|
618
|
-
|
|
618
|
+
### Type
|
|
619
619
|
`number`
|
|
620
|
-
|
|
620
|
+
### Default Value
|
|
621
621
|
`16`
|
|
622
622
|
|
|
623
|
-
|
|
623
|
+
### Units
|
|
624
624
|
`pixels`
|
|
625
625
|
|
|
626
|
-
|
|
626
|
+
### Minimum
|
|
627
627
|
`0`
|
|
628
628
|
|
|
629
629
|
|
|
630
|
-
|
|
630
|
+
### Requires
|
|
631
631
|
`textField`
|
|
632
632
|
|
|
633
|
-
|
|
633
|
+
### Expression
|
|
634
634
|
|
|
635
635
|
Parameters: `zoom, feature`
|
|
636
636
|
|
|
637
637
|
___
|
|
638
638
|
|
|
639
|
-
|
|
639
|
+
### textMaxWidth
|
|
640
640
|
Name: `textMaxWidth`
|
|
641
641
|
|
|
642
|
-
|
|
642
|
+
### Description
|
|
643
643
|
The maximum line width for text wrapping.
|
|
644
644
|
|
|
645
|
-
|
|
645
|
+
### Type
|
|
646
646
|
`number`
|
|
647
|
-
|
|
647
|
+
### Default Value
|
|
648
648
|
`10`
|
|
649
649
|
|
|
650
|
-
|
|
650
|
+
### Units
|
|
651
651
|
`ems`
|
|
652
652
|
|
|
653
|
-
|
|
653
|
+
### Minimum
|
|
654
654
|
`0`
|
|
655
655
|
|
|
656
656
|
|
|
657
|
-
|
|
657
|
+
### Requires
|
|
658
658
|
`textField`
|
|
659
659
|
|
|
660
|
-
|
|
660
|
+
### Supported Style Functions
|
|
661
661
|
`camera`
|
|
662
|
-
|
|
662
|
+
### Expression
|
|
663
663
|
|
|
664
664
|
Parameters: `zoom, feature`
|
|
665
665
|
|
|
666
666
|
___
|
|
667
667
|
|
|
668
|
-
|
|
668
|
+
### textLineHeight
|
|
669
669
|
Name: `textLineHeight`
|
|
670
670
|
|
|
671
|
-
|
|
671
|
+
### Description
|
|
672
672
|
Text leading value for multiLine text.
|
|
673
673
|
|
|
674
|
-
|
|
674
|
+
### Type
|
|
675
675
|
`number`
|
|
676
|
-
|
|
676
|
+
### Default Value
|
|
677
677
|
`1.2`
|
|
678
678
|
|
|
679
|
-
|
|
679
|
+
### Units
|
|
680
680
|
`ems`
|
|
681
681
|
|
|
682
682
|
|
|
683
|
-
|
|
683
|
+
### Requires
|
|
684
684
|
`textField`
|
|
685
685
|
|
|
686
|
-
|
|
686
|
+
### Expression
|
|
687
687
|
|
|
688
688
|
Parameters: `zoom, feature`
|
|
689
689
|
|
|
690
690
|
___
|
|
691
691
|
|
|
692
|
-
|
|
692
|
+
### textLetterSpacing
|
|
693
693
|
Name: `textLetterSpacing`
|
|
694
694
|
|
|
695
|
-
|
|
695
|
+
### Description
|
|
696
696
|
Text tracking amount.
|
|
697
697
|
|
|
698
|
-
|
|
698
|
+
### Type
|
|
699
699
|
`number`
|
|
700
|
-
|
|
700
|
+
### Default Value
|
|
701
701
|
`0`
|
|
702
702
|
|
|
703
|
-
|
|
703
|
+
### Units
|
|
704
704
|
`ems`
|
|
705
705
|
|
|
706
706
|
|
|
707
|
-
|
|
707
|
+
### Requires
|
|
708
708
|
`textField`
|
|
709
709
|
|
|
710
|
-
|
|
710
|
+
### Supported Style Functions
|
|
711
711
|
`camera`
|
|
712
|
-
|
|
712
|
+
### Expression
|
|
713
713
|
|
|
714
714
|
Parameters: `zoom, feature`
|
|
715
715
|
|
|
716
716
|
___
|
|
717
717
|
|
|
718
|
-
|
|
718
|
+
### textJustify
|
|
719
719
|
Name: `textJustify`
|
|
720
720
|
|
|
721
|
-
|
|
721
|
+
### Description
|
|
722
722
|
Text justification options.
|
|
723
723
|
|
|
724
|
-
|
|
724
|
+
### Type
|
|
725
725
|
`enum`
|
|
726
|
-
|
|
726
|
+
### Default Value
|
|
727
727
|
`center`
|
|
728
728
|
|
|
729
|
-
|
|
729
|
+
### Supported Values
|
|
730
730
|
**auto** - The text is aligned towards the anchor position.<br />
|
|
731
731
|
**left** - The text is aligned to the left.<br />
|
|
732
732
|
**center** - The text is centered.<br />
|
|
733
733
|
**right** - The text is aligned to the right.<br />
|
|
734
734
|
|
|
735
735
|
|
|
736
|
-
|
|
736
|
+
### Requires
|
|
737
737
|
`textField`
|
|
738
738
|
|
|
739
|
-
|
|
739
|
+
### Supported Style Functions
|
|
740
740
|
`camera`
|
|
741
|
-
|
|
741
|
+
### Expression
|
|
742
742
|
|
|
743
743
|
Parameters: `zoom, feature`
|
|
744
744
|
|
|
745
745
|
___
|
|
746
746
|
|
|
747
|
-
|
|
747
|
+
### textRadialOffset
|
|
748
748
|
Name: `textRadialOffset`
|
|
749
749
|
|
|
750
|
-
|
|
750
|
+
### Description
|
|
751
751
|
Radial offset of text, in the direction of the symbol's anchor. Useful in combination with `textVariableAnchor`, which defaults to using the twoDimensional `textOffset` if present.
|
|
752
752
|
|
|
753
|
-
|
|
753
|
+
### Type
|
|
754
754
|
`number`
|
|
755
|
-
|
|
755
|
+
### Default Value
|
|
756
756
|
`0`
|
|
757
757
|
|
|
758
|
-
|
|
758
|
+
### Units
|
|
759
759
|
`ems`
|
|
760
760
|
|
|
761
761
|
|
|
762
|
-
|
|
762
|
+
### Requires
|
|
763
763
|
`textField`
|
|
764
764
|
|
|
765
|
-
|
|
765
|
+
### Expression
|
|
766
766
|
|
|
767
767
|
Parameters: `zoom, feature`
|
|
768
768
|
|
|
769
769
|
___
|
|
770
770
|
|
|
771
|
-
|
|
771
|
+
### textVariableAnchor
|
|
772
772
|
Name: `textVariableAnchor`
|
|
773
773
|
|
|
774
|
-
|
|
774
|
+
### Description
|
|
775
775
|
To increase the chance of placing highPriority labels on the map, you can provide an array of `textAnchor` locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use `textJustify: auto` to choose justification based on anchor position. To apply an offset, use the `textRadialOffset` or the twoDimensional `textOffset`.
|
|
776
776
|
|
|
777
|
-
|
|
777
|
+
### Type
|
|
778
778
|
`array<enum>`
|
|
779
779
|
|
|
780
780
|
|
|
781
|
-
|
|
781
|
+
### Requires
|
|
782
782
|
`textField`
|
|
783
783
|
|
|
784
|
-
|
|
784
|
+
### Expression
|
|
785
785
|
|
|
786
786
|
Parameters: `zoom`
|
|
787
787
|
|
|
788
788
|
___
|
|
789
789
|
|
|
790
|
-
|
|
790
|
+
### textAnchor
|
|
791
791
|
Name: `textAnchor`
|
|
792
792
|
|
|
793
|
-
|
|
793
|
+
### Description
|
|
794
794
|
Part of the text placed closest to the anchor.
|
|
795
795
|
|
|
796
|
-
|
|
796
|
+
### Type
|
|
797
797
|
`enum`
|
|
798
|
-
|
|
798
|
+
### Default Value
|
|
799
799
|
`center`
|
|
800
800
|
|
|
801
|
-
|
|
801
|
+
### Supported Values
|
|
802
802
|
**center** - The center of the text is placed closest to the anchor.<br />
|
|
803
803
|
**left** - The left side of the text is placed closest to the anchor.<br />
|
|
804
804
|
**right** - The right side of the text is placed closest to the anchor.<br />
|
|
@@ -810,263 +810,263 @@ Part of the text placed closest to the anchor.
|
|
|
810
810
|
**bottom-right** - The bottom right corner of the text is placed closest to the anchor.<br />
|
|
811
811
|
|
|
812
812
|
|
|
813
|
-
|
|
813
|
+
### Requires
|
|
814
814
|
`textField`
|
|
815
815
|
|
|
816
|
-
|
|
816
|
+
### Disabled By
|
|
817
817
|
`textVariableAnchor`
|
|
818
818
|
|
|
819
|
-
|
|
819
|
+
### Supported Style Functions
|
|
820
820
|
`camera`
|
|
821
|
-
|
|
821
|
+
### Expression
|
|
822
822
|
|
|
823
823
|
Parameters: `zoom, feature`
|
|
824
824
|
|
|
825
825
|
___
|
|
826
826
|
|
|
827
|
-
|
|
827
|
+
### textMaxAngle
|
|
828
828
|
Name: `textMaxAngle`
|
|
829
829
|
|
|
830
|
-
|
|
830
|
+
### Description
|
|
831
831
|
Maximum angle change between adjacent characters.
|
|
832
832
|
|
|
833
|
-
|
|
833
|
+
### Type
|
|
834
834
|
`number`
|
|
835
|
-
|
|
835
|
+
### Default Value
|
|
836
836
|
`45`
|
|
837
837
|
|
|
838
|
-
|
|
838
|
+
### Units
|
|
839
839
|
`degrees`
|
|
840
840
|
|
|
841
841
|
|
|
842
|
-
|
|
842
|
+
### Requires
|
|
843
843
|
`textField`
|
|
844
844
|
|
|
845
|
-
|
|
845
|
+
### Expression
|
|
846
846
|
|
|
847
847
|
Parameters: `zoom`
|
|
848
848
|
|
|
849
849
|
___
|
|
850
850
|
|
|
851
|
-
|
|
851
|
+
### textWritingMode
|
|
852
852
|
Name: `textWritingMode`
|
|
853
853
|
|
|
854
|
-
|
|
854
|
+
### Description
|
|
855
855
|
The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. For symbol with point placement, the order of elements in an array define priority order for the placement of an orientation variant. For symbol with line placement, the default text writing mode is either ['horizontal', 'vertical'] or ['vertical', 'horizontal'], the order doesn't affect the placement.
|
|
856
856
|
|
|
857
|
-
|
|
857
|
+
### Type
|
|
858
858
|
`array<enum>`
|
|
859
859
|
|
|
860
860
|
|
|
861
|
-
|
|
861
|
+
### Requires
|
|
862
862
|
`textField`
|
|
863
863
|
|
|
864
|
-
|
|
864
|
+
### Expression
|
|
865
865
|
|
|
866
866
|
Parameters: `zoom`
|
|
867
867
|
|
|
868
868
|
___
|
|
869
869
|
|
|
870
|
-
|
|
870
|
+
### textRotate
|
|
871
871
|
Name: `textRotate`
|
|
872
872
|
|
|
873
|
-
|
|
873
|
+
### Description
|
|
874
874
|
Rotates the text clockwise.
|
|
875
875
|
|
|
876
|
-
|
|
876
|
+
### Type
|
|
877
877
|
`number`
|
|
878
|
-
|
|
878
|
+
### Default Value
|
|
879
879
|
`0`
|
|
880
880
|
|
|
881
|
-
|
|
881
|
+
### Units
|
|
882
882
|
`degrees`
|
|
883
883
|
|
|
884
884
|
|
|
885
|
-
|
|
885
|
+
### Requires
|
|
886
886
|
`textField`
|
|
887
887
|
|
|
888
|
-
|
|
888
|
+
### Expression
|
|
889
889
|
|
|
890
890
|
Parameters: `zoom, feature`
|
|
891
891
|
|
|
892
892
|
___
|
|
893
893
|
|
|
894
|
-
|
|
894
|
+
### textPadding
|
|
895
895
|
Name: `textPadding`
|
|
896
896
|
|
|
897
|
-
|
|
897
|
+
### Description
|
|
898
898
|
Size of the additional area around the text bounding box used for detecting symbol collisions.
|
|
899
899
|
|
|
900
|
-
|
|
900
|
+
### Type
|
|
901
901
|
`number`
|
|
902
|
-
|
|
902
|
+
### Default Value
|
|
903
903
|
`2`
|
|
904
904
|
|
|
905
|
-
|
|
905
|
+
### Units
|
|
906
906
|
`pixels`
|
|
907
907
|
|
|
908
|
-
|
|
908
|
+
### Minimum
|
|
909
909
|
`0`
|
|
910
910
|
|
|
911
911
|
|
|
912
|
-
|
|
912
|
+
### Requires
|
|
913
913
|
`textField`
|
|
914
914
|
|
|
915
|
-
|
|
915
|
+
### Expression
|
|
916
916
|
|
|
917
917
|
Parameters: `zoom`
|
|
918
918
|
|
|
919
919
|
___
|
|
920
920
|
|
|
921
|
-
|
|
921
|
+
### textKeepUpright
|
|
922
922
|
Name: `textKeepUpright`
|
|
923
923
|
|
|
924
|
-
|
|
924
|
+
### Description
|
|
925
925
|
If true, the text may be flipped vertically to prevent it from being rendered upsideDown.
|
|
926
926
|
|
|
927
|
-
|
|
927
|
+
### Type
|
|
928
928
|
`boolean`
|
|
929
|
-
|
|
929
|
+
### Default Value
|
|
930
930
|
`true`
|
|
931
931
|
|
|
932
932
|
|
|
933
|
-
|
|
933
|
+
### Requires
|
|
934
934
|
`textField`
|
|
935
935
|
|
|
936
|
-
|
|
936
|
+
### Expression
|
|
937
937
|
|
|
938
938
|
Parameters: `zoom`
|
|
939
939
|
|
|
940
940
|
___
|
|
941
941
|
|
|
942
|
-
|
|
942
|
+
### textTransform
|
|
943
943
|
Name: `textTransform`
|
|
944
944
|
|
|
945
|
-
|
|
945
|
+
### Description
|
|
946
946
|
Specifies how to capitalize text, similar to the CSS `textTransform` property.
|
|
947
947
|
|
|
948
|
-
|
|
948
|
+
### Type
|
|
949
949
|
`enum`
|
|
950
|
-
|
|
950
|
+
### Default Value
|
|
951
951
|
`none`
|
|
952
952
|
|
|
953
|
-
|
|
953
|
+
### Supported Values
|
|
954
954
|
**none** - The text is not altered.<br />
|
|
955
955
|
**uppercase** - Forces all letters to be displayed in uppercase.<br />
|
|
956
956
|
**lowercase** - Forces all letters to be displayed in lowercase.<br />
|
|
957
957
|
|
|
958
958
|
|
|
959
|
-
|
|
959
|
+
### Requires
|
|
960
960
|
`textField`
|
|
961
961
|
|
|
962
|
-
|
|
962
|
+
### Expression
|
|
963
963
|
|
|
964
964
|
Parameters: `zoom, feature`
|
|
965
965
|
|
|
966
966
|
___
|
|
967
967
|
|
|
968
|
-
|
|
968
|
+
### textOffset
|
|
969
969
|
Name: `textOffset`
|
|
970
970
|
|
|
971
|
-
|
|
971
|
+
### Description
|
|
972
972
|
Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with textVariableAnchor, input values will be taken as absolute values. Offsets along the x and yAxis will be applied automatically based on the anchor position.
|
|
973
973
|
|
|
974
|
-
|
|
974
|
+
### Type
|
|
975
975
|
`array<number>`
|
|
976
|
-
|
|
976
|
+
### Default Value
|
|
977
977
|
`[0,0]`
|
|
978
978
|
|
|
979
|
-
|
|
979
|
+
### Units
|
|
980
980
|
`ems`
|
|
981
981
|
|
|
982
982
|
|
|
983
|
-
|
|
983
|
+
### Requires
|
|
984
984
|
`textField`
|
|
985
985
|
|
|
986
|
-
|
|
986
|
+
### Disabled By
|
|
987
987
|
`textRadialOffset`
|
|
988
988
|
|
|
989
|
-
|
|
989
|
+
### Expression
|
|
990
990
|
|
|
991
991
|
Parameters: `zoom, feature`
|
|
992
992
|
|
|
993
993
|
___
|
|
994
994
|
|
|
995
|
-
|
|
995
|
+
### textAllowOverlap
|
|
996
996
|
Name: `textAllowOverlap`
|
|
997
997
|
|
|
998
|
-
|
|
998
|
+
### Description
|
|
999
999
|
If true, the text will be visible even if it collides with other previously drawn symbols.
|
|
1000
1000
|
|
|
1001
|
-
|
|
1001
|
+
### Type
|
|
1002
1002
|
`boolean`
|
|
1003
|
-
|
|
1003
|
+
### Default Value
|
|
1004
1004
|
`false`
|
|
1005
1005
|
|
|
1006
1006
|
|
|
1007
|
-
|
|
1007
|
+
### Requires
|
|
1008
1008
|
`textField`
|
|
1009
1009
|
|
|
1010
|
-
|
|
1010
|
+
### Expression
|
|
1011
1011
|
|
|
1012
1012
|
Parameters: `zoom`
|
|
1013
1013
|
|
|
1014
1014
|
___
|
|
1015
1015
|
|
|
1016
|
-
|
|
1016
|
+
### textIgnorePlacement
|
|
1017
1017
|
Name: `textIgnorePlacement`
|
|
1018
1018
|
|
|
1019
|
-
|
|
1019
|
+
### Description
|
|
1020
1020
|
If true, other symbols can be visible even if they collide with the text.
|
|
1021
1021
|
|
|
1022
|
-
|
|
1022
|
+
### Type
|
|
1023
1023
|
`boolean`
|
|
1024
|
-
|
|
1024
|
+
### Default Value
|
|
1025
1025
|
`false`
|
|
1026
1026
|
|
|
1027
1027
|
|
|
1028
|
-
|
|
1028
|
+
### Requires
|
|
1029
1029
|
`textField`
|
|
1030
1030
|
|
|
1031
|
-
|
|
1031
|
+
### Expression
|
|
1032
1032
|
|
|
1033
1033
|
Parameters: `zoom`
|
|
1034
1034
|
|
|
1035
1035
|
___
|
|
1036
1036
|
|
|
1037
|
-
|
|
1037
|
+
### textOptional
|
|
1038
1038
|
Name: `textOptional`
|
|
1039
1039
|
|
|
1040
|
-
|
|
1040
|
+
### Description
|
|
1041
1041
|
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
|
|
1042
1042
|
|
|
1043
|
-
|
|
1043
|
+
### Type
|
|
1044
1044
|
`boolean`
|
|
1045
|
-
|
|
1045
|
+
### Default Value
|
|
1046
1046
|
`false`
|
|
1047
1047
|
|
|
1048
1048
|
|
|
1049
|
-
|
|
1049
|
+
### Requires
|
|
1050
1050
|
`textField, iconImage`
|
|
1051
1051
|
|
|
1052
|
-
|
|
1052
|
+
### Expression
|
|
1053
1053
|
|
|
1054
1054
|
Parameters: `zoom`
|
|
1055
1055
|
|
|
1056
1056
|
___
|
|
1057
1057
|
|
|
1058
|
-
|
|
1058
|
+
### visibility
|
|
1059
1059
|
Name: `visibility`
|
|
1060
1060
|
|
|
1061
|
-
|
|
1061
|
+
### Description
|
|
1062
1062
|
Whether this layer is displayed.
|
|
1063
1063
|
|
|
1064
|
-
|
|
1064
|
+
### Type
|
|
1065
1065
|
`enum`
|
|
1066
|
-
|
|
1066
|
+
### Default Value
|
|
1067
1067
|
`visible`
|
|
1068
1068
|
|
|
1069
|
-
|
|
1069
|
+
### Supported Values
|
|
1070
1070
|
**visible** - The layer is shown.<br />
|
|
1071
1071
|
**none** - The layer is not shown.<br />
|
|
1072
1072
|
|
|
@@ -1074,585 +1074,585 @@ Whether this layer is displayed.
|
|
|
1074
1074
|
|
|
1075
1075
|
___
|
|
1076
1076
|
|
|
1077
|
-
|
|
1077
|
+
### iconOpacity
|
|
1078
1078
|
Name: `iconOpacity`
|
|
1079
1079
|
|
|
1080
|
-
|
|
1080
|
+
### Description
|
|
1081
1081
|
The opacity at which the icon will be drawn.
|
|
1082
1082
|
|
|
1083
|
-
|
|
1083
|
+
### Type
|
|
1084
1084
|
`number`
|
|
1085
|
-
|
|
1085
|
+
### Default Value
|
|
1086
1086
|
`1`
|
|
1087
1087
|
|
|
1088
|
-
|
|
1088
|
+
### Minimum
|
|
1089
1089
|
`0`
|
|
1090
1090
|
|
|
1091
1091
|
|
|
1092
|
-
|
|
1092
|
+
### Maximum
|
|
1093
1093
|
`1`
|
|
1094
1094
|
|
|
1095
|
-
|
|
1095
|
+
### Requires
|
|
1096
1096
|
`iconImage`
|
|
1097
1097
|
|
|
1098
|
-
|
|
1098
|
+
### Expression
|
|
1099
1099
|
|
|
1100
1100
|
Parameters: `zoom, feature, feature-state`
|
|
1101
1101
|
___
|
|
1102
1102
|
|
|
1103
|
-
|
|
1103
|
+
### Name
|
|
1104
1104
|
|
|
1105
1105
|
`iconOpacityTransition`
|
|
1106
1106
|
|
|
1107
|
-
|
|
1107
|
+
### Description
|
|
1108
1108
|
|
|
1109
|
-
The transition affecting any changes to this layer’s iconOpacity
|
|
1109
|
+
The transition affecting any changes to this layer’s iconOpacity property.
|
|
1110
1110
|
|
|
1111
|
-
|
|
1111
|
+
### Type
|
|
1112
1112
|
|
|
1113
1113
|
`{ duration, delay }`
|
|
1114
1114
|
|
|
1115
|
-
|
|
1115
|
+
### Units
|
|
1116
1116
|
`milliseconds`
|
|
1117
1117
|
|
|
1118
|
-
|
|
1118
|
+
### Default Value
|
|
1119
1119
|
`{duration: 300, delay: 0}`
|
|
1120
1120
|
|
|
1121
1121
|
|
|
1122
1122
|
___
|
|
1123
1123
|
|
|
1124
|
-
|
|
1124
|
+
### iconColor
|
|
1125
1125
|
Name: `iconColor`
|
|
1126
1126
|
|
|
1127
|
-
|
|
1127
|
+
### Description
|
|
1128
1128
|
The color of the icon. This can only be used with [SDF icons](/help/troubleshooting/usingRecolorableImagesInMapboxMaps/).
|
|
1129
1129
|
|
|
1130
|
-
|
|
1130
|
+
### Type
|
|
1131
1131
|
`color`
|
|
1132
|
-
|
|
1132
|
+
### Default Value
|
|
1133
1133
|
`#000000`
|
|
1134
1134
|
|
|
1135
1135
|
|
|
1136
|
-
|
|
1136
|
+
### Requires
|
|
1137
1137
|
`iconImage`
|
|
1138
1138
|
|
|
1139
|
-
|
|
1139
|
+
### Expression
|
|
1140
1140
|
|
|
1141
1141
|
Parameters: `zoom, feature, feature-state`
|
|
1142
1142
|
___
|
|
1143
1143
|
|
|
1144
|
-
|
|
1144
|
+
### Name
|
|
1145
1145
|
|
|
1146
1146
|
`iconColorTransition`
|
|
1147
1147
|
|
|
1148
|
-
|
|
1148
|
+
### Description
|
|
1149
1149
|
|
|
1150
|
-
The transition affecting any changes to this layer’s iconColor
|
|
1150
|
+
The transition affecting any changes to this layer’s iconColor property.
|
|
1151
1151
|
|
|
1152
|
-
|
|
1152
|
+
### Type
|
|
1153
1153
|
|
|
1154
1154
|
`{ duration, delay }`
|
|
1155
1155
|
|
|
1156
|
-
|
|
1156
|
+
### Units
|
|
1157
1157
|
`milliseconds`
|
|
1158
1158
|
|
|
1159
|
-
|
|
1159
|
+
### Default Value
|
|
1160
1160
|
`{duration: 300, delay: 0}`
|
|
1161
1161
|
|
|
1162
1162
|
|
|
1163
1163
|
___
|
|
1164
1164
|
|
|
1165
|
-
|
|
1165
|
+
### iconHaloColor
|
|
1166
1166
|
Name: `iconHaloColor`
|
|
1167
1167
|
|
|
1168
|
-
|
|
1168
|
+
### Description
|
|
1169
1169
|
The color of the icon's halo. Icon halos can only be used with [SDF icons](/help/troubleshooting/usingRecolorableImagesInMapboxMaps/).
|
|
1170
1170
|
|
|
1171
|
-
|
|
1171
|
+
### Type
|
|
1172
1172
|
`color`
|
|
1173
|
-
|
|
1173
|
+
### Default Value
|
|
1174
1174
|
`rgba(0, 0, 0, 0)`
|
|
1175
1175
|
|
|
1176
1176
|
|
|
1177
|
-
|
|
1177
|
+
### Requires
|
|
1178
1178
|
`iconImage`
|
|
1179
1179
|
|
|
1180
|
-
|
|
1180
|
+
### Expression
|
|
1181
1181
|
|
|
1182
1182
|
Parameters: `zoom, feature, feature-state`
|
|
1183
1183
|
___
|
|
1184
1184
|
|
|
1185
|
-
|
|
1185
|
+
### Name
|
|
1186
1186
|
|
|
1187
1187
|
`iconHaloColorTransition`
|
|
1188
1188
|
|
|
1189
|
-
|
|
1189
|
+
### Description
|
|
1190
1190
|
|
|
1191
|
-
The transition affecting any changes to this layer’s iconHaloColor
|
|
1191
|
+
The transition affecting any changes to this layer’s iconHaloColor property.
|
|
1192
1192
|
|
|
1193
|
-
|
|
1193
|
+
### Type
|
|
1194
1194
|
|
|
1195
1195
|
`{ duration, delay }`
|
|
1196
1196
|
|
|
1197
|
-
|
|
1197
|
+
### Units
|
|
1198
1198
|
`milliseconds`
|
|
1199
1199
|
|
|
1200
|
-
|
|
1200
|
+
### Default Value
|
|
1201
1201
|
`{duration: 300, delay: 0}`
|
|
1202
1202
|
|
|
1203
1203
|
|
|
1204
1204
|
___
|
|
1205
1205
|
|
|
1206
|
-
|
|
1206
|
+
### iconHaloWidth
|
|
1207
1207
|
Name: `iconHaloWidth`
|
|
1208
1208
|
|
|
1209
|
-
|
|
1209
|
+
### Description
|
|
1210
1210
|
Distance of halo to the icon outline.
|
|
1211
1211
|
|
|
1212
|
-
|
|
1212
|
+
### Type
|
|
1213
1213
|
`number`
|
|
1214
|
-
|
|
1214
|
+
### Default Value
|
|
1215
1215
|
`0`
|
|
1216
1216
|
|
|
1217
|
-
|
|
1217
|
+
### Units
|
|
1218
1218
|
`pixels`
|
|
1219
1219
|
|
|
1220
|
-
|
|
1220
|
+
### Minimum
|
|
1221
1221
|
`0`
|
|
1222
1222
|
|
|
1223
1223
|
|
|
1224
|
-
|
|
1224
|
+
### Requires
|
|
1225
1225
|
`iconImage`
|
|
1226
1226
|
|
|
1227
|
-
|
|
1227
|
+
### Expression
|
|
1228
1228
|
|
|
1229
1229
|
Parameters: `zoom, feature, feature-state`
|
|
1230
1230
|
___
|
|
1231
1231
|
|
|
1232
|
-
|
|
1232
|
+
### Name
|
|
1233
1233
|
|
|
1234
1234
|
`iconHaloWidthTransition`
|
|
1235
1235
|
|
|
1236
|
-
|
|
1236
|
+
### Description
|
|
1237
1237
|
|
|
1238
|
-
The transition affecting any changes to this layer’s iconHaloWidth
|
|
1238
|
+
The transition affecting any changes to this layer’s iconHaloWidth property.
|
|
1239
1239
|
|
|
1240
|
-
|
|
1240
|
+
### Type
|
|
1241
1241
|
|
|
1242
1242
|
`{ duration, delay }`
|
|
1243
1243
|
|
|
1244
|
-
|
|
1244
|
+
### Units
|
|
1245
1245
|
`milliseconds`
|
|
1246
1246
|
|
|
1247
|
-
|
|
1247
|
+
### Default Value
|
|
1248
1248
|
`{duration: 300, delay: 0}`
|
|
1249
1249
|
|
|
1250
1250
|
|
|
1251
1251
|
___
|
|
1252
1252
|
|
|
1253
|
-
|
|
1253
|
+
### iconHaloBlur
|
|
1254
1254
|
Name: `iconHaloBlur`
|
|
1255
1255
|
|
|
1256
|
-
|
|
1256
|
+
### Description
|
|
1257
1257
|
Fade out the halo towards the outside.
|
|
1258
1258
|
|
|
1259
|
-
|
|
1259
|
+
### Type
|
|
1260
1260
|
`number`
|
|
1261
|
-
|
|
1261
|
+
### Default Value
|
|
1262
1262
|
`0`
|
|
1263
1263
|
|
|
1264
|
-
|
|
1264
|
+
### Units
|
|
1265
1265
|
`pixels`
|
|
1266
1266
|
|
|
1267
|
-
|
|
1267
|
+
### Minimum
|
|
1268
1268
|
`0`
|
|
1269
1269
|
|
|
1270
1270
|
|
|
1271
|
-
|
|
1271
|
+
### Requires
|
|
1272
1272
|
`iconImage`
|
|
1273
1273
|
|
|
1274
|
-
|
|
1274
|
+
### Expression
|
|
1275
1275
|
|
|
1276
1276
|
Parameters: `zoom, feature, feature-state`
|
|
1277
1277
|
___
|
|
1278
1278
|
|
|
1279
|
-
|
|
1279
|
+
### Name
|
|
1280
1280
|
|
|
1281
1281
|
`iconHaloBlurTransition`
|
|
1282
1282
|
|
|
1283
|
-
|
|
1283
|
+
### Description
|
|
1284
1284
|
|
|
1285
|
-
The transition affecting any changes to this layer’s iconHaloBlur
|
|
1285
|
+
The transition affecting any changes to this layer’s iconHaloBlur property.
|
|
1286
1286
|
|
|
1287
|
-
|
|
1287
|
+
### Type
|
|
1288
1288
|
|
|
1289
1289
|
`{ duration, delay }`
|
|
1290
1290
|
|
|
1291
|
-
|
|
1291
|
+
### Units
|
|
1292
1292
|
`milliseconds`
|
|
1293
1293
|
|
|
1294
|
-
|
|
1294
|
+
### Default Value
|
|
1295
1295
|
`{duration: 300, delay: 0}`
|
|
1296
1296
|
|
|
1297
1297
|
|
|
1298
1298
|
___
|
|
1299
1299
|
|
|
1300
|
-
|
|
1300
|
+
### iconTranslate
|
|
1301
1301
|
Name: `iconTranslate`
|
|
1302
1302
|
|
|
1303
|
-
|
|
1303
|
+
### Description
|
|
1304
1304
|
Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
|
|
1305
1305
|
|
|
1306
|
-
|
|
1306
|
+
### Type
|
|
1307
1307
|
`array<number>`
|
|
1308
|
-
|
|
1308
|
+
### Default Value
|
|
1309
1309
|
`[0,0]`
|
|
1310
1310
|
|
|
1311
|
-
|
|
1311
|
+
### Units
|
|
1312
1312
|
`pixels`
|
|
1313
1313
|
|
|
1314
1314
|
|
|
1315
|
-
|
|
1315
|
+
### Requires
|
|
1316
1316
|
`iconImage`
|
|
1317
1317
|
|
|
1318
|
-
|
|
1318
|
+
### Expression
|
|
1319
1319
|
|
|
1320
1320
|
Parameters: `zoom`
|
|
1321
1321
|
___
|
|
1322
1322
|
|
|
1323
|
-
|
|
1323
|
+
### Name
|
|
1324
1324
|
|
|
1325
1325
|
`iconTranslateTransition`
|
|
1326
1326
|
|
|
1327
|
-
|
|
1327
|
+
### Description
|
|
1328
1328
|
|
|
1329
|
-
The transition affecting any changes to this layer’s iconTranslate
|
|
1329
|
+
The transition affecting any changes to this layer’s iconTranslate property.
|
|
1330
1330
|
|
|
1331
|
-
|
|
1331
|
+
### Type
|
|
1332
1332
|
|
|
1333
1333
|
`{ duration, delay }`
|
|
1334
1334
|
|
|
1335
|
-
|
|
1335
|
+
### Units
|
|
1336
1336
|
`milliseconds`
|
|
1337
1337
|
|
|
1338
|
-
|
|
1338
|
+
### Default Value
|
|
1339
1339
|
`{duration: 300, delay: 0}`
|
|
1340
1340
|
|
|
1341
1341
|
|
|
1342
1342
|
___
|
|
1343
1343
|
|
|
1344
|
-
|
|
1344
|
+
### iconTranslateAnchor
|
|
1345
1345
|
Name: `iconTranslateAnchor`
|
|
1346
1346
|
|
|
1347
|
-
|
|
1347
|
+
### Description
|
|
1348
1348
|
Controls the frame of reference for `iconTranslate`.
|
|
1349
1349
|
|
|
1350
|
-
|
|
1350
|
+
### Type
|
|
1351
1351
|
`enum`
|
|
1352
|
-
|
|
1352
|
+
### Default Value
|
|
1353
1353
|
`map`
|
|
1354
1354
|
|
|
1355
|
-
|
|
1355
|
+
### Supported Values
|
|
1356
1356
|
**map** - Icons are translated relative to the map.<br />
|
|
1357
1357
|
**viewport** - Icons are translated relative to the viewport.<br />
|
|
1358
1358
|
|
|
1359
1359
|
|
|
1360
|
-
|
|
1360
|
+
### Requires
|
|
1361
1361
|
`iconImage, iconTranslate`
|
|
1362
1362
|
|
|
1363
|
-
|
|
1363
|
+
### Expression
|
|
1364
1364
|
|
|
1365
1365
|
Parameters: `zoom`
|
|
1366
1366
|
|
|
1367
1367
|
___
|
|
1368
1368
|
|
|
1369
|
-
|
|
1369
|
+
### textOpacity
|
|
1370
1370
|
Name: `textOpacity`
|
|
1371
1371
|
|
|
1372
|
-
|
|
1372
|
+
### Description
|
|
1373
1373
|
The opacity at which the text will be drawn.
|
|
1374
1374
|
|
|
1375
|
-
|
|
1375
|
+
### Type
|
|
1376
1376
|
`number`
|
|
1377
|
-
|
|
1377
|
+
### Default Value
|
|
1378
1378
|
`1`
|
|
1379
1379
|
|
|
1380
|
-
|
|
1380
|
+
### Minimum
|
|
1381
1381
|
`0`
|
|
1382
1382
|
|
|
1383
1383
|
|
|
1384
|
-
|
|
1384
|
+
### Maximum
|
|
1385
1385
|
`1`
|
|
1386
1386
|
|
|
1387
|
-
|
|
1387
|
+
### Requires
|
|
1388
1388
|
`textField`
|
|
1389
1389
|
|
|
1390
|
-
|
|
1390
|
+
### Expression
|
|
1391
1391
|
|
|
1392
1392
|
Parameters: `zoom, feature, feature-state`
|
|
1393
1393
|
___
|
|
1394
1394
|
|
|
1395
|
-
|
|
1395
|
+
### Name
|
|
1396
1396
|
|
|
1397
1397
|
`textOpacityTransition`
|
|
1398
1398
|
|
|
1399
|
-
|
|
1399
|
+
### Description
|
|
1400
1400
|
|
|
1401
|
-
The transition affecting any changes to this layer’s textOpacity
|
|
1401
|
+
The transition affecting any changes to this layer’s textOpacity property.
|
|
1402
1402
|
|
|
1403
|
-
|
|
1403
|
+
### Type
|
|
1404
1404
|
|
|
1405
1405
|
`{ duration, delay }`
|
|
1406
1406
|
|
|
1407
|
-
|
|
1407
|
+
### Units
|
|
1408
1408
|
`milliseconds`
|
|
1409
1409
|
|
|
1410
|
-
|
|
1410
|
+
### Default Value
|
|
1411
1411
|
`{duration: 300, delay: 0}`
|
|
1412
1412
|
|
|
1413
1413
|
|
|
1414
1414
|
___
|
|
1415
1415
|
|
|
1416
|
-
|
|
1416
|
+
### textColor
|
|
1417
1417
|
Name: `textColor`
|
|
1418
1418
|
|
|
1419
|
-
|
|
1419
|
+
### Description
|
|
1420
1420
|
The color with which the text will be drawn.
|
|
1421
1421
|
|
|
1422
|
-
|
|
1422
|
+
### Type
|
|
1423
1423
|
`color`
|
|
1424
|
-
|
|
1424
|
+
### Default Value
|
|
1425
1425
|
`#000000`
|
|
1426
1426
|
|
|
1427
1427
|
|
|
1428
|
-
|
|
1428
|
+
### Requires
|
|
1429
1429
|
`textField`
|
|
1430
1430
|
|
|
1431
|
-
|
|
1431
|
+
### Expression
|
|
1432
1432
|
|
|
1433
1433
|
Parameters: `zoom, feature, feature-state`
|
|
1434
1434
|
___
|
|
1435
1435
|
|
|
1436
|
-
|
|
1436
|
+
### Name
|
|
1437
1437
|
|
|
1438
1438
|
`textColorTransition`
|
|
1439
1439
|
|
|
1440
|
-
|
|
1440
|
+
### Description
|
|
1441
1441
|
|
|
1442
|
-
The transition affecting any changes to this layer’s textColor
|
|
1442
|
+
The transition affecting any changes to this layer’s textColor property.
|
|
1443
1443
|
|
|
1444
|
-
|
|
1444
|
+
### Type
|
|
1445
1445
|
|
|
1446
1446
|
`{ duration, delay }`
|
|
1447
1447
|
|
|
1448
|
-
|
|
1448
|
+
### Units
|
|
1449
1449
|
`milliseconds`
|
|
1450
1450
|
|
|
1451
|
-
|
|
1451
|
+
### Default Value
|
|
1452
1452
|
`{duration: 300, delay: 0}`
|
|
1453
1453
|
|
|
1454
1454
|
|
|
1455
1455
|
___
|
|
1456
1456
|
|
|
1457
|
-
|
|
1457
|
+
### textHaloColor
|
|
1458
1458
|
Name: `textHaloColor`
|
|
1459
1459
|
|
|
1460
|
-
|
|
1460
|
+
### Description
|
|
1461
1461
|
The color of the text's halo, which helps it stand out from backgrounds.
|
|
1462
1462
|
|
|
1463
|
-
|
|
1463
|
+
### Type
|
|
1464
1464
|
`color`
|
|
1465
|
-
|
|
1465
|
+
### Default Value
|
|
1466
1466
|
`rgba(0, 0, 0, 0)`
|
|
1467
1467
|
|
|
1468
1468
|
|
|
1469
|
-
|
|
1469
|
+
### Requires
|
|
1470
1470
|
`textField`
|
|
1471
1471
|
|
|
1472
|
-
|
|
1472
|
+
### Expression
|
|
1473
1473
|
|
|
1474
1474
|
Parameters: `zoom, feature, feature-state`
|
|
1475
1475
|
___
|
|
1476
1476
|
|
|
1477
|
-
|
|
1477
|
+
### Name
|
|
1478
1478
|
|
|
1479
1479
|
`textHaloColorTransition`
|
|
1480
1480
|
|
|
1481
|
-
|
|
1481
|
+
### Description
|
|
1482
1482
|
|
|
1483
|
-
The transition affecting any changes to this layer’s textHaloColor
|
|
1483
|
+
The transition affecting any changes to this layer’s textHaloColor property.
|
|
1484
1484
|
|
|
1485
|
-
|
|
1485
|
+
### Type
|
|
1486
1486
|
|
|
1487
1487
|
`{ duration, delay }`
|
|
1488
1488
|
|
|
1489
|
-
|
|
1489
|
+
### Units
|
|
1490
1490
|
`milliseconds`
|
|
1491
1491
|
|
|
1492
|
-
|
|
1492
|
+
### Default Value
|
|
1493
1493
|
`{duration: 300, delay: 0}`
|
|
1494
1494
|
|
|
1495
1495
|
|
|
1496
1496
|
___
|
|
1497
1497
|
|
|
1498
|
-
|
|
1498
|
+
### textHaloWidth
|
|
1499
1499
|
Name: `textHaloWidth`
|
|
1500
1500
|
|
|
1501
|
-
|
|
1501
|
+
### Description
|
|
1502
1502
|
Distance of halo to the font outline. Max text halo width is 1/4 of the fontSize.
|
|
1503
1503
|
|
|
1504
|
-
|
|
1504
|
+
### Type
|
|
1505
1505
|
`number`
|
|
1506
|
-
|
|
1506
|
+
### Default Value
|
|
1507
1507
|
`0`
|
|
1508
1508
|
|
|
1509
|
-
|
|
1509
|
+
### Units
|
|
1510
1510
|
`pixels`
|
|
1511
1511
|
|
|
1512
|
-
|
|
1512
|
+
### Minimum
|
|
1513
1513
|
`0`
|
|
1514
1514
|
|
|
1515
1515
|
|
|
1516
|
-
|
|
1516
|
+
### Requires
|
|
1517
1517
|
`textField`
|
|
1518
1518
|
|
|
1519
|
-
|
|
1519
|
+
### Expression
|
|
1520
1520
|
|
|
1521
1521
|
Parameters: `zoom, feature, feature-state`
|
|
1522
1522
|
___
|
|
1523
1523
|
|
|
1524
|
-
|
|
1524
|
+
### Name
|
|
1525
1525
|
|
|
1526
1526
|
`textHaloWidthTransition`
|
|
1527
1527
|
|
|
1528
|
-
|
|
1528
|
+
### Description
|
|
1529
1529
|
|
|
1530
|
-
The transition affecting any changes to this layer’s textHaloWidth
|
|
1530
|
+
The transition affecting any changes to this layer’s textHaloWidth property.
|
|
1531
1531
|
|
|
1532
|
-
|
|
1532
|
+
### Type
|
|
1533
1533
|
|
|
1534
1534
|
`{ duration, delay }`
|
|
1535
1535
|
|
|
1536
|
-
|
|
1536
|
+
### Units
|
|
1537
1537
|
`milliseconds`
|
|
1538
1538
|
|
|
1539
|
-
|
|
1539
|
+
### Default Value
|
|
1540
1540
|
`{duration: 300, delay: 0}`
|
|
1541
1541
|
|
|
1542
1542
|
|
|
1543
1543
|
___
|
|
1544
1544
|
|
|
1545
|
-
|
|
1545
|
+
### textHaloBlur
|
|
1546
1546
|
Name: `textHaloBlur`
|
|
1547
1547
|
|
|
1548
|
-
|
|
1548
|
+
### Description
|
|
1549
1549
|
The halo's fadeout distance towards the outside.
|
|
1550
1550
|
|
|
1551
|
-
|
|
1551
|
+
### Type
|
|
1552
1552
|
`number`
|
|
1553
|
-
|
|
1553
|
+
### Default Value
|
|
1554
1554
|
`0`
|
|
1555
1555
|
|
|
1556
|
-
|
|
1556
|
+
### Units
|
|
1557
1557
|
`pixels`
|
|
1558
1558
|
|
|
1559
|
-
|
|
1559
|
+
### Minimum
|
|
1560
1560
|
`0`
|
|
1561
1561
|
|
|
1562
1562
|
|
|
1563
|
-
|
|
1563
|
+
### Requires
|
|
1564
1564
|
`textField`
|
|
1565
1565
|
|
|
1566
|
-
|
|
1566
|
+
### Expression
|
|
1567
1567
|
|
|
1568
1568
|
Parameters: `zoom, feature, feature-state`
|
|
1569
1569
|
___
|
|
1570
1570
|
|
|
1571
|
-
|
|
1571
|
+
### Name
|
|
1572
1572
|
|
|
1573
1573
|
`textHaloBlurTransition`
|
|
1574
1574
|
|
|
1575
|
-
|
|
1575
|
+
### Description
|
|
1576
1576
|
|
|
1577
|
-
The transition affecting any changes to this layer’s textHaloBlur
|
|
1577
|
+
The transition affecting any changes to this layer’s textHaloBlur property.
|
|
1578
1578
|
|
|
1579
|
-
|
|
1579
|
+
### Type
|
|
1580
1580
|
|
|
1581
1581
|
`{ duration, delay }`
|
|
1582
1582
|
|
|
1583
|
-
|
|
1583
|
+
### Units
|
|
1584
1584
|
`milliseconds`
|
|
1585
1585
|
|
|
1586
|
-
|
|
1586
|
+
### Default Value
|
|
1587
1587
|
`{duration: 300, delay: 0}`
|
|
1588
1588
|
|
|
1589
1589
|
|
|
1590
1590
|
___
|
|
1591
1591
|
|
|
1592
|
-
|
|
1592
|
+
### textTranslate
|
|
1593
1593
|
Name: `textTranslate`
|
|
1594
1594
|
|
|
1595
|
-
|
|
1595
|
+
### Description
|
|
1596
1596
|
Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
|
|
1597
1597
|
|
|
1598
|
-
|
|
1598
|
+
### Type
|
|
1599
1599
|
`array<number>`
|
|
1600
|
-
|
|
1600
|
+
### Default Value
|
|
1601
1601
|
`[0,0]`
|
|
1602
1602
|
|
|
1603
|
-
|
|
1603
|
+
### Units
|
|
1604
1604
|
`pixels`
|
|
1605
1605
|
|
|
1606
1606
|
|
|
1607
|
-
|
|
1607
|
+
### Requires
|
|
1608
1608
|
`textField`
|
|
1609
1609
|
|
|
1610
|
-
|
|
1610
|
+
### Expression
|
|
1611
1611
|
|
|
1612
1612
|
Parameters: `zoom`
|
|
1613
1613
|
___
|
|
1614
1614
|
|
|
1615
|
-
|
|
1615
|
+
### Name
|
|
1616
1616
|
|
|
1617
1617
|
`textTranslateTransition`
|
|
1618
1618
|
|
|
1619
|
-
|
|
1619
|
+
### Description
|
|
1620
1620
|
|
|
1621
|
-
The transition affecting any changes to this layer’s textTranslate
|
|
1621
|
+
The transition affecting any changes to this layer’s textTranslate property.
|
|
1622
1622
|
|
|
1623
|
-
|
|
1623
|
+
### Type
|
|
1624
1624
|
|
|
1625
1625
|
`{ duration, delay }`
|
|
1626
1626
|
|
|
1627
|
-
|
|
1627
|
+
### Units
|
|
1628
1628
|
`milliseconds`
|
|
1629
1629
|
|
|
1630
|
-
|
|
1630
|
+
### Default Value
|
|
1631
1631
|
`{duration: 300, delay: 0}`
|
|
1632
1632
|
|
|
1633
1633
|
|
|
1634
1634
|
___
|
|
1635
1635
|
|
|
1636
|
-
|
|
1636
|
+
### textTranslateAnchor
|
|
1637
1637
|
Name: `textTranslateAnchor`
|
|
1638
1638
|
|
|
1639
|
-
|
|
1639
|
+
### Description
|
|
1640
1640
|
Controls the frame of reference for `textTranslate`.
|
|
1641
1641
|
|
|
1642
|
-
|
|
1642
|
+
### Type
|
|
1643
1643
|
`enum`
|
|
1644
|
-
|
|
1644
|
+
### Default Value
|
|
1645
1645
|
`map`
|
|
1646
1646
|
|
|
1647
|
-
|
|
1647
|
+
### Supported Values
|
|
1648
1648
|
**map** - The text is translated relative to the map.<br />
|
|
1649
1649
|
**viewport** - The text is translated relative to the viewport.<br />
|
|
1650
1650
|
|
|
1651
1651
|
|
|
1652
|
-
|
|
1652
|
+
### Requires
|
|
1653
1653
|
`textField, textTranslate`
|
|
1654
1654
|
|
|
1655
|
-
|
|
1655
|
+
### Expression
|
|
1656
1656
|
|
|
1657
1657
|
Parameters: `zoom`
|
|
1658
1658
|
|