Package-level declarations

Types

Link copied to clipboard

The accuracy, in meters, of the position source used to retrieve the position of the location indicator.

Link copied to clipboard

The color for drawing the accuracy radius border. To adjust transparency, set the alpha component of the color accordingly.

Link copied to clipboard

The color for drawing the accuracy radius, as a circle. To adjust transparency, set the alpha component of the color accordingly.

Link copied to clipboard

The color with which the background will be drawn.

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

The opacity at which the background will be drawn.

Link copied to clipboard
data class BackgroundPattern(val value: Value, val styleImage: StyleImage? = null)

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.

Link copied to clipboard
data class Bearing(val value: Value)

The bearing of the location indicator.

Link copied to clipboard
data class BearingImage(val value: Value, val styleImage: StyleImage? = null)

Name of image in sprite to use as the middle of the location indicator.

Link copied to clipboard

The size of the bearing image, as a scale factor applied to the size of the specified image.

Link copied to clipboard

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

Link copied to clipboard

The fill color of the circle.

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

The opacity at which the circle will be drawn.

Link copied to clipboard

Orientation of circle when map is pitched.

Link copied to clipboard

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

Link copied to clipboard

Circle radius.

Link copied to clipboard

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

Link copied to clipboard

The stroke color of the circle.

Link copied to clipboard

The opacity of the circle's stroke.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Controls the frame of reference for circle-translate.

Link copied to clipboard

The color of the circle emphasizing the indicator. To adjust transparency, set the alpha component of the color accordingly.

Link copied to clipboard

The radius, in pixel, of the circle emphasizing the indicator, drawn between the accuracy radius and the indicator shadow.

Link copied to clipboard

Whether or not the fill should be antialiased.

Link copied to clipboard

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.

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Provides a control to futher fine-tune the look of the ambient occlusion on the ground beneath the extruded buildings. Lower values give the effect a more solid look while higher values make it smoother.

The extent of the ambient occlusion effect on the ground beneath the extruded buildings in meters.

Link copied to clipboard

Controls the intensity of shading near ground and concave angles between walls. Default value 0.0 disables ambient occlusion and values around 0.3 provide the most plausible results for buildings.

Link copied to clipboard

Shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to height of one floor and brings the most plausible results for buildings. This property works only with legacy light. When 3D lights are enabled fill-extrusion-ambient-occlusion-wall-radius and fill-extrusion-ambient-occlusion-ground-radius are used instead.

Link copied to clipboard

Shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to height of one floor and brings the most plausible results for buildings.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

The color of the flood light effect on the walls of the extruded buildings.

Link copied to clipboard

Provides a control to futher fine-tune the look of the flood light on the ground beneath the extruded buildings. Lower values give the effect a more solid look while higher values make it smoother.

Link copied to clipboard

The extent of the flood light effect on the ground beneath the extruded buildings in meters.

Link copied to clipboard

The intensity of the flood light color.

Link copied to clipboard

The extent of the flood light effect on the walls of the extruded buildings in meters.

Link copied to clipboard

The height with which to extrude this layer.

Link copied to clipboard

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.

Link copied to clipboard
data class FillExtrusionPattern(val value: Value, val styleImage: StyleImage? = null)

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A global multiplier that can be used to scale base, height, AO, and flood light of the fill extrusions.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
data class FillPattern(val value: Value, val styleImage: StyleImage? = null)

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Controls the frame of reference for fill-translate.

Link copied to clipboard
data class Filter(val value: Value)

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed. queryRenderedFeatures on heatmap layers will return points within this radius.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

Intensity of the hillshade

Link copied to clipboard

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

Link copied to clipboard

Direction of light source when map is rotated.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Part of the icon placed closest to the anchor.

Link copied to clipboard

The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

Link copied to clipboard

Controls saturation level of the symbol icon. With the default value of 1 the icon color is preserved while with a value of 0 it is fully desaturated and looks black and white.

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

Fade out the halo towards the outside.

Link copied to clipboard

The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

Link copied to clipboard

Distance of halo to the icon outline.

Link copied to clipboard

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

Link copied to clipboard
data class IconImage(val value: Value, val styleImage: StyleImage? = null)

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The opacity at which the icon will be drawn.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Orientation of icon when map is pitched.

Link copied to clipboard

