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

Package-level declarations

Functions

suspend fun MapCameraManagerDelegate.awaitCameraForCoordinates( 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.

awaitLoadStyle

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.

awaitStyle

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.

genericEvents

@MapboxExperimental

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

Conflated 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 MapFeatureQueryDelegate.queryRenderedFeatures( geometry: RenderedQueryGeometry, options: RenderedQueryOptions): Expected<String, List<QueriedRenderedFeature>>

Queries the map for rendered features.

querySourceFeatures

suspend fun MapFeatureQueryDelegate.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