Type Alias MaplibreGeocoderOptions

MaplibreGeocoderOptions: {
    bbox?: number[];
    clearAndBlurOnEsc?: boolean;
    clearOnBlur?: boolean;
    collapsed?: boolean;
    countries?: string;
    debounceSearch?: number;
    enableEventLogging?: boolean;
    externalGeocoder?: (
        query: string,
        features: CarmenGeojsonFeature[],
        confic: MaplibreGeocoderApiConfig,
    ) => Promise<CarmenGeojsonFeature[]>;
    filter?: (item: CarmenGeojsonFeature) => boolean;
    flyTo?: boolean | FlyToOptions;
    getItemValue?: (item: CarmenGeojsonFeature) => string;
    language?: string;
    limit?: number;
    localGeocoder?: (query: string) => CarmenGeojsonFeature[];
    localGeocoderOnly?: boolean;
    maplibregl?: typeof MaplibreGl;
    marker?: boolean | Marker;
    minLength?: number;
    placeholder?: string;
    popup?: boolean | Popup;
    popupRender?: (item: CarmenGeojsonFeature) => string;
    proximity?: { latitude: number; longitude: number };
    proximityMinZoom?: number;
    render?: (item: CarmenGeojsonFeature) => string;
    reverseGeocode?: boolean;
    reverseMode?: "distance" | "score";
    showResultMarkers?: boolean | MarkerOptions;
    showResultsWhileTyping?: boolean;
    trackProximity?: boolean;
    types?: string;
    zoom?: number;
}

Type declaration

Optionalbbox?: number[]
A bounding box argument: this is a bounding box given as an array in the format [minX, minY, maxX, maxY]. Search results will be limited to the bounding box.
OptionalclearAndBlurOnEsc?: boolean
If true, the geocoder control will clear it's contents and blur when user presses the escape key.
Default
```
false
```
OptionalclearOnBlur?: boolean
If true, the geocoder control will clear its value when the input blurs.
Default
```
false
```
Optionalcollapsed?: boolean
If true, the geocoder control will collapse until hovered or in focus.
Default
```
false
```
Optionalcountries?: string
A comma separated list of country codes to limit results to specified country or countries.
OptionaldebounceSearch?: number
Sets the amount of time, in milliseconds, to wait before querying the server when a user types into the Geocoder input box. This parameter may be useful for reducing the total number of API calls made for a single query.
Default
```
200
```
OptionalenableEventLogging?: boolean
Allow Maplibre to collect anonymous usage statistics from the plugin.
Default
```
true
```
OptionalexternalGeocoder?: (
    query: string,
    features: CarmenGeojsonFeature[],
    confic: MaplibreGeocoderApiConfig,
) => Promise<CarmenGeojsonFeature[]>
A function accepting the query string, current features list, and geocoder options which performs geocoding to supplement results from the Maplibre Geocoding API. Expected to return a Promise which resolves to an Array of CarmenGeojsonFeature.
Optionalfilter?: (item: CarmenGeojsonFeature) => boolean
A function which accepts a CarmenGeojsonFeature to filter out results from the Geocoding API response before they are included in the suggestions list. Return true to keep the item, false otherwise.
OptionalflyTo?: boolean | FlyToOptions
If false, animating the map to a selected result is disabled. If true, animating the map will use the default animation parameters. If an object, it will be passed as options to the map flyTo or fitBounds method providing control over the animation of the transition.
Default
```
true
```

`Optional`getItemValue?: (item: CarmenGeojsonFeature) => string

A function that specifies how the selected result should be rendered in the search bar. HTML tags in the output string will not be rendered. Defaults to (item) => item.place_name.

Example

const GeoApi = {
  forwardGeocode: (config) => { return { features: [] } },
  reverseGeocode: (config) => { return { features: [] } }
  getSuggestions: (config) => { return { suggestions: {text: string, placeId?: string}[] }}
  searchByPlaceId: (config) => { return { place: {type: string, geometry: {type: string, coordinates: [number]} place_name: string, text: string, center: [number] }[] }}
}
const geocoder = new MaplibreGeocoder(GeoApi, {});
map.addControl(geocoder);

