@maplibre/maplibre-react-native 10.0.0-alpha.25 → 10.0.0-alpha.27
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/CHANGELOG.md +10 -0
- package/android/build.gradle +51 -16
- package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleFactory.java +1 -1
- package/docs/Annotation.md +7 -7
- package/docs/BackgroundLayer.md +135 -128
- package/docs/Callout.md +4 -4
- package/docs/Camera.md +15 -15
- package/docs/CircleLayer.md +412 -388
- package/docs/FillExtrusionLayer.md +302 -292
- package/docs/FillLayer.md +265 -251
- package/docs/HeadingIndicator.md +4 -4
- package/docs/HeatmapLayer.md +178 -172
- package/docs/ImageSource.md +4 -4
- package/docs/Images.md +4 -4
- package/docs/Light.md +130 -123
- package/docs/LineLayer.md +524 -498
- package/docs/MapView.md +22 -42
- package/docs/MarkerView.md +4 -4
- package/docs/NativeUserLocation.md +4 -4
- package/docs/PointAnnotation.md +6 -10
- package/docs/RasterLayer.md +317 -310
- package/docs/RasterSource.md +4 -4
- package/docs/ShapeSource.md +15 -15
- package/docs/Style.md +4 -4
- package/docs/SymbolLayer.md +1500 -1406
- package/docs/UserLocation.md +9 -13
- package/docs/VectorSource.md +9 -9
- package/docs/coordinates.md +3 -3
- package/docs/location.md +3 -3
- package/docs/offlineManager.md +28 -44
- package/docs/snapshotManager.md +6 -6
- package/ios/RCTMLN/RCTMLNStyle.h +1 -1
- package/ios/RCTMLN/RCTMLNStyle.m +1 -1
- package/javascript/utils/MaplibreStyles.d.ts +3 -1
- package/javascript/utils/index.ts +8 -7
- package/javascript/utils/styleMap.ts +1 -1
- package/package.json +10 -17
- package/scripts/codegen.ts +12 -9
- package/scripts/templates/MaplibreStyles.ts.ejs +3 -1
- package/scripts/templates/RCTMLNStyle.h.ejs +2 -2
- package/scripts/templates/RCTMLNStyle.m.ejs +2 -2
- package/scripts/templates/RCTMLNStyleFactory.java.ejs +2 -2
- package/scripts/templates/component.md.ejs +83 -82
- package/scripts/templates/styleMap.ts.ejs +2 -2
- package/scripts/utils/MarkdownBuilder.ts +4 -4
- package/scripts/utils/TemplateHelpers.ts +7 -1
- package/scripts/utils/getNativeVersion.ts +1 -1
- package/.husky/pre-commit +0 -5
- package/android/rctmln/.settings/org.eclipse.buildship.core.prefs +0 -2
- package/android/rctmln/build.gradle +0 -64
- package/android/rctmln/proguard-rules.pro +0 -25
- package/ios/RCTMLN/index.d.ts +0 -1183
- package/react-native.config.js +0 -10
- package/scripts/templates/index.d.ts.ejs +0 -86
- /package/android/{rctmln/src → src}/main/AndroidManifest.xml +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/RCTMLNPackage.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/AbstractEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/AbstractEventEmitter.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/AbstractMapFeature.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/MarkerView.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/MarkerViewManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNCallout.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNCalloutManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNMarkerView.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNMarkerViewManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNPointAnnotation.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/annotation/RCTMLNPointAnnotationManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/CameraStop.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/CameraUpdateItem.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/CameraUpdateQueue.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/RCTMLNCamera.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/RCTMLNCameraManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/camera/constants/CameraMode.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/images/RCTMLNImages.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/images/RCTMLNImagesManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/location/LocationComponentManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/location/RCTMLNNativeUserLocation.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/location/RCTMLNNativeUserLocationManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/LayerSourceInfo.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNAndroidTextureMapView.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNAndroidTextureMapViewManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNMapView.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/RCTMLNMapViewManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/mapview/helpers/CameraChangeTracker.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyle.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleFunctionParser.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleValue.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTLayer.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNBackgroundLayer.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNBackgroundLayerManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNCircleLayer.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNCircleLayerManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillExtrusionLayer.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillExtrusionLayerManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillLayer.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNFillLayerManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNHeatmapLayer.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNHeatmapLayerManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNLineLayer.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNLineLayerManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNRasterLayer.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNRasterLayerManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNSymbolLayer.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/layers/RCTMLNSymbolLayerManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/light/RCTMLNLight.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/light/RCTMLNLightManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNImageSource.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNImageSourceManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNRasterSource.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNRasterSourceManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNShapeSource.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNShapeSourceManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNTileSource.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNTileSourceManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNVectorSource.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTMLNVectorSourceManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/components/styles/sources/RCTSource.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/AbstractEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/AndroidCallbackEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/EventEmitter.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/FeatureClickEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/IEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/ImageMissingEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/LocationEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/MapChangeEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/MapClickEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/MapUserTrackingModeEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/OfflineEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/PointAnnotationClickEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/PointAnnotationDragEvent.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/constants/EventKeys.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/events/constants/EventTypes.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/http/CustomHeadersInterceptor.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/LocationManager.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserLocation.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserLocationVerticalAlignment.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserTrackingMode.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/location/UserTrackingState.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNLocationModule.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNLogging.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNModule.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNOfflineModule.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/modules/RCTMLNSnapshotModule.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/BitmapUtils.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ClusterPropertyEntry.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ConvertUtils.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/DownloadMapImageTask.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ExpressionParser.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/GeoJSONUtils.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/GeoViewport.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ImageEntry.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/ResourceUtils.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/SimpleEventCallback.java +0 -0
- /package/android/{rctmln/src → src}/main/java/com/maplibre/rctmln/utils/SphericalMercator.java +0 -0
- /package/android/{rctmln/src → src}/main/res/drawable/empty.xml +0 -0
- /package/android/{rctmln/src → src}/main/res/drawable/empty_drawable.png +0 -0
- /package/android/{rctmln/src → src}/main/res/drawable-xxhdpi/red_marker.png +0 -0
- /package/android/{rctmln/src → src}/main/res/layout/annotation.xml +0 -0
- /package/android/{rctmln/src → src}/main/res/values/strings.xml +0 -0
package/docs/SymbolLayer.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
<!-- DO NOT MODIFY
|
|
1
|
+
<!-- DO NOT MODIFY -->
|
|
2
2
|
<!-- This file is auto-generated from javascript/components/SymbolLayer.tsx -->
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
# `<MapLibreGL.SymbolLayer />`
|
|
4
|
+
SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
## Props
|
|
7
7
|
| Prop | Type | Default | Required | Description |
|
|
8
8
|
| ---- | :--: | :-----: | :------: | :----------: |
|
|
9
9
|
| style | `SymbolLayerStyleProps` | `none` | `false` | Customizable style attributes |
|
|
@@ -11,1648 +11,1742 @@
|
|
|
11
11
|
| sourceID | `FIX ME UNKNOWN TYPE` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | FIX ME NO DESCRIPTION |
|
|
12
12
|
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
* <a href="#name"
|
|
17
|
-
* <a href="#name-1"
|
|
18
|
-
* <a href="#name-2"
|
|
19
|
-
* <a href="#name-3"
|
|
20
|
-
* <a href="#name-4"
|
|
21
|
-
* <a href="#name-5"
|
|
22
|
-
* <a href="#name-6"
|
|
23
|
-
* <a href="#name-7"
|
|
24
|
-
* <a href="#name-8"
|
|
25
|
-
* <a href="#name-9"
|
|
26
|
-
* <a href="#name-10"
|
|
27
|
-
* <a href="#name-11"
|
|
28
|
-
* <a href="#name-12"
|
|
29
|
-
* <a href="#name-13"
|
|
30
|
-
* <a href="#name-14"
|
|
31
|
-
* <a href="#name-15"
|
|
32
|
-
* <a href="#name-16"
|
|
33
|
-
* <a href="#name-17"
|
|
34
|
-
* <a href="#name-18"
|
|
35
|
-
* <a href="#name-19"
|
|
36
|
-
* <a href="#name-20"
|
|
37
|
-
* <a href="#name-21"
|
|
38
|
-
* <a href="#name-22"
|
|
39
|
-
* <a href="#name-23"
|
|
40
|
-
* <a href="#name-24"
|
|
41
|
-
* <a href="#name-25"
|
|
42
|
-
* <a href="#name-26"
|
|
43
|
-
* <a href="#name-27"
|
|
44
|
-
* <a href="#name-28"
|
|
45
|
-
* <a href="#name-29"
|
|
46
|
-
* <a href="#name-30"
|
|
47
|
-
* <a href="#name-31"
|
|
48
|
-
* <a href="#name-32"
|
|
49
|
-
* <a href="#name-33"
|
|
50
|
-
* <a href="#name-34"
|
|
51
|
-
* <a href="#name-35"
|
|
52
|
-
* <a href="#name-36"
|
|
53
|
-
* <a href="#name-37"
|
|
54
|
-
* <a href="#name-38"
|
|
55
|
-
* <a href="#name-39"
|
|
56
|
-
* <a href="#name-40"
|
|
57
|
-
* <a href="#name-41"
|
|
58
|
-
* <a href="#name-42"
|
|
59
|
-
* <a href="#name-43"
|
|
60
|
-
* <a href="#name-44"
|
|
61
|
-
* <a href="#name-45"
|
|
62
|
-
* <a href="#name-46"
|
|
63
|
-
* <a href="#name-47"
|
|
64
|
-
* <a href="#name-48"
|
|
65
|
-
* <a href="#name-49"
|
|
66
|
-
* <a href="#name-50"
|
|
67
|
-
* <a href="#name-51"
|
|
68
|
-
* <a href="#name-52"
|
|
69
|
-
* <a href="#name-53"
|
|
70
|
-
* <a href="#name-54"
|
|
71
|
-
* <a href="#name-55"
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
#### Name
|
|
76
|
-
`symbolPlacement`
|
|
77
|
-
|
|
78
|
-
#### Description
|
|
79
|
-
Label placement relative to its geometry.
|
|
80
|
-
|
|
81
|
-
#### Type
|
|
82
|
-
`enum`
|
|
83
|
-
#### Default Value
|
|
84
|
-
`point`
|
|
85
|
-
|
|
86
|
-
#### Supported Values
|
|
87
|
-
**point** - The label is placed at the point where the geometry is located.<br />
|
|
88
|
-
**line** - The label is placed along the line of the geometry. Can only be used on `LineString` and `Polygon` geometries.<br />
|
|
89
|
-
**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 />
|
|
90
|
-
|
|
14
|
+
## Styles
|
|
15
|
+
|
|
16
|
+
* <a href="#name">`symbolPlacement`</a><br/>
|
|
17
|
+
* <a href="#name-1">`symbolSpacing`</a><br/>
|
|
18
|
+
* <a href="#name-2">`symbolAvoidEdges`</a><br/>
|
|
19
|
+
* <a href="#name-3">`symbolSortKey`</a><br/>
|
|
20
|
+
* <a href="#name-4">`symbolZOrder`</a><br/>
|
|
21
|
+
* <a href="#name-5">`iconAllowOverlap`</a><br/>
|
|
22
|
+
* <a href="#name-6">`iconIgnorePlacement`</a><br/>
|
|
23
|
+
* <a href="#name-7">`iconOptional`</a><br/>
|
|
24
|
+
* <a href="#name-8">`iconRotationAlignment`</a><br/>
|
|
25
|
+
* <a href="#name-9">`iconSize`</a><br/>
|
|
26
|
+
* <a href="#name-10">`iconTextFit`</a><br/>
|
|
27
|
+
* <a href="#name-11">`iconTextFitPadding`</a><br/>
|
|
28
|
+
* <a href="#name-12">`iconImage`</a><br/>
|
|
29
|
+
* <a href="#name-13">`iconRotate`</a><br/>
|
|
30
|
+
* <a href="#name-14">`iconPadding`</a><br/>
|
|
31
|
+
* <a href="#name-15">`iconKeepUpright`</a><br/>
|
|
32
|
+
* <a href="#name-16">`iconOffset`</a><br/>
|
|
33
|
+
* <a href="#name-17">`iconAnchor`</a><br/>
|
|
34
|
+
* <a href="#name-18">`iconPitchAlignment`</a><br/>
|
|
35
|
+
* <a href="#name-19">`textPitchAlignment`</a><br/>
|
|
36
|
+
* <a href="#name-20">`textRotationAlignment`</a><br/>
|
|
37
|
+
* <a href="#name-21">`textField`</a><br/>
|
|
38
|
+
* <a href="#name-22">`textFont`</a><br/>
|
|
39
|
+
* <a href="#name-23">`textSize`</a><br/>
|
|
40
|
+
* <a href="#name-24">`textMaxWidth`</a><br/>
|
|
41
|
+
* <a href="#name-25">`textLineHeight`</a><br/>
|
|
42
|
+
* <a href="#name-26">`textLetterSpacing`</a><br/>
|
|
43
|
+
* <a href="#name-27">`textJustify`</a><br/>
|
|
44
|
+
* <a href="#name-28">`textRadialOffset`</a><br/>
|
|
45
|
+
* <a href="#name-29">`textVariableAnchor`</a><br/>
|
|
46
|
+
* <a href="#name-30">`textAnchor`</a><br/>
|
|
47
|
+
* <a href="#name-31">`textMaxAngle`</a><br/>
|
|
48
|
+
* <a href="#name-32">`textWritingMode`</a><br/>
|
|
49
|
+
* <a href="#name-33">`textRotate`</a><br/>
|
|
50
|
+
* <a href="#name-34">`textPadding`</a><br/>
|
|
51
|
+
* <a href="#name-35">`textKeepUpright`</a><br/>
|
|
52
|
+
* <a href="#name-36">`textTransform`</a><br/>
|
|
53
|
+
* <a href="#name-37">`textOffset`</a><br/>
|
|
54
|
+
* <a href="#name-38">`textAllowOverlap`</a><br/>
|
|
55
|
+
* <a href="#name-39">`textIgnorePlacement`</a><br/>
|
|
56
|
+
* <a href="#name-40">`textOptional`</a><br/>
|
|
57
|
+
* <a href="#name-41">`visibility`</a><br/>
|
|
58
|
+
* <a href="#name-42">`iconOpacity`</a><br/>
|
|
59
|
+
* <a href="#name-43">`iconColor`</a><br/>
|
|
60
|
+
* <a href="#name-44">`iconHaloColor`</a><br/>
|
|
61
|
+
* <a href="#name-45">`iconHaloWidth`</a><br/>
|
|
62
|
+
* <a href="#name-46">`iconHaloBlur`</a><br/>
|
|
63
|
+
* <a href="#name-47">`iconTranslate`</a><br/>
|
|
64
|
+
* <a href="#name-48">`iconTranslateAnchor`</a><br/>
|
|
65
|
+
* <a href="#name-49">`textOpacity`</a><br/>
|
|
66
|
+
* <a href="#name-50">`textColor`</a><br/>
|
|
67
|
+
* <a href="#name-51">`textHaloColor`</a><br/>
|
|
68
|
+
* <a href="#name-52">`textHaloWidth`</a><br/>
|
|
69
|
+
* <a href="#name-53">`textHaloBlur`</a><br/>
|
|
70
|
+
* <a href="#name-54">`textTranslate`</a><br/>
|
|
71
|
+
* <a href="#name-55">`textTranslateAnchor`</a><br/>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### `symbolPlacement`
|
|
91
75
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
Parameters: `zoom`
|
|
95
|
-
|
|
96
|
-
___
|
|
76
|
+
Label placement relative to its geometry.
|
|
97
77
|
|
|
98
|
-
|
|
99
|
-
|
|
78
|
+
<dl>
|
|
79
|
+
<dt>Type</dt>
|
|
80
|
+
<dd>
|
|
81
|
+
<code>enum</code>
|
|
82
|
+
</dd>
|
|
83
|
+
<dt>Default Value</dt>
|
|
84
|
+
<dd><code>point</code></dd>
|
|
85
|
+
<dt>Supported Values</dt>
|
|
86
|
+
<dd>
|
|
87
|
+
<ul>
|
|
88
|
+
<li>
|
|
89
|
+
<code>point</code>: The label is placed at the point where the geometry is located.
|
|
90
|
+
</li>
|
|
91
|
+
<li>
|
|
92
|
+
<code>line</code>: The label is placed along the line of the geometry. Can only be used on `LineString` and `Polygon` geometries.
|
|
93
|
+
</li>
|
|
94
|
+
<li>
|
|
95
|
+
<code>line-center</code>: 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.
|
|
96
|
+
</li>
|
|
97
|
+
</ul>
|
|
98
|
+
</dd>
|
|
99
|
+
<dt>Expression Parameters</dt>
|
|
100
|
+
<dd><code>zoom</code></dd>
|
|
101
|
+
</dl>
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### `symbolSpacing`
|
|
100
106
|
|
|
101
|
-
#### Description
|
|
102
107
|
Distance between two symbol anchors.
|
|
103
108
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
109
|
+
<dl>
|
|
110
|
+
<dt>Type</dt>
|
|
111
|
+
<dd>
|
|
112
|
+
<code>number</code>
|
|
113
|
+
</dd>
|
|
114
|
+
<dt>Default Value</dt>
|
|
115
|
+
<dd><code>250</code></dd>
|
|
116
|
+
</ul>
|
|
117
|
+
</dd>
|
|
118
|
+
<dt>Units</dt>
|
|
119
|
+
<dd><code>pixels</code></dd>
|
|
120
|
+
<dt>Minimum</dt>
|
|
121
|
+
<dd><code>1</code></dd>
|
|
122
|
+
<dt>Expression Parameters</dt>
|
|
123
|
+
<dd><code>zoom</code></dd>
|
|
124
|
+
</dl>
|
|
108
125
|
|
|
109
|
-
#### Units
|
|
110
|
-
`pixels`
|
|
111
126
|
|
|
112
|
-
#### Minimum
|
|
113
|
-
`1`
|
|
114
127
|
|
|
128
|
+
### `symbolAvoidEdges`
|
|
115
129
|
|
|
116
|
-
#### Expression
|
|
117
|
-
|
|
118
|
-
Parameters: `zoom`
|
|
119
|
-
|
|
120
|
-
___
|
|
121
|
-
|
|
122
|
-
#### Name
|
|
123
|
-
`symbolAvoidEdges`
|
|
124
|
-
|
|
125
|
-
#### Description
|
|
126
130
|
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 MapLibre GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
|
|
127
131
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
132
|
+
<dl>
|
|
133
|
+
<dt>Type</dt>
|
|
134
|
+
<dd>
|
|
135
|
+
<code>boolean</code>
|
|
136
|
+
</dd>
|
|
137
|
+
<dt>Default Value</dt>
|
|
138
|
+
<dd><code>false</code></dd>
|
|
139
|
+
</ul>
|
|
140
|
+
</dd>
|
|
141
|
+
<dt>Expression Parameters</dt>
|
|
142
|
+
<dd><code>zoom</code></dd>
|
|
143
|
+
</dl>
|
|
135
144
|
|
|
136
|
-
Parameters: `zoom`
|
|
137
145
|
|
|
138
|
-
___
|
|
139
146
|
|
|
140
|
-
|
|
141
|
-
`symbolSortKey`
|
|
147
|
+
### `symbolSortKey`
|
|
142
148
|
|
|
143
|
-
#### Description
|
|
144
149
|
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.
|
|
145
150
|
|
|
146
|
-
|
|
147
|
-
|
|
151
|
+
<dl>
|
|
152
|
+
<dt>Type</dt>
|
|
153
|
+
<dd>
|
|
154
|
+
<code>number</code>
|
|
155
|
+
</dd>
|
|
156
|
+
</ul>
|
|
157
|
+
</dd>
|
|
158
|
+
<dt>Expression Parameters</dt>
|
|
159
|
+
<dd><code>zoom, feature</code></dd>
|
|
160
|
+
</dl>
|
|
148
161
|
|
|
149
162
|
|
|
150
|
-
#### Expression
|
|
151
163
|
|
|
152
|
-
|
|
164
|
+
### `symbolZOrder`
|
|
153
165
|
|
|
154
|
-
___
|
|
155
|
-
|
|
156
|
-
#### Name
|
|
157
|
-
`symbolZOrder`
|
|
158
|
-
|
|
159
|
-
#### Description
|
|
160
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`.
|
|
161
167
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
168
|
+
<dl>
|
|
169
|
+
<dt>Type</dt>
|
|
170
|
+
<dd>
|
|
171
|
+
<code>enum</code>
|
|
172
|
+
</dd>
|
|
173
|
+
<dt>Default Value</dt>
|
|
174
|
+
<dd><code>auto</code></dd>
|
|
175
|
+
<dt>Supported Values</dt>
|
|
176
|
+
<dd>
|
|
177
|
+
<ul>
|
|
178
|
+
<li>
|
|
179
|
+
<code>auto</code>: 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`.
|
|
180
|
+
</li>
|
|
181
|
+
<li>
|
|
182
|
+
<code>viewport-y</code>: 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`.
|
|
183
|
+
</li>
|
|
184
|
+
<li>
|
|
185
|
+
<code>source</code>: Sorts symbols by `symbol-sort-key` if set. Otherwise, no sorting is applied; symbols are rendered in the same order as the source data.
|
|
186
|
+
</li>
|
|
187
|
+
</ul>
|
|
188
|
+
</dd>
|
|
189
|
+
<dt>Expression Parameters</dt>
|
|
190
|
+
<dd><code>zoom</code></dd>
|
|
191
|
+
</dl>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
### `iconAllowOverlap`
|
|
178
196
|
|
|
179
|
-
#### Name
|
|
180
|
-
`iconAllowOverlap`
|
|
181
|
-
|
|
182
|
-
#### Description
|
|
183
197
|
If true, the icon will be visible even if it collides with other previously drawn symbols.
|
|
184
198
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
199
|
+
<dl>
|
|
200
|
+
<dt>Type</dt>
|
|
201
|
+
<dd>
|
|
202
|
+
<code>boolean</code>
|
|
203
|
+
</dd>
|
|
204
|
+
<dt>Default Value</dt>
|
|
205
|
+
<dd><code>false</code></dd>
|
|
206
|
+
</ul>
|
|
207
|
+
</dd>
|
|
208
|
+
<dt>Requires</dt>
|
|
209
|
+
<dd><code>iconImage</code></dd>
|
|
210
|
+
<dt>Disabled By</dt>
|
|
211
|
+
<dd><code>iconOverlap</code></dd>
|
|
212
|
+
<dt>Expression Parameters</dt>
|
|
213
|
+
<dd><code>zoom</code></dd>
|
|
214
|
+
</dl>
|
|
193
215
|
|
|
194
|
-
#### Disabled By
|
|
195
|
-
`iconOverlap`
|
|
196
216
|
|
|
197
|
-
#### Expression
|
|
198
217
|
|
|
199
|
-
|
|
218
|
+
### `iconIgnorePlacement`
|
|
200
219
|
|
|
201
|
-
___
|
|
202
|
-
|
|
203
|
-
#### Name
|
|
204
|
-
`iconIgnorePlacement`
|
|
205
|
-
|
|
206
|
-
#### Description
|
|
207
220
|
If true, other symbols can be visible even if they collide with the icon.
|
|
208
221
|
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
222
|
+
<dl>
|
|
223
|
+
<dt>Type</dt>
|
|
224
|
+
<dd>
|
|
225
|
+
<code>boolean</code>
|
|
226
|
+
</dd>
|
|
227
|
+
<dt>Default Value</dt>
|
|
228
|
+
<dd><code>false</code></dd>
|
|
229
|
+
</ul>
|
|
230
|
+
</dd>
|
|
231
|
+
<dt>Requires</dt>
|
|
232
|
+
<dd><code>iconImage</code></dd>
|
|
233
|
+
<dt>Expression Parameters</dt>
|
|
234
|
+
<dd><code>zoom</code></dd>
|
|
235
|
+
</dl>
|
|
214
236
|
|
|
215
|
-
#### Requires
|
|
216
|
-
`iconImage`
|
|
217
237
|
|
|
218
|
-
#### Expression
|
|
219
238
|
|
|
220
|
-
|
|
239
|
+
### `iconOptional`
|
|
221
240
|
|
|
222
|
-
___
|
|
223
|
-
|
|
224
|
-
#### Name
|
|
225
|
-
`iconOptional`
|
|
226
|
-
|
|
227
|
-
#### Description
|
|
228
241
|
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
|
|
229
242
|
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
243
|
+
<dl>
|
|
244
|
+
<dt>Type</dt>
|
|
245
|
+
<dd>
|
|
246
|
+
<code>boolean</code>
|
|
247
|
+
</dd>
|
|
248
|
+
<dt>Default Value</dt>
|
|
249
|
+
<dd><code>false</code></dd>
|
|
250
|
+
</ul>
|
|
251
|
+
</dd>
|
|
252
|
+
<dt>Requires</dt>
|
|
253
|
+
<dd><code>iconImage, textField</code></dd>
|
|
254
|
+
<dt>Expression Parameters</dt>
|
|
255
|
+
<dd><code>zoom</code></dd>
|
|
256
|
+
</dl>
|
|
238
257
|
|
|
239
|
-
#### Expression
|
|
240
258
|
|
|
241
|
-
Parameters: `zoom`
|
|
242
259
|
|
|
243
|
-
|
|
260
|
+
### `iconRotationAlignment`
|
|
244
261
|
|
|
245
|
-
#### Name
|
|
246
|
-
`iconRotationAlignment`
|
|
247
|
-
|
|
248
|
-
#### Description
|
|
249
262
|
In combination with `symbolPlacement`, determines the rotation behavior of icons.
|
|
250
263
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
264
|
+
<dl>
|
|
265
|
+
<dt>Type</dt>
|
|
266
|
+
<dd>
|
|
267
|
+
<code>enum</code>
|
|
268
|
+
</dd>
|
|
269
|
+
<dt>Default Value</dt>
|
|
270
|
+
<dd><code>auto</code></dd>
|
|
271
|
+
<dt>Supported Values</dt>
|
|
272
|
+
<dd>
|
|
273
|
+
<ul>
|
|
274
|
+
<li>
|
|
275
|
+
<code>map</code>: 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.
|
|
276
|
+
</li>
|
|
277
|
+
<li>
|
|
278
|
+
<code>viewport</code>: Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.
|
|
279
|
+
</li>
|
|
280
|
+
<li>
|
|
281
|
+
<code>auto</code>: 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`.
|
|
282
|
+
</li>
|
|
283
|
+
</ul>
|
|
284
|
+
</dd>
|
|
285
|
+
<dt>Requires</dt>
|
|
286
|
+
<dd><code>iconImage</code></dd>
|
|
287
|
+
<dt>Expression Parameters</dt>
|
|
288
|
+
<dd><code>zoom</code></dd>
|
|
289
|
+
</dl>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
### `iconSize`
|
|
261
294
|
|
|
262
|
-
#### Requires
|
|
263
|
-
`iconImage`
|
|
264
|
-
|
|
265
|
-
#### Expression
|
|
266
|
-
|
|
267
|
-
Parameters: `zoom`
|
|
268
|
-
|
|
269
|
-
___
|
|
270
|
-
|
|
271
|
-
#### Name
|
|
272
|
-
`iconSize`
|
|
273
|
-
|
|
274
|
-
#### Description
|
|
275
295
|
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.
|
|
276
296
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
297
|
+
<dl>
|
|
298
|
+
<dt>Type</dt>
|
|
299
|
+
<dd>
|
|
300
|
+
<code>number</code>
|
|
301
|
+
</dd>
|
|
302
|
+
<dt>Default Value</dt>
|
|
303
|
+
<dd><code>1</code></dd>
|
|
304
|
+
</ul>
|
|
305
|
+
</dd>
|
|
306
|
+
<dt>Units</dt>
|
|
307
|
+
<dd><code>factor of the original icon size</code></dd>
|
|
308
|
+
<dt>Minimum</dt>
|
|
309
|
+
<dd><code>0</code></dd>
|
|
310
|
+
<dt>Requires</dt>
|
|
311
|
+
<dd><code>iconImage</code></dd>
|
|
312
|
+
<dt>Expression Parameters</dt>
|
|
313
|
+
<dd><code>zoom, feature</code></dd>
|
|
314
|
+
</dl>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
### `iconTextFit`
|
|
284
319
|
|
|
285
|
-
#### Minimum
|
|
286
|
-
`0`
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
#### Requires
|
|
290
|
-
`iconImage`
|
|
291
|
-
|
|
292
|
-
#### Expression
|
|
293
|
-
|
|
294
|
-
Parameters: `zoom, feature`
|
|
295
|
-
|
|
296
|
-
___
|
|
297
|
-
|
|
298
|
-
#### Name
|
|
299
|
-
`iconTextFit`
|
|
300
|
-
|
|
301
|
-
#### Description
|
|
302
320
|
Scales the icon to fit around the associated text.
|
|
303
321
|
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
322
|
+
<dl>
|
|
323
|
+
<dt>Type</dt>
|
|
324
|
+
<dd>
|
|
325
|
+
<code>enum</code>
|
|
326
|
+
</dd>
|
|
327
|
+
<dt>Default Value</dt>
|
|
328
|
+
<dd><code>none</code></dd>
|
|
329
|
+
<dt>Supported Values</dt>
|
|
330
|
+
<dd>
|
|
331
|
+
<ul>
|
|
332
|
+
<li>
|
|
333
|
+
<code>none</code>: The icon is displayed at its intrinsic aspect ratio.
|
|
334
|
+
</li>
|
|
335
|
+
<li>
|
|
336
|
+
<code>width</code>: The icon is scaled in the x-dimension to fit the width of the text.
|
|
337
|
+
</li>
|
|
338
|
+
<li>
|
|
339
|
+
<code>height</code>: The icon is scaled in the y-dimension to fit the height of the text.
|
|
340
|
+
</li>
|
|
341
|
+
<li>
|
|
342
|
+
<code>both</code>: The icon is scaled in both x- and y-dimensions.
|
|
343
|
+
</li>
|
|
344
|
+
</ul>
|
|
345
|
+
</dd>
|
|
346
|
+
<dt>Requires</dt>
|
|
347
|
+
<dd><code>iconImage, textField</code></dd>
|
|
348
|
+
<dt>Expression Parameters</dt>
|
|
349
|
+
<dd><code>zoom</code></dd>
|
|
350
|
+
</dl>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
### `iconTextFitPadding`
|
|
324
355
|
|
|
325
|
-
#### Name
|
|
326
|
-
`iconTextFitPadding`
|
|
327
|
-
|
|
328
|
-
#### Description
|
|
329
356
|
Size of the additional area added to dimensions determined by `iconTextFit`, in clockwise order: top, right, bottom, left.
|
|
330
357
|
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
358
|
+
<dl>
|
|
359
|
+
<dt>Type</dt>
|
|
360
|
+
<dd>
|
|
361
|
+
<code>array<number></code>
|
|
362
|
+
</dd>
|
|
363
|
+
<dt>Default Value</dt>
|
|
364
|
+
<dd><code>[0,0,0,0]</code></dd>
|
|
365
|
+
</ul>
|
|
366
|
+
</dd>
|
|
367
|
+
<dt>Units</dt>
|
|
368
|
+
<dd><code>pixels</code></dd>
|
|
369
|
+
<dt>Requires</dt>
|
|
370
|
+
<dd><code>iconImage, textField</code></dd>
|
|
371
|
+
<dt>Expression Parameters</dt>
|
|
372
|
+
<dd><code>zoom</code></dd>
|
|
373
|
+
</dl>
|
|
342
374
|
|
|
343
|
-
#### Expression
|
|
344
375
|
|
|
345
|
-
Parameters: `zoom`
|
|
346
376
|
|
|
347
|
-
|
|
377
|
+
### `iconImage`
|
|
348
378
|
|
|
349
|
-
#### Name
|
|
350
|
-
`iconImage`
|
|
351
|
-
|
|
352
|
-
#### Description
|
|
353
379
|
Name of image in sprite to use for drawing an image background.
|
|
354
380
|
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
381
|
+
<dl>
|
|
382
|
+
<dt>Type</dt>
|
|
383
|
+
<dd>
|
|
384
|
+
<code>resolvedImage</code>
|
|
385
|
+
</dd>
|
|
386
|
+
</ul>
|
|
387
|
+
</dd>
|
|
388
|
+
<dt>Expression Parameters</dt>
|
|
389
|
+
<dd><code>zoom, feature</code></dd>
|
|
390
|
+
</dl>
|
|
360
391
|
|
|
361
|
-
Parameters: `zoom, feature`
|
|
362
392
|
|
|
363
|
-
___
|
|
364
393
|
|
|
365
|
-
|
|
366
|
-
`iconRotate`
|
|
394
|
+
### `iconRotate`
|
|
367
395
|
|
|
368
|
-
#### Description
|
|
369
396
|
Rotates the icon clockwise.
|
|
370
397
|
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
398
|
+
<dl>
|
|
399
|
+
<dt>Type</dt>
|
|
400
|
+
<dd>
|
|
401
|
+
<code>number</code>
|
|
402
|
+
</dd>
|
|
403
|
+
<dt>Default Value</dt>
|
|
404
|
+
<dd><code>0</code></dd>
|
|
405
|
+
</ul>
|
|
406
|
+
</dd>
|
|
407
|
+
<dt>Units</dt>
|
|
408
|
+
<dd><code>degrees</code></dd>
|
|
409
|
+
<dt>Requires</dt>
|
|
410
|
+
<dd><code>iconImage</code></dd>
|
|
411
|
+
<dt>Expression Parameters</dt>
|
|
412
|
+
<dd><code>zoom, feature</code></dd>
|
|
413
|
+
</dl>
|
|
375
414
|
|
|
376
|
-
#### Units
|
|
377
|
-
`degrees`
|
|
378
415
|
|
|
379
416
|
|
|
380
|
-
|
|
381
|
-
`iconImage`
|
|
417
|
+
### `iconPadding`
|
|
382
418
|
|
|
383
|
-
#### Expression
|
|
384
|
-
|
|
385
|
-
Parameters: `zoom, feature`
|
|
386
|
-
|
|
387
|
-
___
|
|
388
|
-
|
|
389
|
-
#### Name
|
|
390
|
-
`iconPadding`
|
|
391
|
-
|
|
392
|
-
#### Description
|
|
393
419
|
Size of additional area round the icon bounding box used for detecting symbol collisions.
|
|
394
420
|
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
421
|
+
<dl>
|
|
422
|
+
<dt>Type</dt>
|
|
423
|
+
<dd>
|
|
424
|
+
<code>array<number></code>
|
|
425
|
+
</dd>
|
|
426
|
+
<dt>Default Value</dt>
|
|
427
|
+
<dd><code>[2]</code></dd>
|
|
428
|
+
</ul>
|
|
429
|
+
</dd>
|
|
430
|
+
<dt>Units</dt>
|
|
431
|
+
<dd><code>pixels</code></dd>
|
|
432
|
+
<dt>Requires</dt>
|
|
433
|
+
<dd><code>iconImage</code></dd>
|
|
434
|
+
<dt>Expression Parameters</dt>
|
|
435
|
+
<dd><code>zoom, feature</code></dd>
|
|
436
|
+
</dl>
|
|
403
437
|
|
|
404
|
-
#### Requires
|
|
405
|
-
`iconImage`
|
|
406
438
|
|
|
407
|
-
#### Expression
|
|
408
439
|
|
|
409
|
-
|
|
440
|
+
### `iconKeepUpright`
|
|
410
441
|
|
|
411
|
-
___
|
|
412
|
-
|
|
413
|
-
#### Name
|
|
414
|
-
`iconKeepUpright`
|
|
415
|
-
|
|
416
|
-
#### Description
|
|
417
442
|
If true, the icon may be flipped to prevent it from being rendered upsideDown.
|
|
418
443
|
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
444
|
+
<dl>
|
|
445
|
+
<dt>Type</dt>
|
|
446
|
+
<dd>
|
|
447
|
+
<code>boolean</code>
|
|
448
|
+
</dd>
|
|
449
|
+
<dt>Default Value</dt>
|
|
450
|
+
<dd><code>false</code></dd>
|
|
451
|
+
</ul>
|
|
452
|
+
</dd>
|
|
453
|
+
<dt>Requires</dt>
|
|
454
|
+
<dd><code>iconImage</code></dd>
|
|
455
|
+
<dt>Expression Parameters</dt>
|
|
456
|
+
<dd><code>zoom</code></dd>
|
|
457
|
+
</dl>
|
|
427
458
|
|
|
428
|
-
#### Expression
|
|
429
459
|
|
|
430
|
-
Parameters: `zoom`
|
|
431
460
|
|
|
432
|
-
|
|
461
|
+
### `iconOffset`
|
|
433
462
|
|
|
434
|
-
#### Name
|
|
435
|
-
`iconOffset`
|
|
436
|
-
|
|
437
|
-
#### Description
|
|
438
463
|
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.
|
|
439
464
|
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
465
|
+
<dl>
|
|
466
|
+
<dt>Type</dt>
|
|
467
|
+
<dd>
|
|
468
|
+
<code>array<number></code>
|
|
469
|
+
</dd>
|
|
470
|
+
<dt>Default Value</dt>
|
|
471
|
+
<dd><code>[0,0]</code></dd>
|
|
472
|
+
</ul>
|
|
473
|
+
</dd>
|
|
474
|
+
<dt>Requires</dt>
|
|
475
|
+
<dd><code>iconImage</code></dd>
|
|
476
|
+
<dt>Expression Parameters</dt>
|
|
477
|
+
<dd><code>zoom, feature</code></dd>
|
|
478
|
+
</dl>
|
|
448
479
|
|
|
449
|
-
#### Expression
|
|
450
480
|
|
|
451
|
-
Parameters: `zoom, feature`
|
|
452
481
|
|
|
453
|
-
|
|
482
|
+
### `iconAnchor`
|
|
454
483
|
|
|
455
|
-
#### Name
|
|
456
|
-
`iconAnchor`
|
|
457
|
-
|
|
458
|
-
#### Description
|
|
459
484
|
Part of the icon placed closest to the anchor.
|
|
460
485
|
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
486
|
+
<dl>
|
|
487
|
+
<dt>Type</dt>
|
|
488
|
+
<dd>
|
|
489
|
+
<code>enum</code>
|
|
490
|
+
</dd>
|
|
491
|
+
<dt>Default Value</dt>
|
|
492
|
+
<dd><code>center</code></dd>
|
|
493
|
+
<dt>Supported Values</dt>
|
|
494
|
+
<dd>
|
|
495
|
+
<ul>
|
|
496
|
+
<li>
|
|
497
|
+
<code>center</code>: The center of the icon is placed closest to the anchor.
|
|
498
|
+
</li>
|
|
499
|
+
<li>
|
|
500
|
+
<code>left</code>: The left side of the icon is placed closest to the anchor.
|
|
501
|
+
</li>
|
|
502
|
+
<li>
|
|
503
|
+
<code>right</code>: The right side of the icon is placed closest to the anchor.
|
|
504
|
+
</li>
|
|
505
|
+
<li>
|
|
506
|
+
<code>top</code>: The top of the icon is placed closest to the anchor.
|
|
507
|
+
</li>
|
|
508
|
+
<li>
|
|
509
|
+
<code>bottom</code>: The bottom of the icon is placed closest to the anchor.
|
|
510
|
+
</li>
|
|
511
|
+
<li>
|
|
512
|
+
<code>top-left</code>: The top left corner of the icon is placed closest to the anchor.
|
|
513
|
+
</li>
|
|
514
|
+
<li>
|
|
515
|
+
<code>top-right</code>: The top right corner of the icon is placed closest to the anchor.
|
|
516
|
+
</li>
|
|
517
|
+
<li>
|
|
518
|
+
<code>bottom-left</code>: The bottom left corner of the icon is placed closest to the anchor.
|
|
519
|
+
</li>
|
|
520
|
+
<li>
|
|
521
|
+
<code>bottom-right</code>: The bottom right corner of the icon is placed closest to the anchor.
|
|
522
|
+
</li>
|
|
523
|
+
</ul>
|
|
524
|
+
</dd>
|
|
525
|
+
<dt>Requires</dt>
|
|
526
|
+
<dd><code>iconImage</code></dd>
|
|
527
|
+
<dt>Expression Parameters</dt>
|
|
528
|
+
<dd><code>zoom, feature</code></dd>
|
|
529
|
+
</dl>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
### `iconPitchAlignment`
|
|
484
534
|
|
|
485
|
-
___
|
|
486
|
-
|
|
487
|
-
#### Name
|
|
488
|
-
`iconPitchAlignment`
|
|
489
|
-
|
|
490
|
-
#### Description
|
|
491
535
|
Orientation of icon when map is pitched.
|
|
492
536
|
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
537
|
+
<dl>
|
|
538
|
+
<dt>Type</dt>
|
|
539
|
+
<dd>
|
|
540
|
+
<code>enum</code>
|
|
541
|
+
</dd>
|
|
542
|
+
<dt>Default Value</dt>
|
|
543
|
+
<dd><code>auto</code></dd>
|
|
544
|
+
<dt>Supported Values</dt>
|
|
545
|
+
<dd>
|
|
546
|
+
<ul>
|
|
547
|
+
<li>
|
|
548
|
+
<code>map</code>: The icon is aligned to the plane of the map.
|
|
549
|
+
</li>
|
|
550
|
+
<li>
|
|
551
|
+
<code>viewport</code>: The icon is aligned to the plane of the viewport.
|
|
552
|
+
</li>
|
|
553
|
+
<li>
|
|
554
|
+
<code>auto</code>: Automatically matches the value of `icon-rotation-alignment`.
|
|
555
|
+
</li>
|
|
556
|
+
</ul>
|
|
557
|
+
</dd>
|
|
558
|
+
<dt>Requires</dt>
|
|
559
|
+
<dd><code>iconImage</code></dd>
|
|
560
|
+
<dt>Expression Parameters</dt>
|
|
561
|
+
<dd><code>zoom</code></dd>
|
|
562
|
+
</dl>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
### `textPitchAlignment`
|
|
510
567
|
|
|
511
|
-
___
|
|
512
|
-
|
|
513
|
-
#### Name
|
|
514
|
-
`textPitchAlignment`
|
|
515
|
-
|
|
516
|
-
#### Description
|
|
517
568
|
Orientation of text when map is pitched.
|
|
518
569
|
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
570
|
+
<dl>
|
|
571
|
+
<dt>Type</dt>
|
|
572
|
+
<dd>
|
|
573
|
+
<code>enum</code>
|
|
574
|
+
</dd>
|
|
575
|
+
<dt>Default Value</dt>
|
|
576
|
+
<dd><code>auto</code></dd>
|
|
577
|
+
<dt>Supported Values</dt>
|
|
578
|
+
<dd>
|
|
579
|
+
<ul>
|
|
580
|
+
<li>
|
|
581
|
+
<code>map</code>: The text is aligned to the plane of the map.
|
|
582
|
+
</li>
|
|
583
|
+
<li>
|
|
584
|
+
<code>viewport</code>: The text is aligned to the plane of the viewport.
|
|
585
|
+
</li>
|
|
586
|
+
<li>
|
|
587
|
+
<code>auto</code>: Automatically matches the value of `text-rotation-alignment`.
|
|
588
|
+
</li>
|
|
589
|
+
</ul>
|
|
590
|
+
</dd>
|
|
591
|
+
<dt>Requires</dt>
|
|
592
|
+
<dd><code>textField</code></dd>
|
|
593
|
+
<dt>Expression Parameters</dt>
|
|
594
|
+
<dd><code>zoom</code></dd>
|
|
595
|
+
</dl>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
### `textRotationAlignment`
|
|
534
600
|
|
|
535
|
-
Parameters: `zoom`
|
|
536
|
-
|
|
537
|
-
___
|
|
538
|
-
|
|
539
|
-
#### Name
|
|
540
|
-
`textRotationAlignment`
|
|
541
|
-
|
|
542
|
-
#### Description
|
|
543
601
|
In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text.
|
|
544
602
|
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
603
|
+
<dl>
|
|
604
|
+
<dt>Type</dt>
|
|
605
|
+
<dd>
|
|
606
|
+
<code>enum</code>
|
|
607
|
+
</dd>
|
|
608
|
+
<dt>Default Value</dt>
|
|
609
|
+
<dd><code>auto</code></dd>
|
|
610
|
+
<dt>Supported Values</dt>
|
|
611
|
+
<dd>
|
|
612
|
+
<ul>
|
|
613
|
+
<li>
|
|
614
|
+
<code>map</code>: 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.
|
|
615
|
+
</li>
|
|
616
|
+
<li>
|
|
617
|
+
<code>viewport</code>: Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`.
|
|
618
|
+
</li>
|
|
619
|
+
<li>
|
|
620
|
+
<code>viewport-glyph</code>: When `symbol-placement` is set to `point`, aligns text to the x-axis of the viewport. When `symbol-placement` is set to `line` or `line-center`, aligns glyphs to the x-axis of the viewport and places them along the line.
|
|
621
|
+
</li>
|
|
622
|
+
<li>
|
|
623
|
+
<code>auto</code>: 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`.
|
|
624
|
+
</li>
|
|
625
|
+
</ul>
|
|
626
|
+
</dd>
|
|
627
|
+
<dt>Requires</dt>
|
|
628
|
+
<dd><code>textField</code></dd>
|
|
629
|
+
<dt>Expression Parameters</dt>
|
|
630
|
+
<dd><code>zoom</code></dd>
|
|
631
|
+
</dl>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
### `textField`
|
|
559
636
|
|
|
560
|
-
#### Expression
|
|
561
|
-
|
|
562
|
-
Parameters: `zoom`
|
|
563
|
-
|
|
564
|
-
___
|
|
565
|
-
|
|
566
|
-
#### Name
|
|
567
|
-
`textField`
|
|
568
|
-
|
|
569
|
-
#### Description
|
|
570
637
|
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.
|
|
571
638
|
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
639
|
+
<dl>
|
|
640
|
+
<dt>Type</dt>
|
|
641
|
+
<dd>
|
|
642
|
+
<code>formatted</code>
|
|
643
|
+
</dd>
|
|
644
|
+
<dt>Default Value</dt>
|
|
645
|
+
<dd><code></code></dd>
|
|
646
|
+
</ul>
|
|
647
|
+
</dd>
|
|
648
|
+
<dt>Expression Parameters</dt>
|
|
649
|
+
<dd><code>zoom, feature</code></dd>
|
|
650
|
+
</dl>
|
|
579
651
|
|
|
580
|
-
Parameters: `zoom, feature`
|
|
581
652
|
|
|
582
|
-
___
|
|
583
653
|
|
|
584
|
-
|
|
585
|
-
`textFont`
|
|
654
|
+
### `textFont`
|
|
586
655
|
|
|
587
|
-
#### Description
|
|
588
656
|
Font stack to use for displaying text.
|
|
589
657
|
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
658
|
+
<dl>
|
|
659
|
+
<dt>Type</dt>
|
|
660
|
+
<dd>
|
|
661
|
+
<code>array<string></code>
|
|
662
|
+
</dd>
|
|
663
|
+
<dt>Default Value</dt>
|
|
664
|
+
<dd><code>[Open Sans Regular,Arial Unicode MS Regular]</code></dd>
|
|
665
|
+
</ul>
|
|
666
|
+
</dd>
|
|
667
|
+
<dt>Requires</dt>
|
|
668
|
+
<dd><code>textField</code></dd>
|
|
669
|
+
<dt>Supported Style Functions</dt>
|
|
670
|
+
<dd><code>camera</code></dd>
|
|
671
|
+
<dt>Expression Parameters</dt>
|
|
672
|
+
<dd><code>zoom, feature</code></dd>
|
|
673
|
+
</dl>
|
|
594
674
|
|
|
595
675
|
|
|
596
|
-
#### Requires
|
|
597
|
-
`textField`
|
|
598
676
|
|
|
599
|
-
|
|
600
|
-
`camera`
|
|
601
|
-
#### Expression
|
|
677
|
+
### `textSize`
|
|
602
678
|
|
|
603
|
-
Parameters: `zoom, feature`
|
|
604
|
-
|
|
605
|
-
___
|
|
606
|
-
|
|
607
|
-
#### Name
|
|
608
|
-
`textSize`
|
|
609
|
-
|
|
610
|
-
#### Description
|
|
611
679
|
Font size.
|
|
612
680
|
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
681
|
+
<dl>
|
|
682
|
+
<dt>Type</dt>
|
|
683
|
+
<dd>
|
|
684
|
+
<code>number</code>
|
|
685
|
+
</dd>
|
|
686
|
+
<dt>Default Value</dt>
|
|
687
|
+
<dd><code>16</code></dd>
|
|
688
|
+
</ul>
|
|
689
|
+
</dd>
|
|
690
|
+
<dt>Units</dt>
|
|
691
|
+
<dd><code>pixels</code></dd>
|
|
692
|
+
<dt>Minimum</dt>
|
|
693
|
+
<dd><code>0</code></dd>
|
|
694
|
+
<dt>Requires</dt>
|
|
695
|
+
<dd><code>textField</code></dd>
|
|
696
|
+
<dt>Expression Parameters</dt>
|
|
697
|
+
<dd><code>zoom, feature</code></dd>
|
|
698
|
+
</dl>
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
### `textMaxWidth`
|
|
627
703
|
|
|
628
|
-
#### Expression
|
|
629
|
-
|
|
630
|
-
Parameters: `zoom, feature`
|
|
631
|
-
|
|
632
|
-
___
|
|
633
|
-
|
|
634
|
-
#### Name
|
|
635
|
-
`textMaxWidth`
|
|
636
|
-
|
|
637
|
-
#### Description
|
|
638
704
|
The maximum line width for text wrapping.
|
|
639
705
|
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
706
|
+
<dl>
|
|
707
|
+
<dt>Type</dt>
|
|
708
|
+
<dd>
|
|
709
|
+
<code>number</code>
|
|
710
|
+
</dd>
|
|
711
|
+
<dt>Default Value</dt>
|
|
712
|
+
<dd><code>10</code></dd>
|
|
713
|
+
</ul>
|
|
714
|
+
</dd>
|
|
715
|
+
<dt>Units</dt>
|
|
716
|
+
<dd><code>ems</code></dd>
|
|
717
|
+
<dt>Minimum</dt>
|
|
718
|
+
<dd><code>0</code></dd>
|
|
719
|
+
<dt>Requires</dt>
|
|
720
|
+
<dd><code>textField</code></dd>
|
|
721
|
+
<dt>Supported Style Functions</dt>
|
|
722
|
+
<dd><code>camera</code></dd>
|
|
723
|
+
<dt>Expression Parameters</dt>
|
|
724
|
+
<dd><code>zoom, feature</code></dd>
|
|
725
|
+
</dl>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
### `textLineHeight`
|
|
650
730
|
|
|
651
|
-
|
|
652
|
-
#### Requires
|
|
653
|
-
`textField`
|
|
654
|
-
|
|
655
|
-
#### Supported Style Functions
|
|
656
|
-
`camera`
|
|
657
|
-
#### Expression
|
|
658
|
-
|
|
659
|
-
Parameters: `zoom, feature`
|
|
660
|
-
|
|
661
|
-
___
|
|
662
|
-
|
|
663
|
-
#### Name
|
|
664
|
-
`textLineHeight`
|
|
665
|
-
|
|
666
|
-
#### Description
|
|
667
731
|
Text leading value for multiLine text.
|
|
668
732
|
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
733
|
+
<dl>
|
|
734
|
+
<dt>Type</dt>
|
|
735
|
+
<dd>
|
|
736
|
+
<code>number</code>
|
|
737
|
+
</dd>
|
|
738
|
+
<dt>Default Value</dt>
|
|
739
|
+
<dd><code>1.2</code></dd>
|
|
740
|
+
</ul>
|
|
741
|
+
</dd>
|
|
742
|
+
<dt>Units</dt>
|
|
743
|
+
<dd><code>ems</code></dd>
|
|
744
|
+
<dt>Requires</dt>
|
|
745
|
+
<dd><code>textField</code></dd>
|
|
746
|
+
<dt>Expression Parameters</dt>
|
|
747
|
+
<dd><code>zoom</code></dd>
|
|
748
|
+
</dl>
|
|
676
749
|
|
|
677
750
|
|
|
678
|
-
#### Requires
|
|
679
|
-
`textField`
|
|
680
751
|
|
|
681
|
-
|
|
752
|
+
### `textLetterSpacing`
|
|
682
753
|
|
|
683
|
-
Parameters: `zoom`
|
|
684
|
-
|
|
685
|
-
___
|
|
686
|
-
|
|
687
|
-
#### Name
|
|
688
|
-
`textLetterSpacing`
|
|
689
|
-
|
|
690
|
-
#### Description
|
|
691
754
|
Text tracking amount.
|
|
692
755
|
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
756
|
+
<dl>
|
|
757
|
+
<dt>Type</dt>
|
|
758
|
+
<dd>
|
|
759
|
+
<code>number</code>
|
|
760
|
+
</dd>
|
|
761
|
+
<dt>Default Value</dt>
|
|
762
|
+
<dd><code>0</code></dd>
|
|
763
|
+
</ul>
|
|
764
|
+
</dd>
|
|
765
|
+
<dt>Units</dt>
|
|
766
|
+
<dd><code>ems</code></dd>
|
|
767
|
+
<dt>Requires</dt>
|
|
768
|
+
<dd><code>textField</code></dd>
|
|
769
|
+
<dt>Supported Style Functions</dt>
|
|
770
|
+
<dd><code>camera</code></dd>
|
|
771
|
+
<dt>Expression Parameters</dt>
|
|
772
|
+
<dd><code>zoom, feature</code></dd>
|
|
773
|
+
</dl>
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
### `textJustify`
|
|
704
778
|
|
|
705
|
-
#### Supported Style Functions
|
|
706
|
-
`camera`
|
|
707
|
-
#### Expression
|
|
708
|
-
|
|
709
|
-
Parameters: `zoom, feature`
|
|
710
|
-
|
|
711
|
-
___
|
|
712
|
-
|
|
713
|
-
#### Name
|
|
714
|
-
`textJustify`
|
|
715
|
-
|
|
716
|
-
#### Description
|
|
717
779
|
Text justification options.
|
|
718
780
|
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
781
|
+
<dl>
|
|
782
|
+
<dt>Type</dt>
|
|
783
|
+
<dd>
|
|
784
|
+
<code>enum</code>
|
|
785
|
+
</dd>
|
|
786
|
+
<dt>Default Value</dt>
|
|
787
|
+
<dd><code>center</code></dd>
|
|
788
|
+
<dt>Supported Values</dt>
|
|
789
|
+
<dd>
|
|
790
|
+
<ul>
|
|
791
|
+
<li>
|
|
792
|
+
<code>auto</code>: The text is aligned towards the anchor position.
|
|
793
|
+
</li>
|
|
794
|
+
<li>
|
|
795
|
+
<code>left</code>: The text is aligned to the left.
|
|
796
|
+
</li>
|
|
797
|
+
<li>
|
|
798
|
+
<code>center</code>: The text is centered.
|
|
799
|
+
</li>
|
|
800
|
+
<li>
|
|
801
|
+
<code>right</code>: The text is aligned to the right.
|
|
802
|
+
</li>
|
|
803
|
+
</ul>
|
|
804
|
+
</dd>
|
|
805
|
+
<dt>Requires</dt>
|
|
806
|
+
<dd><code>textField</code></dd>
|
|
807
|
+
<dt>Supported Style Functions</dt>
|
|
808
|
+
<dd><code>camera</code></dd>
|
|
809
|
+
<dt>Expression Parameters</dt>
|
|
810
|
+
<dd><code>zoom, feature</code></dd>
|
|
811
|
+
</dl>
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
### `textRadialOffset`
|
|
733
816
|
|
|
734
|
-
#### Supported Style Functions
|
|
735
|
-
`camera`
|
|
736
|
-
#### Expression
|
|
737
|
-
|
|
738
|
-
Parameters: `zoom, feature`
|
|
739
|
-
|
|
740
|
-
___
|
|
741
|
-
|
|
742
|
-
#### Name
|
|
743
|
-
`textRadialOffset`
|
|
744
|
-
|
|
745
|
-
#### Description
|
|
746
817
|
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.
|
|
747
818
|
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
819
|
+
<dl>
|
|
820
|
+
<dt>Type</dt>
|
|
821
|
+
<dd>
|
|
822
|
+
<code>number</code>
|
|
823
|
+
</dd>
|
|
824
|
+
<dt>Default Value</dt>
|
|
825
|
+
<dd><code>0</code></dd>
|
|
826
|
+
</ul>
|
|
827
|
+
</dd>
|
|
828
|
+
<dt>Units</dt>
|
|
829
|
+
<dd><code>ems</code></dd>
|
|
830
|
+
<dt>Requires</dt>
|
|
831
|
+
<dd><code>textField</code></dd>
|
|
832
|
+
<dt>Expression Parameters</dt>
|
|
833
|
+
<dd><code>zoom, feature</code></dd>
|
|
834
|
+
</dl>
|
|
756
835
|
|
|
757
|
-
#### Requires
|
|
758
|
-
`textField`
|
|
759
836
|
|
|
760
|
-
#### Expression
|
|
761
837
|
|
|
762
|
-
|
|
838
|
+
### `textVariableAnchor`
|
|
763
839
|
|
|
764
|
-
___
|
|
765
|
-
|
|
766
|
-
#### Name
|
|
767
|
-
`textVariableAnchor`
|
|
768
|
-
|
|
769
|
-
#### Description
|
|
770
840
|
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`.
|
|
771
841
|
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
842
|
+
<dl>
|
|
843
|
+
<dt>Type</dt>
|
|
844
|
+
<dd>
|
|
845
|
+
<code>array<enum></code>
|
|
846
|
+
</dd>
|
|
847
|
+
</ul>
|
|
848
|
+
</dd>
|
|
849
|
+
<dt>Requires</dt>
|
|
850
|
+
<dd><code>textField</code></dd>
|
|
851
|
+
<dt>Expression Parameters</dt>
|
|
852
|
+
<dd><code>zoom</code></dd>
|
|
853
|
+
</dl>
|
|
778
854
|
|
|
779
|
-
#### Expression
|
|
780
855
|
|
|
781
|
-
Parameters: `zoom`
|
|
782
856
|
|
|
783
|
-
|
|
857
|
+
### `textAnchor`
|
|
784
858
|
|
|
785
|
-
#### Name
|
|
786
|
-
`textAnchor`
|
|
787
|
-
|
|
788
|
-
#### Description
|
|
789
859
|
Part of the text placed closest to the anchor.
|
|
790
860
|
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
861
|
+
<dl>
|
|
862
|
+
<dt>Type</dt>
|
|
863
|
+
<dd>
|
|
864
|
+
<code>enum</code>
|
|
865
|
+
</dd>
|
|
866
|
+
<dt>Default Value</dt>
|
|
867
|
+
<dd><code>center</code></dd>
|
|
868
|
+
<dt>Supported Values</dt>
|
|
869
|
+
<dd>
|
|
870
|
+
<ul>
|
|
871
|
+
<li>
|
|
872
|
+
<code>center</code>: The center of the text is placed closest to the anchor.
|
|
873
|
+
</li>
|
|
874
|
+
<li>
|
|
875
|
+
<code>left</code>: The left side of the text is placed closest to the anchor.
|
|
876
|
+
</li>
|
|
877
|
+
<li>
|
|
878
|
+
<code>right</code>: The right side of the text is placed closest to the anchor.
|
|
879
|
+
</li>
|
|
880
|
+
<li>
|
|
881
|
+
<code>top</code>: The top of the text is placed closest to the anchor.
|
|
882
|
+
</li>
|
|
883
|
+
<li>
|
|
884
|
+
<code>bottom</code>: The bottom of the text is placed closest to the anchor.
|
|
885
|
+
</li>
|
|
886
|
+
<li>
|
|
887
|
+
<code>top-left</code>: The top left corner of the text is placed closest to the anchor.
|
|
888
|
+
</li>
|
|
889
|
+
<li>
|
|
890
|
+
<code>top-right</code>: The top right corner of the text is placed closest to the anchor.
|
|
891
|
+
</li>
|
|
892
|
+
<li>
|
|
893
|
+
<code>bottom-left</code>: The bottom left corner of the text is placed closest to the anchor.
|
|
894
|
+
</li>
|
|
895
|
+
<li>
|
|
896
|
+
<code>bottom-right</code>: The bottom right corner of the text is placed closest to the anchor.
|
|
897
|
+
</li>
|
|
898
|
+
</ul>
|
|
899
|
+
</dd>
|
|
900
|
+
<dt>Requires</dt>
|
|
901
|
+
<dd><code>textField</code></dd>
|
|
902
|
+
<dt>Disabled By</dt>
|
|
903
|
+
<dd><code>textVariableAnchor</code></dd>
|
|
904
|
+
<dt>Supported Style Functions</dt>
|
|
905
|
+
<dd><code>camera</code></dd>
|
|
906
|
+
<dt>Expression Parameters</dt>
|
|
907
|
+
<dd><code>zoom, feature</code></dd>
|
|
908
|
+
</dl>
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
### `textMaxAngle`
|
|
824
913
|
|
|
825
|
-
#### Description
|
|
826
914
|
Maximum angle change between adjacent characters.
|
|
827
915
|
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
916
|
+
<dl>
|
|
917
|
+
<dt>Type</dt>
|
|
918
|
+
<dd>
|
|
919
|
+
<code>number</code>
|
|
920
|
+
</dd>
|
|
921
|
+
<dt>Default Value</dt>
|
|
922
|
+
<dd><code>45</code></dd>
|
|
923
|
+
</ul>
|
|
924
|
+
</dd>
|
|
925
|
+
<dt>Units</dt>
|
|
926
|
+
<dd><code>degrees</code></dd>
|
|
927
|
+
<dt>Requires</dt>
|
|
928
|
+
<dd><code>textField</code></dd>
|
|
929
|
+
<dt>Expression Parameters</dt>
|
|
930
|
+
<dd><code>zoom</code></dd>
|
|
931
|
+
</dl>
|
|
832
932
|
|
|
833
|
-
#### Units
|
|
834
|
-
`degrees`
|
|
835
933
|
|
|
836
934
|
|
|
837
|
-
|
|
838
|
-
`textField`
|
|
935
|
+
### `textWritingMode`
|
|
839
936
|
|
|
840
|
-
#### Expression
|
|
841
|
-
|
|
842
|
-
Parameters: `zoom`
|
|
843
|
-
|
|
844
|
-
___
|
|
845
|
-
|
|
846
|
-
#### Name
|
|
847
|
-
`textWritingMode`
|
|
848
|
-
|
|
849
|
-
#### Description
|
|
850
937
|
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. The order of elements in an array define priority order for the placement of an orientation variant.
|
|
851
938
|
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
939
|
+
<dl>
|
|
940
|
+
<dt>Type</dt>
|
|
941
|
+
<dd>
|
|
942
|
+
<code>array<enum></code>
|
|
943
|
+
</dd>
|
|
944
|
+
</ul>
|
|
945
|
+
</dd>
|
|
946
|
+
<dt>Requires</dt>
|
|
947
|
+
<dd><code>textField</code></dd>
|
|
948
|
+
<dt>Expression Parameters</dt>
|
|
949
|
+
<dd><code>zoom</code></dd>
|
|
950
|
+
</dl>
|
|
860
951
|
|
|
861
|
-
Parameters: `zoom`
|
|
862
952
|
|
|
863
|
-
___
|
|
864
953
|
|
|
865
|
-
|
|
866
|
-
`textRotate`
|
|
954
|
+
### `textRotate`
|
|
867
955
|
|
|
868
|
-
#### Description
|
|
869
956
|
Rotates the text clockwise.
|
|
870
957
|
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
958
|
+
<dl>
|
|
959
|
+
<dt>Type</dt>
|
|
960
|
+
<dd>
|
|
961
|
+
<code>number</code>
|
|
962
|
+
</dd>
|
|
963
|
+
<dt>Default Value</dt>
|
|
964
|
+
<dd><code>0</code></dd>
|
|
965
|
+
</ul>
|
|
966
|
+
</dd>
|
|
967
|
+
<dt>Units</dt>
|
|
968
|
+
<dd><code>degrees</code></dd>
|
|
969
|
+
<dt>Requires</dt>
|
|
970
|
+
<dd><code>textField</code></dd>
|
|
971
|
+
<dt>Expression Parameters</dt>
|
|
972
|
+
<dd><code>zoom, feature</code></dd>
|
|
973
|
+
</dl>
|
|
875
974
|
|
|
876
|
-
#### Units
|
|
877
|
-
`degrees`
|
|
878
975
|
|
|
879
976
|
|
|
880
|
-
|
|
881
|
-
`textField`
|
|
977
|
+
### `textPadding`
|
|
882
978
|
|
|
883
|
-
#### Expression
|
|
884
|
-
|
|
885
|
-
Parameters: `zoom, feature`
|
|
886
|
-
|
|
887
|
-
___
|
|
888
|
-
|
|
889
|
-
#### Name
|
|
890
|
-
`textPadding`
|
|
891
|
-
|
|
892
|
-
#### Description
|
|
893
979
|
Size of the additional area around the text bounding box used for detecting symbol collisions.
|
|
894
980
|
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
981
|
+
<dl>
|
|
982
|
+
<dt>Type</dt>
|
|
983
|
+
<dd>
|
|
984
|
+
<code>number</code>
|
|
985
|
+
</dd>
|
|
986
|
+
<dt>Default Value</dt>
|
|
987
|
+
<dd><code>2</code></dd>
|
|
988
|
+
</ul>
|
|
989
|
+
</dd>
|
|
990
|
+
<dt>Units</dt>
|
|
991
|
+
<dd><code>pixels</code></dd>
|
|
992
|
+
<dt>Minimum</dt>
|
|
993
|
+
<dd><code>0</code></dd>
|
|
994
|
+
<dt>Requires</dt>
|
|
995
|
+
<dd><code>textField</code></dd>
|
|
996
|
+
<dt>Expression Parameters</dt>
|
|
997
|
+
<dd><code>zoom</code></dd>
|
|
998
|
+
</dl>
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
### `textKeepUpright`
|
|
905
1003
|
|
|
906
|
-
|
|
907
|
-
#### Requires
|
|
908
|
-
`textField`
|
|
909
|
-
|
|
910
|
-
#### Expression
|
|
911
|
-
|
|
912
|
-
Parameters: `zoom`
|
|
913
|
-
|
|
914
|
-
___
|
|
915
|
-
|
|
916
|
-
#### Name
|
|
917
|
-
`textKeepUpright`
|
|
918
|
-
|
|
919
|
-
#### Description
|
|
920
1004
|
If true, the text may be flipped vertically to prevent it from being rendered upsideDown.
|
|
921
1005
|
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
1006
|
+
<dl>
|
|
1007
|
+
<dt>Type</dt>
|
|
1008
|
+
<dd>
|
|
1009
|
+
<code>boolean</code>
|
|
1010
|
+
</dd>
|
|
1011
|
+
<dt>Default Value</dt>
|
|
1012
|
+
<dd><code>true</code></dd>
|
|
1013
|
+
</ul>
|
|
1014
|
+
</dd>
|
|
1015
|
+
<dt>Requires</dt>
|
|
1016
|
+
<dd><code>textField</code></dd>
|
|
1017
|
+
<dt>Expression Parameters</dt>
|
|
1018
|
+
<dd><code>zoom</code></dd>
|
|
1019
|
+
</dl>
|
|
927
1020
|
|
|
928
|
-
#### Requires
|
|
929
|
-
`textField`
|
|
930
1021
|
|
|
931
|
-
#### Expression
|
|
932
1022
|
|
|
933
|
-
|
|
1023
|
+
### `textTransform`
|
|
934
1024
|
|
|
935
|
-
___
|
|
936
|
-
|
|
937
|
-
#### Name
|
|
938
|
-
`textTransform`
|
|
939
|
-
|
|
940
|
-
#### Description
|
|
941
1025
|
Specifies how to capitalize text, similar to the CSS `textTransform` property.
|
|
942
1026
|
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
1027
|
+
<dl>
|
|
1028
|
+
<dt>Type</dt>
|
|
1029
|
+
<dd>
|
|
1030
|
+
<code>enum</code>
|
|
1031
|
+
</dd>
|
|
1032
|
+
<dt>Default Value</dt>
|
|
1033
|
+
<dd><code>none</code></dd>
|
|
1034
|
+
<dt>Supported Values</dt>
|
|
1035
|
+
<dd>
|
|
1036
|
+
<ul>
|
|
1037
|
+
<li>
|
|
1038
|
+
<code>none</code>: The text is not altered.
|
|
1039
|
+
</li>
|
|
1040
|
+
<li>
|
|
1041
|
+
<code>uppercase</code>: Forces all letters to be displayed in uppercase.
|
|
1042
|
+
</li>
|
|
1043
|
+
<li>
|
|
1044
|
+
<code>lowercase</code>: Forces all letters to be displayed in lowercase.
|
|
1045
|
+
</li>
|
|
1046
|
+
</ul>
|
|
1047
|
+
</dd>
|
|
1048
|
+
<dt>Requires</dt>
|
|
1049
|
+
<dd><code>textField</code></dd>
|
|
1050
|
+
<dt>Expression Parameters</dt>
|
|
1051
|
+
<dd><code>zoom, feature</code></dd>
|
|
1052
|
+
</dl>
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
### `textOffset`
|
|
958
1057
|
|
|
959
|
-
Parameters: `zoom, feature`
|
|
960
|
-
|
|
961
|
-
___
|
|
962
|
-
|
|
963
|
-
#### Name
|
|
964
|
-
`textOffset`
|
|
965
|
-
|
|
966
|
-
#### Description
|
|
967
1058
|
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.
|
|
968
1059
|
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
1060
|
+
<dl>
|
|
1061
|
+
<dt>Type</dt>
|
|
1062
|
+
<dd>
|
|
1063
|
+
<code>array<number></code>
|
|
1064
|
+
</dd>
|
|
1065
|
+
<dt>Default Value</dt>
|
|
1066
|
+
<dd><code>[0,0]</code></dd>
|
|
1067
|
+
</ul>
|
|
1068
|
+
</dd>
|
|
1069
|
+
<dt>Units</dt>
|
|
1070
|
+
<dd><code>ems</code></dd>
|
|
1071
|
+
<dt>Requires</dt>
|
|
1072
|
+
<dd><code>textField</code></dd>
|
|
1073
|
+
<dt>Disabled By</dt>
|
|
1074
|
+
<dd><code>textRadialOffset</code></dd>
|
|
1075
|
+
<dt>Expression Parameters</dt>
|
|
1076
|
+
<dd><code>zoom, feature</code></dd>
|
|
1077
|
+
</dl>
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
### `textAllowOverlap`
|
|
983
1082
|
|
|
984
|
-
#### Expression
|
|
985
|
-
|
|
986
|
-
Parameters: `zoom, feature`
|
|
987
|
-
|
|
988
|
-
___
|
|
989
|
-
|
|
990
|
-
#### Name
|
|
991
|
-
`textAllowOverlap`
|
|
992
|
-
|
|
993
|
-
#### Description
|
|
994
1083
|
If true, the text will be visible even if it collides with other previously drawn symbols.
|
|
995
1084
|
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1085
|
+
<dl>
|
|
1086
|
+
<dt>Type</dt>
|
|
1087
|
+
<dd>
|
|
1088
|
+
<code>boolean</code>
|
|
1089
|
+
</dd>
|
|
1090
|
+
<dt>Default Value</dt>
|
|
1091
|
+
<dd><code>false</code></dd>
|
|
1092
|
+
</ul>
|
|
1093
|
+
</dd>
|
|
1094
|
+
<dt>Requires</dt>
|
|
1095
|
+
<dd><code>textField</code></dd>
|
|
1096
|
+
<dt>Disabled By</dt>
|
|
1097
|
+
<dd><code>textOverlap</code></dd>
|
|
1098
|
+
<dt>Expression Parameters</dt>
|
|
1099
|
+
<dd><code>zoom</code></dd>
|
|
1100
|
+
</dl>
|
|
1004
1101
|
|
|
1005
|
-
#### Disabled By
|
|
1006
|
-
`textOverlap`
|
|
1007
1102
|
|
|
1008
|
-
#### Expression
|
|
1009
1103
|
|
|
1010
|
-
|
|
1104
|
+
### `textIgnorePlacement`
|
|
1011
1105
|
|
|
1012
|
-
___
|
|
1013
|
-
|
|
1014
|
-
#### Name
|
|
1015
|
-
`textIgnorePlacement`
|
|
1016
|
-
|
|
1017
|
-
#### Description
|
|
1018
1106
|
If true, other symbols can be visible even if they collide with the text.
|
|
1019
1107
|
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1108
|
+
<dl>
|
|
1109
|
+
<dt>Type</dt>
|
|
1110
|
+
<dd>
|
|
1111
|
+
<code>boolean</code>
|
|
1112
|
+
</dd>
|
|
1113
|
+
<dt>Default Value</dt>
|
|
1114
|
+
<dd><code>false</code></dd>
|
|
1115
|
+
</ul>
|
|
1116
|
+
</dd>
|
|
1117
|
+
<dt>Requires</dt>
|
|
1118
|
+
<dd><code>textField</code></dd>
|
|
1119
|
+
<dt>Expression Parameters</dt>
|
|
1120
|
+
<dd><code>zoom</code></dd>
|
|
1121
|
+
</dl>
|
|
1025
1122
|
|
|
1026
|
-
#### Requires
|
|
1027
|
-
`textField`
|
|
1028
1123
|
|
|
1029
|
-
#### Expression
|
|
1030
1124
|
|
|
1031
|
-
|
|
1125
|
+
### `textOptional`
|
|
1032
1126
|
|
|
1033
|
-
___
|
|
1034
|
-
|
|
1035
|
-
#### Name
|
|
1036
|
-
`textOptional`
|
|
1037
|
-
|
|
1038
|
-
#### Description
|
|
1039
1127
|
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
|
|
1040
1128
|
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1129
|
+
<dl>
|
|
1130
|
+
<dt>Type</dt>
|
|
1131
|
+
<dd>
|
|
1132
|
+
<code>boolean</code>
|
|
1133
|
+
</dd>
|
|
1134
|
+
<dt>Default Value</dt>
|
|
1135
|
+
<dd><code>false</code></dd>
|
|
1136
|
+
</ul>
|
|
1137
|
+
</dd>
|
|
1138
|
+
<dt>Requires</dt>
|
|
1139
|
+
<dd><code>textField, iconImage</code></dd>
|
|
1140
|
+
<dt>Expression Parameters</dt>
|
|
1141
|
+
<dd><code>zoom</code></dd>
|
|
1142
|
+
</dl>
|
|
1046
1143
|
|
|
1047
|
-
#### Requires
|
|
1048
|
-
`textField, iconImage`
|
|
1049
1144
|
|
|
1050
|
-
#### Expression
|
|
1051
1145
|
|
|
1052
|
-
|
|
1146
|
+
### `visibility`
|
|
1053
1147
|
|
|
1054
|
-
___
|
|
1055
|
-
|
|
1056
|
-
#### Name
|
|
1057
|
-
`visibility`
|
|
1058
|
-
|
|
1059
|
-
#### Description
|
|
1060
1148
|
Whether this layer is displayed.
|
|
1061
1149
|
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1150
|
+
<dl>
|
|
1151
|
+
<dt>Type</dt>
|
|
1152
|
+
<dd>
|
|
1153
|
+
<code>enum</code>
|
|
1154
|
+
</dd>
|
|
1155
|
+
<dt>Default Value</dt>
|
|
1156
|
+
<dd><code>visible</code></dd>
|
|
1157
|
+
<dt>Supported Values</dt>
|
|
1158
|
+
<dd>
|
|
1159
|
+
<ul>
|
|
1160
|
+
<li>
|
|
1161
|
+
<code>visible</code>: The layer is shown.
|
|
1162
|
+
</li>
|
|
1163
|
+
<li>
|
|
1164
|
+
<code>none</code>: The layer is not shown.
|
|
1165
|
+
</li>
|
|
1166
|
+
</ul>
|
|
1167
|
+
</dd>
|
|
1168
|
+
</dl>
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
### `iconOpacity`
|
|
1074
1173
|
|
|
1075
|
-
#### Name
|
|
1076
|
-
`iconOpacity`
|
|
1077
|
-
|
|
1078
|
-
#### Description
|
|
1079
1174
|
The opacity at which the icon will be drawn.
|
|
1080
1175
|
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1176
|
+
<dl>
|
|
1177
|
+
<dt>Type</dt>
|
|
1178
|
+
<dd>
|
|
1179
|
+
<code>number</code>
|
|
1180
|
+
</dd>
|
|
1181
|
+
<dt>Default Value</dt>
|
|
1182
|
+
<dd><code>1</code></dd>
|
|
1183
|
+
</ul>
|
|
1184
|
+
</dd>
|
|
1185
|
+
<dt>Minimum</dt>
|
|
1186
|
+
<dd><code>0</code></dd>
|
|
1187
|
+
<dt>Maximum</dt>
|
|
1188
|
+
<dd><code>1</code></dd>
|
|
1189
|
+
<dt>Requires</dt>
|
|
1190
|
+
<dd><code>iconImage</code></dd>
|
|
1191
|
+
<dt>Expression Parameters</dt>
|
|
1192
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1193
|
+
</dl>
|
|
1194
|
+
|
|
1195
|
+
### `iconOpacityTransition`
|
|
1196
|
+
|
|
1197
|
+
The transition affecting any changes to this layer’s iconOpacity property.
|
|
1198
|
+
|
|
1199
|
+
<dl>
|
|
1200
|
+
<dt>Type</dt>
|
|
1201
|
+
<dd>
|
|
1202
|
+
<code>{ duration, delay }</code>
|
|
1203
|
+
</dd>
|
|
1204
|
+
|
|
1205
|
+
<dt>Units</dt>
|
|
1206
|
+
<dd>
|
|
1207
|
+
<code>milliseconds</code>
|
|
1208
|
+
</dd>
|
|
1209
|
+
|
|
1210
|
+
<dt>Default Value</dt>
|
|
1211
|
+
<dd>
|
|
1212
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1213
|
+
</dd>
|
|
1214
|
+
</dl>
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
### `iconColor`
|
|
1112
1218
|
|
|
1113
|
-
#### Units
|
|
1114
|
-
`milliseconds`
|
|
1115
|
-
|
|
1116
|
-
#### Default Value
|
|
1117
|
-
`{duration: 300, delay: 0}`
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
___
|
|
1121
|
-
|
|
1122
|
-
#### Name
|
|
1123
|
-
`iconColor`
|
|
1124
|
-
|
|
1125
|
-
#### Description
|
|
1126
1219
|
The color of the icon. This can only be used with SDF icons.
|
|
1127
1220
|
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
Parameters
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1221
|
+
<dl>
|
|
1222
|
+
<dt>Type</dt>
|
|
1223
|
+
<dd>
|
|
1224
|
+
<code>color</code>
|
|
1225
|
+
</dd>
|
|
1226
|
+
<dt>Default Value</dt>
|
|
1227
|
+
<dd><code>#000000</code></dd>
|
|
1228
|
+
</ul>
|
|
1229
|
+
</dd>
|
|
1230
|
+
<dt>Requires</dt>
|
|
1231
|
+
<dd><code>iconImage</code></dd>
|
|
1232
|
+
<dt>Expression Parameters</dt>
|
|
1233
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1234
|
+
</dl>
|
|
1235
|
+
|
|
1236
|
+
### `iconColorTransition`
|
|
1237
|
+
|
|
1238
|
+
The transition affecting any changes to this layer’s iconColor property.
|
|
1239
|
+
|
|
1240
|
+
<dl>
|
|
1241
|
+
<dt>Type</dt>
|
|
1242
|
+
<dd>
|
|
1243
|
+
<code>{ duration, delay }</code>
|
|
1244
|
+
</dd>
|
|
1245
|
+
|
|
1246
|
+
<dt>Units</dt>
|
|
1247
|
+
<dd>
|
|
1248
|
+
<code>milliseconds</code>
|
|
1249
|
+
</dd>
|
|
1250
|
+
|
|
1251
|
+
<dt>Default Value</dt>
|
|
1252
|
+
<dd>
|
|
1253
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1254
|
+
</dd>
|
|
1255
|
+
</dl>
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
### `iconHaloColor`
|
|
1149
1259
|
|
|
1150
|
-
#### Type
|
|
1151
|
-
|
|
1152
|
-
`{ duration, delay }`
|
|
1153
|
-
|
|
1154
|
-
#### Units
|
|
1155
|
-
`milliseconds`
|
|
1156
|
-
|
|
1157
|
-
#### Default Value
|
|
1158
|
-
`{duration: 300, delay: 0}`
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
___
|
|
1162
|
-
|
|
1163
|
-
#### Name
|
|
1164
|
-
`iconHaloColor`
|
|
1165
|
-
|
|
1166
|
-
#### Description
|
|
1167
1260
|
The color of the icon's halo. Icon halos can only be used with SDF icons.
|
|
1168
1261
|
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
Parameters
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1262
|
+
<dl>
|
|
1263
|
+
<dt>Type</dt>
|
|
1264
|
+
<dd>
|
|
1265
|
+
<code>color</code>
|
|
1266
|
+
</dd>
|
|
1267
|
+
<dt>Default Value</dt>
|
|
1268
|
+
<dd><code>rgba(0, 0, 0, 0)</code></dd>
|
|
1269
|
+
</ul>
|
|
1270
|
+
</dd>
|
|
1271
|
+
<dt>Requires</dt>
|
|
1272
|
+
<dd><code>iconImage</code></dd>
|
|
1273
|
+
<dt>Expression Parameters</dt>
|
|
1274
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1275
|
+
</dl>
|
|
1276
|
+
|
|
1277
|
+
### `iconHaloColorTransition`
|
|
1278
|
+
|
|
1279
|
+
The transition affecting any changes to this layer’s iconHaloColor property.
|
|
1280
|
+
|
|
1281
|
+
<dl>
|
|
1282
|
+
<dt>Type</dt>
|
|
1283
|
+
<dd>
|
|
1284
|
+
<code>{ duration, delay }</code>
|
|
1285
|
+
</dd>
|
|
1286
|
+
|
|
1287
|
+
<dt>Units</dt>
|
|
1288
|
+
<dd>
|
|
1289
|
+
<code>milliseconds</code>
|
|
1290
|
+
</dd>
|
|
1291
|
+
|
|
1292
|
+
<dt>Default Value</dt>
|
|
1293
|
+
<dd>
|
|
1294
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1295
|
+
</dd>
|
|
1296
|
+
</dl>
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
### `iconHaloWidth`
|
|
1186
1300
|
|
|
1187
|
-
#### Description
|
|
1188
|
-
|
|
1189
|
-
The transition affecting any changes to this layer’s iconHaloColor propery.
|
|
1190
|
-
|
|
1191
|
-
#### Type
|
|
1192
|
-
|
|
1193
|
-
`{ duration, delay }`
|
|
1194
|
-
|
|
1195
|
-
#### Units
|
|
1196
|
-
`milliseconds`
|
|
1197
|
-
|
|
1198
|
-
#### Default Value
|
|
1199
|
-
`{duration: 300, delay: 0}`
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
___
|
|
1203
|
-
|
|
1204
|
-
#### Name
|
|
1205
|
-
`iconHaloWidth`
|
|
1206
|
-
|
|
1207
|
-
#### Description
|
|
1208
1301
|
Distance of halo to the icon outline.
|
|
1209
1302
|
|
|
1210
1303
|
The unit is in pixels only for SDF sprites that were created with a blur radius of 8, multiplied by the display density. I.e., the radius needs to be 16 for `@2x` sprites, etc.
|
|
1211
1304
|
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1305
|
+
<dl>
|
|
1306
|
+
<dt>Type</dt>
|
|
1307
|
+
<dd>
|
|
1308
|
+
<code>number</code>
|
|
1309
|
+
</dd>
|
|
1310
|
+
<dt>Default Value</dt>
|
|
1311
|
+
<dd><code>0</code></dd>
|
|
1312
|
+
</ul>
|
|
1313
|
+
</dd>
|
|
1314
|
+
<dt>Units</dt>
|
|
1315
|
+
<dd><code>pixels</code></dd>
|
|
1316
|
+
<dt>Minimum</dt>
|
|
1317
|
+
<dd><code>0</code></dd>
|
|
1318
|
+
<dt>Requires</dt>
|
|
1319
|
+
<dd><code>iconImage</code></dd>
|
|
1320
|
+
<dt>Expression Parameters</dt>
|
|
1321
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1322
|
+
</dl>
|
|
1323
|
+
|
|
1324
|
+
### `iconHaloWidthTransition`
|
|
1325
|
+
|
|
1326
|
+
The transition affecting any changes to this layer’s iconHaloWidth property.
|
|
1327
|
+
|
|
1328
|
+
<dl>
|
|
1329
|
+
<dt>Type</dt>
|
|
1330
|
+
<dd>
|
|
1331
|
+
<code>{ duration, delay }</code>
|
|
1332
|
+
</dd>
|
|
1333
|
+
|
|
1334
|
+
<dt>Units</dt>
|
|
1335
|
+
<dd>
|
|
1336
|
+
<code>milliseconds</code>
|
|
1337
|
+
</dd>
|
|
1338
|
+
|
|
1339
|
+
<dt>Default Value</dt>
|
|
1340
|
+
<dd>
|
|
1341
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1342
|
+
</dd>
|
|
1343
|
+
</dl>
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
### `iconHaloBlur`
|
|
1226
1347
|
|
|
1227
|
-
#### Expression
|
|
1228
|
-
|
|
1229
|
-
Parameters: `zoom, feature, feature-state`
|
|
1230
|
-
___
|
|
1231
|
-
|
|
1232
|
-
#### Name
|
|
1233
|
-
|
|
1234
|
-
`iconHaloWidthTransition`
|
|
1235
|
-
|
|
1236
|
-
#### Description
|
|
1237
|
-
|
|
1238
|
-
The transition affecting any changes to this layer’s iconHaloWidth propery.
|
|
1239
|
-
|
|
1240
|
-
#### Type
|
|
1241
|
-
|
|
1242
|
-
`{ duration, delay }`
|
|
1243
|
-
|
|
1244
|
-
#### Units
|
|
1245
|
-
`milliseconds`
|
|
1246
|
-
|
|
1247
|
-
#### Default Value
|
|
1248
|
-
`{duration: 300, delay: 0}`
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
___
|
|
1252
|
-
|
|
1253
|
-
#### Name
|
|
1254
|
-
`iconHaloBlur`
|
|
1255
|
-
|
|
1256
|
-
#### Description
|
|
1257
1348
|
Fade out the halo towards the outside.
|
|
1258
1349
|
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1350
|
+
<dl>
|
|
1351
|
+
<dt>Type</dt>
|
|
1352
|
+
<dd>
|
|
1353
|
+
<code>number</code>
|
|
1354
|
+
</dd>
|
|
1355
|
+
<dt>Default Value</dt>
|
|
1356
|
+
<dd><code>0</code></dd>
|
|
1357
|
+
</ul>
|
|
1358
|
+
</dd>
|
|
1359
|
+
<dt>Units</dt>
|
|
1360
|
+
<dd><code>pixels</code></dd>
|
|
1361
|
+
<dt>Minimum</dt>
|
|
1362
|
+
<dd><code>0</code></dd>
|
|
1363
|
+
<dt>Requires</dt>
|
|
1364
|
+
<dd><code>iconImage</code></dd>
|
|
1365
|
+
<dt>Expression Parameters</dt>
|
|
1366
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1367
|
+
</dl>
|
|
1368
|
+
|
|
1369
|
+
### `iconHaloBlurTransition`
|
|
1370
|
+
|
|
1371
|
+
The transition affecting any changes to this layer’s iconHaloBlur property.
|
|
1372
|
+
|
|
1373
|
+
<dl>
|
|
1374
|
+
<dt>Type</dt>
|
|
1375
|
+
<dd>
|
|
1376
|
+
<code>{ duration, delay }</code>
|
|
1377
|
+
</dd>
|
|
1378
|
+
|
|
1379
|
+
<dt>Units</dt>
|
|
1380
|
+
<dd>
|
|
1381
|
+
<code>milliseconds</code>
|
|
1382
|
+
</dd>
|
|
1383
|
+
|
|
1384
|
+
<dt>Default Value</dt>
|
|
1385
|
+
<dd>
|
|
1386
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1387
|
+
</dd>
|
|
1388
|
+
</dl>
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
### `iconTranslate`
|
|
1293
1392
|
|
|
1294
|
-
#### Default Value
|
|
1295
|
-
`{duration: 300, delay: 0}`
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
___
|
|
1299
|
-
|
|
1300
|
-
#### Name
|
|
1301
|
-
`iconTranslate`
|
|
1302
|
-
|
|
1303
|
-
#### Description
|
|
1304
1393
|
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
1394
|
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1395
|
+
<dl>
|
|
1396
|
+
<dt>Type</dt>
|
|
1397
|
+
<dd>
|
|
1398
|
+
<code>array<number></code>
|
|
1399
|
+
</dd>
|
|
1400
|
+
<dt>Default Value</dt>
|
|
1401
|
+
<dd><code>[0,0]</code></dd>
|
|
1402
|
+
</ul>
|
|
1403
|
+
</dd>
|
|
1404
|
+
<dt>Units</dt>
|
|
1405
|
+
<dd><code>pixels</code></dd>
|
|
1406
|
+
<dt>Requires</dt>
|
|
1407
|
+
<dd><code>iconImage</code></dd>
|
|
1408
|
+
<dt>Expression Parameters</dt>
|
|
1409
|
+
<dd><code>zoom</code></dd>
|
|
1410
|
+
</dl>
|
|
1411
|
+
|
|
1412
|
+
### `iconTranslateTransition`
|
|
1413
|
+
|
|
1414
|
+
The transition affecting any changes to this layer’s iconTranslate property.
|
|
1415
|
+
|
|
1416
|
+
<dl>
|
|
1417
|
+
<dt>Type</dt>
|
|
1418
|
+
<dd>
|
|
1419
|
+
<code>{ duration, delay }</code>
|
|
1420
|
+
</dd>
|
|
1421
|
+
|
|
1422
|
+
<dt>Units</dt>
|
|
1423
|
+
<dd>
|
|
1424
|
+
<code>milliseconds</code>
|
|
1425
|
+
</dd>
|
|
1426
|
+
|
|
1427
|
+
<dt>Default Value</dt>
|
|
1428
|
+
<dd>
|
|
1429
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1430
|
+
</dd>
|
|
1431
|
+
</dl>
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
### `iconTranslateAnchor`
|
|
1330
1435
|
|
|
1331
|
-
#### Type
|
|
1332
|
-
|
|
1333
|
-
`{ duration, delay }`
|
|
1334
|
-
|
|
1335
|
-
#### Units
|
|
1336
|
-
`milliseconds`
|
|
1337
|
-
|
|
1338
|
-
#### Default Value
|
|
1339
|
-
`{duration: 300, delay: 0}`
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
___
|
|
1343
|
-
|
|
1344
|
-
#### Name
|
|
1345
|
-
`iconTranslateAnchor`
|
|
1346
|
-
|
|
1347
|
-
#### Description
|
|
1348
1436
|
Controls the frame of reference for `iconTranslate`.
|
|
1349
1437
|
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1438
|
+
<dl>
|
|
1439
|
+
<dt>Type</dt>
|
|
1440
|
+
<dd>
|
|
1441
|
+
<code>enum</code>
|
|
1442
|
+
</dd>
|
|
1443
|
+
<dt>Default Value</dt>
|
|
1444
|
+
<dd><code>map</code></dd>
|
|
1445
|
+
<dt>Supported Values</dt>
|
|
1446
|
+
<dd>
|
|
1447
|
+
<ul>
|
|
1448
|
+
<li>
|
|
1449
|
+
<code>map</code>: Icons are translated relative to the map.
|
|
1450
|
+
</li>
|
|
1451
|
+
<li>
|
|
1452
|
+
<code>viewport</code>: Icons are translated relative to the viewport.
|
|
1453
|
+
</li>
|
|
1454
|
+
</ul>
|
|
1455
|
+
</dd>
|
|
1456
|
+
<dt>Requires</dt>
|
|
1457
|
+
<dd><code>iconImage, iconTranslate</code></dd>
|
|
1458
|
+
<dt>Expression Parameters</dt>
|
|
1459
|
+
<dd><code>zoom</code></dd>
|
|
1460
|
+
</dl>
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
### `textOpacity`
|
|
1366
1465
|
|
|
1367
|
-
___
|
|
1368
|
-
|
|
1369
|
-
#### Name
|
|
1370
|
-
`textOpacity`
|
|
1371
|
-
|
|
1372
|
-
#### Description
|
|
1373
1466
|
The opacity at which the text will be drawn.
|
|
1374
1467
|
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|
|
1468
|
+
<dl>
|
|
1469
|
+
<dt>Type</dt>
|
|
1470
|
+
<dd>
|
|
1471
|
+
<code>number</code>
|
|
1472
|
+
</dd>
|
|
1473
|
+
<dt>Default Value</dt>
|
|
1474
|
+
<dd><code>1</code></dd>
|
|
1475
|
+
</ul>
|
|
1476
|
+
</dd>
|
|
1477
|
+
<dt>Minimum</dt>
|
|
1478
|
+
<dd><code>0</code></dd>
|
|
1479
|
+
<dt>Maximum</dt>
|
|
1480
|
+
<dd><code>1</code></dd>
|
|
1481
|
+
<dt>Requires</dt>
|
|
1482
|
+
<dd><code>textField</code></dd>
|
|
1483
|
+
<dt>Expression Parameters</dt>
|
|
1484
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1485
|
+
</dl>
|
|
1486
|
+
|
|
1487
|
+
### `textOpacityTransition`
|
|
1488
|
+
|
|
1489
|
+
The transition affecting any changes to this layer’s textOpacity property.
|
|
1490
|
+
|
|
1491
|
+
<dl>
|
|
1492
|
+
<dt>Type</dt>
|
|
1493
|
+
<dd>
|
|
1494
|
+
<code>{ duration, delay }</code>
|
|
1495
|
+
</dd>
|
|
1496
|
+
|
|
1497
|
+
<dt>Units</dt>
|
|
1498
|
+
<dd>
|
|
1499
|
+
<code>milliseconds</code>
|
|
1500
|
+
</dd>
|
|
1501
|
+
|
|
1502
|
+
<dt>Default Value</dt>
|
|
1503
|
+
<dd>
|
|
1504
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1505
|
+
</dd>
|
|
1506
|
+
</dl>
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
### `textColor`
|
|
1404
1510
|
|
|
1405
|
-
`{ duration, delay }`
|
|
1406
|
-
|
|
1407
|
-
#### Units
|
|
1408
|
-
`milliseconds`
|
|
1409
|
-
|
|
1410
|
-
#### Default Value
|
|
1411
|
-
`{duration: 300, delay: 0}`
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
___
|
|
1415
|
-
|
|
1416
|
-
#### Name
|
|
1417
|
-
`textColor`
|
|
1418
|
-
|
|
1419
|
-
#### Description
|
|
1420
1511
|
The color with which the text will be drawn.
|
|
1421
1512
|
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
Parameters
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1513
|
+
<dl>
|
|
1514
|
+
<dt>Type</dt>
|
|
1515
|
+
<dd>
|
|
1516
|
+
<code>color</code>
|
|
1517
|
+
</dd>
|
|
1518
|
+
<dt>Default Value</dt>
|
|
1519
|
+
<dd><code>#000000</code></dd>
|
|
1520
|
+
</ul>
|
|
1521
|
+
</dd>
|
|
1522
|
+
<dt>Requires</dt>
|
|
1523
|
+
<dd><code>textField</code></dd>
|
|
1524
|
+
<dt>Expression Parameters</dt>
|
|
1525
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1526
|
+
</dl>
|
|
1527
|
+
|
|
1528
|
+
### `textColorTransition`
|
|
1529
|
+
|
|
1530
|
+
The transition affecting any changes to this layer’s textColor property.
|
|
1531
|
+
|
|
1532
|
+
<dl>
|
|
1533
|
+
<dt>Type</dt>
|
|
1534
|
+
<dd>
|
|
1535
|
+
<code>{ duration, delay }</code>
|
|
1536
|
+
</dd>
|
|
1537
|
+
|
|
1538
|
+
<dt>Units</dt>
|
|
1539
|
+
<dd>
|
|
1540
|
+
<code>milliseconds</code>
|
|
1541
|
+
</dd>
|
|
1542
|
+
|
|
1543
|
+
<dt>Default Value</dt>
|
|
1544
|
+
<dd>
|
|
1545
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1546
|
+
</dd>
|
|
1547
|
+
</dl>
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
### `textHaloColor`
|
|
1441
1551
|
|
|
1442
|
-
The transition affecting any changes to this layer’s textColor propery.
|
|
1443
|
-
|
|
1444
|
-
#### Type
|
|
1445
|
-
|
|
1446
|
-
`{ duration, delay }`
|
|
1447
|
-
|
|
1448
|
-
#### Units
|
|
1449
|
-
`milliseconds`
|
|
1450
|
-
|
|
1451
|
-
#### Default Value
|
|
1452
|
-
`{duration: 300, delay: 0}`
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
___
|
|
1456
|
-
|
|
1457
|
-
#### Name
|
|
1458
|
-
`textHaloColor`
|
|
1459
|
-
|
|
1460
|
-
#### Description
|
|
1461
1552
|
The color of the text's halo, which helps it stand out from backgrounds.
|
|
1462
1553
|
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
Parameters
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1554
|
+
<dl>
|
|
1555
|
+
<dt>Type</dt>
|
|
1556
|
+
<dd>
|
|
1557
|
+
<code>color</code>
|
|
1558
|
+
</dd>
|
|
1559
|
+
<dt>Default Value</dt>
|
|
1560
|
+
<dd><code>rgba(0, 0, 0, 0)</code></dd>
|
|
1561
|
+
</ul>
|
|
1562
|
+
</dd>
|
|
1563
|
+
<dt>Requires</dt>
|
|
1564
|
+
<dd><code>textField</code></dd>
|
|
1565
|
+
<dt>Expression Parameters</dt>
|
|
1566
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1567
|
+
</dl>
|
|
1568
|
+
|
|
1569
|
+
### `textHaloColorTransition`
|
|
1570
|
+
|
|
1571
|
+
The transition affecting any changes to this layer’s textHaloColor property.
|
|
1572
|
+
|
|
1573
|
+
<dl>
|
|
1574
|
+
<dt>Type</dt>
|
|
1575
|
+
<dd>
|
|
1576
|
+
<code>{ duration, delay }</code>
|
|
1577
|
+
</dd>
|
|
1578
|
+
|
|
1579
|
+
<dt>Units</dt>
|
|
1580
|
+
<dd>
|
|
1581
|
+
<code>milliseconds</code>
|
|
1582
|
+
</dd>
|
|
1583
|
+
|
|
1584
|
+
<dt>Default Value</dt>
|
|
1585
|
+
<dd>
|
|
1586
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1587
|
+
</dd>
|
|
1588
|
+
</dl>
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
### `textHaloWidth`
|
|
1478
1592
|
|
|
1479
|
-
`textHaloColorTransition`
|
|
1480
|
-
|
|
1481
|
-
#### Description
|
|
1482
|
-
|
|
1483
|
-
The transition affecting any changes to this layer’s textHaloColor propery.
|
|
1484
|
-
|
|
1485
|
-
#### Type
|
|
1486
|
-
|
|
1487
|
-
`{ duration, delay }`
|
|
1488
|
-
|
|
1489
|
-
#### Units
|
|
1490
|
-
`milliseconds`
|
|
1491
|
-
|
|
1492
|
-
#### Default Value
|
|
1493
|
-
`{duration: 300, delay: 0}`
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
___
|
|
1497
|
-
|
|
1498
|
-
#### Name
|
|
1499
|
-
`textHaloWidth`
|
|
1500
|
-
|
|
1501
|
-
#### Description
|
|
1502
1593
|
Distance of halo to the font outline. Max text halo width is 1/4 of the fontSize.
|
|
1503
1594
|
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1595
|
+
<dl>
|
|
1596
|
+
<dt>Type</dt>
|
|
1597
|
+
<dd>
|
|
1598
|
+
<code>number</code>
|
|
1599
|
+
</dd>
|
|
1600
|
+
<dt>Default Value</dt>
|
|
1601
|
+
<dd><code>0</code></dd>
|
|
1602
|
+
</ul>
|
|
1603
|
+
</dd>
|
|
1604
|
+
<dt>Units</dt>
|
|
1605
|
+
<dd><code>pixels</code></dd>
|
|
1606
|
+
<dt>Minimum</dt>
|
|
1607
|
+
<dd><code>0</code></dd>
|
|
1608
|
+
<dt>Requires</dt>
|
|
1609
|
+
<dd><code>textField</code></dd>
|
|
1610
|
+
<dt>Expression Parameters</dt>
|
|
1611
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1612
|
+
</dl>
|
|
1613
|
+
|
|
1614
|
+
### `textHaloWidthTransition`
|
|
1615
|
+
|
|
1616
|
+
The transition affecting any changes to this layer’s textHaloWidth property.
|
|
1617
|
+
|
|
1618
|
+
<dl>
|
|
1619
|
+
<dt>Type</dt>
|
|
1620
|
+
<dd>
|
|
1621
|
+
<code>{ duration, delay }</code>
|
|
1622
|
+
</dd>
|
|
1623
|
+
|
|
1624
|
+
<dt>Units</dt>
|
|
1625
|
+
<dd>
|
|
1626
|
+
<code>milliseconds</code>
|
|
1627
|
+
</dd>
|
|
1628
|
+
|
|
1629
|
+
<dt>Default Value</dt>
|
|
1630
|
+
<dd>
|
|
1631
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1632
|
+
</dd>
|
|
1633
|
+
</dl>
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
### `textHaloBlur`
|
|
1515
1637
|
|
|
1516
|
-
#### Requires
|
|
1517
|
-
`textField`
|
|
1518
|
-
|
|
1519
|
-
#### Expression
|
|
1520
|
-
|
|
1521
|
-
Parameters: `zoom, feature, feature-state`
|
|
1522
|
-
___
|
|
1523
|
-
|
|
1524
|
-
#### Name
|
|
1525
|
-
|
|
1526
|
-
`textHaloWidthTransition`
|
|
1527
|
-
|
|
1528
|
-
#### Description
|
|
1529
|
-
|
|
1530
|
-
The transition affecting any changes to this layer’s textHaloWidth propery.
|
|
1531
|
-
|
|
1532
|
-
#### Type
|
|
1533
|
-
|
|
1534
|
-
`{ duration, delay }`
|
|
1535
|
-
|
|
1536
|
-
#### Units
|
|
1537
|
-
`milliseconds`
|
|
1538
|
-
|
|
1539
|
-
#### Default Value
|
|
1540
|
-
`{duration: 300, delay: 0}`
|
|
1541
|
-
|
|
1542
|
-
|
|
1543
|
-
___
|
|
1544
|
-
|
|
1545
|
-
#### Name
|
|
1546
|
-
`textHaloBlur`
|
|
1547
|
-
|
|
1548
|
-
#### Description
|
|
1549
1638
|
The halo's fadeout distance towards the outside.
|
|
1550
1639
|
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
|
|
1558
|
-
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1640
|
+
<dl>
|
|
1641
|
+
<dt>Type</dt>
|
|
1642
|
+
<dd>
|
|
1643
|
+
<code>number</code>
|
|
1644
|
+
</dd>
|
|
1645
|
+
<dt>Default Value</dt>
|
|
1646
|
+
<dd><code>0</code></dd>
|
|
1647
|
+
</ul>
|
|
1648
|
+
</dd>
|
|
1649
|
+
<dt>Units</dt>
|
|
1650
|
+
<dd><code>pixels</code></dd>
|
|
1651
|
+
<dt>Minimum</dt>
|
|
1652
|
+
<dd><code>0</code></dd>
|
|
1653
|
+
<dt>Requires</dt>
|
|
1654
|
+
<dd><code>textField</code></dd>
|
|
1655
|
+
<dt>Expression Parameters</dt>
|
|
1656
|
+
<dd><code>zoom, feature, feature-state</code></dd>
|
|
1657
|
+
</dl>
|
|
1658
|
+
|
|
1659
|
+
### `textHaloBlurTransition`
|
|
1660
|
+
|
|
1661
|
+
The transition affecting any changes to this layer’s textHaloBlur property.
|
|
1662
|
+
|
|
1663
|
+
<dl>
|
|
1664
|
+
<dt>Type</dt>
|
|
1665
|
+
<dd>
|
|
1666
|
+
<code>{ duration, delay }</code>
|
|
1667
|
+
</dd>
|
|
1668
|
+
|
|
1669
|
+
<dt>Units</dt>
|
|
1670
|
+
<dd>
|
|
1671
|
+
<code>milliseconds</code>
|
|
1672
|
+
</dd>
|
|
1673
|
+
|
|
1674
|
+
<dt>Default Value</dt>
|
|
1675
|
+
<dd>
|
|
1676
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1677
|
+
</dd>
|
|
1678
|
+
</dl>
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
### `textTranslate`
|
|
1582
1682
|
|
|
1583
|
-
#### Units
|
|
1584
|
-
`milliseconds`
|
|
1585
|
-
|
|
1586
|
-
#### Default Value
|
|
1587
|
-
`{duration: 300, delay: 0}`
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
___
|
|
1591
|
-
|
|
1592
|
-
#### Name
|
|
1593
|
-
`textTranslate`
|
|
1594
|
-
|
|
1595
|
-
#### Description
|
|
1596
1683
|
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
1684
|
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1685
|
+
<dl>
|
|
1686
|
+
<dt>Type</dt>
|
|
1687
|
+
<dd>
|
|
1688
|
+
<code>array<number></code>
|
|
1689
|
+
</dd>
|
|
1690
|
+
<dt>Default Value</dt>
|
|
1691
|
+
<dd><code>[0,0]</code></dd>
|
|
1692
|
+
</ul>
|
|
1693
|
+
</dd>
|
|
1694
|
+
<dt>Units</dt>
|
|
1695
|
+
<dd><code>pixels</code></dd>
|
|
1696
|
+
<dt>Requires</dt>
|
|
1697
|
+
<dd><code>textField</code></dd>
|
|
1698
|
+
<dt>Expression Parameters</dt>
|
|
1699
|
+
<dd><code>zoom</code></dd>
|
|
1700
|
+
</dl>
|
|
1701
|
+
|
|
1702
|
+
### `textTranslateTransition`
|
|
1703
|
+
|
|
1704
|
+
The transition affecting any changes to this layer’s textTranslate property.
|
|
1705
|
+
|
|
1706
|
+
<dl>
|
|
1707
|
+
<dt>Type</dt>
|
|
1708
|
+
<dd>
|
|
1709
|
+
<code>{ duration, delay }</code>
|
|
1710
|
+
</dd>
|
|
1711
|
+
|
|
1712
|
+
<dt>Units</dt>
|
|
1713
|
+
<dd>
|
|
1714
|
+
<code>milliseconds</code>
|
|
1715
|
+
</dd>
|
|
1716
|
+
|
|
1717
|
+
<dt>Default Value</dt>
|
|
1718
|
+
<dd>
|
|
1719
|
+
<code>{duration: 300, delay: 0}</code>
|
|
1720
|
+
</dd>
|
|
1721
|
+
</dl>
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
### `textTranslateAnchor`
|
|
1620
1725
|
|
|
1621
|
-
The transition affecting any changes to this layer’s textTranslate propery.
|
|
1622
|
-
|
|
1623
|
-
#### Type
|
|
1624
|
-
|
|
1625
|
-
`{ duration, delay }`
|
|
1626
|
-
|
|
1627
|
-
#### Units
|
|
1628
|
-
`milliseconds`
|
|
1629
|
-
|
|
1630
|
-
#### Default Value
|
|
1631
|
-
`{duration: 300, delay: 0}`
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
___
|
|
1635
|
-
|
|
1636
|
-
#### Name
|
|
1637
|
-
`textTranslateAnchor`
|
|
1638
|
-
|
|
1639
|
-
#### Description
|
|
1640
1726
|
Controls the frame of reference for `textTranslate`.
|
|
1641
1727
|
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1728
|
+
<dl>
|
|
1729
|
+
<dt>Type</dt>
|
|
1730
|
+
<dd>
|
|
1731
|
+
<code>enum</code>
|
|
1732
|
+
</dd>
|
|
1733
|
+
<dt>Default Value</dt>
|
|
1734
|
+
<dd><code>map</code></dd>
|
|
1735
|
+
<dt>Supported Values</dt>
|
|
1736
|
+
<dd>
|
|
1737
|
+
<ul>
|
|
1738
|
+
<li>
|
|
1739
|
+
<code>map</code>: The text is translated relative to the map.
|
|
1740
|
+
</li>
|
|
1741
|
+
<li>
|
|
1742
|
+
<code>viewport</code>: The text is translated relative to the viewport.
|
|
1743
|
+
</li>
|
|
1744
|
+
</ul>
|
|
1745
|
+
</dd>
|
|
1746
|
+
<dt>Requires</dt>
|
|
1747
|
+
<dd><code>textField, textTranslate</code></dd>
|
|
1748
|
+
<dt>Expression Parameters</dt>
|
|
1749
|
+
<dd><code>zoom</code></dd>
|
|
1750
|
+
</dl>
|
|
1656
1751
|
|
|
1657
|
-
Parameters: `zoom`
|
|
1658
1752
|
|