maplibre-compose-material3/dev.sargunv.maplibrecompose.material3.controls/DisappearingScaleBar

DisappearingScaleBar

@Composable
fun DisappearingScaleBar(metersPerDp: Double, zoom: Double, modifier: Modifier = Modifier, measures: ScaleBarMeasures = defaultScaleBarMeasures(), haloColor: Color = MaterialTheme.colorScheme.surface, color: Color = contentColorFor(haloColor), textStyle: TextStyle = MaterialTheme.typography.labelMedium, alignment: Alignment.Horizontal = Alignment.Start, visibilityDuration: Duration = 3.seconds, enterTransition: EnterTransition = fadeIn(), exitTransition: ExitTransition = fadeOut())(source)

An animated scale bar that appears when the zoom level of the map changes, and then disappears after visibilityDuration. This composable wraps ScaleBar with visibility animations.

Parameters

metersPerDp

how many meters are displayed in one device independent pixel (dp), i.e. the scale. See CameraState.metersPerDpAtTarget

zoom

zoom level of the map

modifier

the Modifier to be applied to this layout node

measures

which measures to show on the scale bar. If null, measures will be selected based on the system settings or otherwise the user's locale.

haloColor

halo for better visibility when displayed on top of the map

color

scale bar and text color.

textStyle

the text style. The text size is the deciding factor how large the scale bar is is displayed.

alignment

horizontal alignment of the scale bar and text

visibilityDuration

how long it should be visible after the zoom changed

enterTransition

EnterTransition(s) used for the appearing animation

exitTransition

ExitTransition(s) used for the disappearing animation