@maplibre/maplibre-gl-geocoder
    Preparing search index...

    Type Alias MaplibreGeocoderApiConfig

    type MaplibreGeocoderApiConfig = {
        bbox?: number[];
        countries?: string;
        language?: string;
        limit?: number;
        proximity?: number[];
        query?: string | number[];
        reverseMode?: "distance" | "score";
        types?: string;
    }
    Index

    Properties

    bbox? countries? language? limit? proximity? query? reverseMode? types?

    Properties

    bbox?: number[]

    A bounding box given as an array in the format [minX, minY, maxX, maxY]. Search results will be limited to the bounding box.

    countries?: string

    A comma separated list of country codes to limit results to specified country or countries.

    language?: string

    Specify the language to use for response text and query result weighting. Options are IETF language tags comprised of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas. Defaults to the browser's language settings.

    limit?: number

    Number of results to limit by

    proximity?: number[]

    A geographical point given as an object with latitude and longitude properties. Search results closer to this point will be given higher priority.

    query?: string | number[]

    Search query string

    reverseMode?: "distance" | "score"

    Set the factors that are used to sort nearby results.

    types?: string

    A comma seperated list of types that filter results to match those specified. See https://docs.mapbox.com/api/search/#data-types for available types. If reverseGeocode is enabled, you should specify one type. If you configure more than one type, the first type will be used.

    Settings

    Member Visibility

    On This Page

    Properties