Layers

Search Style Specification

Ready to get started?

Create a free account to start building with Mapbox.

Sign Up

Additional Developer Resources

Mapbox Developer Discord

Developer Cheatsheet

Mapbox Support

Ask AI

A style's layers property lists all the layers available in that style. The type of layer is specified by the "type" property, and must be one of background, fill, line, symbol, raster, raster-particle, circle, fill-extrusion, heatmap, hillshade, sky, model.

Except for layers of the background or sky types, each layer must refer to a source. Layers take the data that they get from a source, optionally filter features, and then define how those features are styled.

Here is an example layers object which could be included in a style:

"layers": [
  {
    "id": "water",
    "source": "mapbox-streets",
    "source-layer": "water",
    "type": "fill",
    "paint": {
      "fill-color": "#00ffff"
    }
  }
]

Layer properties

id

Required string .

Unique layer name.

type

Required enum . One of "fill", "line", "symbol", "circle", "heatmap", "fill-extrusion", "raster", "raster-particle", "hillshade", "model", "background", "sky", "slot", "clip".

Rendering type of this layer.

"fill":

A filled polygon with an optional stroked border.

"line":

A stroked line.

"symbol":

An icon or a text label.

"circle":

A filled circle.

"heatmap":

A heatmap.

"fill-extrusion":

An extruded (3D) polygon.

"raster":

Raster map textures such as satellite imagery.

"raster-particle":

Particle animation driven by textures such as wind maps.

"hillshade":

Client-side hillshading visualization based on DEM data. Currently, the implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.

"model":

A 3D model

"background":

The background color or pattern of the map.

"sky":

A spherical dome around the map that is always rendered behind all other layers.

"slot":

Marks the position of a slot.

"clip":

Layer that removes 3D content from map.

filter

Optional expression .

An expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The ["feature-state", ...] expression is not supported in filter expressions. The ["pitch"] and ["distance-from-center"] expressions are supported only for filter expressions on the symbol layer.

layout

Optional layout .

Layout properties for the layer.

maxzoom

Optional number between 0 and 24 inclusive.

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

metadata

Optional .

Arbitrary properties useful to track with the layer, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'mapbox:'.

minzoom

Optional number between 0 and 24 inclusive.

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

paint

Optional paint .

Default paint properties for this layer.

slot

Optional string .

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 11.0.0	>= 11.0.0

source

Optional string .

Name of a source description to be used for this layer. Required for all layer types except background and slot.

source-layer

Optional string .

Layer to use from a vector tile source. Required for vector and raster-array sources; prohibited for all other source types, including GeoJSON sources.

Layer sub-properties

Layers have two sub-properties that determine how data from that layer is rendered: layout and paint properties.

Layout properties

Layout properties appear in the layer's "layout" object. They are applied early in the rendering process and define how data for that layer is passed to the GPU. Changes to a layout property require an asynchronous "layout" step.

Paint properties

Paint properties are applied later in the rendering process. Paint properties appear in the layer's "paint" object. Changes to a paint property are cheap and happen synchronously.

background

The background style layer covers the entire map. Use a background style layer to configure a color or pattern to show below all other map content. If the background layer is transparent or omitted from the style, any part of the map view that does not show another style layer is transparent.

The Vintage map style uses a custom SVG background-pattern to achieve a textured vintage look.

background-color

Paint property. Optional color . Defaults to "#000000". Disabled by background-pattern. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in intensity. Defaults to 0. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

background-pattern

Paint property. Optional resolvedImage .

Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

background-pitch-alignment

EXPERIMENTAL

Paint property. Optional enum . One of "map", "viewport". Defaults to "map".

Orientation of background layer.

"map":

The background is aligned to the plane of the map.

"viewport":

The background is aligned to the plane of the viewport, covering the whole screen. Note: This mode disables the automatic reordering of the layer when terrain or globe projection is used.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.8.0	>= 11.8.0	>= 11.8.0

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

fill

A fill style layer renders one or more filled (and optionally stroked) polygons on a map. You can use a fill layer to configure the visual appearance of polygon or multipolygon features.

This map of Washington, D.C. uses the fill-opacity paint property to render a semi-transparent polygon generated by the Isochrone API, showing how far a person can walk from the center of the city in ten minutes.

fill-antialias

Paint property. Optional boolean . Defaults to true.

Whether or not the fill should be antialiased.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

fill-color

Paint property. Optional color . Defaults to "#000000". Disabled by fill-pattern. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in intensity. Defaults to 0. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional color . Disabled by fill-pattern. Requires fill-antialias to be true. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-pattern

Paint property. Optional resolvedImage .

Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.49.0	>= 6.5.0	>= 4.4.0

fill-sort-key

Layout property. Optional number .

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 1.2.0	>= 9.1.0	>= 5.8.0
data-driven styling	>= 1.2.0	>= 9.1.0	>= 5.8.0

fill-translate

Paint property. Optional array of numbers . Units in pixels. Defaults to [0,0]. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-translate-anchor

Paint property. Optional enum . One of "map", "viewport". Defaults to "map". Requires fill-translate.

Controls the frame of reference for fill-translate.

"map":

The fill is translated relative to the map.

"viewport":

The fill is translated relative to the viewport.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

fill-z-offset

EXPERIMENTAL

Paint property. Optional number greater than or equal to 0. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

line

A line style layer renders one or more stroked polylines on the map. You can use a line layer to configure the visual appearance of polyline or multipolyline features.

This map of a Strava user's hike through Grand Teton National Park uses the line-color and line-width paint properties to style the strong red line of the user's route.

line-blur

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-cap

Layout property. Optional enum . One of "butt", "round", "square". Defaults to "butt".

The display of line endings.

"butt":

A cap with a squared-off end which is drawn to the exact endpoint of the line.

"round":

A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.

"square":

A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 2.3.0	Not yet supported	Not yet supported

line-color

Paint property. Optional color . Defaults to "#000000". Disabled by line-pattern. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-cross-slope

EXPERIMENTAL

Layout property. Optional number . Requires line-z-offset.

Defines the slope of an elevated line. A value of 0 creates a horizontal line. A value of 1 creates a vertical line. Other values are currently not supported. If undefined, the line follows the terrain slope. This is an experimental property with some known issues:

