Transition
- Transition sub-properties
- Global Transitionable Properties
- Paint Transitionable Properties
- background-color
- background-emissive-strength
- background-opacity
- building-flood-light-color
- building-flood-light-ground-attenuation
- building-flood-light-intensity
- circle-blur
- circle-color
- circle-emissive-strength
- circle-opacity
- circle-radius
- circle-stroke-color
- circle-stroke-opacity
- circle-stroke-width
- circle-translate
- fill-color
- fill-emissive-strength
- fill-extrusion-ambient-occlusion-ground-attenuation
- fill-extrusion-ambient-occlusion-ground-radius
- fill-extrusion-ambient-occlusion-intensity
- fill-extrusion-ambient-occlusion-radius
- fill-extrusion-ambient-occlusion-wall-radius
- fill-extrusion-base
- fill-extrusion-color
- fill-extrusion-emissive-strength
- fill-extrusion-flood-light-color
- fill-extrusion-flood-light-ground-attenuation
- fill-extrusion-flood-light-ground-radius
- fill-extrusion-flood-light-intensity
- fill-extrusion-flood-light-wall-radius
- fill-extrusion-height
- fill-extrusion-line-width
- fill-extrusion-opacity
- fill-extrusion-translate
- fill-extrusion-vertical-scale
- fill-opacity
- fill-outline-color
- fill-translate
- fill-z-offset
- heatmap-intensity
- heatmap-opacity
- heatmap-radius
- hillshade-accent-color
- hillshade-emissive-strength
- hillshade-exaggeration
- hillshade-highlight-color
- hillshade-shadow-color
- icon-color
- icon-emissive-strength
- icon-halo-blur
- icon-halo-color
- icon-halo-width
- icon-occlusion-opacity
- icon-opacity
- icon-translate
- line-blur
- line-color
- line-emissive-strength
- line-gap-width
- line-occlusion-opacity
- line-offset
- line-opacity
- line-translate
- line-trim-color
- line-width
- model-ambient-occlusion-intensity
- model-color
- model-color-mix-intensity
- model-emissive-strength
- model-height-based-emissive-strength-multiplier
- model-opacity
- model-rotation
- model-roughness
- model-scale
- model-translation
- raster-brightness-max
- raster-brightness-min
- raster-color-mix
- raster-color-range
- raster-contrast
- raster-elevation
- raster-emissive-strength
- raster-hue-rotate
- raster-opacity
- raster-particle-elevation
- raster-particle-fade-opacity-factor
- raster-particle-speed-factor
- raster-saturation
- sky-opacity
- symbol-z-offset
- text-color
- text-emissive-strength
- text-halo-blur
- text-halo-color
- text-halo-width
- text-occlusion-opacity
- text-opacity
- text-translate
- Layout Transitionable Properties
A transition property controls timing for the interpolation between a transitionable style property's previous value and new value. A style's root transition property provides global transition defaults for that style.
"transition": {
"duration": 300,
"delay": 0
}
Any transitionable layer property, marked by , may also have its own *-transition property, defined in the layer's paint or layout properties, that defines specific transition timing, overriding the global transition values.
"fill-opacity-transition": {
"duration": 300,
"delay": 0
}
Transition sub-properties
Whether setting the global transition property or a specific *-transition property, the following sub-properties are supported.
delay
Length of time before a transition begins.
duration
Time allotted for transitions to complete.
Global Transitionable Properties
color
Color tint for lighting extruded geometries.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
exaggeration
0 and 1000 inclusive. Defaults to 1. Requires source. Supports interpolateexpressions. Transitionable. Exaggerates the elevation of the terrain by multiplying the data from the DEM with this value.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
high-color
The color of the atmosphere region above the horizon, high-color extends further above the horizon than the color property and its spread can be controlled with horizon-blend. The opacity can be set to 0 to remove the high atmosphere color contribution.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 2.9.0 | >= 10.6.0 | >= 10.6.0 |
horizon-blend
0 and 1 inclusive. Defaults to ["interpolate",["linear"],["zoom"],4,0.2,7,0.1]. Supports interpolateexpressions. Transitionable. Horizon blend applies a smooth fade from the color of the atmosphere to the color of space. A value of zero leaves a sharp transition from atmosphere to space. Increasing the value blends the color of atmosphere into increasingly high angles of the sky.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 2.3.0 | >= 10.6.0 | >= 10.6.0 |
intensity
0 and 1 inclusive. Defaults to 0.5. Supports interpolateexpressions. Transitionable. Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
position
[1.15,210,30]. Supports interpolateexpressions. Transitionable. Position of the light source relative to lit (extruded) geometries, in [r radial coordinate, a azimuthal angle, p polar angle] where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0° (0° when light.anchor is set to viewport corresponds to the top of the viewport, or 0° when light.anchor is set to map corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0°, directly above, to 180°, directly below).
[
1.5,
90,
80
]
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
range
-20 and 20 inclusive. Defaults to [0.5,10]. Supports interpolateexpressions. Transitionable. The start and end distance range in which fog fades from fully transparent to fully opaque. The distance to the point at the center of the map is defined as zero, so that negative range values are closer to the camera, and positive values are farther away.
[
0.5,
10
]
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 2.3.0 | >= 10.6.0 | >= 10.6.0 |
space-color
["interpolate",["linear"],["zoom"],4,"#010b19",7,"#367ab9"]. Supports interpolateexpressions. Transitionable. The color of the region above the horizon and after the end of the horizon-blend contribution. The opacity can be set to 0 to have a transparent background.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 2.9.0 | >= 10.6.0 | >= 10.6.0 |
star-intensity
0 and 1 inclusive. Defaults to ["interpolate",["linear"],["zoom"],5,0.35,6,0]. Supports interpolateexpressions. Transitionable. A value controlling the star intensity where 0 will show no stars and 1 will show stars at their maximum intensity.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 2.9.0 | >= 10.6.0 | >= 10.6.0 |
vertical-range
0. Defaults to [0,0]. Supports interpolateexpressions. Transitionable. An array of two number values, specifying the vertical range, measured in meters, over which the fog should gradually fade out. When both parameters are set to zero, the fog will be rendered without any vertical constraints.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
Paint Transitionable Properties
background-color
"#000000". Disabled by background-pattern. Supports interpolateexpressions. Transitionable. The color with which the background will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
background-emissive-strength
0. Units in intensity. Defaults to 0. Requires lights. Supports interpolateexpressions. Transitionable. Controls the intensity of light emitted on the source features.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
background-opacity
0 and 1 inclusive. Defaults to 1. Supports interpolateexpressions. Transitionable. The opacity at which the background will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
building-flood-light-color
"#ffffff". Requires lights. Supports interpolateexpressions. Transitionable. The color of the flood light effect on the walls of the buildings.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.16.0 | >= 11.16.0 | >= 11.16.0 |
building-flood-light-ground-attenuation
0 and 1 inclusive. Defaults to 0.69. Requires lights. Supports interpolateexpressions. Transitionable. Provides a control to futher fine-tune the look of the flood light on the ground beneath the buildings. Lower values give the effect a more solid look while higher values make it smoother.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.16.0 | >= 11.16.0 | >= 11.16.0 |
building-flood-light-intensity
0 and 1 inclusive. Defaults to 0. Requires lights. Supports interpolateexpressions. Transitionable. The intensity of the flood light color.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.16.0 | >= 11.16.0 | >= 11.16.0 |
circle-blur
0. Supports feature-state and interpolateexpressions. Transitionable. Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. Setting a negative value renders the blur as an inner glow effect.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.20.0 | >= 5.0.0 | >= 3.5.0 |
circle-color
"#000000". Supports feature-state and interpolateexpressions. Transitionable. The fill color of the circle.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.18.0 | >= 5.0.0 | >= 3.5.0 |
circle-emissive-strength
0. Units in intensity. Defaults to 0. Requires lights. Supports interpolateexpressions. Transitionable. Controls the intensity of light emitted on the source features.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
circle-opacity
0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable. The opacity at which the circle will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.20.0 | >= 5.0.0 | >= 3.5.0 |
circle-radius
0. Units in pixels. Defaults to 5. Supports feature-state and interpolateexpressions. Transitionable. Circle radius.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.18.0 | >= 5.0.0 | >= 3.5.0 |
circle-stroke-color
"#000000". Supports feature-state and interpolateexpressions. Transitionable. The stroke color of the circle.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
circle-stroke-opacity
0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable. The opacity of the circle's stroke.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
circle-stroke-width
0. Units in pixels. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable. The width of the circle's stroke. Strokes are placed outside of the circle-radius.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
circle-translate
[0,0]. Supports interpolateexpressions. Transitionable. The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
fill-color
"#000000". Disabled by fill-pattern. Supports feature-state and interpolateexpressions. Transitionable. The color of the filled part of this layer. This color can be specified as rgba with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.19.0 | >= 5.0.0 | >= 3.5.0 |
fill-emissive-strength
0. Units in intensity. Defaults to 0. Requires lights. Supports interpolateexpressions. Transitionable. Controls the intensity of light emitted on the source features.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-ambient-occlusion-ground-attenuation
0 and 1 inclusive. Defaults to 0.69. Requires lights. Supports interpolateexpressions. Transitionable. Provides a control to futher fine-tune the look of the ambient occlusion on the ground beneath the extruded buildings. Lower values give the effect a more solid look while higher values make it smoother.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-ambient-occlusion-ground-radius
0. Defaults to 3. Requires lights. Supports interpolateexpressions. Transitionable. The extent of the ambient occlusion effect on the ground beneath the extruded buildings in meters.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-ambient-occlusion-intensity
0 and 1 inclusive. Defaults to 0. Supports interpolateexpressions. Transitionable. Controls the intensity of shading near ground and concave angles between walls. Default value 0.0 disables ambient occlusion and values around 0.3 provide the most plausible results for buildings.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 10.7.0 | >= 10.7.0 |
fill-extrusion-ambient-occlusion-radius
0. Defaults to 3. Requires fill-extrusion-edge-radius. Supports interpolateexpressions. Transitionable. Shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to height of one floor and brings the most plausible results for buildings. This property works only with legacy light. When 3D lights are enabled fill-extrusion-ambient-occlusion-wall-radius and fill-extrusion-ambient-occlusion-ground-radius are used instead.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 10.7.0 | >= 10.7.0 |
fill-extrusion-ambient-occlusion-wall-radius
0. Defaults to 3. Requires lights. Requires fill-extrusion-edge-radius. Supports interpolateexpressions. Transitionable. Shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to height of one floor and brings the most plausible results for buildings.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-base
0. Units in meters. Defaults to 0. Requires fill-extrusion-height. Supports feature-state and interpolateexpressions. Transitionable. The height with which to extrude the base of this layer. Must be less than or equal to fill-extrusion-height.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
data-driven styling | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-color
"#000000". Disabled by fill-extrusion-pattern. Supports feature-state and interpolateexpressions. Transitionable. The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root light settings. If this color is specified as rgba with an alpha component, the alpha component will be ignored; use fill-extrusion-opacity to set layer opacity.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
data-driven styling | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-emissive-strength
0. Units in intensity. Defaults to 0. Requires lights. Supports feature-state and interpolateexpressions. Transitionable. Controls the intensity of light emitted on the source features.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.8.0 | >= 11.8.0 | >= 11.8.0 |
fill-extrusion-flood-light-color
"#ffffff". Requires lights. Supports interpolateexpressions. Transitionable. The color of the flood light effect on the walls of the extruded buildings.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-flood-light-ground-attenuation
0 and 1 inclusive. Defaults to 0.69. Requires lights. Supports interpolateexpressions. Transitionable. Provides a control to futher fine-tune the look of the flood light on the ground beneath the extruded buildings. Lower values give the effect a more solid look while higher values make it smoother.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-flood-light-ground-radius
0. Requires lights. Supports feature-state and interpolateexpressions. Transitionable. The extent of the flood light effect on the ground beneath the extruded buildings in meters. Note: this experimental property is evaluated once per tile, during tile initialization. Changing the property value could trigger tile reload. The feature-state styling is deprecated and will get removed soon.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-flood-light-intensity
0 and 1 inclusive. Defaults to 0. Requires lights. Supports interpolateexpressions. Transitionable. The intensity of the flood light color.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-flood-light-wall-radius
0. Units in meters. Defaults to 0. Requires lights. Supports feature-state and interpolateexpressions. Transitionable. The extent of the flood light effect on the walls of the extruded buildings in meters.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-extrusion-height
0. Units in meters. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable. The height with which to extrude this layer.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
data-driven styling | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-line-width
0. Units in meters. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable. If a non-zero value is provided, it sets the fill-extrusion layer into wall rendering mode. The value is used to render the feature with the given width over the outlines of the geometry. Note: This property is experimental and some other fill-extrusion properties might not be supported with non-zero line width.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
data-driven styling | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
fill-extrusion-opacity
0 and 1 inclusive. Defaults to 1. Supports interpolateexpressions. Transitionable. The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-translate
[0,0]. Supports interpolateexpressions. Transitionable. The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 |
fill-extrusion-vertical-scale
0. Defaults to 1. Supports interpolateexpressions. Transitionable. A global multiplier that can be used to scale base, height, AO, and flood light of the fill extrusions.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
fill-opacity
0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable. The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.21.0 | >= 5.0.0 | >= 3.5.0 |
fill-outline-color
true. Supports feature-state and interpolateexpressions. Transitionable. The outline color of the fill. Matches the value of fill-color if unspecified.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.19.0 | >= 5.0.0 | >= 3.5.0 |
fill-translate
[0,0]. Supports interpolateexpressions. Transitionable. The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
fill-z-offset
0. Defaults to 0. Supports interpolateexpressions. Transitionable. Specifies an uniform elevation in meters. Note: If the value is zero, the layer will be rendered on the ground. Non-zero values will elevate the layer from the sea level, which can cause it to be rendered below the terrain.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.7.0 | Not yet supported | Not yet supported |
data-driven styling | >= 3.7.0 | Not yet supported | Not yet supported |
heatmap-intensity
0. Defaults to 1. Supports interpolateexpressions. Transitionable. Similar to heatmap-weight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
heatmap-opacity
0 and 1 inclusive. Defaults to 1. Supports interpolateexpressions. Transitionable. The global opacity at which the heatmap layer will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
heatmap-radius
1. Units in pixels. Defaults to 30. Supports feature-state and interpolateexpressions. Transitionable. Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed. queryRenderedFeatures on heatmap layers will return points within this radius.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.41.0 | >= 6.0.0 | >= 4.0.0 |
data-driven styling | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
hillshade-accent-color
"#000000". Supports interpolateexpressions. Transitionable. The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
hillshade-emissive-strength
0. Units in intensity. Defaults to 0. Requires lights. Supports interpolateexpressions. Transitionable. Controls the intensity of light emitted on the source features.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
hillshade-exaggeration
0 and 1 inclusive. Defaults to 0.5. Supports interpolateexpressions. Transitionable. Intensity of the hillshade
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
hillshade-highlight-color
"#FFFFFF". Supports interpolateexpressions. Transitionable. The shading color of areas that faces towards the light source.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
hillshade-shadow-color
"#000000". Supports interpolateexpressions. Transitionable. The shading color of areas that face away from the light source.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.43.0 | >= 6.0.0 | >= 4.0.0 |
icon-color
"#000000". Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable. The color of the icon. This can only be used with SDF icons.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-emissive-strength
0. Units in intensity. Defaults to 1. Requires lights. Supports feature-state and interpolateexpressions. Transitionable. Controls the intensity of light emitted on the source features.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
icon-halo-blur
0. Units in pixels. Defaults to 0. Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable. Fade out the halo towards the outside.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-halo-color
"rgba(0, 0, 0, 0)". Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable. The color of the icon's halo. Icon halos can only be used with SDF icons.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-halo-width
0. Units in pixels. Defaults to 0. Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable. Distance of halo to the icon outline.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-occlusion-opacity
0 and 1 inclusive. Defaults to 0. Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable. The opacity at which the icon will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.6.0 |
data-driven styling | >= 3.5.0 | >= 11.5.0 | >= 11.6.0 |
icon-opacity
0 and 1 inclusive. Defaults to 1. Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable. The opacity at which the icon will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
icon-translate
[0,0]. Requires icon-image. Supports interpolateexpressions. Transitionable. 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.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
line-blur
0. Units in pixels. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable. Blur applied to the line, in pixels.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
line-color
"#000000". Disabled by line-pattern. Supports feature-state and interpolateexpressions. Transitionable. The color with which the line will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.23.0 | >= 5.0.0 | >= 3.5.0 |
line-emissive-strength
0. Units in intensity. Defaults to 0. Requires lights. Supports interpolateexpressions. Transitionable. Controls the intensity of light emitted on the source features.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
line-gap-width
0. Units in pixels. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable. Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
line-occlusion-opacity
0 and 1 inclusive. Defaults to 0. Supports interpolateexpressions. Transitionable. Opacity multiplier (multiplies line-opacity value) of the line part that is occluded by 3D objects. Value 0 hides occluded part, value 1 means the same opacity as non-occluded part. The property is not supported when line-opacity has data-driven styling.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.5.0 |
line-offset
0. Supports feature-state and interpolateexpressions. Transitionable. The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.12.1 | >= 3.0.0 | >= 3.1.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
line-opacity
0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable. The opacity at which the line will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.29.0 | >= 5.0.0 | >= 3.5.0 |
line-translate
[0,0]. Supports interpolateexpressions. Transitionable. The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
line-trim-color
"transparent". Requires line-trim-offset. Requires source to be "geojson". Supports interpolateexpressions. Transitionable. The color to be used for rendering the trimmed line section that is defined by the line-trim-offset property.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.6.0 | >= 11.6.0 | >= 11.6.0 |
line-width
0. Units in pixels. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable. Stroke thickness.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.39.0 | >= 5.2.0 | >= 3.7.0 |
model-ambient-occlusion-intensity
0 and 1 inclusive. Defaults to 1. Supports interpolateexpressions. Transitionable. Intensity of the ambient occlusion if present in the 3D model.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-color
"#ffffff". Supports feature-state and interpolateexpressions. Transitionable. The tint color of the model layer. model-color-mix-intensity (defaults to 0) defines tint(mix) intensity - this means that, this color is not used unless model-color-mix-intensity gets value greater than 0. Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-color-mix-intensity
0 and 1 inclusive. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable. Intensity of model-color (on a scale from 0 to 1) in color mix with original 3D model's colors. Higher number will present a higher model-color contribution in mix. Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-emissive-strength
0 and 5 inclusive. Units in intensity. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable. Strength of the emission. There is no emission for value 0. For value 1.0, only emissive component (no shading) is displayed and values above 1.0 produce light contribution to surrounding area, for some of the parts (e.g. doors). Expressions that depend on measure-light are only supported as a global layer value (and not for each feature) when using GeoJSON or vector tile as the model layer source.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-height-based-emissive-strength-multiplier
[1,1,1,1,0]. Supports feature-state and interpolateexpressions. Transitionable. Emissive strength multiplier along model height (gradient begin, gradient end, value at begin, value at end, gradient curve power (logarithmic scale, curve power = pow(10, val)).
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-opacity
0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable. The opacity of the model layer. Except for zoom, expressions that are data-driven are not supported if using GeoJSON or vector tile as the model layer source.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.9.0 | >= 11.9.0 | >= 11.9.0 |
model-rotation
[0,0,0]. Supports feature-state and interpolateexpressions. Transitionable. The rotation of the model in euler angles [lon, lat, z].
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-roughness
0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable. Material roughness. Material is fully smooth for value 0, and fully rough for value 1. Affects only layers using batched-model source.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-scale
[1,1,1]. Supports feature-state and interpolateexpressions. Transitionable. The scale of the model. Expressions that are zoom-dependent are not supported if using GeoJSON or vector tile as the model layer source.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
model-translation
[0,0,0]. Supports feature-state and interpolateexpressions. Transitionable. The translation of the model in meters in form of [longitudal, latitudal, altitude] offsets.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
raster-brightness-max
0 and 1 inclusive. Defaults to 1. Supports interpolateexpressions. Transitionable. Increase or reduce the brightness of the image. The value is the maximum brightness.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-brightness-min
0 and 1 inclusive. Defaults to 0. Supports interpolateexpressions. Transitionable. Increase or reduce the brightness of the image. The value is the minimum brightness.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-color-mix
[0.2126,0.7152,0.0722,0]. Requires raster-color. Supports interpolateexpressions. Transitionable. When raster-color is active, specifies the combination of source RGB channels used to compute the raster value. Computed using the equation mix.r * src.r + mix.g * src.g + mix.b * src.b + mix.a. The first three components specify the mix of source red, green, and blue channels, respectively. The fourth component serves as a constant offset and is not multipled by source alpha. Source alpha is instead carried through and applied as opacity to the colorized result. Default value corresponds to RGB luminosity.
[
0.2126,
0.7152,
0.0722,
0
]
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
raster-color-range
interpolateexpressions. Transitionable. When raster-color is active, specifies the range over which raster-color is tabulated. Units correspond to the computed raster value via raster-color-mix. For rasterarray sources, if raster-color-range is unspecified, the source's stated data range is used.
[
0.5,
10
]
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
raster-contrast
-1 and 1 inclusive. Defaults to 0. Supports interpolateexpressions. Transitionable. Increase or reduce the contrast of the image.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-elevation
0. Defaults to 0. Supports interpolateexpressions. Transitionable. Specifies an uniform elevation from the ground, in meters.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.1.0 | >= 11.2.0 | >= 11.2.0 |
raster-emissive-strength
0. Units in intensity. Defaults to 0. Requires lights. Supports interpolateexpressions. Transitionable. Controls the intensity of light emitted on the source features.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.1.0 | >= 11.1.0 | >= 11.1.0 |
raster-hue-rotate
0. Supports interpolateexpressions. Transitionable. Rotates hues around the color wheel.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-opacity
0 and 1 inclusive. Defaults to 1. Supports interpolateexpressions. Transitionable. The opacity at which the image will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
raster-particle-elevation
0. Defaults to 0. Supports interpolateexpressions. Transitionable. Specifies an uniform elevation from the ground, in meters.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
raster-particle-fade-opacity-factor
0 and 1 inclusive. Defaults to 0.98. Supports interpolateexpressions. Transitionable. Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
raster-particle-speed-factor
0 and 1 inclusive. Defaults to 0.2. Supports interpolateexpressions. Transitionable. Defines a coefficient for the speed of particles’ motion.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.3.0 | >= 11.4.0 | >= 11.4.0 |
raster-saturation
-1 and 1 inclusive. Defaults to 0. Supports interpolateexpressions. Transitionable. Increase or reduce the saturation of the image.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
sky-opacity
0 and 1 inclusive. Defaults to 1. Supports interpolateexpressions. Transitionable. The opacity of the entire sky layer.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 2.0.0 | >= 10.0.0 | >= 10.0.0 |
symbol-z-offset
0. Defaults to 0. Requires symbol-z-elevate to be true. Supports interpolateexpressions. Transitionable. Specifies an uniform elevation from the ground, in meters.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
data-driven styling | >= 3.7.0 | >= 11.7.0 | >= 11.7.0 |
text-color
"#000000". Requires text-field. Supports feature-state and interpolateexpressions. Transitionable. The color with which the text will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-emissive-strength
0. Units in intensity. Defaults to 1. Requires lights. Supports feature-state and interpolateexpressions. Transitionable. Controls the intensity of light emitted on the source features.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
data-driven styling | >= 3.0.0 | >= 11.0.0 | >= 11.0.0 |
text-halo-blur
0. Units in pixels. Defaults to 0. Requires text-field. Supports feature-state and interpolateexpressions. Transitionable. The halo's fadeout distance towards the outside.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-halo-color
"rgba(0, 0, 0, 0)". Requires text-field. Supports feature-state and interpolateexpressions. Transitionable. The color of the text's halo, which helps it stand out from backgrounds.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-halo-width
0. Units in pixels. Defaults to 0. Requires text-field. Supports feature-state and interpolateexpressions. Transitionable. Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-occlusion-opacity
0 and 1 inclusive. Defaults to 0. Requires text-field. Supports feature-state and interpolateexpressions. Transitionable. The opacity at which the text will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.5.0 | >= 11.5.0 | >= 11.6.0 |
data-driven styling | >= 3.5.0 | >= 11.5.0 | >= 11.6.0 |
text-opacity
0 and 1 inclusive. Defaults to 1. Requires text-field. Supports feature-state and interpolateexpressions. Transitionable. The opacity at which the text will be drawn.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
data-driven styling | >= 0.33.0 | >= 5.0.0 | >= 3.5.0 |
text-translate
[0,0]. Requires text-field. Supports interpolateexpressions. Transitionable. 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.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 0.10.0 | >= 2.0.1 | >= 2.0.0 |
Layout Transitionable Properties
building-flip-roof-orientation
false. Requires building-roof-shape. Supports feature-state and interpolateexpressions. Transitionable. Flips the orientation of the roofs for the buildings. This only affects simple geometries. Namely buildings whose footprints form a quadrilateral. By default (false), the roof ridge takes the direction of the longer edge of the quadrilateral.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.16.0 | >= 11.16.0 | >= 11.16.0 |
data-driven styling | >= 3.16.0 | >= 11.16.0 | >= 11.16.0 |
building-flood-light-ground-radius
0. Requires lights. Supports feature-state and interpolateexpressions. Transitionable. The extent of the flood light effect on the ground beneath the buildings in meters.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.16.0 | >= 11.16.0 | >= 11.16.0 |
data-driven styling | >= 3.16.0 | >= 11.16.0 | >= 11.16.0 |
building-flood-light-wall-radius
0. Units in meters. Defaults to 0. Requires lights. Supports feature-state and interpolateexpressions. Transitionable. The extent of the flood light effect on the walls of the buildings in meters.
| SDK Support | Mapbox GL JS | Android SDK | iOS SDK |
|---|---|---|---|
basic functionality | >= 3.16.0 | >= 11.16.0 | >= 11.16.0 |
data-driven styling | >= 3.16.0 | >= 11.16.0 | >= 11.16.0 |