Type Alias AllPaintProperties
"background-color"?: PropertyValueSpecification<ColorSpecification>;
"background-color-transition"?: TransitionSpecification;
"background-opacity"?: PropertyValueSpecification<number>;
"background-opacity-transition"?: TransitionSpecification;
"background-pattern"?: PropertyValueSpecification<
ResolvedImageSpecification,
>;
"background-pattern-transition"?: TransitionSpecification;
"circle-blur"?: DataDrivenPropertyValueSpecification<number>;
"circle-blur-transition"?: TransitionSpecification;
"circle-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
"circle-color-transition"?: TransitionSpecification;
"circle-opacity"?: DataDrivenPropertyValueSpecification<number>;
"circle-opacity-transition"?: TransitionSpecification;
"circle-pitch-alignment"?: PropertyValueSpecification<"map" | "viewport">;
"circle-pitch-scale"?: PropertyValueSpecification<"map" | "viewport">;
"circle-radius"?: DataDrivenPropertyValueSpecification<number>;
"circle-radius-transition"?: TransitionSpecification;
"circle-stroke-color"?: DataDrivenPropertyValueSpecification<
ColorSpecification,
>;
"circle-stroke-color-transition"?: TransitionSpecification;
"circle-stroke-opacity"?: DataDrivenPropertyValueSpecification<number>;
"circle-stroke-opacity-transition"?: TransitionSpecification;
"circle-stroke-width"?: DataDrivenPropertyValueSpecification<number>;
"circle-stroke-width-transition"?: TransitionSpecification;
"circle-translate"?: PropertyValueSpecification<[number, number]>;
"circle-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"circle-translate-transition"?: TransitionSpecification;
"color-relief-color"?: ExpressionSpecification;
"color-relief-opacity"?: PropertyValueSpecification<number>;
"color-relief-opacity-transition"?: TransitionSpecification;
"fill-antialias"?: PropertyValueSpecification<boolean>;
"fill-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
"fill-color-transition"?: TransitionSpecification;
"fill-extrusion-base"?: DataDrivenPropertyValueSpecification<number>;
"fill-extrusion-base-transition"?: TransitionSpecification;
"fill-extrusion-color"?: DataDrivenPropertyValueSpecification<
ColorSpecification,
>;
"fill-extrusion-color-transition"?: TransitionSpecification;
"fill-extrusion-height"?: DataDrivenPropertyValueSpecification<number>;
"fill-extrusion-height-transition"?: TransitionSpecification;
"fill-extrusion-opacity"?: PropertyValueSpecification<number>;
"fill-extrusion-opacity-transition"?: TransitionSpecification;
"fill-extrusion-pattern"?: DataDrivenPropertyValueSpecification<
ResolvedImageSpecification,
>;
"fill-extrusion-pattern-transition"?: TransitionSpecification;
"fill-extrusion-translate"?: PropertyValueSpecification<[number, number]>;
"fill-extrusion-translate-anchor"?: PropertyValueSpecification<
"map"
| "viewport",
>;
"fill-extrusion-translate-transition"?: TransitionSpecification;
"fill-extrusion-vertical-gradient"?: PropertyValueSpecification<boolean>;
"fill-layer-opacity"?: PropertyValueSpecification<number>;
"fill-layer-opacity-transition"?: TransitionSpecification;
"fill-opacity"?: DataDrivenPropertyValueSpecification<number>;
"fill-opacity-transition"?: TransitionSpecification;
"fill-outline-color"?: DataDrivenPropertyValueSpecification<
ColorSpecification,
>;
"fill-outline-color-transition"?: TransitionSpecification;
"fill-pattern"?: DataDrivenPropertyValueSpecification<
ResolvedImageSpecification,
>;
"fill-pattern-transition"?: TransitionSpecification;
"fill-translate"?: PropertyValueSpecification<[number, number]>;
"fill-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"fill-translate-transition"?: TransitionSpecification;
"heatmap-color"?: ExpressionSpecification;
"heatmap-intensity"?: PropertyValueSpecification<number>;
"heatmap-intensity-transition"?: TransitionSpecification;
"heatmap-opacity"?: PropertyValueSpecification<number>;
"heatmap-opacity-transition"?: TransitionSpecification;
"heatmap-radius"?: DataDrivenPropertyValueSpecification<number>;
"heatmap-radius-transition"?: TransitionSpecification;
"heatmap-weight"?: DataDrivenPropertyValueSpecification<number>;
"hillshade-accent-color"?: PropertyValueSpecification<ColorSpecification>;
"hillshade-accent-color-transition"?: TransitionSpecification;
"hillshade-exaggeration"?: PropertyValueSpecification<number>;
"hillshade-exaggeration-transition"?: TransitionSpecification;
"hillshade-highlight-color"?: PropertyValueSpecification<
ColorArraySpecification,
>;
"hillshade-highlight-color-transition"?: TransitionSpecification;
"hillshade-illumination-altitude"?: PropertyValueSpecification<
NumberArraySpecification,
>;
"hillshade-illumination-anchor"?: PropertyValueSpecification<
"map"
| "viewport",
>;
"hillshade-illumination-direction"?: PropertyValueSpecification<
NumberArraySpecification,
>;
"hillshade-method"?: PropertyValueSpecification<
"standard"
| "basic"
| "combined"
| "igor"
| "multidirectional",
>;
"hillshade-shadow-color"?: PropertyValueSpecification<
ColorArraySpecification,
>;
"hillshade-shadow-color-transition"?: TransitionSpecification;
"icon-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
"icon-color-transition"?: TransitionSpecification;
"icon-halo-blur"?: DataDrivenPropertyValueSpecification<number>;
"icon-halo-blur-transition"?: TransitionSpecification;
"icon-halo-color"?: DataDrivenPropertyValueSpecification<
ColorSpecification,
>;
"icon-halo-color-transition"?: TransitionSpecification;
"icon-halo-width"?: DataDrivenPropertyValueSpecification<number>;
"icon-halo-width-transition"?: TransitionSpecification;
"icon-opacity"?: DataDrivenPropertyValueSpecification<number>;
"icon-opacity-transition"?: TransitionSpecification;
"icon-translate"?: PropertyValueSpecification<[number, number]>;
"icon-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"icon-translate-transition"?: TransitionSpecification;
"line-blur"?: DataDrivenPropertyValueSpecification<number>;
"line-blur-transition"?: TransitionSpecification;
"line-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
"line-color-transition"?: TransitionSpecification;
"line-dasharray"?: DataDrivenPropertyValueSpecification<number[]>;
"line-dasharray-transition"?: TransitionSpecification;
"line-gap-width"?: DataDrivenPropertyValueSpecification<number>;
"line-gap-width-transition"?: TransitionSpecification;
"line-gradient"?: ExpressionSpecification;
"line-layer-opacity"?: PropertyValueSpecification<number>;
"line-layer-opacity-transition"?: TransitionSpecification;
"line-offset"?: DataDrivenPropertyValueSpecification<number>;
"line-offset-transition"?: TransitionSpecification;
"line-opacity"?: DataDrivenPropertyValueSpecification<number>;
"line-opacity-transition"?: TransitionSpecification;
"line-pattern"?: DataDrivenPropertyValueSpecification<
ResolvedImageSpecification,
>;
"line-pattern-transition"?: TransitionSpecification;
"line-translate"?: PropertyValueSpecification<[number, number]>;
"line-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"line-translate-transition"?: TransitionSpecification;
"line-width"?: DataDrivenPropertyValueSpecification<number>;
"line-width-transition"?: TransitionSpecification;
"raster-brightness-max"?: PropertyValueSpecification<number>;
"raster-brightness-max-transition"?: TransitionSpecification;
"raster-brightness-min"?: PropertyValueSpecification<number>;
"raster-brightness-min-transition"?: TransitionSpecification;
"raster-contrast"?: PropertyValueSpecification<number>;
"raster-contrast-transition"?: TransitionSpecification;
"raster-fade-duration"?: PropertyValueSpecification<number>;
"raster-hue-rotate"?: PropertyValueSpecification<number>;
"raster-hue-rotate-transition"?: TransitionSpecification;
"raster-opacity"?: PropertyValueSpecification<number>;
"raster-opacity-transition"?: TransitionSpecification;
"raster-resampling"?: PropertyValueSpecification<"linear" | "nearest">;
"raster-saturation"?: PropertyValueSpecification<number>;
"raster-saturation-transition"?: TransitionSpecification;
resampling?: PropertyValueSpecification<"linear" | "nearest">;
"text-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
"text-color-transition"?: TransitionSpecification;
"text-halo-blur"?: DataDrivenPropertyValueSpecification<number>;
"text-halo-blur-transition"?: TransitionSpecification;
"text-halo-color"?: DataDrivenPropertyValueSpecification<
ColorSpecification,
>;
"text-halo-color-transition"?: TransitionSpecification;
"text-halo-width"?: DataDrivenPropertyValueSpecification<number>;
"text-halo-width-transition"?: TransitionSpecification;
"text-opacity"?: DataDrivenPropertyValueSpecification<number>;
"text-opacity-transition"?: TransitionSpecification;
"text-translate"?: PropertyValueSpecification<[number, number]>;
"text-translate-anchor"?: PropertyValueSpecification<"map" | "viewport">;
"text-translate-transition"?: TransitionSpecification;
}
Index
Properties
Properties
Optionalbackground-color
The color with which the background will be drawn.
Optionalbackground-color-transition
Optionalbackground-opacity
The opacity at which the background will be drawn.
Optionalbackground-opacity-transition
Optionalbackground-pattern
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.
Optionalbackground-pattern-transition
Optionalcircle-blur
Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
Optionalcircle-blur-transition
Optionalcircle-color
The fill color of the circle.
Optionalcircle-color-transition
Optionalcircle-opacity
The opacity at which the circle will be drawn.
Optionalcircle-opacity-transition
Optionalcircle-pitch-alignment
Orientation of circle when map is pitched.
Optionalcircle-pitch-scale
Controls the scaling behavior of the circle when the map is pitched.
Optionalcircle-radius
Circle radius.
Optionalcircle-radius-transition
Optionalcircle-stroke-color
The stroke color of the circle.
Optionalcircle-stroke-color-transition
Optionalcircle-stroke-opacity
The opacity of the circle's stroke.
Optionalcircle-stroke-opacity-transition
Optionalcircle-stroke-width
The width of the circle's stroke. Strokes are placed outside of the circle-radius.
Optionalcircle-stroke-width-transition
Optionalcircle-translate
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
Optionalcircle-translate-anchor
Controls the frame of reference for circle-translate.
Optionalcircle-translate-transition
Optionalcolor-relief-color
Defines the color of each pixel based on its elevation. Should be an expression that uses ["elevation"] as input.
Optionalcolor-relief-opacity
The opacity at which the color-relief will be drawn.
Optionalcolor-relief-opacity-transition
Optionalfill-antialias
Whether or not the fill should be antialiased.
Optionalfill-color
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. When used with an SDF fill pattern, this serves as the foreground color of the pattern.
Optionalfill-color-transition
Optionalfill-extrusion-base
The height with which to extrude the base of this layer. Must be less than or equal to fill-extrusion-height.
Optionalfill-extrusion-base-transition
Optionalfill-extrusion-color
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.
Optionalfill-extrusion-color-transition
Optionalfill-extrusion-height
The height with which to extrude this layer.
Optionalfill-extrusion-height-transition
Optionalfill-extrusion-opacity
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.
Optionalfill-extrusion-opacity-transition
Optionalfill-extrusion-pattern
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.
Optionalfill-extrusion-pattern-transition
Optionalfill-extrusion-translate
The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
Optionalfill-extrusion-translate-anchor
Controls the frame of reference for fill-extrusion-translate.
Optionalfill-extrusion-translate-transition
Optionalfill-extrusion-vertical-gradient
Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.
Optionalfill-layer-opacity
Opacity applied to the layer as a whole. Unlike fill-opacity and alpha values in fill-color, which are applied per feature and accumulate where fills overlap, fill-layer-opacity is applied once so overlapping fills appear as a single surface at the given opacity. When both fill-opacity and fill-layer-opacity are set, the per-feature, overlap accumulation is preserved, then fill-layer-opacity composites the result. This property affects only the layer it is set on and cannot be used to composite multiple layers together or control how this layer blends with layers above or below it.
Optionalfill-layer-opacity-transition
Optionalfill-opacity
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.
Optionalfill-opacity-transition
Optionalfill-outline-color
The outline color of the fill. Matches the value of fill-color if unspecified.
Optionalfill-outline-color-transition
Optionalfill-pattern
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.
Optionalfill-pattern-transition
Optionalfill-translate
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
Optionalfill-translate-anchor
Controls the frame of reference for fill-translate.
Optionalfill-translate-transition
Optionalheatmap-color
Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"] as input.
Optionalheatmap-intensity
Similar to heatmap-weight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
Optionalheatmap-intensity-transition
Optionalheatmap-opacity
The global opacity at which the heatmap layer will be drawn.
Optionalheatmap-opacity-transition
Optionalheatmap-radius
Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.
Optionalheatmap-radius-transition
Optionalheatmap-weight
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.
Optionalhillshade-accent-color
The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
Optionalhillshade-accent-color-transition
Optionalhillshade-exaggeration
Intensity of the hillshade
Optionalhillshade-exaggeration-transition
Optionalhillshade-highlight-color
The shading color of areas that faces towards the light source(s). Only when hillshade-method is set to multidirectional can you specify multiple light sources.
Optionalhillshade-highlight-color-transition
Optionalhillshade-illumination-altitude
The altitude of the light source(s) used to generate the hillshading with 0 as sunset and 90 as noon. Only when hillshade-method is set to multidirectional can you specify multiple light sources.
Optionalhillshade-illumination-anchor
Direction of light source when map is rotated.
Optionalhillshade-illumination-direction
The direction of the light source(s) 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. Only when hillshade-method is set to multidirectional can you specify multiple light sources.
Optionalhillshade-method
"standard"
| "basic"
| "combined"
| "igor"
| "multidirectional",
>
The hillshade algorithm to use, one of standard, basic, combined, igor, or multidirectional.