• Vertical lines don't support line caps
• line-join: round is not supported with this property

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.8.0	>= 11.9.0	>= 11.9.0

line-dasharray

Paint property. Optional array of numbers greater than or equal to 0. Units in line widths. Disabled by line-pattern.

Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. Note that GeoJSON sources with lineMetrics: true specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 2.3.0	Not yet supported	Not yet supported

line-elevation-reference

EXPERIMENTAL

Layout property. Optional enum . One of "none", "sea", "ground", "hd-road-markup". Defaults to "none".

Selects the base of line-elevation. Some modes might require precomputed elevation data in the tileset.

"none":

Elevated rendering is disabled.

"sea":

Elevated rendering is enabled. Use this mode to elevate lines relative to the sea level.

"ground":

Elevated rendering is enabled. Use this mode to elevate lines relative to the ground's height below them.

"hd-road-markup":

Elevated rendering is enabled. Use this mode to describe additive and stackable features that should exist only on top of road polygons.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.8.0	>= 11.9.0	>= 11.9.0

line-emissive-strength

Paint property. Optional number greater than or equal to 0. Units in intensity. Defaults to 0. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-gradient

Paint property. Optional color . Disabled by line-pattern. Requires source to be "geojson". Supports smooth-rampinterpolateexpressions.

A gradient used to color a line feature at various distances along its length. Defined using a step or interpolate expression which outputs a color for each corresponding line-progress input value. line-progress is a percentage of the line feature's total length as measured on the webmercator projected coordinate plane (a number between 0 and 1). Can only be used with GeoJSON sources that specify "lineMetrics": true.

[
  "interpolate",
  [
    "linear"
  ],
  [
    "line-progress"
  ],
  0,
  "blue",
  0.1,
  "royalblue",
  0.3,
  "cyan",
  0.5,
  "lime",
  0.7,
  "yellow",
  1,
  "red"
]

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.45.0	>= 6.5.0	>= 4.4.0
data-driven styling	Not yet supported	Not yet supported	Not yet supported

line-join

Layout property. Optional enum . One of "bevel", "round", "miter", "none". Defaults to "miter".

The display of lines when joining.

"bevel":

A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width.

"round":

A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line.

"miter":

A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.

"none":

Line segments are not joined together, each one creates a separate line. Useful in combination with line-pattern. Line-cap property is not respected. Can't be used with data-driven styling.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.40.0	>= 5.2.0	>= 3.7.0
none value	>= 3.4.0	>= 11.5.0	>= 11.5.0

line-miter-limit

Layout property. Optional number . Defaults to 2. Requires line-join to be "miter". Supports smooth-rampinterpolateexpressions.

Used to automatically convert miter joins to bevel joins for sharp angles.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

line-occlusion-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number . Units in pixels. Defaults to 0. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-pattern

Paint property. Optional resolvedImage .

Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.49.0	>= 6.5.0	>= 4.4.0

line-round-limit

Layout property. Optional number . Defaults to 1.05. Requires line-join to be "round". Supports smooth-rampinterpolateexpressions.

Used to automatically convert round joins to miter joins for shallow angles.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

line-sort-key

Layout property. Optional number .

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 1.2.0	>= 9.1.0	>= 5.8.0
data-driven styling	>= 1.2.0	>= 9.1.0	>= 5.8.0

line-translate

Paint property. Optional array of numbers . Units in pixels. Defaults to [0,0]. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-translate-anchor

Paint property. Optional enum . One of "map", "viewport". Defaults to "map". Requires line-translate.

Controls the frame of reference for line-translate.

"map":

The line is translated relative to the map.

"viewport":

The line is translated relative to the viewport.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

line-trim-color

EXPERIMENTAL

Paint property. Optional color . Defaults to "transparent". Requires line-trim-offset. Requires source to be "geojson". Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-trim-fade-range

EXPERIMENTAL

Paint property. Optional array of numbers [ between 0 and 1 inclusive, between 0 and 1 inclusive ]. Defaults to [0,0]. Requires line-trim-offset. Requires source to be "geojson". Supports smooth-rampinterpolateexpressions.

The fade range for the trim-start and trim-end points is defined by the line-trim-offset property. The first element of the array represents the fade range from the trim-start point toward the end of the line, while the second element defines the fade range from the trim-end point toward the beginning of the line. The fade result is achieved by interpolating between line-trim-color and the color specified by the line-color or the line-gradient property.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.6.0	>= 11.6.0	>= 11.6.0

line-trim-offset

Paint property. Optional array of numbers [ between 0 and 1 inclusive, between 0 and 1 inclusive ]. Defaults to [0,0]. Requires source to be "geojson".

The line part between [trim-start, trim-end] will be painted using line-trim-color, which is transparent by default to produce a route vanishing effect. The line trim-off offset is based on the whole line range [0.0, 1.0].

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.9.0	>= 10.5.0	>= 10.5.0

line-width

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 1. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

line-z-offset

EXPERIMENTAL

Layout property. Optional number . Defaults to 0. Requires line-elevation-reference.

Vertical offset from ground, in meters. Defaults to 0. This is an experimental property with some known issues:

• Not supported for globe projection at the moment
• Elevated line discontinuity is possible on tile borders with terrain enabled
• Rendering artifacts can happen near line joins and line caps depending on the line styling
• Rendering artifacts relating to line-opacity and line-blur
• Elevated line visibility is determined by layer order
• Z-fighting issues can happen with intersecting elevated lines
• Elevated lines don't cast shadows

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.5.0	>= 11.5.0	>= 11.5.0
data-driven styling	>= 3.5.0	>= 11.5.0	>= 11.5.0

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

symbol

A symbol style layer renders icon and text labels at points or along lines on a map. You can use a symbol layer to configure the visual appearance of labels for features in vector tiles.

This map of Denver area businesses uses the icon-image layout property to use a custom image as an icon in a symbol layer.

icon-allow-overlap

Layout property. Optional boolean . Defaults to false. Requires icon-image.

If true, the icon will be visible even if it collides with other previously drawn symbols.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

icon-anchor

Layout property. Optional enum . One of "center", "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right". Defaults to "center". Requires icon-image.

Part of the icon placed closest to the anchor.

"center":

