@maplibre/maplibre-react-native 10.0.0-alpha.24 → 10.0.0-alpha.26
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 +12 -0
- package/CONTRIBUTING.md +1 -1
- package/android/build.gradle +51 -16
- package/docs/Annotation.md +8 -17
- package/docs/BackgroundLayer.md +136 -128
- package/docs/Callout.md +5 -4
- package/docs/Camera.md +38 -39
- package/docs/CircleLayer.md +413 -388
- package/docs/FillExtrusionLayer.md +303 -292
- package/docs/FillLayer.md +266 -251
- package/docs/HeadingIndicator.md +5 -4
- package/docs/HeatmapLayer.md +179 -172
- package/docs/ImageSource.md +5 -4
- package/docs/Images.md +5 -4
- package/docs/Light.md +131 -123
- package/docs/LineLayer.md +525 -498
- package/docs/MapView.md +23 -42
- package/docs/MarkerView.md +5 -4
- package/docs/NativeUserLocation.md +5 -4
- package/docs/PointAnnotation.md +7 -10
- package/docs/RasterLayer.md +318 -310
- package/docs/RasterSource.md +5 -4
- package/docs/ShapeSource.md +16 -15
- package/docs/Style.md +5 -4
- package/docs/SymbolLayer.md +1501 -1406
- package/docs/UserLocation.md +10 -13
- package/docs/VectorSource.md +10 -9
- package/docs/coordinates.md +4 -3
- package/docs/docs.json +49 -88
- package/docs/location.md +4 -3
- package/docs/offlineManager.md +29 -44
- package/docs/snapshotManager.md +7 -6
- package/ios/RCTMLN/RCTMLNCamera.h +0 -3
- package/ios/RCTMLN/RCTMLNCamera.m +1 -1
- package/ios/RCTMLN/RCTMLNCameraManager.m +0 -3
- package/javascript/MLNModule.ts +9 -0
- package/javascript/Maplibre.ts +1 -1
- package/javascript/components/{annotations/Annotation.tsx → Annotation.tsx} +5 -5
- package/javascript/components/Camera.tsx +257 -388
- package/javascript/components/UserLocation.tsx +1 -1
- package/javascript/hooks/useNativeRef.ts +2 -1
- package/javascript/types/CameraMode.ts +6 -0
- package/package.json +16 -24
- package/scripts/codegen.ts +340 -0
- package/scripts/templates/MaplibreStyles.ts.ejs +8 -7
- package/scripts/templates/RCTMLNStyle.h.ejs +4 -3
- package/scripts/templates/RCTMLNStyle.m.ejs +11 -10
- package/scripts/templates/RCTMLNStyleFactory.java.ejs +12 -11
- package/scripts/templates/component.md.ejs +88 -85
- package/scripts/templates/index.d.ts.ejs +2 -1
- package/scripts/templates/styleMap.ts.ejs +2 -1
- package/scripts/utils/{DocJSONBuilder.js → DocJSONBuilder.ts} +133 -128
- package/scripts/utils/{JSDocNodeTree.js → JSDocNodeTree.ts} +14 -13
- package/scripts/utils/MarkdownBuilder.ts +44 -0
- package/scripts/utils/{template-globals.js → TemplateHelpers.ts} +66 -95
- package/scripts/utils/getNativeVersion.ts +53 -0
- package/tsconfig.json +2 -3
- 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/docs/OfflineManager.md +0 -246
- package/react-native.config.js +0 -10
- package/scripts/download-style-spec.sh +0 -15
- package/scripts/generate-docs.js +0 -396
- package/scripts/utils/MarkdownBuilder.js +0 -37
- package/style-spec/v8.json +0 -6645
- /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/RCTMLNStyleFactory.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,8 +1,9 @@
|
|
|
1
|
-
<!--
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
<!-- DO NOT MODIFY! -->
|
|
2
|
+
<!-- This file is auto-generated from javascript/components/SymbolLayer.tsx -->
|
|
3
|
+
# `<MapLibreGL.SymbolLayer />`
|
|
4
|
+
SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map.
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
## Props
|
|
6
7
|
| Prop | Type | Default | Required | Description |
|
|
7
8
|
| ---- | :--: | :-----: | :------: | :----------: |
|
|
8
9
|
| style | `SymbolLayerStyleProps` | `none` | `false` | Customizable style attributes |
|
|
@@ -10,1648 +11,1742 @@
|
|
|
10
11
|
| sourceID | `FIX ME UNKNOWN TYPE` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | FIX ME NO DESCRIPTION |
|
|
11
12
|
|
|
12
13
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
* <a href="#name"
|
|
16
|
-
* <a href="#name-1"
|
|
17
|
-
* <a href="#name-2"
|
|
18
|
-
* <a href="#name-3"
|
|
19
|
-
* <a href="#name-4"
|
|
20
|
-
* <a href="#name-5"
|
|
21
|
-
* <a href="#name-6"
|
|
22
|
-
* <a href="#name-7"
|
|
23
|
-
* <a href="#name-8"
|
|
24
|
-
* <a href="#name-9"
|
|
25
|
-
* <a href="#name-10"
|
|
26
|
-
* <a href="#name-11"
|
|
27
|
-
* <a href="#name-12"
|
|
28
|
-
* <a href="#name-13"
|
|
29
|
-
* <a href="#name-14"
|
|
30
|
-
* <a href="#name-15"
|
|
31
|
-
* <a href="#name-16"
|
|
32
|
-
* <a href="#name-17"
|
|
33
|
-
* <a href="#name-18"
|
|
34
|
-
* <a href="#name-19"
|
|
35
|
-
* <a href="#name-20"
|
|
36
|
-
* <a href="#name-21"
|
|
37
|
-
* <a href="#name-22"
|
|
38
|
-
* <a href="#name-23"
|
|
39
|
-
* <a href="#name-24"
|
|
40
|
-
* <a href="#name-25"
|
|
41
|
-
* <a href="#name-26"
|
|
42
|
-
* <a href="#name-27"
|
|
43
|
-
* <a href="#name-28"
|
|
44
|
-
* <a href="#name-29"
|
|
45
|
-
* <a href="#name-30"
|
|
46
|
-
* <a href="#name-31"
|
|
47
|
-
* <a href="#name-32"
|
|
48
|
-
* <a href="#name-33"
|
|
49
|
-
* <a href="#name-34"
|
|
50
|
-
* <a href="#name-35"
|
|
51
|
-
* <a href="#name-36"
|
|
52
|
-
* <a href="#name-37"
|
|
53
|
-
* <a href="#name-38"
|
|
54
|
-
* <a href="#name-39"
|
|
55
|
-
* <a href="#name-40"
|
|
56
|
-
* <a href="#name-41"
|
|
57
|
-
* <a href="#name-42"
|
|
58
|
-
* <a href="#name-43"
|
|
59
|
-
* <a href="#name-44"
|
|
60
|
-
* <a href="#name-45"
|
|
61
|
-
* <a href="#name-46"
|
|
62
|
-
* <a href="#name-47"
|
|
63
|
-
* <a href="#name-48"
|
|
64
|
-
* <a href="#name-49"
|
|
65
|
-
* <a href="#name-50"
|
|
66
|
-
* <a href="#name-51"
|
|
67
|
-
* <a href="#name-52"
|
|
68
|
-
* <a href="#name-53"
|
|
69
|
-
* <a href="#name-54"
|
|
70
|
-
* <a href="#name-55"
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
#### Name
|
|
75
|
-
`symbolPlacement`
|
|
76
|
-
|
|
77
|
-
#### Description
|
|
78
|
-
Label placement relative to its geometry.
|
|
79
|
-
|
|
80
|
-
#### Type
|
|
81
|
-
`enum`
|
|
82
|
-
#### Default Value
|
|
83
|
-
`point`
|
|
84
|
-
|
|
85
|
-
#### Supported Values
|
|
86
|
-
**point** - The label is placed at the point where the geometry is located.<br />
|
|
87
|
-
**line** - The label is placed along the line of the geometry. Can only be used on `LineString` and `Polygon` geometries.<br />
|
|
88
|
-
**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 />
|
|
89
|
-
|
|
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`
|
|
90
75
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
Parameters: `zoom`
|
|
94
|
-
|
|
95
|
-
___
|
|
76
|
+
Label placement relative to its geometry.
|
|
96
77
|
|
|
97
|
-
|
|
98
|
-
|
|
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`
|
|
99
106
|
|
|
100
|
-
#### Description
|
|
101
107
|
Distance between two symbol anchors.
|
|
102
108
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
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>
|
|
107
125
|
|
|
108
|
-
#### Units
|
|
109
|
-
`pixels`
|
|
110
126
|
|
|
111
|
-
#### Minimum
|
|
112
|
-
`1`
|
|
113
127
|
|
|
128
|
+
### `symbolAvoidEdges`
|
|
114
129
|
|
|
115
|
-
#### Expression
|
|
116
|
-
|
|
117
|
-
Parameters: `zoom`
|
|
118
|
-
|
|
119
|
-
___
|
|
120
|
-
|
|
121
|
-
#### Name
|
|
122
|
-
`symbolAvoidEdges`
|
|
123
|
-
|
|
124
|
-
#### Description
|
|
125
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.
|
|
126
131
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
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>
|
|
134
144
|
|
|
135
|
-
Parameters: `zoom`
|
|
136
145
|
|
|
137
|
-
___
|
|
138
146
|
|
|
139
|
-
|
|
140
|
-
`symbolSortKey`
|
|
147
|
+
### `symbolSortKey`
|
|
141
148
|
|
|
142
|
-
#### Description
|
|
143
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.
|
|
144
150
|
|
|
145
|
-
|
|
146
|
-
|
|
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>
|
|
147
161
|
|
|
148
162
|
|
|
149
|
-
#### Expression
|
|
150
163
|
|
|
151
|
-
|
|
164
|
+
### `symbolZOrder`
|
|
152
165
|
|
|
153
|
-
___
|
|
154
|
-
|
|
155
|
-
#### Name
|
|
156
|
-
`symbolZOrder`
|
|
157
|
-
|
|
158
|
-
#### Description
|
|
159
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`.
|
|
160
167
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
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`
|
|
177
196
|
|
|
178
|
-
#### Name
|
|
179
|
-
`iconAllowOverlap`
|
|
180
|
-
|
|
181
|
-
#### Description
|
|
182
197
|
If true, the icon will be visible even if it collides with other previously drawn symbols.
|
|
183
198
|
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
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>
|
|
192
215
|
|
|
193
|
-
#### Disabled By
|
|
194
|
-
`iconOverlap`
|
|
195
216
|
|
|
196
|
-
#### Expression
|
|
197
217
|
|
|
198
|
-
|
|
218
|
+
### `iconIgnorePlacement`
|
|
199
219
|
|
|
200
|
-
___
|
|
201
|
-
|
|
202
|
-
#### Name
|
|
203
|
-
`iconIgnorePlacement`
|
|
204
|
-
|
|
205
|
-
#### Description
|
|
206
220
|
If true, other symbols can be visible even if they collide with the icon.
|
|
207
221
|
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
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>
|
|
213
236
|
|
|
214
|
-
#### Requires
|
|
215
|
-
`iconImage`
|
|
216
237
|
|
|
217
|
-
#### Expression
|
|
218
238
|
|
|
219
|
-
|
|
239
|
+
### `iconOptional`
|
|
220
240
|
|
|
221
|
-
___
|
|
222
|
-
|
|
223
|
-
#### Name
|
|
224
|
-
`iconOptional`
|
|
225
|
-
|
|
226
|
-
#### Description
|
|
227
241
|
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
|
|
228
242
|
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
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>
|
|
237
257
|
|
|
238
|
-
#### Expression
|
|
239
258
|
|
|
240
|
-
Parameters: `zoom`
|
|
241
259
|
|
|
242
|
-
|
|
260
|
+
### `iconRotationAlignment`
|
|
243
261
|
|
|
244
|
-
#### Name
|
|
245
|
-
`iconRotationAlignment`
|
|
246
|
-
|
|
247
|
-
#### Description
|
|
248
262
|
In combination with `symbolPlacement`, determines the rotation behavior of icons.
|
|
249
263
|
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
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`
|
|
260
294
|
|
|
261
|
-
#### Requires
|
|
262
|
-
`iconImage`
|
|
263
|
-
|
|
264
|
-
#### Expression
|
|
265
|
-
|
|
266
|
-
Parameters: `zoom`
|
|
267
|
-
|
|
268
|
-
___
|
|
269
|
-
|
|
270
|
-
#### Name
|
|
271
|
-
`iconSize`
|
|
272
|
-
|
|
273
|
-
#### Description
|
|
274
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.
|
|
275
296
|
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
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`
|
|
283
319
|
|
|
284
|
-
#### Minimum
|
|
285
|
-
`0`
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
#### Requires
|
|
289
|
-
`iconImage`
|
|
290
|
-
|
|
291
|
-
#### Expression
|
|
292
|
-
|
|
293
|
-
Parameters: `zoom, feature`
|
|
294
|
-
|
|
295
|
-
___
|
|
296
|
-
|
|
297
|
-
#### Name
|
|
298
|
-
`iconTextFit`
|
|
299
|
-
|
|
300
|
-
#### Description
|
|
301
320
|
Scales the icon to fit around the associated text.
|
|
302
321
|
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
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`
|
|
323
355
|
|
|
324
|
-
#### Name
|
|
325
|
-
`iconTextFitPadding`
|
|
326
|
-
|
|
327
|
-
#### Description
|
|
328
356
|
Size of the additional area added to dimensions determined by `iconTextFit`, in clockwise order: top, right, bottom, left.
|
|
329
357
|
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
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>
|
|
341
374
|
|
|
342
|
-
#### Expression
|
|
343
375
|
|
|
344
|
-
Parameters: `zoom`
|
|
345
376
|
|
|
346
|
-
|
|
377
|
+
### `iconImage`
|
|
347
378
|
|
|
348
|
-
#### Name
|
|
349
|
-
`iconImage`
|
|
350
|
-
|
|
351
|
-
#### Description
|
|
352
379
|
Name of image in sprite to use for drawing an image background.
|
|
353
380
|
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
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>
|
|
359
391
|
|
|
360
|
-
Parameters: `zoom, feature`
|
|
361
392
|
|
|
362
|
-
___
|
|
363
393
|
|
|
364
|
-
|
|
365
|
-
`iconRotate`
|
|
394
|
+
### `iconRotate`
|
|
366
395
|
|
|
367
|
-
#### Description
|
|
368
396
|
Rotates the icon clockwise.
|
|
369
397
|
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
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>
|
|
374
414
|
|
|
375
|
-
#### Units
|
|
376
|
-
`degrees`
|
|
377
415
|
|
|
378
416
|
|
|
379
|
-
|
|
380
|
-
`iconImage`
|
|
417
|
+
### `iconPadding`
|
|
381
418
|
|
|
382
|
-
#### Expression
|
|
383
|
-
|
|
384
|
-
Parameters: `zoom, feature`
|
|
385
|
-
|
|
386
|
-
___
|
|
387
|
-
|
|
388
|
-
#### Name
|
|
389
|
-
`iconPadding`
|
|
390
|
-
|
|
391
|
-
#### Description
|
|
392
419
|
Size of additional area round the icon bounding box used for detecting symbol collisions.
|
|
393
420
|
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
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>
|
|
402
437
|
|
|
403
|
-
#### Requires
|
|
404
|
-
`iconImage`
|
|
405
438
|
|
|
406
|
-
#### Expression
|
|
407
439
|
|
|
408
|
-
|
|
440
|
+
### `iconKeepUpright`
|
|
409
441
|
|
|
410
|
-
___
|
|
411
|
-
|
|
412
|
-
#### Name
|
|
413
|
-
`iconKeepUpright`
|
|
414
|
-
|
|
415
|
-
#### Description
|
|
416
442
|
If true, the icon may be flipped to prevent it from being rendered upsideDown.
|
|
417
443
|
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
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>
|
|
426
458
|
|
|
427
|
-
#### Expression
|
|
428
459
|
|
|
429
|
-
Parameters: `zoom`
|
|
430
460
|
|
|
431
|
-
|
|
461
|
+
### `iconOffset`
|
|
432
462
|
|
|
433
|
-
#### Name
|
|
434
|
-
`iconOffset`
|
|
435
|
-
|
|
436
|
-
#### Description
|
|
437
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.
|
|
438
464
|
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
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>
|
|
447
479
|
|
|
448
|
-
#### Expression
|
|
449
480
|
|
|
450
|
-
Parameters: `zoom, feature`
|
|
451
481
|
|
|
452
|
-
|
|
482
|
+
### `iconAnchor`
|
|
453
483
|
|
|
454
|
-
#### Name
|
|
455
|
-
`iconAnchor`
|
|
456
|
-
|
|
457
|
-
#### Description
|
|
458
484
|
Part of the icon placed closest to the anchor.
|
|
459
485
|
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
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`
|
|
483
534
|
|
|
484
|
-
___
|
|
485
|
-
|
|
486
|
-
#### Name
|
|
487
|
-
`iconPitchAlignment`
|
|
488
|
-
|
|
489
|
-
#### Description
|
|
490
535
|
Orientation of icon when map is pitched.
|
|
491
536
|
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
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`
|
|
509
567
|
|
|
510
|
-
___
|
|
511
|
-
|
|
512
|
-
#### Name
|
|
513
|
-
`textPitchAlignment`
|
|
514
|
-
|
|
515
|
-
#### Description
|
|
516
568
|
Orientation of text when map is pitched.
|
|
517
569
|
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
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`
|
|
533
600
|
|
|
534
|
-
Parameters: `zoom`
|
|
535
|
-
|
|
536
|
-
___
|
|
537
|
-
|
|
538
|
-
#### Name
|
|
539
|
-
`textRotationAlignment`
|
|
540
|
-
|
|
541
|
-
#### Description
|
|
542
601
|
In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text.
|
|
543
602
|
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
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`
|
|
558
636
|
|
|
559
|
-
#### Expression
|
|
560
|
-
|
|
561
|
-
Parameters: `zoom`
|
|
562
|
-
|
|
563
|
-
___
|
|
564
|
-
|
|
565
|
-
#### Name
|
|
566
|
-
`textField`
|
|
567
|
-
|
|
568
|
-
#### Description
|
|
569
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.
|
|
570
638
|
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
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>
|
|
578
651
|
|
|
579
|
-
Parameters: `zoom, feature`
|
|
580
652
|
|
|
581
|
-
___
|
|
582
653
|
|
|
583
|
-
|
|
584
|
-
`textFont`
|
|
654
|
+
### `textFont`
|
|
585
655
|
|
|
586
|
-
#### Description
|
|
587
656
|
Font stack to use for displaying text.
|
|
588
657
|
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
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>
|
|
593
674
|
|
|
594
675
|
|
|
595
|
-
#### Requires
|
|
596
|
-
`textField`
|
|
597
676
|
|
|
598
|
-
|
|
599
|
-
`camera`
|
|
600
|
-
#### Expression
|
|
677
|
+
### `textSize`
|
|
601
678
|
|
|
602
|
-
Parameters: `zoom, feature`
|
|
603
|
-
|
|
604
|
-
___
|
|
605
|
-
|
|
606
|
-
#### Name
|
|
607
|
-
`textSize`
|
|
608
|
-
|
|
609
|
-
#### Description
|
|
610
679
|
Font size.
|
|
611
680
|
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
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`
|
|
626
703
|
|
|
627
|
-
#### Expression
|
|
628
|
-
|
|
629
|
-
Parameters: `zoom, feature`
|
|
630
|
-
|
|
631
|
-
___
|
|
632
|
-
|
|
633
|
-
#### Name
|
|
634
|
-
`textMaxWidth`
|
|
635
|
-
|
|
636
|
-
#### Description
|
|
637
704
|
The maximum line width for text wrapping.
|
|
638
705
|
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
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`
|
|
649
730
|
|
|
650
|
-
|
|
651
|
-
#### Requires
|
|
652
|
-
`textField`
|
|
653
|
-
|
|
654
|
-
#### Supported Style Functions
|
|
655
|
-
`camera`
|
|
656
|
-
#### Expression
|
|
657
|
-
|
|
658
|
-
Parameters: `zoom, feature`
|
|
659
|
-
|
|
660
|
-
___
|
|
661
|
-
|
|
662
|
-
#### Name
|
|
663
|
-
`textLineHeight`
|
|
664
|
-
|
|
665
|
-
#### Description
|
|
666
731
|
Text leading value for multiLine text.
|
|
667
732
|
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
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>
|
|
675
749
|
|
|
676
750
|
|
|
677
|
-
#### Requires
|
|
678
|
-
`textField`
|
|
679
751
|
|
|
680
|
-
|
|
752
|
+
### `textLetterSpacing`
|
|
681
753
|
|
|
682
|
-
Parameters: `zoom`
|
|
683
|
-
|
|
684
|
-
___
|
|
685
|
-
|
|
686
|
-
#### Name
|
|
687
|
-
`textLetterSpacing`
|
|
688
|
-
|
|
689
|
-
#### Description
|
|
690
754
|
Text tracking amount.
|
|
691
755
|
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
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`
|
|
703
778
|
|
|
704
|
-
#### Supported Style Functions
|
|
705
|
-
`camera`
|
|
706
|
-
#### Expression
|
|
707
|
-
|
|
708
|
-
Parameters: `zoom, feature`
|
|
709
|
-
|
|
710
|
-
___
|
|
711
|
-
|
|
712
|
-
#### Name
|
|
713
|
-
`textJustify`
|
|
714
|
-
|
|
715
|
-
#### Description
|
|
716
779
|
Text justification options.
|
|
717
780
|
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
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`
|
|
732
816
|
|
|
733
|
-
#### Supported Style Functions
|
|
734
|
-
`camera`
|
|
735
|
-
#### Expression
|
|
736
|
-
|
|
737
|
-
Parameters: `zoom, feature`
|
|
738
|
-
|
|
739
|
-
___
|
|
740
|
-
|
|
741
|
-
#### Name
|
|
742
|
-
`textRadialOffset`
|
|
743
|
-
|
|
744
|
-
#### Description
|
|
745
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.
|
|
746
818
|
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
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>
|
|
755
835
|
|
|
756
|
-
#### Requires
|
|
757
|
-
`textField`
|
|
758
836
|
|
|
759
|
-
#### Expression
|
|
760
837
|
|
|
761
|
-
|
|
838
|
+
### `textVariableAnchor`
|
|
762
839
|
|
|
763
|
-
___
|
|
764
|
-
|
|
765
|
-
#### Name
|
|
766
|
-
`textVariableAnchor`
|
|
767
|
-
|
|
768
|
-
#### Description
|
|
769
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`.
|
|
770
841
|
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
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>
|
|
777
854
|
|
|
778
|
-
#### Expression
|
|
779
855
|
|
|
780
|
-
Parameters: `zoom`
|
|
781
856
|
|
|
782
|
-
|
|
857
|
+
### `textAnchor`
|
|
783
858
|
|
|
784
|
-
#### Name
|
|
785
|
-
`textAnchor`
|
|
786
|
-
|
|
787
|
-
#### Description
|
|
788
859
|
Part of the text placed closest to the anchor.
|
|
789
860
|
|
|
790
|
-
|
|
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
|
-
|
|
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`
|
|
823
913
|
|
|
824
|
-
#### Description
|
|
825
914
|
Maximum angle change between adjacent characters.
|
|
826
915
|
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
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>
|
|
831
932
|
|
|
832
|
-
#### Units
|
|
833
|
-
`degrees`
|
|
834
933
|
|
|
835
934
|
|
|
836
|
-
|
|
837
|
-
`textField`
|
|
935
|
+
### `textWritingMode`
|
|
838
936
|
|
|
839
|
-
#### Expression
|
|
840
|
-
|
|
841
|
-
Parameters: `zoom`
|
|
842
|
-
|
|
843
|
-
___
|
|
844
|
-
|
|
845
|
-
#### Name
|
|
846
|
-
`textWritingMode`
|
|
847
|
-
|
|
848
|
-
#### Description
|
|
849
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.
|
|
850
938
|
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
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>
|
|
859
951
|
|
|
860
|
-
Parameters: `zoom`
|
|
861
952
|
|
|
862
|
-
___
|
|
863
953
|
|
|
864
|
-
|
|
865
|
-
`textRotate`
|
|
954
|
+
### `textRotate`
|
|
866
955
|
|
|
867
|
-
#### Description
|
|
868
956
|
Rotates the text clockwise.
|
|
869
957
|
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
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>
|
|
874
974
|
|
|
875
|
-
#### Units
|
|
876
|
-
`degrees`
|
|
877
975
|
|
|
878
976
|
|
|
879
|
-
|
|
880
|
-
`textField`
|
|
977
|
+
### `textPadding`
|
|
881
978
|
|
|
882
|
-
#### Expression
|
|
883
|
-
|
|
884
|
-
Parameters: `zoom, feature`
|
|
885
|
-
|
|
886
|
-
___
|
|
887
|
-
|
|
888
|
-
#### Name
|
|
889
|
-
`textPadding`
|
|
890
|
-
|
|
891
|
-
#### Description
|
|
892
979
|
Size of the additional area around the text bounding box used for detecting symbol collisions.
|
|
893
980
|
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
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`
|
|
904
1003
|
|
|
905
|
-
|
|
906
|
-
#### Requires
|
|
907
|
-
`textField`
|
|
908
|
-
|
|
909
|
-
#### Expression
|
|
910
|
-
|
|
911
|
-
Parameters: `zoom`
|
|
912
|
-
|
|
913
|
-
___
|
|
914
|
-
|
|
915
|
-
#### Name
|
|
916
|
-
`textKeepUpright`
|
|
917
|
-
|
|
918
|
-
#### Description
|
|
919
1004
|
If true, the text may be flipped vertically to prevent it from being rendered upsideDown.
|
|
920
1005
|
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
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>
|
|
926
1020
|
|
|
927
|
-
#### Requires
|
|
928
|
-
`textField`
|
|
929
1021
|
|
|
930
|
-
#### Expression
|
|
931
1022
|
|
|
932
|
-
|
|
1023
|
+
### `textTransform`
|
|
933
1024
|
|
|
934
|
-
___
|
|
935
|
-
|
|
936
|
-
#### Name
|
|
937
|
-
`textTransform`
|
|
938
|
-
|
|
939
|
-
#### Description
|
|
940
1025
|
Specifies how to capitalize text, similar to the CSS `textTransform` property.
|
|
941
1026
|
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
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`
|
|
957
1057
|
|
|
958
|
-
Parameters: `zoom, feature`
|
|
959
|
-
|
|
960
|
-
___
|
|
961
|
-
|
|
962
|
-
#### Name
|
|
963
|
-
`textOffset`
|
|
964
|
-
|
|
965
|
-
#### Description
|
|
966
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.
|
|
967
1059
|
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
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`
|
|
982
1082
|
|
|
983
|
-
#### Expression
|
|
984
|
-
|
|
985
|
-
Parameters: `zoom, feature`
|
|
986
|
-
|
|
987
|
-
___
|
|
988
|
-
|
|
989
|
-
#### Name
|
|
990
|
-
`textAllowOverlap`
|
|
991
|
-
|
|
992
|
-
#### Description
|
|
993
1083
|
If true, the text will be visible even if it collides with other previously drawn symbols.
|
|
994
1084
|
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
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>
|
|
1003
1101
|
|
|
1004
|
-
#### Disabled By
|
|
1005
|
-
`textOverlap`
|
|
1006
1102
|
|
|
1007
|
-
#### Expression
|
|
1008
1103
|
|
|
1009
|
-
|
|
1104
|
+
### `textIgnorePlacement`
|
|
1010
1105
|
|
|
1011
|
-
___
|
|
1012
|
-
|
|
1013
|
-
#### Name
|
|
1014
|
-
`textIgnorePlacement`
|
|
1015
|
-
|
|
1016
|
-
#### Description
|
|
1017
1106
|
If true, other symbols can be visible even if they collide with the text.
|
|
1018
1107
|
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
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>
|
|
1024
1122
|
|
|
1025
|
-
#### Requires
|
|
1026
|
-
`textField`
|
|
1027
1123
|
|
|
1028
|
-
#### Expression
|
|
1029
1124
|
|
|
1030
|
-
|
|
1125
|
+
### `textOptional`
|
|
1031
1126
|
|
|
1032
|
-
___
|
|
1033
|
-
|
|
1034
|
-
#### Name
|
|
1035
|
-
`textOptional`
|
|
1036
|
-
|
|
1037
|
-
#### Description
|
|
1038
1127
|
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
|
|
1039
1128
|
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
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>
|
|
1045
1143
|
|
|
1046
|
-
#### Requires
|
|
1047
|
-
`textField, iconImage`
|
|
1048
1144
|
|
|
1049
|
-
#### Expression
|
|
1050
1145
|
|
|
1051
|
-
|
|
1146
|
+
### `visibility`
|
|
1052
1147
|
|
|
1053
|
-
___
|
|
1054
|
-
|
|
1055
|
-
#### Name
|
|
1056
|
-
`visibility`
|
|
1057
|
-
|
|
1058
|
-
#### Description
|
|
1059
1148
|
Whether this layer is displayed.
|
|
1060
1149
|
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
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`
|
|
1073
1173
|
|
|
1074
|
-
#### Name
|
|
1075
|
-
`iconOpacity`
|
|
1076
|
-
|
|
1077
|
-
#### Description
|
|
1078
1174
|
The opacity at which the icon will be drawn.
|
|
1079
1175
|
|
|
1080
|
-
|
|
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
|
-
|
|
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`
|
|
1111
1218
|
|
|
1112
|
-
#### Units
|
|
1113
|
-
`milliseconds`
|
|
1114
|
-
|
|
1115
|
-
#### Default Value
|
|
1116
|
-
`{duration: 300, delay: 0}`
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
___
|
|
1120
|
-
|
|
1121
|
-
#### Name
|
|
1122
|
-
`iconColor`
|
|
1123
|
-
|
|
1124
|
-
#### Description
|
|
1125
1219
|
The color of the icon. This can only be used with SDF icons.
|
|
1126
1220
|
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
Parameters
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
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`
|
|
1148
1259
|
|
|
1149
|
-
#### Type
|
|
1150
|
-
|
|
1151
|
-
`{ duration, delay }`
|
|
1152
|
-
|
|
1153
|
-
#### Units
|
|
1154
|
-
`milliseconds`
|
|
1155
|
-
|
|
1156
|
-
#### Default Value
|
|
1157
|
-
`{duration: 300, delay: 0}`
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
___
|
|
1161
|
-
|
|
1162
|
-
#### Name
|
|
1163
|
-
`iconHaloColor`
|
|
1164
|
-
|
|
1165
|
-
#### Description
|
|
1166
1260
|
The color of the icon's halo. Icon halos can only be used with SDF icons.
|
|
1167
1261
|
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
Parameters
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
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`
|
|
1185
1300
|
|
|
1186
|
-
#### Description
|
|
1187
|
-
|
|
1188
|
-
The transition affecting any changes to this layer’s iconHaloColor propery.
|
|
1189
|
-
|
|
1190
|
-
#### Type
|
|
1191
|
-
|
|
1192
|
-
`{ duration, delay }`
|
|
1193
|
-
|
|
1194
|
-
#### Units
|
|
1195
|
-
`milliseconds`
|
|
1196
|
-
|
|
1197
|
-
#### Default Value
|
|
1198
|
-
`{duration: 300, delay: 0}`
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
___
|
|
1202
|
-
|
|
1203
|
-
#### Name
|
|
1204
|
-
`iconHaloWidth`
|
|
1205
|
-
|
|
1206
|
-
#### Description
|
|
1207
1301
|
Distance of halo to the icon outline.
|
|
1208
1302
|
|
|
1209
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.
|
|
1210
1304
|
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
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`
|
|
1225
1347
|
|
|
1226
|
-
#### Expression
|
|
1227
|
-
|
|
1228
|
-
Parameters: `zoom, feature, feature-state`
|
|
1229
|
-
___
|
|
1230
|
-
|
|
1231
|
-
#### Name
|
|
1232
|
-
|
|
1233
|
-
`iconHaloWidthTransition`
|
|
1234
|
-
|
|
1235
|
-
#### Description
|
|
1236
|
-
|
|
1237
|
-
The transition affecting any changes to this layer’s iconHaloWidth propery.
|
|
1238
|
-
|
|
1239
|
-
#### Type
|
|
1240
|
-
|
|
1241
|
-
`{ duration, delay }`
|
|
1242
|
-
|
|
1243
|
-
#### Units
|
|
1244
|
-
`milliseconds`
|
|
1245
|
-
|
|
1246
|
-
#### Default Value
|
|
1247
|
-
`{duration: 300, delay: 0}`
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
___
|
|
1251
|
-
|
|
1252
|
-
#### Name
|
|
1253
|
-
`iconHaloBlur`
|
|
1254
|
-
|
|
1255
|
-
#### Description
|
|
1256
1348
|
Fade out the halo towards the outside.
|
|
1257
1349
|
|
|
1258
|
-
|
|
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
|
-
|
|
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`
|
|
1292
1392
|
|
|
1293
|
-
#### Default Value
|
|
1294
|
-
`{duration: 300, delay: 0}`
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
___
|
|
1298
|
-
|
|
1299
|
-
#### Name
|
|
1300
|
-
`iconTranslate`
|
|
1301
|
-
|
|
1302
|
-
#### Description
|
|
1303
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.
|
|
1304
1394
|
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
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`
|
|
1329
1435
|
|
|
1330
|
-
#### Type
|
|
1331
|
-
|
|
1332
|
-
`{ duration, delay }`
|
|
1333
|
-
|
|
1334
|
-
#### Units
|
|
1335
|
-
`milliseconds`
|
|
1336
|
-
|
|
1337
|
-
#### Default Value
|
|
1338
|
-
`{duration: 300, delay: 0}`
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
___
|
|
1342
|
-
|
|
1343
|
-
#### Name
|
|
1344
|
-
`iconTranslateAnchor`
|
|
1345
|
-
|
|
1346
|
-
#### Description
|
|
1347
1436
|
Controls the frame of reference for `iconTranslate`.
|
|
1348
1437
|
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
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`
|
|
1365
1465
|
|
|
1366
|
-
___
|
|
1367
|
-
|
|
1368
|
-
#### Name
|
|
1369
|
-
`textOpacity`
|
|
1370
|
-
|
|
1371
|
-
#### Description
|
|
1372
1466
|
The opacity at which the text will be drawn.
|
|
1373
1467
|
|
|
1374
|
-
|
|
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
|
-
|
|
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`
|
|
1403
1510
|
|
|
1404
|
-
`{ duration, delay }`
|
|
1405
|
-
|
|
1406
|
-
#### Units
|
|
1407
|
-
`milliseconds`
|
|
1408
|
-
|
|
1409
|
-
#### Default Value
|
|
1410
|
-
`{duration: 300, delay: 0}`
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
___
|
|
1414
|
-
|
|
1415
|
-
#### Name
|
|
1416
|
-
`textColor`
|
|
1417
|
-
|
|
1418
|
-
#### Description
|
|
1419
1511
|
The color with which the text will be drawn.
|
|
1420
1512
|
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
Parameters
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
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`
|
|
1440
1551
|
|
|
1441
|
-
The transition affecting any changes to this layer’s textColor propery.
|
|
1442
|
-
|
|
1443
|
-
#### Type
|
|
1444
|
-
|
|
1445
|
-
`{ duration, delay }`
|
|
1446
|
-
|
|
1447
|
-
#### Units
|
|
1448
|
-
`milliseconds`
|
|
1449
|
-
|
|
1450
|
-
#### Default Value
|
|
1451
|
-
`{duration: 300, delay: 0}`
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
___
|
|
1455
|
-
|
|
1456
|
-
#### Name
|
|
1457
|
-
`textHaloColor`
|
|
1458
|
-
|
|
1459
|
-
#### Description
|
|
1460
1552
|
The color of the text's halo, which helps it stand out from backgrounds.
|
|
1461
1553
|
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
Parameters
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
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`
|
|
1477
1592
|
|
|
1478
|
-
`textHaloColorTransition`
|
|
1479
|
-
|
|
1480
|
-
#### Description
|
|
1481
|
-
|
|
1482
|
-
The transition affecting any changes to this layer’s textHaloColor propery.
|
|
1483
|
-
|
|
1484
|
-
#### Type
|
|
1485
|
-
|
|
1486
|
-
`{ duration, delay }`
|
|
1487
|
-
|
|
1488
|
-
#### Units
|
|
1489
|
-
`milliseconds`
|
|
1490
|
-
|
|
1491
|
-
#### Default Value
|
|
1492
|
-
`{duration: 300, delay: 0}`
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
___
|
|
1496
|
-
|
|
1497
|
-
#### Name
|
|
1498
|
-
`textHaloWidth`
|
|
1499
|
-
|
|
1500
|
-
#### Description
|
|
1501
1593
|
Distance of halo to the font outline. Max text halo width is 1/4 of the fontSize.
|
|
1502
1594
|
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
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`
|
|
1514
1637
|
|
|
1515
|
-
#### Requires
|
|
1516
|
-
`textField`
|
|
1517
|
-
|
|
1518
|
-
#### Expression
|
|
1519
|
-
|
|
1520
|
-
Parameters: `zoom, feature, feature-state`
|
|
1521
|
-
___
|
|
1522
|
-
|
|
1523
|
-
#### Name
|
|
1524
|
-
|
|
1525
|
-
`textHaloWidthTransition`
|
|
1526
|
-
|
|
1527
|
-
#### Description
|
|
1528
|
-
|
|
1529
|
-
The transition affecting any changes to this layer’s textHaloWidth propery.
|
|
1530
|
-
|
|
1531
|
-
#### Type
|
|
1532
|
-
|
|
1533
|
-
`{ duration, delay }`
|
|
1534
|
-
|
|
1535
|
-
#### Units
|
|
1536
|
-
`milliseconds`
|
|
1537
|
-
|
|
1538
|
-
#### Default Value
|
|
1539
|
-
`{duration: 300, delay: 0}`
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
___
|
|
1543
|
-
|
|
1544
|
-
#### Name
|
|
1545
|
-
`textHaloBlur`
|
|
1546
|
-
|
|
1547
|
-
#### Description
|
|
1548
1638
|
The halo's fadeout distance towards the outside.
|
|
1549
1639
|
|
|
1550
|
-
|
|
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
|
-
|
|
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`
|
|
1581
1682
|
|
|
1582
|
-
#### Units
|
|
1583
|
-
`milliseconds`
|
|
1584
|
-
|
|
1585
|
-
#### Default Value
|
|
1586
|
-
`{duration: 300, delay: 0}`
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
___
|
|
1590
|
-
|
|
1591
|
-
#### Name
|
|
1592
|
-
`textTranslate`
|
|
1593
|
-
|
|
1594
|
-
#### Description
|
|
1595
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.
|
|
1596
1684
|
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
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`
|
|
1619
1725
|
|
|
1620
|
-
The transition affecting any changes to this layer’s textTranslate propery.
|
|
1621
|
-
|
|
1622
|
-
#### Type
|
|
1623
|
-
|
|
1624
|
-
`{ duration, delay }`
|
|
1625
|
-
|
|
1626
|
-
#### Units
|
|
1627
|
-
`milliseconds`
|
|
1628
|
-
|
|
1629
|
-
#### Default Value
|
|
1630
|
-
`{duration: 300, delay: 0}`
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
___
|
|
1634
|
-
|
|
1635
|
-
#### Name
|
|
1636
|
-
`textTranslateAnchor`
|
|
1637
|
-
|
|
1638
|
-
#### Description
|
|
1639
1726
|
Controls the frame of reference for `textTranslate`.
|
|
1640
1727
|
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
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>
|
|
1655
1751
|
|
|
1656
|
-
Parameters: `zoom`
|
|
1657
1752
|
|