Optionallanguage?: 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.
Optionallimit?: number
Maximum number of results to show.
Default
```
5
```
OptionallocalGeocoder?: (query: string) => CarmenGeojsonFeature[]
A function accepting the query string which performs local geocoding to supplement results from the Maplibre Geocoding API. Expected to return an Array of CarmenGeojsonFeature.
OptionallocalGeocoderOnly?: boolean
If true, indicates that the localGeocoder results should be the only ones returned to the user. If false, indicates that the localGeocoder results should be combined with those from the Maplibre API with the localGeocoder results ranked higher.
Default
```
false
```
Optionalmaplibregl?: typeof MaplibreGl
A maplibre-gl instance to use when creating Markers. Required if options.marker is true.
Default
```
false
```
Optionalmarker?: boolean | Marker
If true, a Marker will be added to the map at the location of the user-selected result using a default set of Marker options. If the value is an object, the marker will be constructed using these options. If false, no marker will be added to the map. Requires that options.maplibregl also be set.
Default
```
true
```
OptionalminLength?: number
Minimum number of characters to enter before results are shown.
Default
```
2
```
Optionalplaceholder?: string
Override the default placeholder attribute value.
Default
```
"Search"
```
Optionalpopup?: boolean | Popup
If true, a Popup will be added to the map when clicking on a marker using a default set of popup options. If the value is an object, the popup will be constructed using these options. If false, no popup will be added to the map. Requires that options.maplibregl also be set.
Default
```
false
```
OptionalpopupRender?: (item: CarmenGeojsonFeature) => string
A function that specifies how the results should be rendered in the popup menu. Any HTML in the returned string will be rendered.
Optionalproximity?: { latitude: number; longitude: number }
a proximity argument: this is a geographical point given as an object with latitude and longitude properties. Search results closer to this point will be given higher priority.
OptionalproximityMinZoom?: number
If setting promiximity, this is the minimum zoom level at which to start taking it into account.
Default
```
9
```
Optionalrender?: (item: CarmenGeojsonFeature) => string
A function that specifies how the results should be rendered in the dropdown menu. Any HTML in the returned string will be rendered.
OptionalreverseGeocode?: boolean
If true, enable reverse geocoding mode. In reverse geocoding, search input is expected to be coordinates in the form lat, lon, with suggestions being the reverse geocodes.
Default
```
false
```
OptionalreverseMode?: "distance" | "score"
Set the factors that are used to sort nearby results.
OptionalshowResultMarkers?: boolean | MarkerOptions
If true, Markers will be added to the map at the location the top results for the query. If the value is an object, the marker will be constructed using these options. If false, no marker will be added to the map. Requires that options.maplibregl also be set.
Default
```
true
```
OptionalshowResultsWhileTyping?: boolean
If false, indicates that search will only occur on enter key press. If true, indicates that the Geocoder will search on the input box being updated above the minLength option.
Default
```
false
```
OptionaltrackProximity?: boolean
If true, the geocoder proximity will automatically update based on the map view.
Default
```
true
```
Optionaltypes?: 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.
Optionalzoom?: number
On geocoded result what zoom level should the map animate to when a bbox isn't found in the response. If a bbox is found the map will fit to the bbox.
Default
```
16
```

Type Alias MaplibreGeocoderOptions

Type declaration

Optionalbbox?: number[]

OptionalclearAndBlurOnEsc?: boolean

Default

OptionalclearOnBlur?: boolean

Default

Optionalcollapsed?: boolean

Default

Optionalcountries?: string

OptionaldebounceSearch?: number

Default

OptionalenableEventLogging?: boolean

Default

OptionalexternalGeocoder?: ( query: string, features: CarmenGeojsonFeature[], confic: MaplibreGeocoderApiConfig,) => Promise<CarmenGeojsonFeature[]>

Optionalfilter?: (item: CarmenGeojsonFeature) => boolean

OptionalflyTo?: boolean | FlyToOptions

Default

OptionalgetItemValue?: (item: CarmenGeojsonFeature) => string

Example

Optionallanguage?: string

Optionallimit?: number

Default

OptionallocalGeocoder?: (query: string) => CarmenGeojsonFeature[]

OptionallocalGeocoderOnly?: boolean

Default

Optionalmaplibregl?: typeof MaplibreGl

Default

Optionalmarker?: boolean | Marker

Default

OptionalminLength?: number

Default

Optionalplaceholder?: string

Default

Optionalpopup?: boolean | Popup

Default

OptionalpopupRender?: (item: CarmenGeojsonFeature) => string

Optionalproximity?: { latitude: number; longitude: number }

OptionalproximityMinZoom?: number

Default

Optionalrender?: (item: CarmenGeojsonFeature) => string

OptionalreverseGeocode?: boolean

Default

OptionalreverseMode?: "distance" | "score"

OptionalshowResultMarkers?: boolean | MarkerOptions

Default

OptionalshowResultsWhileTyping?: boolean

Default

OptionaltrackProximity?: boolean

Default

Optionaltypes?: string

Optionalzoom?: number

Default

Settings

`Optional`bbox?: number[]

`Optional`clearAndBlurOnEsc?: boolean

`Optional`clearOnBlur?: boolean

`Optional`collapsed?: boolean

`Optional`countries?: string

`Optional`debounceSearch?: number

`Optional`enableEventLogging?: boolean

`Optional`externalGeocoder?: (
query: string,
features: CarmenGeojsonFeature[],
confic: MaplibreGeocoderApiConfig,
) => Promise<CarmenGeojsonFeature[]>

`Optional`filter?: (item: CarmenGeojsonFeature) => boolean

`Optional`flyTo?: boolean | FlyToOptions

`Optional`getItemValue?: (item: CarmenGeojsonFeature) => string

`Optional`language?: string

`Optional`limit?: number

`Optional`localGeocoder?: (query: string) => CarmenGeojsonFeature[]

`Optional`localGeocoderOnly?: boolean

`Optional`maplibregl?: typeof MaplibreGl

`Optional`marker?: boolean | Marker

`Optional`minLength?: number

`Optional`placeholder?: string

`Optional`popup?: boolean | Popup

`Optional`popupRender?: (item: CarmenGeojsonFeature) => string

`Optional`proximity?: { latitude: number; longitude: number }

`Optional`proximityMinZoom?: number

`Optional`render?: (item: CarmenGeojsonFeature) => string

`Optional`reverseGeocode?: boolean

`Optional`reverseMode?: "distance" | "score"

`Optional`showResultMarkers?: boolean | MarkerOptions

`Optional`showResultsWhileTyping?: boolean

`Optional`trackProximity?: boolean

`Optional`types?: string

`Optional`zoom?: number