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

    Type Alias MaplibreGeocoderApi

    An API which contains reverseGeocode and forwardGeocode functions to be used by this plugin

    const GeoApi = {
      forwardGeocode: (config) => { return { features: [] } },
      reverseGeocode: (config) => { return { features: [] } }
      getSuggestions: (config) => { return { suggestions: [{text: "string", placeId?: "placeId"}] }}
      searchByPlaceId: (config) => { return { place: [{type: "Feature", geometry: {type: "Point", properties: {otherOptinalFields: "someValue"}, coordinates: [1, 2]}}] }}
    }
    const geocoder = new MaplibreGeocoder(GeoApi, {});
    map.addControl(geocoder);
    type MaplibreGeocoderApi = {
        forwardGeocode: (
            config: MaplibreGeocoderApiConfig,
        ) => Promise<MaplibreGeocoderFeatureResults>;
        getSuggestions?: (
            config: MaplibreGeocoderApiConfig,
        ) => Promise<MaplibreGeocoderSuggestionResults>;
        reverseGeocode?: (
            config: MaplibreGeocoderApiConfig,
        ) => Promise<MaplibreGeocoderFeatureResults>;
        searchByPlaceId?: (
            config: MaplibreGeocoderApiConfig,
        ) => Promise<MaplibreGeocoderPlaceResults>;
    }
    Index

    Properties

    forwardGeocode getSuggestions? reverseGeocode? searchByPlaceId?

    Properties

    forwardGeocode: (
        config: MaplibreGeocoderApiConfig,
    ) => Promise<MaplibreGeocoderFeatureResults>

    Forward geocode function should return an object including a collection of CarmenGeojsonFeature.

    Type Declaration

    getSuggestions?: (
        config: MaplibreGeocoderApiConfig,
    ) => Promise<MaplibreGeocoderSuggestionResults>
    reverseGeocode?: (
        config: MaplibreGeocoderApiConfig,
    ) => Promise<MaplibreGeocoderFeatureResults>

    Reverse geocode function should return an object including a collection of CarmenGeojsonFeature.

    searchByPlaceId?: (
        config: MaplibreGeocoderApiConfig,
    ) => Promise<MaplibreGeocoderPlaceResults>

    Settings

    Member Visibility

    On This Page

    Properties