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

MapState

@Stable

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

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.

getFeatureState

@MapboxExperimental

suspend fun <FS : FeatureState> getFeatureState(featuresetFeature: FeaturesetFeature<FS>): FS

Gets the state map of a feature from a featureset asynchronously.

pixelForCoordinate

suspend fun pixelForCoordinate(coordinate: Point): ScreenCoordinate

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

queryRenderedFeatures

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

Queries the map for rendered features.

@MapboxExperimental

@JvmOverloads

suspend fun <FF : FeaturesetFeature<*>> queryRenderedFeatures(descriptor: TypedFeaturesetDescriptor<*, FF>, geometry: RenderedQueryGeometry? = null, filter: Expression? = null): List<FF>

Queries the map for given descriptor and returns typed FeaturesetFeature list of rendered features.

removeFeatureState

@MapboxExperimental

@JvmOverloads

suspend fun <FS : FeatureState, FSK : FeatureStateKey<FS>> removeFeatureState(featuresetFeature: FeaturesetFeature<FS>, stateKey: FSK? = null): Expected<String, None>

Removes entries from a feature state based on featuresetFeature coming from an interaction callback.

resetFeatureStates

@MapboxExperimental

suspend fun resetFeatureStates(descriptor: TypedFeaturesetDescriptor<*, *>): Expected<String, None>

Reset all the feature states within a style source.

setFeatureState

@MapboxExperimental

suspend fun <FS : FeatureState> setFeatureState(featuresetFeature: FeaturesetFeature<FS>, state: FS): Expected<String, None>

Sets the state map for given featuresetFeature coming from an interaction callback asynchronously.

Properties

cameraChangedEvents

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

val mapIdleEvents: Flow<MapIdle>

Flow of MapIdle updates from MapboxMap.subscribeMapIdle.

mapLoadedEvents

val mapLoadedEvents: Flow<MapLoaded>

Flow of MapLoaded updates from MapboxMap.subscribeMapLoaded.

mapLoadingErrorEvents

val mapLoadingErrorEvents: Flow<MapLoadingError>

Flow of MapLoadingError updates from MapboxMap.subscribeMapLoadingError.

renderFrameFinishedEvents

val renderFrameFinishedEvents: Flow<RenderFrameFinished>

Flow of RenderFrameFinished updates from MapboxMap.subscribeRenderFrameFinished.

renderFrameStartedEvents

val renderFrameStartedEvents: Flow<RenderFrameStarted>

Flow of RenderFrameStarted updates from MapboxMap.subscribeRenderFrameStarted.

resourceRequestEvents

val resourceRequestEvents: Flow<ResourceRequest>

Flow of ResourceRequest updates from MapboxMap.subscribeResourceRequest.

sourceAddedEvents

val sourceAddedEvents: Flow<SourceAdded>

Flow of SourceAdded updates from MapboxMap.subscribeSourceAdded.

sourceDataLoadedEvents

val sourceDataLoadedEvents: Flow<SourceDataLoaded>

Flow of SourceDataLoaded updates from MapboxMap.subscribeSourceDataLoaded.

sourceRemovedEvents

val sourceRemovedEvents: Flow<SourceRemoved>

Flow of SourceRemoved updates from MapboxMap.subscribeSourceRemoved.

styleDataLoadedEvents

val styleDataLoadedEvents: Flow<StyleDataLoaded>

Flow of StyleDataLoaded updates from MapboxMap.subscribeStyleDataLoaded.

styleImageMissingEvents

val styleImageMissingEvents: Flow<StyleImageMissing>

Flow of StyleImageMissing updates from MapboxMap.subscribeStyleImageMissing.

styleImageRemoveUnusedEvents

val styleImageRemoveUnusedEvents: Flow<StyleImageRemoveUnused>

Flow of StyleImageRemoveUnused updates from MapboxMap.subscribeStyleImageRemoveUnused.

styleLoadedEvents

val styleLoadedEvents: Flow<StyleLoaded>

Flow of StyleLoaded updates from MapboxMap.subscribeStyleLoaded.