Rotates the icon clockwise.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Scales the icon to fit around the associated text.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Controls the frame of reference for icon-translate.

Link copied to clipboard

The displacement off the center of the top image and the shadow image when the pitch of the map is greater than 0. This helps producing a three-dimensional appearence.

Link copied to clipboard

Blur applied to the line, in pixels.

Link copied to clipboard

The color of the line border. If line-border-width is greater than zero and the alpha value of this color is 0 (default), the color for the border will be selected automatically based on the line color.

Link copied to clipboard

The width of the line border. A value of zero means no border.

Link copied to clipboard
data class LineCap(val value: Value)

The display of line endings.

Link copied to clipboard

The color with which the line will be drawn.

Link copied to clipboard

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.

Link copied to clipboard

Decrease line layer opacity based on occlusion from 3D objects. Value 0 disables occlusion, value 1 means fully occluded.

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The display of lines when joining.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The opacity at which the line will be drawn.

Link copied to clipboard
data class LinePattern(val value: Value, val styleImage: StyleImage? = null)

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Controls the frame of reference for line-translate.

Link copied to clipboard

The line part between trim-start, trim-end will be marked as transparent to make a route vanishing effect. The line trim-off offset is based on the whole line range 0.0, 1.0.

Link copied to clipboard

Stroke thickness.

Link copied to clipboard

An array of latitude, longitude, altitude position of the location indicator.

Link copied to clipboard

The opacity of the entire location indicator layer.

Link copied to clipboard
data class MaxZoom(val value: Value)

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

Link copied to clipboard
data class MinZoom(val value: Value)

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

Link copied to clipboard

Intensity of the ambient occlusion if present in the 3D model.

Link copied to clipboard

Enable/Disable shadow casting for this layer

Link copied to clipboard

The tint color of the model layer. model-color-mix-intensity (defaults to 0) defines tint(mix) intensity - this means that, this color is not used unless model-color-mix-intensity gets value greater than 0.

Link copied to clipboard

Intensity of model-color (on a scale from 0 to 1) in color mix with original 3D model's colors. Higher number will present a higher model-color contribution in mix.

Link copied to clipboard

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

Link copied to clipboard

Strength of the emission. There is no emission for value 0. For value 1.0, only emissive component (no shading) is displayed and values above 1.0 produce light contribution to surrounding area, for some of the parts (e.g. doors). Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source.