The center of the icon is placed closest to the anchor.

"left":

The left side of the icon is placed closest to the anchor.

"right":

The right side of the icon is placed closest to the anchor.

"top":

The top of the icon is placed closest to the anchor.

"bottom":

The bottom of the icon is placed closest to the anchor.

"top-left":

The top left corner of the icon is placed closest to the anchor.

"top-right":

The top right corner of the icon is placed closest to the anchor.

"bottom-left":

The bottom left corner of the icon is placed closest to the anchor.

"bottom-right":

The bottom right corner of the icon is placed closest to the anchor.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.40.0	>= 5.2.0	>= 3.7.0
data-driven styling	>= 0.40.0	>= 5.2.0	>= 3.7.0

icon-color

Paint property. Optional color . Defaults to "#000000". Requires icon-image. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-color-brightness-max

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1.

Increase or reduce the brightness of the symbols. The value is the maximum brightness.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.5.0	>= 11.5.0	>= 11.5.0

icon-color-brightness-min

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.

Increase or reduce the brightness of the symbols. The value is the minimum brightness.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.5.0	>= 11.5.0	>= 11.5.0

icon-color-contrast

Paint property. Optional number between -1 and 1 inclusive. Defaults to 0.

Increase or reduce the contrast of the symbol icon.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.5.0	>= 11.5.0	>= 11.5.0

icon-color-saturation

Paint property. Optional number between -1 and 1 inclusive. Defaults to 0.

Increase or reduce the saturation of the symbol icon.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.1.0	>= 11.1.0	>= 11.1.0

icon-emissive-strength

Paint property. Optional number greater than or equal to 0. Units in intensity. Defaults to 1. Requires lights. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Requires icon-image. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional color . Defaults to "rgba(0, 0, 0, 0)". Requires icon-image. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Requires icon-image. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-ignore-placement

Layout property. Optional boolean . Defaults to false. Requires icon-image.

If true, other symbols can be visible even if they collide with the icon.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

icon-image

Layout property. Optional resolvedImage .

Name of image in sprite to use for drawing an image background.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.35.0	>= 5.1.0	>= 3.6.0

icon-image-cross-fade

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0. Requires icon-image. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

Controls the transition progress between the image variants of icon-image. Zero means the first variant is used, one is the second, and in between they are blended together.

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-keep-upright

Layout property. Optional boolean . Defaults to false. Requires icon-image. Requires icon-rotation-alignment to be "map". Requires symbol-placement to be "line", or "line-center".

If true, the icon may be flipped to prevent it from being rendered upside-down.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

icon-occlusion-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0. Requires icon-image. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-offset

Layout property. Optional array of numbers . Defaults to [0,0]. Requires icon-image. Supports smooth-rampinterpolateexpressions.

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 icon-size to obtain the final offset in pixels. When combined with icon-rotate the offset will be as if the rotated direction was up.

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

icon-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Requires icon-image. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-optional

Layout property. Optional boolean . Defaults to false. Requires icon-image. Requires text-field.

If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

icon-padding

Layout property. Optional number greater than or equal to 0. Units in pixels. Defaults to 2. Requires icon-image. Supports smooth-rampinterpolateexpressions.

Size of the additional area around the icon bounding box used for detecting symbol collisions.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

icon-pitch-alignment

Layout property. Optional enum . One of "map", "viewport", "auto". Defaults to "auto". Requires icon-image.

Orientation of icon when map is pitched.

"map":

The icon is aligned to the plane of the map.

"viewport":

The icon is aligned to the plane of the viewport.

"auto":

Automatically matches the value of icon-rotation-alignment.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.39.0	>= 5.2.0	>= 3.7.0

icon-rotate

Layout property. Optional number . Units in degrees. Defaults to 0. Requires icon-image. Supports smooth-rampinterpolateexpressions.

Rotates the icon clockwise.

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

icon-rotation-alignment

Layout property. Optional enum . One of "map", "viewport", "auto". Defaults to "auto". Requires icon-image.

In combination with symbol-placement, determines the rotation behavior of icons.

"map":

When symbol-placement is set to point, aligns icons east-west. When symbol-placement is set to line or line-center, aligns icon x-axes with the line.

"viewport":

Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of symbol-placement.

"auto":

When symbol-placement is set to point, this is equivalent to viewport. When symbol-placement is set to line or line-center, this is equivalent to map.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
auto value	>= 0.25.0	>= 4.2.0	>= 3.4.0

icon-size

Layout property. Optional number greater than or equal to 0. Units in factor of the original icon size. Defaults to 1. Requires icon-image. Supports smooth-rampinterpolateexpressions.

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 icon-size. 1 is the original size; 3 triples the size of the image.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.35.0	>= 5.1.0	>= 3.6.0

icon-text-fit

Layout property. Optional enum . One of "none", "width", "height", "both". Defaults to "none". Requires icon-image. Requires text-field.

Scales the icon to fit around the associated text.

"none":

The icon is displayed at its intrinsic aspect ratio.

"width":

The icon is scaled in the x-dimension to fit the width of the text.

"height":

The icon is scaled in the y-dimension to fit the height of the text.

"both":

The icon is scaled in both x- and y-dimensions.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.21.0	>= 4.2.0	>= 3.4.0
stretchable icons	>= 1.6.0	>= 9.2.0	>= 5.8.0
data-driven styling	>= 3.0.0	>= 11.0.0	>= 11.0.0

icon-text-fit-padding

Layout property. Optional array of numbers . Units in pixels. Defaults to [0,0,0,0]. Requires icon-image. Requires text-field. Requires icon-text-fit to be "both", or "width", or "height". Supports smooth-rampinterpolateexpressions.

Size of the additional area added to dimensions determined by icon-text-fit, in clockwise order: top, right, bottom, left.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.21.0	>= 4.2.0	>= 3.4.0
data-driven styling	>= 3.0.0	>= 11.0.0	>= 11.0.0

icon-translate

Paint property. Optional array of numbers . Units in pixels. Defaults to [0,0]. Requires icon-image. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

icon-translate-anchor

Paint property. Optional enum . One of "map", "viewport". Defaults to "map". Requires icon-image. Requires icon-translate.

Controls the frame of reference for icon-translate.

"map":

Icons are translated relative to the map.

