Package-level declarations

Types

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

Defines a Boolean primitive that can accommodate a Boolean. See Boolean.

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

Defines the color used by the Maps render engine. It can be either Color or an Expression.

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

Defines a primitive that can accommodate a list of Double.

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

Defines a primitive that can accommodate a range of two Double. Usually defined by a lower and upper limit.

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

Defines a Number primitive that can accommodate a Double.

Link copied to clipboard

Utility to generate a random ID.

Link copied to clipboard

Class that holds the configs for one import ID.

Link copied to clipboard

Class that holds MapboxMapComposable content per each LayerPosition.

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

Defines a Number primitive that can accommodate a Long.

Link copied to clipboard

Marks a composable function as being expected to be used inside another composable function that is also marked or inferred to be marked as a MapboxStyleComposable.

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

Defines a primitive that can accommodate a list of com.mapbox.geojson.Points.

Link copied to clipboard
data class SlotsContent

Class that holds MapboxMapComposable content per each slot.

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

Defines a list of String primitive that can accommodate a list of String.

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

Defines a String primitive that can accommodate a String. See String.

Link copied to clipboard
data class StyleImage(val imageId: String, val image: Image, val scale: Float? = null, val sdf: Boolean = false, val stretchX: List<ImageStretches> = listOf(), val stretchY: List<ImageStretches> = listOf(), val content: ImageContent? = null)

Style image to used with runtime styling.

Link copied to clipboard

Class that holds ImportConfigs per each Import ID.

Link copied to clipboard

The state holder for the Style.

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.

Functions

Link copied to clipboard
fun GenericStyle(style: String, styleImportsContent: @Composable StyleImportsScope.() -> Unit? = null, slotsContent: SlotsContent = remember { SlotsContent() }, layerPositionedContent: LayerPositionedContent = remember { LayerPositionedContent() }, styleState: StyleState = rememberStyleState())
fun GenericStyle(style: String, styleImportsContent: @Composable StyleImportsScope.() -> Unit? = null, slotsContent: SlotsContent = remember { SlotsContent() }, layerPositionedContent: LayerPositionedContent = remember { LayerPositionedContent() }, styleImportsConfig: StyleImportsConfig = remember { StyleImportsConfig() }, projection: Projection = Projection.INITIAL, atmosphereState: AtmosphereState = remember { AtmosphereState() }, terrainState: TerrainState = TerrainState.INITIAL, lightsState: LightsState = LightsState.INITIAL, styleTransition: TransitionOptions = remember { transition { } })

Generic Style that you can insert MapboxMapComposable functions in any slot you defined as a plain string, or set any map import configs given as plain string and Value pairs.

Link copied to clipboard

Type-safe builder for ImportConfigs.

Link copied to clipboard

Type-safe builder for layer position based MapboxMapComposable content.

Link copied to clipboard
fun MapStyle(style: String, styleImportsContent: @Composable StyleImportsScope.() -> Unit? = null, styleState: StyleState = rememberStyleState())
fun MapStyle(style: String, styleImportsContent: @Composable StyleImportsScope.() -> Unit? = null, projection: Projection = Projection.INITIAL, atmosphereState: AtmosphereState = remember { AtmosphereState() }, terrainState: TerrainState = TerrainState.INITIAL, lightsState: LightsState = LightsState.INITIAL, styleTransition: TransitionOptions = remember { transition { } })

A simple composable function to set the style to the map without slots or import configs.

Link copied to clipboard
fun rememberStyleImage(imageId: String, imageBitmap: ImageBitmap, scale: Float? = null, sdf: Boolean = false, stretchX: List<ImageStretches> = listOf(), stretchY: List<ImageStretches> = listOf(), content: ImageContent? = null): StyleImage

Create and remember a StyleImage with ImageBitmap.

fun rememberStyleImage(imageId: String, @DrawableRes resourceId: Int, scale: Float? = null, sdf: Boolean = false, stretchX: List<ImageStretches> = listOf(), stretchY: List<ImageStretches> = listOf(), content: ImageContent? = null): StyleImage

Create and remember a StyleImage with resourceId.

fun rememberStyleImage(key: Any?, imageId: String, painter: Painter, scale: Float? = null, sdf: Boolean = false, stretchX: List<ImageStretches> = listOf(), stretchY: List<ImageStretches> = listOf(), content: ImageContent? = null): StyleImage

Create and remember a StyleImage with painter and key.

Link copied to clipboard
inline fun rememberStyleState(crossinline init: StyleState.() -> Unit = {}): StyleState

Create and remember a StyleState with init block.

Link copied to clipboard

Type-safe builder for slot based MapboxMapComposable content.

Link copied to clipboard