Style Specification
Layers

Layers

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, circle, fill-extrusion, heatmap, hillshade.

Except for layers of the background type, each layer needs to 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.

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

filter

Optional expression.

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

id

Required string.

Unique layer name.

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.

source

Optional string.

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

source-layer

Optional string.

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

type

Required enum. One of "fill", "line", "symbol", "circle", "heatmap", "fill-extrusion", "raster", "hillshade", "background".

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.

"hillshade":

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

"background":

The background color or pattern of the map.


Layers have two sub-properties that determine how data from that layer is rendered: layout and paint 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 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

background-color

Paint property. Optional color. Defaults to "#000000". Disabled by background-pattern. Supports interpolateexpressions. Transitionable.

The color with which the background will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

background-opacity

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

The opacity at which the background will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

background-pattern

Paint property. Optional resolvedImage. Transitionable.

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

Not yet supportedNot yet supportedNot yet supportedNot 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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

fill

fill-antialias

Paint property. Optional boolean. Defaults to true.

Whether or not the fill should be antialiased.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

fill-color

Paint property. Optional color. Defaults to "#000000". Disabled by fill-pattern. Supports feature-state and interpolateexpressions. Transitionable.

The color of the filled part of this layer. This color can be specified as rgba with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.19.0>= 5.0.0>= 3.5.0>= 0.4.0

fill-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable.

The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.21.0>= 5.0.0>= 3.5.0>= 0.4.0

fill-outline-color

Paint property. Optional color. Disabled by fill-pattern. Requires fill-antialias to be true. Supports feature-state and interpolateexpressions. Transitionable.

The outline color of the fill. Matches the value of fill-color if unspecified.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.19.0>= 5.0.0>= 3.5.0>= 0.4.0

fill-pattern

Paint property. Optional resolvedImage. Transitionable.

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.49.0>= 6.5.0>= 4.4.0>= 0.11.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 1.2.0>= 9.1.0>= 5.8.0>= 0.15.0

data-driven styling

>= 1.2.0>= 9.1.0>= 5.8.0>= 0.15.0

fill-translate

Paint property. Optional array of numbers. Units in pixels. Defaults to [0,0]. Supports interpolateexpressions. Transitionable.

The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

line

line-blur

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable.

Blur applied to the line, in pixels.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

line-color

Paint property. Optional color. Defaults to "#000000". Disabled by line-pattern. Supports feature-state and interpolateexpressions. Transitionable.

The color with which the line will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.23.0>= 5.0.0>= 3.5.0>= 0.4.0

line-dasharray

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

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

Not yet supportedNot yet supportedNot yet supportedNot yet supported

line-gap-width

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable.

Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

line-gradient

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

Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify "lineMetrics": true.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.45.0>= 6.5.0>= 4.4.0>= 0.11.0

data-driven styling

Not yet supportedNot yet supportedNot yet supportedNot yet supported

line-join

Layout property. Optional enum. One of "bevel", "round", "miter". 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.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.40.0>= 5.2.0>= 3.7.0>= 0.6.0

line-miter-limit

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

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

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

line-offset

Paint property. Optional number. Units in pixels. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable.

The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.12.1>= 3.0.0>= 3.1.0>= 0.1.0

data-driven styling

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

line-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable.

The opacity at which the line will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

line-pattern

Paint property. Optional resolvedImage. Transitionable.

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.49.0>= 6.5.0>= 4.4.0>= 0.11.0

line-round-limit

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

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

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 1.2.0>= 9.1.0>= 5.8.0>= 0.15.0

data-driven styling

>= 1.2.0>= 9.1.0>= 5.8.0>= 0.15.0

line-translate

Paint property. Optional array of numbers. Units in pixels. Defaults to [0,0]. Supports interpolateexpressions. Transitionable.

The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

line-width

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable.

Stroke thickness.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.39.0>= 5.2.0>= 3.7.0>= 0.6.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

