mapbox-maps-android/com.mapbox.maps.coroutine

Package-level declarations

Functions

suspend fun MapboxMap.awaitLoadStyle(styleExtension: StyleContract.StyleExtension): Style

Load a new style from a style extension, suspends until style is loaded.

suspend fun MapboxMap.awaitLoadStyle(style: String): Style

Load a new style from a style URI or JSON, suspends until style is loaded.

suspend fun MapboxMap.awaitStyle(): Style

Get the Style of the map.

cameraForCoordinates

suspend fun MapboxMap.cameraForCoordinates(coordinates: List<Point>, camera: CameraOptions, coordinatesPadding: EdgeInsets? = null, maxZoom: Double? = null, offset: ScreenCoordinate? = null): CameraOptions

Convenience method that returns the CameraOptions object for given parameters.

@MapboxExperimental

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

Flow of GenericEvent updates from MapboxMap.subscribeGenericEvent.

getFeatureState

suspend fun MapboxMap.getFeatureState(sourceId: String, sourceLayerId: String? = null, featureId: String): Expected<String, Value>

Get the state map of a feature within a style source.

getGeoJsonClusterChildren

suspend fun MapboxMap.getGeoJsonClusterChildren(sourceIdentifier: String, cluster: Feature): Expected<String, FeatureExtensionValue>

Returns the children (original points or clusters) of a cluster (on the next zoom level) given its id (cluster_id value from feature properties) from a GeoJsonSource.

getGeoJsonClusterExpansionZoom

suspend fun MapboxMap.getGeoJsonClusterExpansionZoom(sourceIdentifier: String, cluster: Feature): Expected<String, FeatureExtensionValue>

Returns the zoom on which the cluster expands into several children (useful for "click to zoom" feature) given the cluster's cluster_id (cluster_id value from feature properties) from a GeoJsonSource.

getGeoJsonClusterLeaves

suspend fun MapboxMap.getGeoJsonClusterLeaves(sourceIdentifier: String, cluster: Feature, limit: Long, offset: Long): Expected<String, FeatureExtensionValue>

Returns all the leaves (original points) of a cluster (given its cluster_id) from a GeoJsonSource, with pagination support: limit is the number of leaves to return (set to Infinity for all points), and offset is the amount of points to skip (for pagination).

queryRenderedFeatures

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

Queries the map for rendered features.

querySourceFeatures

suspend fun MapboxMap.querySourceFeatures(sourceId: String, options: SourceQueryOptions): Expected<String, List<QueriedSourceFeature>>

Queries the map for source features.

removeFeatureState

suspend fun MapboxMap.removeFeatureState(sourceId: String, sourceLayerId: String? = null, featureId: String, stateKey: String? = null): Expected<String, None>

Removes entries from a feature state object.

resetFeatureStates

suspend fun MapboxMap.resetFeatureStates(sourceId: String, sourceLayerId: String? = null): Expected<String, None>

Reset all the feature states within a style source.

setFeatureState

suspend fun MapboxMap.setFeatureState(sourceId: String, sourceLayerId: String? = null, featureId: String, state: Value): Expected<String, None>

Updates the state object of a feature within a style source.

Properties

cameraChangedEvents

val MapboxMap.cameraChangedEvents: Flow<CameraChanged>

Flow of CameraChanged updates from MapboxMap.subscribeCameraChanged.

val MapboxMap.mapIdleEvents: Flow<MapIdle>

Flow of MapIdle updates from MapboxMap.subscribeMapIdle.

mapLoadedEvents

val MapboxMap.mapLoadedEvents: Flow<MapLoaded>

Flow of MapLoaded updates from MapboxMap.subscribeMapLoaded.

mapLoadingErrorEvents

val MapboxMap.mapLoadingErrorEvents: Flow<MapLoadingError>

Flow of MapLoadingError updates from MapboxMap.subscribeMapLoadingError.

renderFrameFinishedEvents

val MapboxMap.renderFrameFinishedEvents: Flow<RenderFrameFinished>

Flow of RenderFrameFinished updates from MapboxMap.subscribeRenderFrameFinished.

renderFrameStartedEvents

val MapboxMap.renderFrameStartedEvents: Flow<RenderFrameStarted>

Flow of RenderFrameStarted updates from MapboxMap.subscribeRenderFrameStarted.

resourceRequestEvents

val MapboxMap.resourceRequestEvents: Flow<ResourceRequest>

Flow of ResourceRequest updates from MapboxMap.subscribeResourceRequest.

sourceAddedEvents

val MapboxMap.sourceAddedEvents: Flow<SourceAdded>

Flow of SourceAdded updates from MapboxMap.subscribeSourceAdded.

sourceDataLoadedEvents

val MapboxMap.sourceDataLoadedEvents: Flow<SourceDataLoaded>

Flow of SourceDataLoaded updates from MapboxMap.subscribeSourceDataLoaded.

sourceRemovedEvents

val MapboxMap.sourceRemovedEvents: Flow<SourceRemoved>

Flow of SourceRemoved updates from MapboxMap.subscribeSourceRemoved.

styleDataLoadedEvents

val MapboxMap.styleDataLoadedEvents: Flow<StyleDataLoaded>

Flow of StyleDataLoaded updates from MapboxMap.subscribeStyleDataLoaded.

styleImageMissingEvents

val MapboxMap.styleImageMissingEvents: Flow<StyleImageMissing>

Flow of StyleImageMissing updates from MapboxMap.subscribeStyleImageMissing.

styleImageRemoveUnusedEvents

val MapboxMap.styleImageRemoveUnusedEvents: Flow<StyleImageRemoveUnused>

Flow of StyleImageRemoveUnused updates from MapboxMap.subscribeStyleImageRemoveUnused.

styleLoadedEvents

val MapboxMap.styleLoadedEvents: Flow<StyleLoaded>

Flow of StyleLoaded updates from MapboxMap.subscribeStyleLoaded.