maplibre-compose/org.maplibre.compose.location

Package-level declarations

Types

enum BearingUpdate : Enum<BearingUpdate>

How updateCamera updates camera bearing.

HeadingTrackingStatus

sealed interface HeadingTrackingStatus

Current state of device-heading collection managed by rememberLocationState.

LocationChangeScope

interface LocationChangeScope

The measurements that triggered a LocationTrackingEffect callback.

LocationClickHandler

typealias LocationClickHandler = (LocationMeasurement) -> Unit

LocationPuckColors

class LocationPuckColors(val dotFillColorCurrentLocation: Color = Color.Companion.Blue, val dotFillColorOldLocation: Color = Color.Companion.Gray, val dotStrokeColor: Color = Color.Companion.White, val shadowColor: Color = Color.Companion.Black, val accuracyStrokeColor: Color = Color.Companion.Blue, val accuracyFillColor: Color = accuracyStrokeColor.copy(alpha = 0.3f), val bearingColor: Color = Color.Companion.Red)

Colors for LocationPuck

LocationPuckSizes

class LocationPuckSizes(val dotRadius: Dp = 6.dp, val dotStrokeWidth: Dp = 3.dp, val shadowSize: Dp = 3.dp, val shadowOffset: DpOffset = DpOffset(0.dp, 1.dp), val shadowBlur: Float = 1.0f, val accuracyStrokeWidth: Dp = 1.dp, val bearingSize: Dp = dotRadius)

Sizing parameters for LocationPuck

class LocationState

Lifecycle-aware state for foreground location and heading tracking.

LocationTrackingStatus

sealed interface LocationTrackingStatus

Current state of the foreground location updates managed by rememberLocationState.

Functions

fun LocationPuck(idPrefix: String, locationState: LocationState, oldLocationThreshold: Duration = 30.seconds, accuracyThreshold: Length = 50.meters, colors: LocationPuckColors = LocationPuckColors(), sizes: LocationPuckSizes = LocationPuckSizes(), onClick: LocationClickHandler? = null, onLongClick: LocationClickHandler? = null)

Adds multiple layers to form a location puck from lifecycle-aware locationState.

fun LocationPuck(idPrefix: String, location: LocationMeasurement?, measurementMark: TimeMark? = null, bearing: Bearing? = location?.course, bearingAccuracy: Rotation? = defaultBearingAccuracy(location, bearing), oldLocationThreshold: Duration = 30.seconds, accuracyThreshold: Length = 50.meters, colors: LocationPuckColors = LocationPuckColors(), sizes: LocationPuckSizes = LocationPuckSizes(), onClick: LocationClickHandler? = null, onLongClick: LocationClickHandler? = null)

Adds multiple layers to form a location puck.

LocationTrackingEffect

fun LocationTrackingEffect(locationState: LocationState, enabled: Boolean = true, trackBearing: Boolean = true, onLocationChange: suspend LocationChangeScope.() -> Unit)

A form of LaunchedEffect that is specialized for tracking user location.

mostAccurateBearing

fun LocationState.mostAccurateBearing(): Bearing?

Returns the most accurate bearing measurement available.

mostAccurateBearingAccuracy

fun LocationState.mostAccurateBearingAccuracy(): Rotation?

Returns the estimated error of mostAccurateBearing, or null when unknown.

rememberDefaultHeadingProvider

actual fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

expect fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

actual fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

actual fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

actual fun rememberDefaultHeadingProvider(): HeadingProvider

Creates and remembers the default heading provider for the current platform.

rememberDefaultLocationProvider

actual fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

expect fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

actual fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

actual fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

actual fun rememberDefaultLocationProvider(): LocationProvider

Creates and remembers the default location provider for the current platform.

rememberLocationState

fun rememberLocationState(provider: LocationProvider = rememberDefaultLocationProvider(), request: LocationRequest = LocationRequest(), headingProvider: HeadingProvider = NoHeadingProvider, headingRequest: HeadingRequest = HeadingRequest(), enabled: Boolean = true, lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current, minActiveState: Lifecycle.State = Lifecycle.State.STARTED): LocationState

Remembers foreground location and heading state.

rememberSystemSettingsLauncher

actual fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

expect fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

actual fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

actual fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

actual fun rememberSystemSettingsLauncher(): SystemSettingsLauncher

Creates and remembers the platform SystemSettingsLauncher.

suspend fun LocationChangeScope.updateCamera(mapState: MapState, animationDuration: Duration? = 300.milliseconds, updateBearing: BearingUpdate = BearingUpdate.TRACK_AUTOMATIC)

Convenience method for keeping mapState in sync with the location change that triggered this LocationTrackingEffect callback.