"viewport":

Icons are translated relative to the viewport.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

symbol-avoid-edges

Layout property. Optional boolean . Defaults to false.

If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

symbol-elevation-reference

EXPERIMENTAL

Layout property. Optional enum . One of "sea", "ground", "hd-road-markup". Defaults to "ground".

Selects the base of symbol-elevation.

"sea":

Elevate symbols relative to the sea level.

"ground":

Elevate symbols relative to the ground's height below them.

"hd-road-markup":

Use this mode to enable elevated behavior for features that are rendered on top of 3D road polygons. The feature is currently being developed.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	Not yet supported	>= 11.9.0	>= 11.9.0

symbol-placement

Layout property. Optional enum . One of "point", "line", "line-center". Defaults to "point".

Label placement relative to its geometry.

"point":

The label is placed at the point where the geometry is located.

"line":

The label is placed along the line of the geometry. Can only be used on LineString and Polygon geometries.

"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.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
line-center value	>= 0.47.0	>= 6.4.0	>= 4.3.0

symbol-sort-key

Layout property. Optional number .

Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When icon-allow-overlap or text-allow-overlap is false, features with a lower sort key will have priority during placement. When icon-allow-overlap or text-allow-overlap is set to true, features with a higher sort key will overlap over features with a lower sort key.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.53.0	>= 7.4.0	>= 4.11.0
data-driven styling	>= 0.53.0	>= 7.4.0	>= 4.11.0

symbol-spacing

Layout property. Optional number greater than or equal to 1. Units in pixels. Defaults to 250. Requires symbol-placement to be "line". Supports smooth-rampinterpolateexpressions.

Distance between two symbol anchors.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

symbol-z-elevate

Layout property. Optional boolean . Defaults to false. Requires symbol-placement to be "point". Requires symbol-z-order to be "auto".

Position symbol on buildings (both fill extrusions and models) rooftops. In order to have minimal impact on performance, this is supported only when fill-extrusion-height is not zoom-dependent and remains unchanged. For fading in buildings when zooming in, fill-extrusion-vertical-scale should be used and symbols would raise with building rooftops. Symbols are sorted by elevation, except in cases when viewport-y sorting or symbol-sort-key are applied.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 11.0.0	>= 11.0.0

symbol-z-offset

EXPERIMENTAL

Paint property. Optional number greater than or equal to 0. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

symbol-z-order

Layout property. Optional enum . One of "auto", "viewport-y", "source". Defaults to "auto".

Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport. To control the order and prioritization of symbols otherwise, use symbol-sort-key.

"auto":

Sorts symbols by symbol-sort-key if set. Otherwise, sorts symbols by their y-position relative to the viewport if icon-allow-overlap or text-allow-overlap is set to true or icon-ignore-placement or text-ignore-placement is false.

"viewport-y":

Sorts symbols by their y-position relative to the viewport if any of the following is set to true: icon-allow-overlap, text-allow-overlap, icon-ignore-placement, text-ignore-placement.

"source":

Sorts symbols by symbol-sort-key if set. Otherwise, no sorting is applied; symbols are rendered in the same order as the source data.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.49.0	>= 6.6.0	>= 4.5.0

text-allow-overlap

Layout property. Optional boolean . Defaults to false. Requires text-field.

If true, the text will be visible even if it collides with other previously drawn symbols.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

text-anchor

Layout property. Optional enum . One of "center", "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right". Defaults to "center". Requires text-field. Disabled by text-variable-anchor.

Part of the text placed closest to the anchor.

"center":

The center of the text is placed closest to the anchor.

"left":

The left side of the text is placed closest to the anchor.

"right":

The right side of the text is placed closest to the anchor.

"top":

The top of the text is placed closest to the anchor.

"bottom":

The bottom of the text is placed closest to the anchor.

"top-left":

The top left corner of the text is placed closest to the anchor.

"top-right":

The top right corner of the text is placed closest to the anchor.

"bottom-left":

The bottom left corner of the text is placed closest to the anchor.

"bottom-right":

The bottom right corner of the text is placed closest to the anchor.

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

text-color

Paint property. Optional color . Defaults to "#000000". Requires text-field. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in intensity. Defaults to 1. Requires lights. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-field

Layout property. Optional formatted . Defaults to "".

Value to use for a text label. If a plain string is provided, it will be treated as a formatted with default/inherited formatting options. SDF images are not supported in formatted text and will be ignored.

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-font

Layout property. Optional array of strings . Defaults to ["Open Sans Regular","Arial Unicode MS Regular"]. Requires text-field.

Font stack to use for displaying text.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.43.0	>= 6.0.0	>= 4.0.0

text-halo-blur

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Requires text-field. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional color . Defaults to "rgba(0, 0, 0, 0)". Requires text-field. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Requires text-field. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-ignore-placement

Layout property. Optional boolean . Defaults to false. Requires text-field.

If true, other symbols can be visible even if they collide with the text.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

text-justify

Layout property. Optional enum . One of "auto", "left", "center", "right". Defaults to "center". Requires text-field.

Text justification options.

"auto":

The text is aligned towards the anchor position.

"left":

The text is aligned to the left.

"center":

The text is centered.

"right":

The text is aligned to the right.

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
auto	>= 0.54.0	>= 7.4.0	>= 4.10.0

text-keep-upright

Layout property. Optional boolean . Defaults to true. Requires text-field. Requires text-rotation-alignment to be "map". Requires symbol-placement to be "line", or "line-center".

If true, the text may be flipped vertically to prevent it from being rendered upside-down.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

text-letter-spacing

Layout property. Optional number . Units in ems. Defaults to 0. Requires text-field. Supports smooth-rampinterpolateexpressions.

Text tracking amount.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.40.0	>= 5.2.0	>= 3.7.0

text-line-height

Layout property. Optional number . Units in ems. Defaults to 1.2. Requires text-field. Supports smooth-rampinterpolateexpressions.

Text leading value for multi-line text.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 2.3.0	>= 10.0.0	>= 10.0.0

text-max-angle

Layout property. Optional number . Units in degrees. Defaults to 45. Requires text-field. Requires symbol-placement to be "line", or "line-center". Supports smooth-rampinterpolateexpressions.

Maximum angle change between adjacent characters.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

