Selects the unit of line-width. The same unit is automatically used for line-blur and line-offset. Note: This is an experimental property and might be removed in a future release. Default value: "pixels".

LocationIndicatorLayerState

@Stable

class LocationIndicatorLayerState

The state holder for LocationIndicatorLayer's layer properties.

ModelElevationReferenceValue

@Immutable

data class ModelElevationReferenceValue(val value: Value) : HoldsValue

Selects the base of the model. Some modes might require precomputed elevation data in the tileset. Default value: "ground".

ModelLayerState

@Stable

class ModelLayerState

The state holder for ModelLayer's layer properties.

ModelScaleModeValue

@Immutable

data class ModelScaleModeValue(val value: Value) : HoldsValue

Defines scaling mode. Only applies to location-indicator type layers. Default value: "map".

ModelTypeValue

@Immutable

data class ModelTypeValue(val value: Value) : HoldsValue

Defines rendering behavior of model in respect to other 3D scene objects. Default value: "common-3d".

OcclusionOpacityModeValue

@Immutable

data class OcclusionOpacityModeValue(val value: Value) : HoldsValue

Specify how opacity in case of being occluded should be applied Default value: "anchor".

RasterLayerState

@Stable

class RasterLayerState

The state holder for RasterLayer's layer properties.

RasterParticleLayerState

@Stable

@MapboxExperimental

class RasterParticleLayerState

The state holder for RasterParticleLayer's layer properties.

RasterResamplingValue

@Immutable

data class RasterResamplingValue(val value: Value) : HoldsValue

The resampling/interpolation method to use for overscaling, also known as texture magnification filter Default value: "linear".

SkyLayerState

@Stable

class SkyLayerState

The state holder for SkyLayer's layer properties.

SkyTypeValue

@Immutable

data class SkyTypeValue(val value: Value) : HoldsValue

The type of the sky Default value: "atmosphere".

SymbolElevationReferenceValue

@Immutable

@MapboxExperimental

data class SymbolElevationReferenceValue(val value: Value) : HoldsValue

Selects the base of symbol-elevation. Default value: "ground".

SymbolLayerState

@Stable

class SymbolLayerState

The state holder for SymbolLayer's layer properties.

SymbolPlacementValue

@Immutable

data class SymbolPlacementValue(val value: Value) : HoldsValue

Label placement relative to its geometry. Default value: "point".

SymbolZOrderValue

@Immutable

data class SymbolZOrderValue(val value: Value) : HoldsValue

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. Default value: "auto".

TextAnchorValue

@Immutable

data class TextAnchorValue(val value: Value) : HoldsValue

Part of the text placed closest to the anchor. Default value: "center".

TextJustifyValue

@Immutable

data class TextJustifyValue(val value: Value) : HoldsValue

Text justification options. Default value: "center".

TextPitchAlignmentValue

@Immutable

data class TextPitchAlignmentValue(val value: Value) : HoldsValue

Orientation of text when map is pitched. Default value: "auto".

TextRotationAlignmentValue

@Immutable

data class TextRotationAlignmentValue(val value: Value) : HoldsValue

In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text. Default value: "auto".

TextTransformValue

@Immutable

data class TextTransformValue(val value: Value) : HoldsValue

Specifies how to capitalize text, similar to the CSS text-transform property. Default value: "none".

TextTranslateAnchorValue

@Immutable

data class TextTranslateAnchorValue(val value: Value) : HoldsValue

Controls the frame of reference for text-translate. Default value: "map".

TextVariableAnchor

@Immutable

data class TextVariableAnchor

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.

TextVariableAnchorListValue

@Immutable

data class TextVariableAnchorListValue(val value: Value) : HoldsValue

TextWritingMode

@Immutable

data class TextWritingMode

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.

TextWritingModeListValue

@Immutable

data class TextWritingModeListValue(val value: Value) : HoldsValue

VisibilityValue

@Immutable

data class VisibilityValue(val value: Value) : HoldsValue

Whether this layer is displayed. Default value: "visible".

Functions

BackgroundLayer

@Composable

fun BackgroundLayer(layerId: String = remember { generateRandomLayerId("background") }, backgroundLayerState: BackgroundLayerState = remember { BackgroundLayerState() })