Emissive strength multiplier along model height (gradient begin, gradient end, value at begin, value at end, gradient curve power (logarithmic scale, curve power = pow(10, val)).

Link copied to clipboard
data class ModelId(val value: Value, val modelInfo: Pair<String, String>? = null)

Model to render.

Link copied to clipboard

The opacity of the model layer.

Link copied to clipboard

Enable/Disable shadow receiving for this layer

Link copied to clipboard

The rotation of the model in euler angles lon, lat, z.

Link copied to clipboard

Material roughness. Material is fully smooth for value 0, and fully rough for value 1. Affects only layers using batched-model source.

Link copied to clipboard

The scale of the model.

Link copied to clipboard

Defines scaling mode. Only applies to location-indicator type layers.

Link copied to clipboard

The translation of the model in meters in form of longitudal, latitudal, altitude offsets.

Link copied to clipboard

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

Link copied to clipboard

The amount of the perspective compensation, between 0 and 1. A value of 1 produces a location indicator of constant width across the screen. A value of 0 makes it scale naturally according to the viewing projection.

Link copied to clipboard

Displayed band of raster array source layer

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

When raster-color is active, specifies the combination of source RGB channels used to compute the raster value. Computed using the equation mix.r * src.r + mix.g * src.g + mix.b * src.b + mix.a. The first three components specify the mix of source red, green, and blue channels, respectively. The fourth component serves as a constant offset and is not multipled by source alpha. Source alpha is instead carried through and applied as opacity to the colorized result. Default value corresponds to RGB luminosity.

Link copied to clipboard

When raster-color is active, specifies the range over which raster-color is tabulated. Units correspond to the computed raster value via raster-color-mix.

Link copied to clipboard

Increase or reduce the contrast of the image.

Link copied to clipboard

Specifies an uniform elevation from the ground, in meters. Only supported with image sources.

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

Fade duration when a new tile is added.

Link copied to clipboard

Rotates hues around the color wheel.

Link copied to clipboard

The opacity at which the image will be drawn.

Link copied to clipboard

Displayed band of raster array source layer

Link copied to clipboard

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

Link copied to clipboard

Defines the amount of particles per tile.

Link copied to clipboard

Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Defines a coefficient for the speed of particles’ motion.

Link copied to clipboard

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

Link copied to clipboard

Increase or reduce the saturation of the image.

Link copied to clipboard
data class ShadowImage(val value: Value, val styleImage: StyleImage? = null)

Name of image in sprite to use as the background of the location indicator.

Link copied to clipboard

The size of the shadow image, as a scale factor applied to the size of the specified image.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The opacity of the entire sky layer.

Link copied to clipboard
data class SkyType(val value: Value)

The type of the sky

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Label placement relative to its geometry.

Link copied to clipboard

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.

Link copied to clipboard

Distance between two symbol anchors.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Part of the text placed closest to the anchor.

Link copied to clipboard

The color with which the text will be drawn.

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

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

Link copied to clipboard

Font stack to use for displaying text.

Link copied to clipboard

The halo's fadeout distance towards the outside.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Text justification options.

Link copied to clipboard

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

Link copied to clipboard

Text tracking amount.

Link copied to clipboard

Text leading value for multi-line text.

Link copied to clipboard

Maximum angle change between adjacent characters.

Link copied to clipboard

The maximum line width for text wrapping.

Link copied to clipboard

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.

Link copied to clipboard

The opacity at which the text will be drawn.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Orientation of text when map is pitched.

Link copied to clipboard

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.

Link copied to clipboard

Rotates the text clockwise.

Link copied to clipboard

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

Link copied to clipboard

Font size.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Controls the frame of reference for text-translate.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
data class TopImage(val value: Value, val styleImage: StyleImage? = null)

Name of image in sprite to use as the top of the location indicator.

Link copied to clipboard

The size of the top image, as a scale factor applied to the size of the specified image.

Link copied to clipboard
data class Transition

Defines the timing for the interpolation between a transitionable style layer property's previous value and new value.

Link copied to clipboard

Whether this layer is displayed.

Functions

Link copied to clipboard
fun BackgroundLayer(layerId: String = remember { generateRandomLayerId("background") }, backgroundColor: BackgroundColor = BackgroundColor.default, backgroundColorTransition: Transition = Transition.default, backgroundEmissiveStrength: BackgroundEmissiveStrength = BackgroundEmissiveStrength.default, backgroundEmissiveStrengthTransition: Transition = Transition.default, backgroundOpacity: BackgroundOpacity = BackgroundOpacity.default, backgroundOpacityTransition: Transition = Transition.default, backgroundPattern: BackgroundPattern = BackgroundPattern.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default)

The background color or pattern of the map.

Link copied to clipboard
fun CircleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("circle") }, circleSortKey: CircleSortKey = CircleSortKey.default, circleBlur: CircleBlur = CircleBlur.default, circleBlurTransition: Transition = Transition.default, circleColor: CircleColor = CircleColor.default, circleColorTransition: Transition = Transition.default, circleEmissiveStrength: CircleEmissiveStrength = CircleEmissiveStrength.default, circleEmissiveStrengthTransition: Transition = Transition.default, circleOpacity: CircleOpacity = CircleOpacity.default, circleOpacityTransition: Transition = Transition.default, circlePitchAlignment: CirclePitchAlignment = CirclePitchAlignment.default, circlePitchScale: CirclePitchScale = CirclePitchScale.default, circleRadius: CircleRadius = CircleRadius.default, circleRadiusTransition: Transition = Transition.default, circleStrokeColor: CircleStrokeColor = CircleStrokeColor.default, circleStrokeColorTransition: Transition = Transition.default, circleStrokeOpacity: CircleStrokeOpacity = CircleStrokeOpacity.default, circleStrokeOpacityTransition: Transition = Transition.default, circleStrokeWidth: CircleStrokeWidth = CircleStrokeWidth.default, circleStrokeWidthTransition: Transition = Transition.default, circleTranslate: CircleTranslate = CircleTranslate.default, circleTranslateTransition: Transition = Transition.default, circleTranslateAnchor: CircleTranslateAnchor = CircleTranslateAnchor.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

