Layers

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.

Unique layer name.

Layout properties for the layer.

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

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

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

Default paint properties for this layer.

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

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

Rendering type of this layer.

The color with which the background will be drawn.

The opacity at which the background will be drawn.

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.

Whether this layer is displayed.

Whether or not the fill should be antialiased.

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.

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.

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

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.

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

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

Controls the frame of reference for fill-translate.

Whether this layer is displayed.

Blur applied to the line, in pixels.

The display of line endings.

The color with which the line will be drawn.

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.

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

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

The display of lines when joining.

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

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.

The opacity at which the line will be drawn.

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.

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

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

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

Controls the frame of reference for line-translate.

Stroke thickness.

Whether this layer is displayed.

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

Part of the icon placed closest to the anchor.

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

Fade out the halo towards the outside.

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

Distance of halo to the icon outline.

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

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

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

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.

The opacity at which the icon will be drawn.

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

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

Orientation of icon when map is pitched.

Rotates the icon clockwise.

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

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.

Scales the icon to fit around the associated text.

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

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.

Controls the frame of reference for icon-translate.

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.

Label placement relative to its geometry.

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.

Distance between two symbol anchors.

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.

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

Part of the text placed closest to the anchor.

The color with which the text will be drawn.

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.

Font stack to use for displaying text.

The halo's fadeout distance towards the outside.

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

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

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

Text justification options.

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

Text tracking amount.

Text leading value for multi-line text.

Maximum angle change between adjacent characters.

The maximum line width for text wrapping.

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.

The opacity at which the text will be drawn.

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

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

Orientation of text when map is pitched.

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.

Rotates the text clockwise.

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

Font size.

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

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.

Controls the frame of reference for text-translate.

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.

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.

Whether this layer is displayed.

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

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

Increase or reduce the contrast of the image.

Fade duration when a new tile is added.

Rotates hues around the color wheel.

The opacity at which the image will be drawn.

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

Increase or reduce the saturation of the image.

Whether this layer is displayed.

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

The fill color of the circle.

The opacity at which the circle will be drawn.

Orientation of circle when map is pitched.

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

Circle radius.

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

The stroke color of the circle.

The opacity of the circle's stroke.

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

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

Controls the frame of reference for circle-translate.

Whether this layer is displayed.

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

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.

The height with which to extrude this layer.

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.

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.

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

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

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

Whether this layer is displayed.

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

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

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

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

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.

Whether this layer is displayed.

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

Intensity of the hillshade

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

Direction of light source when map is rotated.

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.

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

Whether this layer is displayed.