@Composable

inline fun BackgroundLayer(layerId: String = remember { generateRandomLayerId("background") }, crossinline init: BackgroundLayerState.() -> Unit)

The background color or pattern of the map.

CircleLayer

@Composable

fun CircleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("circle") }, circleLayerState: CircleLayerState = remember { CircleLayerState() })

@Composable

inline fun CircleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("circle") }, crossinline init: CircleLayerState.() -> Unit)

A filled circle.

ClipLayer

@Composable

fun ClipLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("clip") }, clipLayerState: ClipLayerState = remember { ClipLayerState() })

@Composable

inline fun ClipLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("clip") }, crossinline init: ClipLayerState.() -> Unit)

Layer that removes 3D content from map.

FillExtrusionLayer

@Composable

fun FillExtrusionLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("fill-extrusion") }, fillExtrusionLayerState: FillExtrusionLayerState = remember { FillExtrusionLayerState() })

@Composable

inline fun FillExtrusionLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("fill-extrusion") }, crossinline init: FillExtrusionLayerState.() -> Unit)

An extruded (3D) polygon.

FillLayer

@Composable

fun FillLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("fill") }, fillLayerState: FillLayerState = remember { FillLayerState() })

@Composable

inline fun FillLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("fill") }, crossinline init: FillLayerState.() -> Unit)

A filled polygon with an optional stroked border.

HeatmapLayer

@Composable

fun HeatmapLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("heatmap") }, heatmapLayerState: HeatmapLayerState = remember { HeatmapLayerState() })

@Composable

inline fun HeatmapLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("heatmap") }, crossinline init: HeatmapLayerState.() -> Unit)

A heatmap.

HillshadeLayer

@Composable

fun HillshadeLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("hillshade") }, hillshadeLayerState: HillshadeLayerState = remember { HillshadeLayerState() })

@Composable

inline fun HillshadeLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("hillshade") }, crossinline init: HillshadeLayerState.() -> Unit)

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

LineLayer

@Composable

fun LineLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("line") }, lineLayerState: LineLayerState = remember { LineLayerState() })

@Composable

inline fun LineLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("line") }, crossinline init: LineLayerState.() -> Unit)

A stroked line.

LocationIndicatorLayer

@Composable

fun LocationIndicatorLayer(layerId: String = remember { generateRandomLayerId("location-indicator") }, locationIndicatorLayerState: LocationIndicatorLayerState = remember { LocationIndicatorLayerState() })

@Composable

inline fun LocationIndicatorLayer(layerId: String = remember { generateRandomLayerId("location-indicator") }, crossinline init: LocationIndicatorLayerState.() -> Unit)

Location Indicator layer.

ModelLayer

@Composable

fun ModelLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("model") }, modelLayerState: ModelLayerState = remember { ModelLayerState() })

@Composable

inline fun ModelLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("model") }, crossinline init: ModelLayerState.() -> Unit)

A 3D model

RasterLayer

@Composable

fun RasterLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster") }, rasterLayerState: RasterLayerState = remember { RasterLayerState() })

@Composable

inline fun RasterLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster") }, crossinline init: RasterLayerState.() -> Unit)

Raster map textures such as satellite imagery.

RasterParticleLayer

@Composable

@MapboxExperimental

fun RasterParticleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster-particle") }, rasterParticleLayerState: RasterParticleLayerState = remember { RasterParticleLayerState() })

@Composable

@MapboxExperimental

inline fun RasterParticleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster-particle") }, crossinline init: RasterParticleLayerState.() -> Unit)

Particle animation driven by textures such as wind maps.

SkyLayer

@Composable

fun SkyLayer(layerId: String = remember { generateRandomLayerId("sky") }, skyLayerState: SkyLayerState = remember { SkyLayerState() })

@Composable

inline fun SkyLayer(layerId: String = remember { generateRandomLayerId("sky") }, crossinline init: SkyLayerState.() -> Unit)

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

SymbolLayer

@Composable

fun SymbolLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("symbol") }, symbolLayerState: SymbolLayerState = remember { SymbolLayerState() })

@Composable

inline fun SymbolLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("symbol") }, crossinline init: SymbolLayerState.() -> Unit)

An icon or a text label.