A filled circle.

Link copied to clipboard
fun FillExtrusionLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("fill-extrusion") }, fillExtrusionEdgeRadius: FillExtrusionEdgeRadius = FillExtrusionEdgeRadius.default, fillExtrusionAmbientOcclusionGroundAttenuation: FillExtrusionAmbientOcclusionGroundAttenuation = FillExtrusionAmbientOcclusionGroundAttenuation.default, fillExtrusionAmbientOcclusionGroundAttenuationTransition: Transition = Transition.default, fillExtrusionAmbientOcclusionGroundRadius: FillExtrusionAmbientOcclusionGroundRadius = FillExtrusionAmbientOcclusionGroundRadius.default, fillExtrusionAmbientOcclusionGroundRadiusTransition: Transition = Transition.default, fillExtrusionAmbientOcclusionIntensity: FillExtrusionAmbientOcclusionIntensity = FillExtrusionAmbientOcclusionIntensity.default, fillExtrusionAmbientOcclusionIntensityTransition: Transition = Transition.default, fillExtrusionAmbientOcclusionRadius: FillExtrusionAmbientOcclusionRadius = FillExtrusionAmbientOcclusionRadius.default, fillExtrusionAmbientOcclusionRadiusTransition: Transition = Transition.default, fillExtrusionAmbientOcclusionWallRadius: FillExtrusionAmbientOcclusionWallRadius = FillExtrusionAmbientOcclusionWallRadius.default, fillExtrusionAmbientOcclusionWallRadiusTransition: Transition = Transition.default, fillExtrusionBase: FillExtrusionBase = FillExtrusionBase.default, fillExtrusionBaseTransition: Transition = Transition.default, fillExtrusionColor: FillExtrusionColor = FillExtrusionColor.default, fillExtrusionColorTransition: Transition = Transition.default, fillExtrusionCutoffFadeRange: FillExtrusionCutoffFadeRange = FillExtrusionCutoffFadeRange.default, fillExtrusionEmissiveStrength: FillExtrusionEmissiveStrength = FillExtrusionEmissiveStrength.default, fillExtrusionEmissiveStrengthTransition: Transition = Transition.default, fillExtrusionFloodLightColor: FillExtrusionFloodLightColor = FillExtrusionFloodLightColor.default, fillExtrusionFloodLightColorTransition: Transition = Transition.default, fillExtrusionFloodLightGroundAttenuation: FillExtrusionFloodLightGroundAttenuation = FillExtrusionFloodLightGroundAttenuation.default, fillExtrusionFloodLightGroundAttenuationTransition: Transition = Transition.default, fillExtrusionFloodLightGroundRadius: FillExtrusionFloodLightGroundRadius = FillExtrusionFloodLightGroundRadius.default, fillExtrusionFloodLightGroundRadiusTransition: Transition = Transition.default, fillExtrusionFloodLightIntensity: FillExtrusionFloodLightIntensity = FillExtrusionFloodLightIntensity.default, fillExtrusionFloodLightIntensityTransition: Transition = Transition.default, fillExtrusionFloodLightWallRadius: FillExtrusionFloodLightWallRadius = FillExtrusionFloodLightWallRadius.default, fillExtrusionFloodLightWallRadiusTransition: Transition = Transition.default, fillExtrusionHeight: FillExtrusionHeight = FillExtrusionHeight.default, fillExtrusionHeightTransition: Transition = Transition.default, fillExtrusionOpacity: FillExtrusionOpacity = FillExtrusionOpacity.default, fillExtrusionOpacityTransition: Transition = Transition.default, fillExtrusionPattern: FillExtrusionPattern = FillExtrusionPattern.default, fillExtrusionRoundedRoof: FillExtrusionRoundedRoof = FillExtrusionRoundedRoof.default, fillExtrusionTranslate: FillExtrusionTranslate = FillExtrusionTranslate.default, fillExtrusionTranslateTransition: Transition = Transition.default, fillExtrusionTranslateAnchor: FillExtrusionTranslateAnchor = FillExtrusionTranslateAnchor.default, fillExtrusionVerticalGradient: FillExtrusionVerticalGradient = FillExtrusionVerticalGradient.default, fillExtrusionVerticalScale: FillExtrusionVerticalScale = FillExtrusionVerticalScale.default, fillExtrusionVerticalScaleTransition: Transition = Transition.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