symbol

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.40.0>= 5.2.0>= 3.7.0>= 0.6.0

data-driven styling

>= 0.40.0>= 5.2.0>= 3.7.0>= 0.6.0

icon-color

Paint property. Optional color. Defaults to "#000000". Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable.

The color of the icon. This can only be used with sdf icons.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.0

icon-halo-blur

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable.

Fade out the halo towards the outside.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.0

icon-halo-color

Paint property. Optional color. Defaults to "rgba(0, 0, 0, 0)". Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable.

The color of the icon's halo. Icon halos can only be used with SDF icons.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.0

icon-halo-width

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable.

Distance of halo to the icon outline.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

icon-image

Layout property. Optional resolvedImage.

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

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.35.0>= 5.1.0>= 3.6.0>= 0.5.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

icon-offset

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

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

icon-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Requires icon-image. Supports feature-state and interpolateexpressions. Transitionable.

The opacity at which the icon will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

icon-padding

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

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

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.39.0>= 5.2.0>= 3.7.0>= 0.6.0

icon-rotate

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

Rotates the icon clockwise.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.21.0>= 5.0.0>= 3.5.0>= 0.4.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

auto value

>= 0.25.0>= 4.2.0>= 3.4.0>= 0.3.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 interpolateexpressions.

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.35.0>= 5.1.0>= 3.6.0>= 0.5.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.21.0>= 4.2.0>= 3.4.0>= 0.2.1

stretchable icons

>= 1.6.0>= 9.2.0>= 5.8.0>= 0.15.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 interpolateexpressions.

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

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.21.0>= 4.2.0>= 3.4.0>= 0.2.1

icon-translate

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

Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

line-center value

>= 0.47.0>= 6.4.0>= 4.3.0>= 0.10.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.53.0>= 7.4.0>= 4.11.0>= 0.14.0

data-driven styling

>= 0.53.0>= 7.4.0>= 4.11.0>= 0.14.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 interpolateexpressions.

Distance between two symbol anchors.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 icon-allow-overlap or text-allow-overlap is set to true or icon-ignore-placement or text-ignore-placement is false.

"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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.49.0>= 6.6.0>= 4.5.0>= 0.12.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.39.0>= 5.2.0>= 3.7.0>= 0.6.0

text-color

Paint property. Optional color. Defaults to "#000000". Requires text-field. Supports feature-state and interpolateexpressions. Transitionable.

The color with which the text will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.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.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.43.0>= 6.0.0>= 4.0.0>= 0.7.0

text-halo-blur

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Requires text-field. Supports feature-state and interpolateexpressions. Transitionable.

The halo's fadeout distance towards the outside.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.0

text-halo-color

Paint property. Optional color. Defaults to "rgba(0, 0, 0, 0)". Requires text-field. Supports feature-state and interpolateexpressions. Transitionable.

The color of the text's halo, which helps it stand out from backgrounds.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.0

text-halo-width

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Requires text-field. Supports feature-state and interpolateexpressions. Transitionable.

Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.39.0>= 5.2.0>= 3.7.0>= 0.6.0

auto

>= 0.54.0>= 7.4.0>= 4.10.0>= 0.14.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

text-letter-spacing

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

Text tracking amount.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.40.0>= 5.2.0>= 3.7.0>= 0.6.0

text-line-height

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

Text leading value for multi-line text.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 interpolateexpressions.

Maximum angle change between adjacent characters.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

text-max-width

Layout property. Optional number greater than or equal to 0. Units in ems. Defaults to 10. Requires text-field. Supports interpolateexpressions.

The maximum line width for text wrapping.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.40.0>= 5.2.0>= 3.7.0>= 0.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 interpolateexpressions.

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.35.0>= 5.1.0>= 3.6.0>= 0.5.0

text-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Requires text-field. Supports feature-state and interpolateexpressions. Transitionable.

The opacity at which the text will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

text-padding

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

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

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.21.0>= 4.2.0>= 3.4.0>= 0.2.1