Optionalhillshade-shadow-color
The shading color of areas that face away from the light source(s). Only when hillshade-method is set to multidirectional can you specify multiple light sources.
Optionalhillshade-shadow-color-transition
Optionalicon-color
The color of the icon. This can only be used with SDF icons.
Optionalicon-color-transition
Optionalicon-halo-blur
Fade out the halo towards the outside.
Optionalicon-halo-blur-transition
Optionalicon-halo-color
The color of the icon's halo. Icon halos can only be used with SDF icons.
Optionalicon-halo-color-transition
Optionalicon-halo-width
Distance of halo to the icon outline.
The unit is in pixels only for SDF sprites that were created with a blur radius of 8, multiplied by the display density. I.e., the radius needs to be 16 for @2x sprites, etc.
Optionalicon-halo-width-transition
Optionalicon-opacity
The opacity at which the icon will be drawn.
Optionalicon-opacity-transition
Optionalicon-translate
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.
Optionalicon-translate-anchor
Controls the frame of reference for icon-translate.
Optionalicon-translate-transition
Optionalline-blur
Blur applied to the line, in pixels.
Optionalline-blur-transition
Optionalline-color
The color with which the line will be drawn.
Optionalline-color-transition
Optionalline-dasharray
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. GeoJSON sources with lineMetrics: true specified won't render dashed lines to the expected scale. Zoom-dependent expressions will be evaluated only at integer zoom levels. The only way to create an array value is using ["literal", [...]]; arrays cannot be read from or derived from feature properties.
Optionalline-dasharray-transition
Optionalline-gap-width
Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
Optionalline-gap-width-transition
Optionalline-gradient
Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify "lineMetrics": true.
Optionalline-layer-opacity
Opacity applied to the layer as a whole. Unlike line-opacity and alpha values in line-color, which are applied per feature and accumulate where lines overlap, line-layer-opacity is applied once so overlapping lines appear as a single surface at the given opacity. When both line-opacity and line-layer-opacity are set, the per-feature, overlap accumulation is preserved, then layer-opacity composites the result. This property affects only the layer it is set on and cannot be used to composite multiple layers together or control how this layer blends with layers above or below it.
Optionalline-layer-opacity-transition
Optionalline-offset
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.
Optionalline-offset-transition
Optionalline-opacity
The opacity at which the line will be drawn.
Optionalline-opacity-transition
Optionalline-pattern
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.
Optionalline-pattern-transition
Optionalline-translate
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
Optionalline-translate-anchor
Controls the frame of reference for line-translate.
Optionalline-translate-transition
Optionalline-width
Stroke thickness.
Optionalline-width-transition
Optionalraster-brightness-max
Increase or reduce the brightness of the image. The value is the maximum brightness.
Optionalraster-brightness-max-transition
Optionalraster-brightness-min
Increase or reduce the brightness of the image. The value is the minimum brightness.
Optionalraster-brightness-min-transition
Optionalraster-contrast
Increase or reduce the contrast of the image.
Optionalraster-contrast-transition
Optionalraster-fade-duration
Fade duration when a new tile is added, or when a video is started or its coordinates are updated.
Optionalraster-hue-rotate
Rotates hues around the color wheel.
Optionalraster-hue-rotate-transition
Optionalraster-opacity
The opacity at which the image will be drawn.
Optionalraster-opacity-transition
Optionalraster-resampling
The resampling/interpolation method to use for overscaling, also known as texture magnification filter. It is advised to use the generic resampling paint property instead.
Optionalraster-saturation
Increase or reduce the saturation of the image.
Optionalraster-saturation-transition
Optionalresampling
The resampling/interpolation method to use for overscaling, also known as texture magnification filter.

Optionaltext-color
The color with which the text will be drawn.
Optionaltext-color-transition
Optionaltext-halo-blur
The halo's fadeout distance towards the outside.
Optionaltext-halo-blur-transition
Optionaltext-halo-color
The color of the text's halo, which helps it stand out from backgrounds.
Optionaltext-halo-color-transition
Optionaltext-halo-width
Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
Optionaltext-halo-width-transition
Optionaltext-opacity
The opacity at which the text will be drawn.
Optionaltext-opacity-transition
Optionaltext-translate
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.
Optionaltext-translate-anchor
Controls the frame of reference for text-translate.
Union of all paint properties across all layer types.