MapState

fun MapState()

Constructor for the MapState.

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.

coordinateForPixel

suspend fun coordinateForPixel(pixel: ScreenCoordinate): Point

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

coordinateInfoForPixel

suspend fun coordinateInfoForPixel(pixel: ScreenCoordinate): CoordinateInfo

Calculates the geographical coordinate information that corresponds to a given screen coordinate.

coordinatesForPixels

suspend fun coordinatesForPixels(pixels: List<ScreenCoordinate>): List<Point>

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

coordinatesInfoForPixels

suspend fun coordinatesInfoForPixels(pixels: List<ScreenCoordinate>): List<CoordinateInfo>

Calculates the geographical coordinates information that corresponds to the given screen coordinates.

genericEvents

@MapboxExperimental

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

Conflated 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).

pixelsForCoordinates

suspend fun pixelsForCoordinates(coordinates: List<Point>): List<ScreenCoordinate>

Calculate screen coordinates that corresponds to geographical coordinates (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.

queryRenderedRasterValues

@MapboxExperimental

suspend fun queryRenderedRasterValues(coordinate: ScreenCoordinate, options: RenderedRasterQueryOptions): Expected<String, QueriedRasterValues>

Queries the map for rendered raster values at a specific coordinate.

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.

tileCover

@MapboxExperimental

@JvmOverloads

suspend fun tileCover(tileCoverOptions: TileCoverOptions, cameraOptions: CameraOptions? = null): List<CanonicalTileID>

Returns tileIDs that cover current map camera.

cameraChangedCoalescedEvents

@MapboxExperimental

val cameraChangedCoalescedEvents: Flow<CameraChangedCoalesced>

Conflated Flow of CameraChangedCoalesced updates from MapboxMap.subscribeCameraChangedCoalesced.

cameraChangedEvents

val cameraChangedEvents: Flow<CameraChanged>

Conflated Flow of CameraChanged updates from MapboxMap.subscribeCameraChanged.

gesturesSettings

var ~~gesturesSettings~~: GesturesSettings

Gesture configuration allows to control the user touch interaction.

gesturesState

@MapboxExperimental

var gesturesState: GesturesState

State holder for gesture configuration and per-gesture event observation.

mapIdleEvents

val mapIdleEvents: Flow<MapIdle>

Conflated Flow of MapIdle updates from MapboxMap.subscribeMapIdle.

mapLoadedEvents

val mapLoadedEvents: Flow<MapLoaded>

Conflated Flow of MapLoaded updates from MapboxMap.subscribeMapLoaded.

mapLoadingErrorEvents

val mapLoadingErrorEvents: Flow<MapLoadingError>

Conflated Flow of MapLoadingError updates from MapboxMap.subscribeMapLoadingError.

renderFrameFinishedEvents

val renderFrameFinishedEvents: Flow<RenderFrameFinished>

Conflated Flow of RenderFrameFinished updates from MapboxMap.subscribeRenderFrameFinished.

renderFrameStartedEvents

val renderFrameStartedEvents: Flow<RenderFrameStarted>

Conflated Flow of RenderFrameStarted updates from MapboxMap.subscribeRenderFrameStarted.

resourceRequestEvents

val resourceRequestEvents: Flow<ResourceRequest>

Conflated Flow of ResourceRequest updates from MapboxMap.subscribeResourceRequest.

sourceAddedEvents

val sourceAddedEvents: Flow<SourceAdded>

Conflated Flow of SourceAdded updates from MapboxMap.subscribeSourceAdded.

sourceDataLoadedEvents

val sourceDataLoadedEvents: Flow<SourceDataLoaded>

Conflated Flow of SourceDataLoaded updates from MapboxMap.subscribeSourceDataLoaded.

sourceRemovedEvents

val sourceRemovedEvents: Flow<SourceRemoved>

Conflated Flow of SourceRemoved updates from MapboxMap.subscribeSourceRemoved.

styleDataLoadedEvents

val styleDataLoadedEvents: Flow<StyleDataLoaded>

Conflated Flow of StyleDataLoaded updates from MapboxMap.subscribeStyleDataLoaded.

styleImageMissingEvents

val styleImageMissingEvents: Flow<StyleImageMissing>

Conflated Flow of StyleImageMissing updates from MapboxMap.subscribeStyleImageMissing.

styleImageRemoveUnusedEvents

val styleImageRemoveUnusedEvents: Flow<StyleImageRemoveUnused>

Conflated Flow of StyleImageRemoveUnused updates from MapboxMap.subscribeStyleImageRemoveUnused.

styleLoadedEvents

val styleLoadedEvents: Flow<StyleLoaded>

Conflated Flow of StyleLoaded updates from MapboxMap.subscribeStyleLoaded.

MapState

Constructors

Types

Functions

Properties