auto value

>= 0.25.0>= 4.2.0>= 3.4.0>= 0.3.0

text-radial-offset

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

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.54.0>= 7.4.0>= 4.10.0>= 0.14.0

data-driven styling

>= 0.54.0>= 7.4.0>= 4.10.0>= 0.14.0

text-rotate

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

Rotates the text clockwise.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.35.0>= 5.1.0>= 3.6.0>= 0.5.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

auto value

>= 0.25.0>= 4.2.0>= 3.4.0>= 0.3.0

text-size

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

Font size.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.35.0>= 5.1.0>= 3.6.0>= 0.5.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.33.0>= 5.0.0>= 3.5.0>= 0.4.0

text-translate

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

Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.54.0>= 7.4.0>= 4.10.0>= 0.14.0

text-writing-mode

Layout property. Optional array of enums. One of "horizontal", "vertical". Requires text-field. Requires symbol-placement to be "point".

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

"horizontal":

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

"vertical":

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

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 1.3.0>= 8.3.0>= 5.3.0>= 0.15.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

raster

raster-brightness-max

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

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

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

raster-brightness-min

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

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

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

raster-contrast

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

Increase or reduce the contrast of the image.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

raster-fade-duration

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

Fade duration when a new tile is added.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

raster-hue-rotate

Paint property. Optional number. Units in degrees. Defaults to 0. Supports interpolateexpressions. Transitionable.

Rotates hues around the color wheel.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

raster-opacity

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

The opacity at which the image will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.47.0>= 6.3.0>= 4.2.0>= 0.9.0

raster-saturation

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

Increase or reduce the saturation of the image.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

circle

circle-blur

Paint property. Optional number. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable.

Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.20.0>= 5.0.0>= 3.5.0>= 0.4.0

circle-color

Paint property. Optional color. Defaults to "#000000". Supports feature-state and interpolateexpressions. Transitionable.

The fill color of the circle.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.18.0>= 5.0.0>= 3.5.0>= 0.4.0

circle-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable.

The opacity at which the circle will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.20.0>= 5.0.0>= 3.5.0>= 0.4.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.39.0>= 5.2.0>= 3.7.0>= 0.6.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.21.0>= 4.2.0>= 3.4.0>= 0.2.1

circle-radius

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 5. Supports feature-state and interpolateexpressions. Transitionable.

Circle radius.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

data-driven styling

>= 0.18.0>= 5.0.0>= 3.5.0>= 0.4.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 1.2.0>= 9.2.0>= 5.9.0>= 0.16.0

data-driven styling

>= 1.2.0>= 9.2.0>= 5.9.0>= 0.16.0

circle-stroke-color

Paint property. Optional color. Defaults to "#000000". Supports feature-state and interpolateexpressions. Transitionable.

The stroke color of the circle.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

data-driven styling

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

circle-stroke-opacity

Paint property. Optional number between 0 and 1 inclusive. Defaults to 1. Supports feature-state and interpolateexpressions. Transitionable.

The opacity of the circle's stroke.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

data-driven styling

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

circle-stroke-width

Paint property. Optional number greater than or equal to 0. Units in pixels. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable.

The width of the circle's stroke. Strokes are placed outside of the circle-radius.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

data-driven styling

>= 0.29.0>= 5.0.0>= 3.5.0>= 0.4.0

circle-translate

Paint property. Optional array of numbers. Units in pixels. Defaults to [0,0]. Supports interpolateexpressions. Transitionable.

The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.10.0>= 2.0.1>= 2.0.0>= 0.1.0

fill-extrusion

fill-extrusion-base

Paint property. Optional number greater than or equal to 0. Units in meters. Defaults to 0. Requires fill-extrusion-height. Supports feature-state and interpolateexpressions. Transitionable.

The height with which to extrude the base of this layer. Must be less than or equal to fill-extrusion-height.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.0

data-driven styling

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.0

fill-extrusion-color

