Skip to content

QueryRenderedFeaturesOptions

QueryRenderedFeaturesOptions: object

Options to pass to query the map for the rendered features

Type declaration

availableImages?

optional availableImages: string[]

An array of string representing the available images

filter?

optional filter: FilterSpecification

A filter to limit query results.

layers?

optional layers: string[]

An array of style layer IDs for the query to inspect. Only features within these layers will be returned. If this parameter is undefined, all layers will be checked.

validate?

optional validate: boolean

Whether to check if the [options.filter] conforms to the MapLibre Style Specification. Disabling validation is a performance optimization that should only be used if you have previously validated the values you will be passing to this function.

Defined in

src/source/query_features.ts:14