An extruded (3D) polygon.

Link copied to clipboard
fun FillLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("fill") }, fillSortKey: FillSortKey = FillSortKey.default, fillAntialias: FillAntialias = FillAntialias.default, fillColor: FillColor = FillColor.default, fillColorTransition: Transition = Transition.default, fillEmissiveStrength: FillEmissiveStrength = FillEmissiveStrength.default, fillEmissiveStrengthTransition: Transition = Transition.default, fillOpacity: FillOpacity = FillOpacity.default, fillOpacityTransition: Transition = Transition.default, fillOutlineColor: FillOutlineColor = FillOutlineColor.default, fillOutlineColorTransition: Transition = Transition.default, fillPattern: FillPattern = FillPattern.default, fillTranslate: FillTranslate = FillTranslate.default, fillTranslateTransition: Transition = Transition.default, fillTranslateAnchor: FillTranslateAnchor = FillTranslateAnchor.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

A filled polygon with an optional stroked border.

Link copied to clipboard
fun HeatmapLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("heatmap") }, heatmapColor: HeatmapColor = HeatmapColor.default, heatmapIntensity: HeatmapIntensity = HeatmapIntensity.default, heatmapIntensityTransition: Transition = Transition.default, heatmapOpacity: HeatmapOpacity = HeatmapOpacity.default, heatmapOpacityTransition: Transition = Transition.default, heatmapRadius: HeatmapRadius = HeatmapRadius.default, heatmapRadiusTransition: Transition = Transition.default, heatmapWeight: HeatmapWeight = HeatmapWeight.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

A heatmap.

Link copied to clipboard
fun HillshadeLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("hillshade") }, hillshadeAccentColor: HillshadeAccentColor = HillshadeAccentColor.default, hillshadeAccentColorTransition: Transition = Transition.default, hillshadeEmissiveStrength: HillshadeEmissiveStrength = HillshadeEmissiveStrength.default, hillshadeEmissiveStrengthTransition: Transition = Transition.default, hillshadeExaggeration: HillshadeExaggeration = HillshadeExaggeration.default, hillshadeExaggerationTransition: Transition = Transition.default, hillshadeHighlightColor: HillshadeHighlightColor = HillshadeHighlightColor.default, hillshadeHighlightColorTransition: Transition = Transition.default, hillshadeIlluminationAnchor: HillshadeIlluminationAnchor = HillshadeIlluminationAnchor.default, hillshadeIlluminationDirection: HillshadeIlluminationDirection = HillshadeIlluminationDirection.default, hillshadeShadowColor: HillshadeShadowColor = HillshadeShadowColor.default, hillshadeShadowColorTransition: Transition = Transition.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

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

Link copied to clipboard
fun LineLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("line") }, lineCap: LineCap = LineCap.default, lineJoin: LineJoin = LineJoin.default, lineMiterLimit: LineMiterLimit = LineMiterLimit.default, lineRoundLimit: LineRoundLimit = LineRoundLimit.default, lineSortKey: LineSortKey = LineSortKey.default, lineBlur: LineBlur = LineBlur.default, lineBlurTransition: Transition = Transition.default, lineBorderColor: LineBorderColor = LineBorderColor.default, lineBorderColorTransition: Transition = Transition.default, lineBorderWidth: LineBorderWidth = LineBorderWidth.default, lineBorderWidthTransition: Transition = Transition.default, lineColor: LineColor = LineColor.default, lineColorTransition: Transition = Transition.default, lineDasharray: LineDasharray = LineDasharray.default, lineDepthOcclusionFactor: LineDepthOcclusionFactor = LineDepthOcclusionFactor.default, lineDepthOcclusionFactorTransition: Transition = Transition.default, lineEmissiveStrength: LineEmissiveStrength = LineEmissiveStrength.default, lineEmissiveStrengthTransition: Transition = Transition.default, lineGapWidth: LineGapWidth = LineGapWidth.default, lineGapWidthTransition: Transition = Transition.default, lineGradient: LineGradient = LineGradient.default, lineOffset: LineOffset = LineOffset.default, lineOffsetTransition: Transition = Transition.default, lineOpacity: LineOpacity = LineOpacity.default, lineOpacityTransition: Transition = Transition.default, linePattern: LinePattern = LinePattern.default, lineTranslate: LineTranslate = LineTranslate.default, lineTranslateTransition: Transition = Transition.default, lineTranslateAnchor: LineTranslateAnchor = LineTranslateAnchor.default, lineTrimOffset: LineTrimOffset = LineTrimOffset.default, lineWidth: LineWidth = LineWidth.default, lineWidthTransition: Transition = Transition.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

