maplibre-compose/org.maplibre.compose.map/OrnamentOptions

OrnamentOptions

@Immutable

Defines which additional platform-specific UI elements are displayed on top of the map.

The companion object provides some presets available from common code, but fine-grained customization on multiple platforms requires configuring these options in expect/actual code.

@Immutable

actual class OrnamentOptions(source)

@Immutable

actual data class OrnamentOptions(source)

@Immutable

actual data class OrnamentOptions(source)

Parameters

padding

Padding of the ornaments to the edge of the map.

isLogoEnabled

Determines if the MapLibre logo is displayed.

logoAlignment

Specifies the location of the MapLibre logo. On Android, only the four corners are supported (TopStart, TopEnd, BottomStart, BottomEnd). On iOS, the four corners, centers along the edges, and the center are supported.

isAttributionEnabled

Determines if the copyright attribution button is displayed.

attributionAlignment

Specifies the location of the attribution button. On Android, only the four corners are supported (TopStart, TopEnd, BottomStart, BottomEnd). On iOS, the four corners, centers along the edges, and the center are supported.

isCompassEnabled

Determines if a compass is displayed to indicate north and reset the camera alignment.

compassAlignment

Specifies the location of the compass. On Android, only the four corners are supported (TopStart, TopEnd, BottomStart, BottomEnd). On iOS, the four corners, centers along the edges, and the center are supported.

isScaleBarEnabled

Determines if a scale bar is displayed to indicate the map scale.

scaleBarAlignment

Specifies the location of the scale bar. On Android, only the four corners are supported (TopStart, TopEnd, BottomStart, BottomEnd). On iOS, the four corners, centers along the edges, and the center are supported.

Constructors

OrnamentOptions

constructor()

constructor(isLogoEnabled: Boolean = true, logoAlignment: Alignment = Alignment.Companion.BottomStart, isAttributionEnabled: Boolean = true, attributionAlignment: Alignment = Alignment.Companion.BottomEnd, isNavigationEnabled: Boolean = true, navigationAlignment: Alignment = Alignment.Companion.TopEnd, isScaleBarEnabled: Boolean = true, scaleBarAlignment: Alignment = Alignment.Companion.TopStart)

constructor(padding: PaddingValues = PaddingValues(0.dp), isLogoEnabled: Boolean = true, logoAlignment: Alignment = Alignment.Companion.BottomStart, isAttributionEnabled: Boolean = true, attributionAlignment: Alignment = Alignment.Companion.BottomEnd, isCompassEnabled: Boolean = true, compassAlignment: Alignment = Alignment.Companion.TopEnd, isScaleBarEnabled: Boolean = true, scaleBarAlignment: Alignment = Alignment.Companion.TopStart)