com.tomtom.sdk.maps:map-display-compose-common/com.tomtom.sdk.map.display.compose.state/MapViewState

MapViewState

@Stable

class MapViewState

The state of TomTomMap composable.

To create an instance use rememberMapViewState.

Types

Companion

object Companion

Properties

cameraState

val cameraState: CameraState

The CameraState of the map view.

copyrightsState

val copyrightsState: CopyrightsState

The CopyrightsState of the map view.

frameRate

var frameRate: Int

The frame rate cap on the map renderer. It is useful for scenarios where the map is not fully visible to the user, and there is no need to render it with its full performance.

gestureState

val gestureState: GesturesState

The GesturesState of the map view.

locale

var locale: Locale

Sets map locale.

locationState

val locationState: LocationState

The LocationState of the map view.

renderedFeatureState

val renderedFeatureState: RenderedFeatureState

The RenderedFeatureState of the map view.

safeArea

var safeArea: PaddingValues

Sets padding on the map view to determine space for the safe area. The safe area is the part of the viewport which is considered completely visible by the user i.e. not covered by UI components such as buttons or sliders.

styleState

val styleState: MapStyleState

The MapStyleState of the map view.

Functions

getGeoPointForOffset

suspend fun getGeoPointForOffset(offset: Offset): GeoPoint?

Converts a offset on the map view to a position on the map. Returns a GeoPoint or null if the offset is not visible.

getScreenOffsetForGeoPoint

suspend fun getScreenOffsetForGeoPoint(geoPoint: GeoPoint): Offset?

Converts a geoPoint on the map into a Offset on the map. Returns the offset or null if the geoPoint is not visible.

getVisualRegion

suspend fun getVisualRegion(): VisibleRegion

Returns the currently visible region.

toString

open override fun toString(): String