A stroked line.

Link copied to clipboard
fun LocationIndicatorLayer(layerId: String = remember { generateRandomLayerId("location-indicator") }, bearingImage: BearingImage = BearingImage.default, shadowImage: ShadowImage = ShadowImage.default, topImage: TopImage = TopImage.default, accuracyRadius: AccuracyRadius = AccuracyRadius.default, accuracyRadiusTransition: Transition = Transition.default, accuracyRadiusBorderColor: AccuracyRadiusBorderColor = AccuracyRadiusBorderColor.default, accuracyRadiusBorderColorTransition: Transition = Transition.default, accuracyRadiusColor: AccuracyRadiusColor = AccuracyRadiusColor.default, accuracyRadiusColorTransition: Transition = Transition.default, bearing: Bearing = Bearing.default, bearingTransition: Transition = Transition.default, bearingImageSize: BearingImageSize = BearingImageSize.default, bearingImageSizeTransition: Transition = Transition.default, emphasisCircleColor: EmphasisCircleColor = EmphasisCircleColor.default, emphasisCircleColorTransition: Transition = Transition.default, emphasisCircleRadius: EmphasisCircleRadius = EmphasisCircleRadius.default, emphasisCircleRadiusTransition: Transition = Transition.default, imagePitchDisplacement: ImagePitchDisplacement = ImagePitchDisplacement.default, location: Location = Location.default, locationTransition: Transition = Transition.default, locationIndicatorOpacity: LocationIndicatorOpacity = LocationIndicatorOpacity.default, locationIndicatorOpacityTransition: Transition = Transition.default, perspectiveCompensation: PerspectiveCompensation = PerspectiveCompensation.default, shadowImageSize: ShadowImageSize = ShadowImageSize.default, shadowImageSizeTransition: Transition = Transition.default, topImageSize: TopImageSize = TopImageSize.default, topImageSizeTransition: Transition = Transition.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

Location Indicator layer.

Link copied to clipboard
fun ModelLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("model") }, modelId: ModelId = ModelId.default, modelAmbientOcclusionIntensity: ModelAmbientOcclusionIntensity = ModelAmbientOcclusionIntensity.default, modelAmbientOcclusionIntensityTransition: Transition = Transition.default, modelCastShadows: ModelCastShadows = ModelCastShadows.default, modelColor: ModelColor = ModelColor.default, modelColorTransition: Transition = Transition.default, modelColorMixIntensity: ModelColorMixIntensity = ModelColorMixIntensity.default, modelColorMixIntensityTransition: Transition = Transition.default, modelCutoffFadeRange: ModelCutoffFadeRange = ModelCutoffFadeRange.default, modelEmissiveStrength: ModelEmissiveStrength = ModelEmissiveStrength.default, modelEmissiveStrengthTransition: Transition = Transition.default, modelHeightBasedEmissiveStrengthMultiplier: ModelHeightBasedEmissiveStrengthMultiplier = ModelHeightBasedEmissiveStrengthMultiplier.default, modelHeightBasedEmissiveStrengthMultiplierTransition: Transition = Transition.default, modelOpacity: ModelOpacity = ModelOpacity.default, modelOpacityTransition: Transition = Transition.default, modelReceiveShadows: ModelReceiveShadows = ModelReceiveShadows.default, modelRotation: ModelRotation = ModelRotation.default, modelRotationTransition: Transition = Transition.default, modelRoughness: ModelRoughness = ModelRoughness.default, modelRoughnessTransition: Transition = Transition.default, modelScale: ModelScale = ModelScale.default, modelScaleTransition: Transition = Transition.default, modelScaleMode: ModelScaleMode = ModelScaleMode.default, modelTranslation: ModelTranslation = ModelTranslation.default, modelTranslationTransition: Transition = Transition.default, modelType: ModelType = ModelType.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

A layer to render 3D Models.