text-max-width

Layout property. Optional number greater than or equal to 0. Units in ems. Defaults to 10. Requires text-field. Requires symbol-placement to be "point". Supports smooth-rampinterpolateexpressions.

The maximum line width for text wrapping.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.40.0	>= 5.2.0	>= 3.7.0

text-occlusion-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0. Requires text-field. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-offset

Layout property. Optional array of numbers . Units in ems. Defaults to [0,0]. Requires text-field. Disabled by text-radial-offset. Supports smooth-rampinterpolateexpressions.

Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.35.0	>= 5.1.0	>= 3.6.0

text-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Requires text-field. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-optional

Layout property. Optional boolean . Defaults to false. Requires text-field. Requires icon-image.

If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

text-padding

Layout property. Optional number greater than or equal to 0. Units in pixels. Defaults to 2. Requires text-field. Supports smooth-rampinterpolateexpressions.

Size of the additional area around the text bounding box used for detecting symbol collisions.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

text-pitch-alignment

Layout property. Optional enum . One of "map", "viewport", "auto". Defaults to "auto". Requires text-field.

Orientation of text when map is pitched.

"map":

The text is aligned to the plane of the map.

"viewport":

The text is aligned to the plane of the viewport.

"auto":

Automatically matches the value of text-rotation-alignment.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.21.0	>= 4.2.0	>= 3.4.0
auto value	>= 0.25.0	>= 4.2.0	>= 3.4.0

text-radial-offset

Layout property. Optional number . Units in ems. Defaults to 0. Requires text-field. Supports smooth-rampinterpolateexpressions.

Radial offset of text, in the direction of the symbol's anchor. Useful in combination with text-variable-anchor, which defaults to using the two-dimensional text-offset if present.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.54.0	>= 7.4.0	>= 4.10.0
data-driven styling	>= 0.54.0	>= 7.4.0	>= 4.10.0

text-rotate

Layout property. Optional number . Units in degrees. Defaults to 0. Requires text-field. Supports smooth-rampinterpolateexpressions.

Rotates the text clockwise.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
data-driven styling	>= 0.35.0	>= 5.1.0	>= 3.6.0

text-rotation-alignment

Layout property. Optional enum . One of "map", "viewport", "auto". Defaults to "auto". Requires text-field.

In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text.

"map":

When symbol-placement is set to point, aligns text east-west. When symbol-placement is set to line or line-center, aligns text x-axes with the line.

"viewport":

Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of symbol-placement.

"auto":

When symbol-placement is set to point, this is equivalent to viewport. When symbol-placement is set to line or line-center, this is equivalent to map.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
auto value	>= 0.25.0	>= 4.2.0	>= 3.4.0

text-size

Layout property. Optional number greater than or equal to 0. Units in pixels. Defaults to 16. Requires text-field. Supports smooth-rampinterpolateexpressions.

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.35.0	>= 5.1.0	>= 3.6.0

text-transform

Layout property. Optional enum . One of "none", "uppercase", "lowercase". Defaults to "none". Requires text-field.

Specifies how to capitalize text, similar to the CSS text-transform property.

"none":

The text is not altered.

"uppercase":

Forces all letters to be displayed in uppercase.

"lowercase":

Forces all letters to be displayed in lowercase.

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

Paint property. Optional array of numbers . Units in pixels. Defaults to [0,0]. Requires text-field. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

text-translate-anchor

Paint property. Optional enum . One of "map", "viewport". Defaults to "map". Requires text-field. Requires text-translate.

Controls the frame of reference for text-translate.

"map":

The text is translated relative to the map.

"viewport":

The text is translated relative to the viewport.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

text-variable-anchor

Layout property. Optional array of enums . One of "center", "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right". Requires text-field. Requires symbol-placement to be "point".

To increase the chance of placing high-priority labels on the map, you can provide an array of text-anchor locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use text-justify: auto to choose justification based on anchor position. To apply an offset, use the text-radial-offset or the two-dimensional text-offset.

"center":

The center of the text is placed closest to the anchor.

"left":

The left side of the text is placed closest to the anchor.

"right":

The right side of the text is placed closest to the anchor.

"top":

The top of the text is placed closest to the anchor.

"bottom":

The bottom of the text is placed closest to the anchor.

"top-left":

The top left corner of the text is placed closest to the anchor.

"top-right":

The top right corner of the text is placed closest to the anchor.

"bottom-left":

The bottom left corner of the text is placed closest to the anchor.

"bottom-right":

The bottom right corner of the text is placed closest to the anchor.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.54.0	>= 7.4.0	>= 4.10.0

text-writing-mode

Layout property. Optional array of enums . One of "horizontal", "vertical". Requires text-field.

The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. For symbol with point placement, the order of elements in an array define priority order for the placement of an orientation variant. For symbol with line placement, the default text writing mode is either ['horizontal', 'vertical'] or ['vertical', 'horizontal'], the order doesn't affect the placement.

"horizontal":

If a text's language supports horizontal writing mode, symbols would be laid out horizontally.

"vertical":

If a text's language supports vertical writing mode, symbols would be laid out vertically.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 1.3.0	>= 8.3.0	>= 5.3.0

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

raster

A raster style layer renders raster tiles on a map. You can use a raster layer to configure the color parameters of raster tiles.

This interactive SWIR imagery map by Maxar uses the visibility layout property to show or hide raster layers with shortwave infrared satellite imagery of California wildfires.

raster-array-band

EXPERIMENTAL

Paint property. Optional string . Requires source to be "raster-array".

Displayed band of raster array source layer. Defaults to the first band if not set.

"band-name"

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.1.0	>= 11.1.0	>= 11.1.0

raster-brightness-max

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional color . Supports smooth-rampinterpolateexpressions.

Defines a color map by which to colorize a raster layer, parameterized by the ["raster-value"] expression and evaluated at 256 uniformly spaced steps over the range specified by raster-color-range.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 11.0.0	>= 11.0.0
data-driven styling	Not yet supported	Not yet supported	Not yet supported

raster-color-mix

Paint property. Optional array of numbers . Defaults to [0.2126,0.7152,0.0722,0]. Requires raster-color. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional array of numbers . Requires raster-color. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between -1 and 1 inclusive. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

