queryRenderedFeatures

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

Queries the map for rendered features.

It will suspend until current MapState is set to the MapboxMap composable function.

Return

a list of QueriedRenderedFeature or a string describing an error.

Parameters

geometry

The screen pixel coordinates (point, line string or box) to query for rendered features.

options

The render query options for querying rendered features.


@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.

Return

A typed instance list of the FeaturesetFeature.

Parameters

geometry

The optional geometry (ScreenCoordinate, ScreenBox or list of ScreenCoordinates) to query for rendered features. Passing NULL is equivalent to passing a bounding box encompassing the entire map viewport.

descriptor

TypedFeaturesetDescriptor object representing either a featureset or a single layer.

filter

optional global filter.