Link copied to clipboard
fun RasterLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster") }, rasterArrayBand: RasterArrayBand = RasterArrayBand.default, rasterBrightnessMax: RasterBrightnessMax = RasterBrightnessMax.default, rasterBrightnessMaxTransition: Transition = Transition.default, rasterBrightnessMin: RasterBrightnessMin = RasterBrightnessMin.default, rasterBrightnessMinTransition: Transition = Transition.default, rasterColor: RasterColor = RasterColor.default, rasterColorMix: RasterColorMix = RasterColorMix.default, rasterColorMixTransition: Transition = Transition.default, rasterColorRange: RasterColorRange = RasterColorRange.default, rasterColorRangeTransition: Transition = Transition.default, rasterContrast: RasterContrast = RasterContrast.default, rasterContrastTransition: Transition = Transition.default, rasterElevation: RasterElevation = RasterElevation.default, rasterElevationTransition: Transition = Transition.default, rasterEmissiveStrength: RasterEmissiveStrength = RasterEmissiveStrength.default, rasterEmissiveStrengthTransition: Transition = Transition.default, rasterFadeDuration: RasterFadeDuration = RasterFadeDuration.default, rasterHueRotate: RasterHueRotate = RasterHueRotate.default, rasterHueRotateTransition: Transition = Transition.default, rasterOpacity: RasterOpacity = RasterOpacity.default, rasterOpacityTransition: Transition = Transition.default, rasterResampling: RasterResampling = RasterResampling.default, rasterSaturation: RasterSaturation = RasterSaturation.default, rasterSaturationTransition: Transition = Transition.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

Raster map textures such as satellite imagery.

Link copied to clipboard
fun RasterParticleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster-particle") }, rasterParticleArrayBand: RasterParticleArrayBand = RasterParticleArrayBand.default, rasterParticleColor: RasterParticleColor = RasterParticleColor.default, rasterParticleCount: RasterParticleCount = RasterParticleCount.default, rasterParticleFadeOpacityFactor: RasterParticleFadeOpacityFactor = RasterParticleFadeOpacityFactor.default, rasterParticleFadeOpacityFactorTransition: Transition = Transition.default, rasterParticleMaxSpeed: RasterParticleMaxSpeed = RasterParticleMaxSpeed.default, rasterParticleResetRateFactor: RasterParticleResetRateFactor = RasterParticleResetRateFactor.default, rasterParticleSpeedFactor: RasterParticleSpeedFactor = RasterParticleSpeedFactor.default, rasterParticleSpeedFactorTransition: Transition = Transition.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

Particle animation driven by textures such as wind maps.