EXPERIMENTAL

Paint property. Optional number greater than or equal to 0. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in intensity. Defaults to 0. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-fade-duration

Paint property. Optional number greater than or equal to 0. Units in milliseconds. Defaults to 300. Supports smooth-rampinterpolateexpressions.

Fade duration when a new tile is added.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

raster-hue-rotate

Paint property. Optional number . Units in degrees. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-resampling

Paint property. Optional enum . One of "linear", "nearest". Defaults to "linear".

The resampling/interpolation method to use for overscaling, also known as texture magnification filter

"linear":

(Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled

"nearest":

Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.47.0	>= 6.3.0	>= 4.2.0

raster-saturation

Paint property. Optional number between -1 and 1 inclusive. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

raster-particle

A raster-particle style layer renders a particle animation on a map. A velocity tileset drives the layer, providing the relative speed and direction for the particles. Use the layer to configure particle animation properties, such as speed, density, and colorization.

A particle animation driven by a wind tileset derived from the Global Forecast System (GFS).

raster-particle-array-band

Paint property. Optional string .

Displayed band of raster array source layer

"\"1713348000\""

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.3.0	>= 11.4.0	>= 11.4.0

raster-particle-color

Paint property. Optional color . Supports smooth-rampinterpolateexpressions.

Defines a color map by which to colorize a raster particle layer, parameterized by the ["raster-particle-speed"] expression and evaluated at 256 uniformly spaced steps over the range specified by raster-particle-max-speed.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.3.0	>= 11.4.0	>= 11.4.0
data-driven styling	Not yet supported	Not yet supported	Not yet supported

raster-particle-count

Paint property. Optional number greater than or equal to 1. Defaults to 512.

Defines the amount of particles per tile.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.3.0	>= 11.4.0	>= 11.4.0

raster-particle-elevation

Paint property. Optional number greater than or equal to 0. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.98. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-max-speed

Paint property. Optional number greater than or equal to 1. Defaults to 1.

Defines the maximum speed for particles. Velocities with magnitudes equal to or exceeding this value are clamped to the max value.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.3.0	>= 11.4.0	>= 11.4.0

raster-particle-reset-rate-factor

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.8.

Defines a coefficient for a time period at which particles will restart at a random position, to avoid degeneration (empty areas without particles).

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.3.0	>= 11.4.0	>= 11.4.0

raster-particle-speed-factor

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.2. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.3.0	>= 11.4.0	>= 11.4.0
expressions support	>= 3.3.0	>= 11.4.0	>= 11.4.0

circle

A circle style layer renders one or more filled circles on a map. You can use a circle layer to configure the visual appearance of point or point collection features in vector tiles. A circle layer renders circles whose radii are measured in screen units.

This cluster map uses a circle layer with a GeoJSON data source and sets the source's cluster property to true to visualize points as clusters.

circle-blur

Paint property. Optional number . Defaults to 0. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional color . Defaults to "#000000". Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-elevation-reference

EXPERIMENTAL

Layout property. Optional enum . One of "none", "hd-road-markup". Defaults to "none".

Selects the base of circle-elevation. Some modes might require precomputed elevation data in the tileset.

"none":

Elevated rendering is disabled.

"hd-road-markup":

Elevated rendering is enabled. Use this mode to describe additive and stackable features that should exist only on top of road polygons.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	Not yet supported	>= 11.11.0	>= 11.11.0

circle-emissive-strength

Paint property. Optional number greater than or equal to 0. Units in intensity. Defaults to 0. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-pitch-alignment

Paint property. Optional enum . One of "map", "viewport". Defaults to "viewport".

Orientation of circle when map is pitched.

"map":

The circle is aligned to the plane of the map.

"viewport":

The circle is aligned to the plane of the viewport.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.39.0	>= 5.2.0	>= 3.7.0

circle-pitch-scale

Paint property. Optional enum . One of "map", "viewport". Defaults to "map".

Controls the scaling behavior of the circle when the map is pitched.

"map":

Circles are scaled according to their apparent distance to the camera.

"viewport":

Circles are not scaled.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.21.0	>= 4.2.0	>= 3.4.0

circle-radius

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 5. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-sort-key

Layout property. Optional number .

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 1.2.0	>= 9.2.0	>= 5.9.0
data-driven styling	>= 1.2.0	>= 9.2.0	>= 5.9.0

circle-stroke-color

Paint property. Optional color . Defaults to "#000000". Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional array of numbers . Units in pixels. Defaults to [0,0]. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

circle-translate-anchor

Paint property. Optional enum . One of "map", "viewport". Defaults to "map". Requires circle-translate.

Controls the frame of reference for circle-translate.

"map":

The circle is translated relative to the map.

"viewport":

The circle is translated relative to the viewport.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.10.0	>= 2.0.1	>= 2.0.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

fill-extrusion

A fill-extrusion style layer renders one or more filled (and optionally stroked) extruded (3D) polygons on a map. You can use a fill-extrusion layer to configure the extrusion and visual appearance of polygon or multipolygon features.

This map uses an external dataset to provide data-driven values for the fill-extrusion-height paint property of various country polygons in a fill-extrusion layer.

fill-extrusion-ambient-occlusion-ground-attenuation

EXPERIMENTAL

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.69. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

EXPERIMENTAL

Paint property. Optional number greater than or equal to 0. Defaults to 3. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Defaults to 3. Requires fill-extrusion-edge-radius. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

EXPERIMENTAL

Paint property. Optional number greater than or equal to 0. Defaults to 3. Requires lights. Requires fill-extrusion-edge-radius. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in meters. Defaults to 0. Requires fill-extrusion-height. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-base-alignment

EXPERIMENTAL

Paint property. Optional enum . One of "terrain", "flat". Defaults to "terrain". Requires fill-extrusion-base.

Controls the behavior of fill extrusion base over terrain

"terrain":

The fill extrusion base follows terrain slope.

"flat":

The fill extrusion base is flat over terrain.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.8.0	>= 11.8.0	>= 11.8.0

fill-extrusion-cast-shadows

Paint property. Optional boolean . Defaults to true.

Enable/Disable shadow casting for this layer

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.7.0	>= 11.8.0	>= 11.8.0

fill-extrusion-color

Paint property. Optional color . Defaults to "#000000". Disabled by fill-extrusion-pattern. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-cutoff-fade-range

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.

This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. Fade out is implemented by scaling down and removing buildings in the fade range in a staggered fashion. Opacity is not changed. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 11.0.0	>= 11.0.0

fill-extrusion-edge-radius

EXPERIMENTAL

Layout property. Optional number between 0 and 1 inclusive. Defaults to 0.

Radius of a fill extrusion edge in meters. If not zero, rounds extrusion edges for a smoother appearance.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 10.7.0	>= 10.7.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

fill-extrusion-emissive-strength

Paint property. Optional number greater than or equal to 0. Units in intensity. Defaults to 0. Requires lights. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

EXPERIMENTAL

Paint property. Optional color . Defaults to "#ffffff". Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

EXPERIMENTAL

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.69. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

EXPERIMENTAL

Paint property. Optional number . Units in meters. Defaults to 0. Requires lights. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

EXPERIMENTAL

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

EXPERIMENTAL

Paint property. Optional number greater than or equal to 0. Units in meters. Defaults to 0. Requires lights. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in meters. Defaults to 0. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-height-alignment

EXPERIMENTAL

Paint property. Optional enum . One of "terrain", "flat". Defaults to "flat". Requires fill-extrusion-height.

Controls the behavior of fill extrusion height over terrain

"terrain":

The fill extrusion height follows terrain slope.

"flat":

The fill extrusion height is flat over terrain.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.8.0	>= 11.8.0	>= 11.8.0

fill-extrusion-line-width

EXPERIMENTAL

Paint property. Optional number greater than or equal to 0. Units in meters. Defaults to 0. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-pattern

Paint property. Optional resolvedImage .

Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.27.0	>= 5.1.0	>= 3.6.0
data-driven styling	>= 0.49.0	>= 6.5.0	>= 4.4.0

fill-extrusion-rounded-roof

EXPERIMENTAL

Paint property. Optional boolean . Defaults to true. Requires fill-extrusion-edge-radius.

Indicates whether top edges should be rounded when fill-extrusion-edge-radius has a value greater than 0. If false, rounded edges are only applied to the sides. Default is true.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 10.10.0	>= 10.10.0

fill-extrusion-translate

Paint property. Optional array of numbers . Units in pixels. Defaults to [0,0]. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-translate-anchor

Paint property. Optional enum . One of "map", "viewport". Defaults to "map". Requires fill-extrusion-translate.

Controls the frame of reference for fill-extrusion-translate.

"map":

The fill extrusion is translated relative to the map.

"viewport":

The fill extrusion is translated relative to the viewport.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.27.0	>= 5.1.0	>= 3.6.0

fill-extrusion-vertical-gradient

Paint property. Optional boolean . Defaults to true.

Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.50.0	>= 7.0.0	>= 4.7.0

fill-extrusion-vertical-scale

EXPERIMENTAL

Paint property. Optional number greater than or equal to 0. Defaults to 1. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.27.0	>= 5.1.0	>= 3.6.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

heatmap

A heatmap style layer renders a range of colors to represent the density of points in an area.

This visualization of earthquake data uses a heatmap layer with carefully defined paint properties to highlight areas where earthquake frequency is high and many points are clustered closely together.

heatmap-color

Paint property. Optional color . Defaults to ["interpolate",["linear"],["heatmap-density"],0,"rgba(0, 0, 255, 0)",0.1,"royalblue",0.3,"cyan",0.5,"lime",0.7,"yellow",1,"red"]. Supports smooth-rampinterpolateexpressions.

Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"] as input.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.41.0	>= 6.0.0	>= 4.0.0
data-driven styling	Not yet supported	Not yet supported	Not yet supported

heatmap-intensity

Paint property. Optional number greater than or equal to 0. Defaults to 1. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 1. Units in pixels. Defaults to 30. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

heatmap-weight

Paint property. Optional number greater than or equal to 0. Defaults to 1. Supports combinefeature-state and smooth-rampinterpolateexpressions.

A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.41.0	>= 6.0.0	>= 4.0.0
data-driven styling	>= 0.41.0	>= 6.0.0	>= 4.0.0

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.41.0	>= 6.0.0	>= 4.0.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

hillshade

A hillshade style layer renders digital elevation model (DEM) data on the client-side. The implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.

This map of Mount Shasta uses a high value for the hillshade-exaggeration paint property to apply an intense shading effect.

hillshade-accent-color

Paint property. Optional color . Defaults to "#000000". Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number greater than or equal to 0. Units in intensity. Defaults to 0. Requires lights. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.5. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional color . Defaults to "#FFFFFF". Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-illumination-anchor

Paint property. Optional enum . One of "map", "viewport". Defaults to "viewport".

Direction of light source when map is rotated.

"map":

The hillshade illumination is relative to the north direction.

"viewport":

The hillshade illumination is relative to the top of the viewport.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.43.0	>= 6.0.0	>= 4.0.0

hillshade-illumination-direction

Paint property. Optional number between 0 and 359 inclusive. Defaults to 335. Supports smooth-rampinterpolateexpressions.

The direction of the light source used to generate the hillshading with 0 as the top of the viewport if hillshade-illumination-anchor is set to viewport and due north if hillshade-illumination-anchor is set to map and no 3d lights enabled. If hillshade-illumination-anchor is set to map and 3d lights enabled, the direction from 3d lights is used instead.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.43.0	>= 6.0.0	>= 4.0.0

hillshade-shadow-color

Paint property. Optional color . Defaults to "#000000". Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 0.43.0	>= 6.0.0	>= 4.0.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

sky

Warning

As of v2.9.0, fog is the preferred method for atmospheric styling. Sky layer is not supported by the globe projection, and will be phased out in a future release.

A sky style layer renders a stylized spherical dome that encompasses the entire map and is automatically rendered behind all layers. This can be used to fill the area above the horizon with a simulated sky that represents a particular time-of-day, or stylized custom gradients.

A simulated sunrise over the deserts of California using sky-type: 'atmosphere' paint property.

sky-atmosphere-color

Paint property. Optional color . Defaults to "white". Requires sky-type to be "atmosphere".

A color used to tweak the main atmospheric scattering coefficients. Using white applies the default coefficients giving the natural blue color to the atmosphere. This color affects how heavily the corresponding wavelength is represented during scattering. The alpha channel describes the density of the atmosphere, with 1 maximum density and 0 no density.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.0.0	>= 10.0.0	>= 10.0.0

sky-atmosphere-halo-color

Paint property. Optional color . Defaults to "white". Requires sky-type to be "atmosphere".

A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.0.0	>= 10.0.0	>= 10.0.0

sky-atmosphere-sun

Paint property. Optional array of numbers [ between 0 and 360 inclusive, between 0 and 180 inclusive ]. Units in degrees. Requires sky-type to be "atmosphere".

Position of the sun center [a azimuthal angle, p polar angle]. The azimuthal angle indicates the position of the sun relative to 0° north, where degrees proceed clockwise. The polar angle indicates the height of the sun, where 0° is directly above, at zenith, and 90° at the horizon. When this property is ommitted, the sun center is directly inherited from the light position.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.0.0	>= 10.0.0	>= 10.0.0

sky-atmosphere-sun-intensity

Paint property. Optional number between 0 and 100 inclusive. Defaults to 10. Requires sky-type to be "atmosphere".

Intensity of the sun as a light source in the atmosphere (on a scale from 0 to a 100). Setting higher values will brighten up the sky.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.0.0	>= 10.0.0	>= 10.0.0

sky-gradient

Paint property. Optional color . Defaults to ["interpolate",["linear"],["sky-radial-progress"],0.8,"#87ceeb",1,"white"]. Requires sky-type to be "gradient". Supports smooth-rampinterpolateexpressions.

Defines a radial color gradient with which to color the sky. The color values can be interpolated with an expression using sky-radial-progress. The range [0, 1] for the interpolant covers a radial distance (in degrees) of [0, sky-gradient-radius] centered at the position specified by sky-gradient-center.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.0.0	>= 10.0.0	>= 10.0.0
data-driven styling	Not yet supported	Not yet supported	Not yet supported

sky-gradient-center

Paint property. Optional array of numbers [ between 0 and 360 inclusive, between 0 and 180 inclusive ]. Units in degrees. Defaults to [0,0]. Requires sky-type to be "gradient".

Position of the gradient center [a azimuthal angle, p polar angle]. The azimuthal angle indicates the position of the gradient center relative to 0° north, where degrees proceed clockwise. The polar angle indicates the height of the gradient center, where 0° is directly above, at zenith, and 90° at the horizon.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.0.0	>= 10.0.0	>= 10.0.0

sky-gradient-radius

Paint property. Optional number between 0 and 180 inclusive. Defaults to 90. Requires sky-type to be "gradient".

The angular distance (measured in degrees) from sky-gradient-center up to which the gradient extends. A value of 180 causes the gradient to wrap around to the opposite direction from sky-gradient-center.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.0.0	>= 10.0.0	>= 10.0.0

sky-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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

sky-type

Paint property. Optional enum . One of "gradient", "atmosphere". Defaults to "atmosphere".

The type of the sky

"gradient":

Renders the sky with a gradient that can be configured with sky-gradient-radius and sky-gradient.

"atmosphere":

Renders the sky with a simulated atmospheric scattering algorithm, the sun direction can be attached to the light position or explicitly set through sky-atmosphere-sun.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.0.0	>= 10.0.0	>= 10.0.0

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 2.0.0	>= 10.0.0	>= 10.0.0
expressions support	>= 3.0.0	>= 11.0.0	>= 11.0.0

model

Warning

Note that this is an experimental feature which is under development and is prone to change.

A model style layer renders 3D buildings and instanced models (for example, trees in standard style).model layer renders content from following sources:

1. vector or GeoJSON (Used for trees in standard style)
2. batched-model (Used for landmark buildings in standard style)

To place third party models on the map the first approach should be used. It's possible to adjust rotation, scale, color, color mix and level of details for the models using the properties of the model layer.

Various trees rendered on the map using model-id layout property and model-rotation paint property.

model-ambient-occlusion-intensity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports smooth-rampinterpolateexpressions. opacityTransitionable.

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-cast-shadows

Paint property. Optional boolean . Defaults to true.

Enable/Disable shadow casting for this layer

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 11.0.0	>= 11.0.0

model-color

Paint property. Optional color . Defaults to "#ffffff". Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-cutoff-fade-range

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.

This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. The automatic cutoff range is calculated according to the minimum required zoom level of the source and layer. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 11.0.0	>= 11.0.0

model-emissive-strength

Paint property. Optional number between 0 and 5 inclusive. Units in intensity. Defaults to 0. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional array of numbers . Defaults to [1,1,1,1,0]. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-id

Layout property. Optional string . Defaults to "". Requires source to be "geojson", or "vector".

Model to render. It can be either a string referencing an element to the models root property or an internal or external URL

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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-receive-shadows

Paint property. Optional boolean . Defaults to true.

Enable/Disable shadow receiving for this layer

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 11.0.0	>= 11.0.0

model-rotation

Paint property. Optional array of numbers . Units in degrees. Defaults to [0,0,0]. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional array of numbers . Defaults to [1,1,1]. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

Paint property. Optional array of numbers . Defaults to [0,0,0]. Supports combinefeature-state and smooth-rampinterpolateexpressions. opacityTransitionable.

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

model-type

Paint property. Optional enum . One of "common-3d", "location-indicator". Defaults to "common-3d".

Defines rendering behavior of model in respect to other 3D scene objects.

"common-3d":

Integrated to 3D scene, using depth testing, along with terrain, fill-extrusions and custom layer.

"location-indicator":

Displayed over other 3D content, occluded by terrain.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 11.0.0	>= 11.0.0

visibility

Layout property. Optional enum . One of "visible", "none". Defaults to "visible".

Whether this layer is displayed.

"visible":

The layer is shown.

"none":

The layer is not shown.

SDK Support	Mapbox GL JS	Android SDK	iOS SDK
basic functionality	>= 3.0.0	>= 11.0.0	>= 11.0.0

Ready to get started?

Create a free account to start building with Mapbox.

Sign Up

Additional Developer Resources

Mapbox Developer Discord

Developer Cheatsheet

Mapbox Support

Ask AI

Was this page helpful?