mapbox-maps-android/com.mapbox.maps.extension.compose/MapState

MapState

@MapboxExperimental

class MapState

The MapState that can be hoisted to observe map events, query rendered features and control gestures settings.

Constructors

MapState

fun MapState()

Constructor for the MapState.

Types

Companion

object Companion

Public companion object of MapState.

Holder

@MapboxExperimental

data class Holder(val savedProperties: Map<String, Parcelable>) : Parcelable

MapState Holder class to be used within Saver.

Functions

genericEvents

@MapboxExperimental

fun genericEvents(eventName: String): Flow<GenericEvent>

Flow of GenericEvent updates from MapboxMap.subscribeGenericEvent.

pixelForCoordinate

@MapboxExperimental

suspend fun pixelForCoordinate(coordinate: Point): ScreenCoordinate

Calculate a screen coordinate that corresponds to a geographical coordinate (i.e., longitude-latitude pair).

queryRenderedFeatures

@MapboxExperimental

suspend fun queryRenderedFeatures(geometry: RenderedQueryGeometry, options: RenderedQueryOptions): Expected<String, List<QueriedRenderedFeature>>

Queries the map for rendered features.

Properties

cameraChangedEvents

@MapboxExperimental

val cameraChangedEvents: Flow<CameraChanged>

Flow of CameraChanged updates from MapboxMap.subscribeCameraChanged.

gesturesSettings

var gesturesSettings: GesturesSettings

Gesture configuration allows to control the user touch interaction.

mapIdleEvents

@MapboxExperimental

val mapIdleEvents: Flow<MapIdle>

Flow of MapIdle updates from MapboxMap.subscribeMapIdle.

mapLoadedEvents

@MapboxExperimental

val mapLoadedEvents: Flow<MapLoaded>

Flow of MapLoaded updates from MapboxMap.subscribeMapLoaded.

mapLoadingErrorEvents

@MapboxExperimental

val mapLoadingErrorEvents: Flow<MapLoadingError>

Flow of MapLoadingError updates from MapboxMap.subscribeMapLoadingError.

renderFrameFinishedEvents

@MapboxExperimental

val renderFrameFinishedEvents: Flow<RenderFrameFinished>

Flow of RenderFrameFinished updates from MapboxMap.subscribeRenderFrameFinished.

renderFrameStartedEvents

@MapboxExperimental

val renderFrameStartedEvents: Flow<RenderFrameStarted>

Flow of RenderFrameStarted updates from MapboxMap.subscribeRenderFrameStarted.

resourceRequestEvents

@MapboxExperimental

val resourceRequestEvents: Flow<ResourceRequest>

Flow of ResourceRequest updates from MapboxMap.subscribeResourceRequest.

sourceAddedEvents

@MapboxExperimental

val sourceAddedEvents: Flow<SourceAdded>

Flow of SourceAdded updates from MapboxMap.subscribeSourceAdded.

sourceDataLoadedEvents

@MapboxExperimental

val sourceDataLoadedEvents: Flow<SourceDataLoaded>

Flow of SourceDataLoaded updates from MapboxMap.subscribeSourceDataLoaded.

sourceRemovedEvents

@MapboxExperimental

val sourceRemovedEvents: Flow<SourceRemoved>

Flow of SourceRemoved updates from MapboxMap.subscribeSourceRemoved.

styleDataLoadedEvents

@MapboxExperimental

val styleDataLoadedEvents: Flow<StyleDataLoaded>

Flow of StyleDataLoaded updates from MapboxMap.subscribeStyleDataLoaded.

styleImageMissingEvents

@MapboxExperimental

val styleImageMissingEvents: Flow<StyleImageMissing>

Flow of StyleImageMissing updates from MapboxMap.subscribeStyleImageMissing.

styleImageRemoveUnusedEvents

@MapboxExperimental

val styleImageRemoveUnusedEvents: Flow<StyleImageRemoveUnused>

Flow of StyleImageRemoveUnused updates from MapboxMap.subscribeStyleImageRemoveUnused.

styleLoadedEvents

@MapboxExperimental

val styleLoadedEvents: Flow<StyleLoaded>

Flow of StyleLoaded updates from MapboxMap.subscribeStyleLoaded.