mapbox-maps-android/com.mapbox.maps.extension.compose.style.layers.generated

Package-level declarations

Types

Link copied to clipboard
@Stable
class BackgroundLayerState

The state holder for BackgroundLayer's layer properties.

Link copied to clipboard
@Stable
class CircleLayerState

The state holder for CircleLayer's layer properties.

Link copied to clipboard
@Immutable
data class CirclePitchAlignmentValue(val value: Value)

Orientation of circle when map is pitched. Default value: "viewport".

Link copied to clipboard
@Immutable
data class CirclePitchScaleValue(val value: Value)

Controls the scaling behavior of the circle when the map is pitched. Default value: "map".

Link copied to clipboard
@Immutable
data class CircleTranslateAnchorValue(val value: Value)

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

Link copied to clipboard
@Stable
@MapboxExperimental
class ClipLayerState

The state holder for ClipLayer's layer properties.

Link copied to clipboard
@Immutable
@MapboxExperimental
data class ClipLayerTypes

Layer types that will also be removed if fallen below this clip layer. Default value: [].

Link copied to clipboard
@Immutable
@MapboxExperimental
data class ClipLayerTypesListValue(val value: Value)

Layer types that will also be removed if fallen below this clip layer. Default value: [].

Link copied to clipboard
@Stable
class FillExtrusionLayerState

The state holder for FillExtrusionLayer's layer properties.

Link copied to clipboard
@Immutable
data class FillExtrusionTranslateAnchorValue(val value: Value)

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

Link copied to clipboard
@Stable
class FillLayerState

The state holder for FillLayer's layer properties.

Link copied to clipboard
@Immutable
data class FillTranslateAnchorValue(val value: Value)

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

Link copied to clipboard
@Stable
class HeatmapLayerState

The state holder for HeatmapLayer's layer properties.

Link copied to clipboard
@Immutable
data class HillshadeIlluminationAnchorValue(val value: Value)

Direction of light source when map is rotated. Default value: "viewport".

Link copied to clipboard
@Stable
class HillshadeLayerState

The state holder for HillshadeLayer's layer properties.

Link copied to clipboard
@Immutable
data class IconAnchorValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class IconPitchAlignmentValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class IconRotationAlignmentValue(val value: Value)

In combination with symbol-placement, determines the rotation behavior of icons. Default value: "auto".

Link copied to clipboard
@Immutable
data class IconTextFitValue(val value: Value)

Scales the icon to fit around the associated text. Default value: "none".

Link copied to clipboard
@Immutable
data class IconTranslateAnchorValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class LineCapValue(val value: Value)

The display of line endings. Default value: "butt".

Link copied to clipboard
@Immutable
data class LineJoinValue(val value: Value)

The display of lines when joining. Default value: "miter".

Link copied to clipboard
@Stable
class LineLayerState

The state holder for LineLayer's layer properties.

Link copied to clipboard
@Immutable
data class LineTranslateAnchorValue(val value: Value)

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

Link copied to clipboard
@Stable
class LocationIndicatorLayerState

The state holder for LocationIndicatorLayer's layer properties.

Link copied to clipboard
@Stable
@MapboxExperimental
class ModelLayerState

The state holder for ModelLayer's layer properties.

Link copied to clipboard
@Immutable
@MapboxExperimental
data class ModelScaleModeValue(val value: Value)

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

Link copied to clipboard
@Immutable
@MapboxExperimental
data class ModelTypeValue(val value: Value)

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

Link copied to clipboard
@Stable
class RasterLayerState

The state holder for RasterLayer's layer properties.

Link copied to clipboard
@Stable
@MapboxExperimental
class RasterParticleLayerState

The state holder for RasterParticleLayer's layer properties.

Link copied to clipboard
@Immutable
data class RasterResamplingValue(val value: Value)

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

Link copied to clipboard
@Stable
class SkyLayerState

The state holder for SkyLayer's layer properties.

Link copied to clipboard
@Immutable
data class SkyTypeValue(val value: Value)

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

Link copied to clipboard
@Immutable
@MapboxExperimental
data class SymbolElevationReferenceValue(val value: Value)

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

Link copied to clipboard
@Stable
class SymbolLayerState

The state holder for SymbolLayer's layer properties.

Link copied to clipboard
@Immutable
data class SymbolPlacementValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class SymbolZOrderValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class TextAnchorValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class TextJustifyValue(val value: Value)

Text justification options. Default value: "center".

Link copied to clipboard
@Immutable
data class TextPitchAlignmentValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class TextRotationAlignmentValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class TextTransformValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class TextTranslateAnchorValue(val value: Value)

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

Link copied to clipboard
@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.

Link copied to clipboard
@Immutable
data class TextVariableAnchorListValue(val value: Value)

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

Link copied to clipboard
@Immutable
data class TextWritingModeListValue(val value: Value)

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
@Immutable
data class VisibilityValue(val value: Value)

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

Functions

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@Composable
@MapboxExperimental
fun ClipLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("clip") }, clipLayerState: ClipLayerState = remember { ClipLayerState() })
@Composable
@MapboxExperimental
inline fun ClipLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("clip") }, crossinline init: ClipLayerState.() -> Unit)

Layer that removes 3D content from map.

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@Composable
@MapboxExperimental
fun ModelLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("model") }, modelLayerState: ModelLayerState = remember { ModelLayerState() })
@Composable
@MapboxExperimental
inline fun ModelLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("model") }, crossinline init: ModelLayerState.() -> Unit)

A layer to render 3D Models.

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@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.