For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
Type Alias QueryRenderedFeaturesOptions
type QueryRenderedFeaturesOptions = {
availableImages?: string[];
filter?: FilterSpecification;
layers?: string[] | Set<string>;
validate?: boolean;
}
availableImages?: string[];
filter?: FilterSpecification;
layers?: string[] | Set<string>;
validate?: boolean;
}
Properties
OptionalavailableImages
availableImages?: string[]
An array of string representing the available images
Optionalfilter
A filter to limit query results.
Optionallayers
layers?: string[] | Set<string>
An array or set 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.
Optionalvalidate
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.
Options to pass to query the map for the rendered features