Link copied to clipboard
fun SkyLayer(layerId: String = remember { generateRandomLayerId("sky") }, skyAtmosphereColor: SkyAtmosphereColor = SkyAtmosphereColor.default, skyAtmosphereHaloColor: SkyAtmosphereHaloColor = SkyAtmosphereHaloColor.default, skyAtmosphereSun: SkyAtmosphereSun = SkyAtmosphereSun.default, skyAtmosphereSunIntensity: SkyAtmosphereSunIntensity = SkyAtmosphereSunIntensity.default, skyGradient: SkyGradient = SkyGradient.default, skyGradientCenter: SkyGradientCenter = SkyGradientCenter.default, skyGradientRadius: SkyGradientRadius = SkyGradientRadius.default, skyOpacity: SkyOpacity = SkyOpacity.default, skyOpacityTransition: Transition = Transition.default, skyType: SkyType = SkyType.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

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

Link copied to clipboard
fun SymbolLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("symbol") }, iconAllowOverlap: IconAllowOverlap = IconAllowOverlap.default, iconAnchor: IconAnchor = IconAnchor.default, iconIgnorePlacement: IconIgnorePlacement = IconIgnorePlacement.default, iconImage: IconImage = IconImage.default, iconKeepUpright: IconKeepUpright = IconKeepUpright.default, iconOffset: IconOffset = IconOffset.default, iconOptional: IconOptional = IconOptional.default, iconPadding: IconPadding = IconPadding.default, iconPitchAlignment: IconPitchAlignment = IconPitchAlignment.default, iconRotate: IconRotate = IconRotate.default, iconRotationAlignment: IconRotationAlignment = IconRotationAlignment.default, iconSize: IconSize = IconSize.default, iconTextFit: IconTextFit = IconTextFit.default, iconTextFitPadding: IconTextFitPadding = IconTextFitPadding.default, symbolAvoidEdges: SymbolAvoidEdges = SymbolAvoidEdges.default, symbolPlacement: SymbolPlacement = SymbolPlacement.default, symbolSortKey: SymbolSortKey = SymbolSortKey.default, symbolSpacing: SymbolSpacing = SymbolSpacing.default, symbolZElevate: SymbolZElevate = SymbolZElevate.default, symbolZOrder: SymbolZOrder = SymbolZOrder.default, textAllowOverlap: TextAllowOverlap = TextAllowOverlap.default, textAnchor: TextAnchor = TextAnchor.default, textField: TextField = TextField.default, textFont: TextFont = TextFont.default, textIgnorePlacement: TextIgnorePlacement = TextIgnorePlacement.default, textJustify: TextJustify = TextJustify.default, textKeepUpright: TextKeepUpright = TextKeepUpright.default, textLetterSpacing: TextLetterSpacing = TextLetterSpacing.default, textLineHeight: TextLineHeight = TextLineHeight.default, textMaxAngle: TextMaxAngle = TextMaxAngle.default, textMaxWidth: TextMaxWidth = TextMaxWidth.default, textOffset: TextOffset = TextOffset.default, textOptional: TextOptional = TextOptional.default, textPadding: TextPadding = TextPadding.default, textPitchAlignment: TextPitchAlignment = TextPitchAlignment.default, textRadialOffset: TextRadialOffset = TextRadialOffset.default, textRotate: TextRotate = TextRotate.default, textRotationAlignment: TextRotationAlignment = TextRotationAlignment.default, textSize: TextSize = TextSize.default, textTransform: TextTransform = TextTransform.default, textVariableAnchor: TextVariableAnchor = TextVariableAnchor.default, textWritingMode: TextWritingMode = TextWritingMode.default, iconColor: IconColor = IconColor.default, iconColorTransition: Transition = Transition.default, iconColorSaturation: IconColorSaturation = IconColorSaturation.default, iconColorSaturationTransition: Transition = Transition.default, iconEmissiveStrength: IconEmissiveStrength = IconEmissiveStrength.default, iconEmissiveStrengthTransition: Transition = Transition.default, iconHaloBlur: IconHaloBlur = IconHaloBlur.default, iconHaloBlurTransition: Transition = Transition.default, iconHaloColor: IconHaloColor = IconHaloColor.default, iconHaloColorTransition: Transition = Transition.default, iconHaloWidth: IconHaloWidth = IconHaloWidth.default, iconHaloWidthTransition: Transition = Transition.default, iconImageCrossFade: IconImageCrossFade = IconImageCrossFade.default, iconImageCrossFadeTransition: Transition = Transition.default, iconOpacity: IconOpacity = IconOpacity.default, iconOpacityTransition: Transition = Transition.default, iconTranslate: IconTranslate = IconTranslate.default, iconTranslateTransition: Transition = Transition.default, iconTranslateAnchor: IconTranslateAnchor = IconTranslateAnchor.default, textColor: TextColor = TextColor.default, textColorTransition: Transition = Transition.default, textEmissiveStrength: TextEmissiveStrength = TextEmissiveStrength.default, textEmissiveStrengthTransition: Transition = Transition.default, textHaloBlur: TextHaloBlur = TextHaloBlur.default, textHaloBlurTransition: Transition = Transition.default, textHaloColor: TextHaloColor = TextHaloColor.default, textHaloColorTransition: Transition = Transition.default, textHaloWidth: TextHaloWidth = TextHaloWidth.default, textHaloWidthTransition: Transition = Transition.default, textOpacity: TextOpacity = TextOpacity.default, textOpacityTransition: Transition = Transition.default, textTranslate: TextTranslate = TextTranslate.default, textTranslateTransition: Transition = Transition.default, textTranslateAnchor: TextTranslateAnchor = TextTranslateAnchor.default, visibility: Visibility = Visibility.default, minZoom: MinZoom = MinZoom.default, maxZoom: MaxZoom = MaxZoom.default, sourceLayer: SourceLayer = SourceLayer.default, filter: Filter = Filter.default)

An icon or a text label.