Type alias QueryRenderedFeaturesOptions

QueryRenderedFeaturesOptions: {
    availableImages?: string[];
    filter?: FilterSpecification;
    layers?: string[];
    validate?: boolean;
}

Options to pass to query the map for the rendered features

Type declaration

  • Optional availableImages?: string[]

    An array of string representing the available images

  • Optional filter?: FilterSpecification

    A filter to limit query results.

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

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