Paint property. Optional color. Defaults to "#000000". Disabled by fill-extrusion-pattern. Supports feature-state and interpolateexpressions. Transitionable.

The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root light settings. If this color is specified as rgba with an alpha component, the alpha component will be ignored; use fill-extrusion-opacity to set layer opacity.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.0

data-driven styling

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.0

fill-extrusion-height

Paint property. Optional number greater than or equal to 0. Units in meters. Defaults to 0. Supports feature-state and interpolateexpressions. Transitionable.

The height with which to extrude this layer.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.0

data-driven styling

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.0

fill-extrusion-opacity

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

The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.0

fill-extrusion-pattern

Paint property. Optional resolvedImage. Transitionable.

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.0

data-driven styling

>= 0.49.0>= 6.5.0>= 4.4.0>= 0.11.0

fill-extrusion-translate

Paint property. Optional array of numbers. Units in pixels. Defaults to [0,0]. Supports interpolateexpressions. Transitionable.

The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.50.0Not yet supported>= 4.7.0>= 0.13.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.27.0>= 5.1.0>= 3.6.0>= 0.5.0

heatmap

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

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.41.0>= 6.0.0>= 4.0.0>= 0.7.0

data-driven styling

Not yet supportedNot yet supportedNot yet supportedNot yet supported

heatmap-intensity

Paint property. Optional number greater than or equal to 0. Defaults to 1. Supports interpolateexpressions. Transitionable.

Similar to heatmap-weight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.41.0>= 6.0.0>= 4.0.0>= 0.7.0

heatmap-opacity

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

The global opacity at which the heatmap layer will be drawn.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.41.0>= 6.0.0>= 4.0.0>= 0.7.0

heatmap-radius

Paint property. Optional number greater than or equal to 1. Units in pixels. Defaults to 30. Supports feature-state and interpolateexpressions. Transitionable.

Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.41.0>= 6.0.0>= 4.0.0>= 0.7.0

data-driven styling

>= 0.43.0>= 6.0.0>= 4.0.0>= 0.7.0

heatmap-weight

Paint property. Optional number greater than or equal to 0. Defaults to 1. Supports feature-state and interpolateexpressions.

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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.41.0>= 6.0.0>= 4.0.0>= 0.7.0

data-driven styling

>= 0.41.0>= 6.0.0>= 4.0.0>= 0.7.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.41.0>= 6.0.0>= 4.0.0>= 0.7.0

hillshade

hillshade-accent-color

Paint property. Optional color. Defaults to "#000000". Supports interpolateexpressions. Transitionable.

The shading color used to accentuate rugged terrain like sharp cliffs and gorges.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.43.0>= 6.0.0>= 4.0.0>= 0.7.0

hillshade-exaggeration

Paint property. Optional number between 0 and 1 inclusive. Defaults to 0.5. Supports interpolateexpressions. Transitionable.

Intensity of the hillshade

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.43.0>= 6.0.0>= 4.0.0>= 0.7.0

hillshade-highlight-color

Paint property. Optional color. Defaults to "#FFFFFF". Supports interpolateexpressions. Transitionable.

The shading color of areas that faces towards the light source.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.43.0>= 6.0.0>= 4.0.0>= 0.7.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.43.0>= 6.0.0>= 4.0.0>= 0.7.0

hillshade-illumination-direction

Paint property. Optional number between 0 and 359 inclusive. Defaults to 335. Supports interpolateexpressions.

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.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.43.0>= 6.0.0>= 4.0.0>= 0.7.0

hillshade-shadow-color

Paint property. Optional color. Defaults to "#000000". Supports interpolateexpressions. Transitionable.

The shading color of areas that face away from the light source.

SDK SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.43.0>= 6.0.0>= 4.0.0>= 0.7.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 SupportMapbox GL JSAndroid SDKiOS SDKmacOS SDK

basic functionality

>= 0.43.0>= 6.0.0>= 4.0.0>= 0.7.0
Was this page helpful?