From f59ae7039805860f3ed1fcb48ef13fdf273170df Mon Sep 17 00:00:00 2001 From: simon04 Date: Thu, 2 Jan 2025 19:44:06 +0000 Subject: [PATCH] deploy: 6d006cb52371e8f4ca3aaa442b90badebb066b3f --- docs/classes/Geocoder.html | 16 ++++++++-------- docs/classes/geocoders.ArcGis.html | 10 +++++----- docs/classes/geocoders.AzureMaps.html | 8 ++++---- docs/classes/geocoders.Bing.html | 8 ++++---- docs/classes/geocoders.Google.html | 8 ++++---- docs/classes/geocoders.HERE.html | 8 ++++---- docs/classes/geocoders.HEREv2.html | 8 ++++---- docs/classes/geocoders.LatLng.html | 6 +++--- docs/classes/geocoders.MapQuest.html | 8 ++++---- docs/classes/geocoders.Mapbox.html | 10 +++++----- docs/classes/geocoders.Neutrino.html | 10 +++++----- docs/classes/geocoders.Nominatim.html | 8 ++++---- docs/classes/geocoders.OpenCage.html | 10 +++++----- docs/classes/geocoders.OpenLocationCode.html | 8 ++++---- docs/classes/geocoders.Openrouteservice.html | 10 +++++----- docs/classes/geocoders.Pelias.html | 10 +++++----- docs/classes/geocoders.Photon.html | 10 +++++----- docs/classes/geocoders.What3Words.html | 10 +++++----- docs/functions/geocoder-1.html | 2 +- docs/functions/geocoders.arcgis-1.html | 2 +- docs/functions/geocoders.azure.html | 2 +- docs/functions/geocoders.bing-1.html | 2 +- docs/functions/geocoders.geocodeEarth-1.html | 2 +- docs/functions/geocoders.geocodingParams.html | 2 +- docs/functions/geocoders.google-1.html | 2 +- docs/functions/geocoders.here-1.html | 2 +- docs/functions/geocoders.latLng-1.html | 2 +- docs/functions/geocoders.mapQuest-1.html | 2 +- docs/functions/geocoders.mapbox-1.html | 2 +- docs/functions/geocoders.mapzen-1.html | 2 +- docs/functions/geocoders.neutrino-1.html | 2 +- docs/functions/geocoders.nominatim-1.html | 2 +- docs/functions/geocoders.openLocationCode-1.html | 2 +- docs/functions/geocoders.opencage-1.html | 2 +- docs/functions/geocoders.openrouteservice-1.html | 2 +- docs/functions/geocoders.parseLatLng.html | 2 +- docs/functions/geocoders.pelias-1.html | 2 +- docs/functions/geocoders.photon-1.html | 2 +- docs/functions/geocoders.reverseParams.html | 2 +- docs/functions/geocoders.what3words-1.html | 2 +- docs/index.html | 1 + docs/interfaces/geocoders.ArcGisOptions.html | 10 +++++----- docs/interfaces/geocoders.ArcGisResponse.html | 4 ++-- docs/interfaces/geocoders.AzureMapsOptions.html | 4 ++-- docs/interfaces/geocoders.AzureMapsResponse.html | 4 ++-- docs/interfaces/geocoders.BingOptions.html | 10 +++++----- docs/interfaces/geocoders.CodeArea.html | 4 ++-- docs/interfaces/geocoders.GeocoderOptions.html | 10 +++++----- docs/interfaces/geocoders.GeocodingContext.html | 4 ++-- docs/interfaces/geocoders.GeocodingResult.html | 14 +++++++------- docs/interfaces/geocoders.GoogleOptions.html | 10 +++++----- docs/interfaces/geocoders.GoogleResponse.html | 4 ++-- docs/interfaces/geocoders.HEREv2Response.html | 4 ++-- docs/interfaces/geocoders.HereOptions.html | 14 +++++++------- docs/interfaces/geocoders.IGeocoder.html | 8 ++++---- docs/interfaces/geocoders.LatLngOptions.html | 6 +++--- docs/interfaces/geocoders.MapQuestOptions.html | 10 +++++----- docs/interfaces/geocoders.MapboxOptions.html | 10 +++++----- docs/interfaces/geocoders.MapboxResponse.html | 4 ++-- docs/interfaces/geocoders.NeutrinoOptions.html | 10 +++++----- docs/interfaces/geocoders.NominatimAddress.html | 4 ++-- docs/interfaces/geocoders.NominatimOptions.html | 12 ++++++------ docs/interfaces/geocoders.NominatimResult.html | 4 ++-- docs/interfaces/geocoders.OpenCageOptions.html | 10 +++++----- .../geocoders.OpenLocationCodeApi.html | 4 ++-- .../geocoders.OpenLocationCodeOptions.html | 4 ++-- docs/interfaces/geocoders.PeliasOptions.html | 10 +++++----- docs/interfaces/geocoders.PhotonOptions.html | 10 +++++----- docs/interfaces/geocoders.What3WordsOptions.html | 10 +++++----- docs/types/geocoders.NominatimResponse.html | 2 +- docs/types/geocoders.PeliasResponse.html | 2 +- docs/types/geocoders.PhotonResponse.html | 2 +- docs/variables/geocoders.GeocodeEarth.html | 2 +- docs/variables/geocoders.Mapzen.html | 2 +- 74 files changed, 217 insertions(+), 216 deletions(-) diff --git a/docs/classes/Geocoder.html b/docs/classes/Geocoder.html index baed5c2..9960be8 100644 --- a/docs/classes/Geocoder.html +++ b/docs/classes/Geocoder.html @@ -1,5 +1,5 @@ Geocoder | leaflet-control-geocoder

Class Geocoder

This is the geocoder control. It works like any other Leaflet control, and is added to the map.

-

Hierarchy

  • EventedControl
    • Geocoder

Constructors

constructor +

Hierarchy

  • EventedControl
    • Geocoder

Constructors

constructor

Properties

options

Methods

addEventListener addEventParent @@ -27,7 +27,7 @@ setQuery

Constructors

constructor

  • new Geocoder(options?: Partial<GeocoderControlOptions>): Geocoder

  • Instantiates a geocoder control (to be invoked using new)

    Parameters

    • Optionaloptions: Partial<GeocoderControlOptions>

      the options

      -

    Returns Geocoder

Properties

options

options: GeocoderControlOptions = ...

Methods

addEventListener

  • addEventListener(
        type: "baselayerchange" | "overlayadd" | "overlayremove",
        fn: LayersControlEventHandlerFn,
        context?: any,
    ): this

  • Alias for on(...)

    +

Returns Geocoder

Properties

options

options: GeocoderControlOptions = ...

Methods

addEventListener

  • addEventListener(
        type: "baselayerchange" | "overlayadd" | "overlayremove",
        fn: LayersControlEventHandlerFn,
        context?: any,
    ): this

  • Alias for on(...)

    Adds a listener function (fn) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types @@ -137,7 +137,7 @@

    Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • addOneTimeEventListener(eventMap: LeafletEventHandlerFnMap): this

  • Alias for once(...)

    Behaves as on(...), except the listener will only get fired once and then removed.

    -

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

addThrobberClass

addTo

  • addTo(map: Map): this

  • Parameters

    • map: Map

    Returns this

clearAllEventListeners

  • clearAllEventListeners(): this

  • Alias for off()

    +

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

addThrobberClass

addTo

  • addTo(map: Map): this

  • Parameters

    • map: Map

    Returns this

clearAllEventListeners

  • clearAllEventListeners(): this

  • Alias for off()

    Removes all listeners to all events on the object.

    Returns this

fire

  • fire(type: string, data?: any, propagate?: boolean): this

  • Fires an event of the specified type. You can optionally provide a data object — the first argument of the listener function will contain its properties. @@ -165,7 +165,7 @@

    Parameters

    • type: "tileunload" | "tileloadstart" | "tileload" | "tileabort"
    • fn: TileEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • listens(
        type: "tileerror",
        fn: TileEventHandlerFn,
        context?: any,
        propagate?: boolean,
    ): boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: "tileerror"
    • fn: TileEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

  • listens(
        type: string,
        fn: LeafletEventHandlerFn,
        context?: any,
        propagate?: boolean,
    ): boolean

  • Returns true if a particular event type has any listeners attached to it.

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any
    • Optionalpropagate: boolean

    Returns boolean

markGeocode

off

  • off(
        type: "baselayerchange" | "overlayadd" | "overlayremove",
        fn?: LayersControlEventHandlerFn,
        context?: any,
    ): this

  • Removes a previously added listener function. If no function is specified, +

    Parameters

    • event: MarkGeocodeEvent

    Returns Geocoder

off

  • off(
        type: "baselayerchange" | "overlayadd" | "overlayremove",
        fn?: LayersControlEventHandlerFn,
        context?: any,
    ): this

  • Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener.

    @@ -288,10 +288,10 @@ keyword will point to). You can also pass several space-separated types (e.g. 'click dblclick').

    Parameters

    • type: string
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • on(eventMap: LeafletEventHandlerFnMap): this

  • Adds a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove}

    -

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

  • on(type: "markgeocode", fn: MarkGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "markgeocode"
    • fn: MarkGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • on(type: "startgeocode", fn: StartGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "startgeocode"
    • fn: StartGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • on(type: "startsuggest", fn: StartGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "startsuggest"
    • fn: StartGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • on(type: "finishsuggest", fn: FinishGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "finishsuggest"
    • fn: FinishGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • on(type: "finishgeocode", fn: FinishGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "finishgeocode"
    • fn: FinishGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

onAdd

  • onAdd(map: Map): HTMLDivElement

  • Returns the container DOM element for the control and add listeners on relevant map events.

    +

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

  • on(type: "markgeocode", fn: MarkGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "markgeocode"
    • fn: MarkGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • on(type: "startgeocode", fn: StartGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "startgeocode"
    • fn: StartGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • on(type: "startsuggest", fn: StartGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "startsuggest"
    • fn: StartGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • on(type: "finishsuggest", fn: FinishGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "finishsuggest"
    • fn: FinishGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

  • on(type: "finishgeocode", fn: FinishGeocodeEventHandlerFn, context?: any): this

  • Parameters

    • type: "finishgeocode"
    • fn: FinishGeocodeEventHandlerFn
    • Optionalcontext: any

    Returns this

onAdd

once

  • once(
        type: "baselayerchange" | "overlayadd" | "overlayremove",
        fn: LayersControlEventHandlerFn,
        context?: any,
    ): this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    +

once

  • once(
        type: "baselayerchange" | "overlayadd" | "overlayremove",
        fn: LayersControlEventHandlerFn,
        context?: any,
    ): this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "baselayerchange" | "overlayadd" | "overlayremove"
    • fn: LayersControlEventHandlerFn
    • Optionalcontext: any

    Returns this

  • once(
        type: "layeradd" | "layerremove",
        fn: LayerEventHandlerFn,
        context?: any,
    ): this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type: "layeradd" | "layerremove"
    • fn: LayerEventHandlerFn
    • Optionalcontext: any

    Returns this

  • once(
        type:
            | "zoom"
            | "zoomlevelschange"
            | "unload"
            | "viewreset"
            | "load"
            | "zoomstart"
            | "movestart"
            | "move"
            | "zoomend"
            | "moveend"
            | "autopanstart"
            | "dragstart"
            | "drag"
            | "add"
            | "remove"
            | "loading"
            | "error"
            | "update"
            | "down"
            | "predrag",
        fn: LeafletEventHandlerFn,
        context?: any,
    ): this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    Parameters

    • type:
          | "zoom"
          | "zoomlevelschange"
          | "unload"
          | "viewreset"
          | "load"
          | "zoomstart"
          | "movestart"
          | "move"
          | "zoomend"
          | "moveend"
          | "autopanstart"
          | "dragstart"
          | "drag"
          | "add"
          | "remove"
          | "loading"
          | "error"
          | "update"
          | "down"
          | "predrag"
    • fn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • once(type: "resize", fn: ResizeEventHandlerFn, context?: any): this

  • Behaves as on(...), except the listener will only get fired once and then removed.

    @@ -385,6 +385,6 @@

    Parameters

    • type: string
    • Optionalfn: LeafletEventHandlerFn
    • Optionalcontext: any

    Returns this

  • removeEventListener(eventMap: LeafletEventHandlerFnMap): this

  • Alias for off(...)

    Removes a set of type/listener pairs.

    Parameters

    • eventMap: LeafletEventHandlerFnMap

    Returns this

removeEventParent

  • removeEventParent(obj: Evented): this

  • Removes an event parent, so it will stop receiving propagated events

    -

    Parameters

    • obj: Evented

    Returns this

removeThrobberClass

setPosition

  • setPosition(position: ControlPosition): this

  • Parameters

    • position: ControlPosition

    Returns this

setQuery

  • setQuery(string: string): this

  • Sets the query string on the text input

    +

    Parameters

    • obj: Evented

    Returns this

removeThrobberClass

setPosition

  • setPosition(position: ControlPosition): this

  • Parameters

    • position: ControlPosition

    Returns this

setQuery

  • setQuery(string: string): this

  • Sets the query string on the text input

    Parameters

    • string: string

      the query string

      -

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.ArcGis.html b/docs/classes/geocoders.ArcGis.html index f819a75..f51b892 100644 --- a/docs/classes/geocoders.ArcGis.html +++ b/docs/classes/geocoders.ArcGis.html @@ -1,14 +1,14 @@ ArcGis | leaflet-control-geocoder

Class ArcGis

Implementation of the ArcGIS geocoder

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode reverse suggest -

Constructors

constructor

Properties

options

options: ArcGisOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: ArcGisOptions = ...

Methods

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

suggest

  • suggest(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

suggest

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.AzureMaps.html b/docs/classes/geocoders.AzureMaps.html index fc347f8..ddc5fd4 100644 --- a/docs/classes/geocoders.AzureMaps.html +++ b/docs/classes/geocoders.AzureMaps.html @@ -1,8 +1,8 @@ AzureMaps | leaflet-control-geocoder

Class AzureMaps

Implementation of Azure Maps Geocoding

https://learn.microsoft.com/en-us/rest/api/maps/search?view=rest-maps-1.0

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Methods

geocode reverse -

Constructors

constructor

Methods

geocode

reverse

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

geocode

reverse

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/geocoders.Bing.html b/docs/classes/geocoders.Bing.html index 62f898b..048f141 100644 --- a/docs/classes/geocoders.Bing.html +++ b/docs/classes/geocoders.Bing.html @@ -2,13 +2,13 @@

Bing Maps for Enterprise is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps for Enterprise services until June 30th, 2025. Enterprise account customers can continue to use Bing Maps for Enterprise services until June 30th, 2028.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode reverse -

Constructors

constructor

Properties

options

options: BingOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: BingOptions = ...

Methods

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.Google.html b/docs/classes/geocoders.Google.html index c1fa14d..15a8fe9 100644 --- a/docs/classes/geocoders.Google.html +++ b/docs/classes/geocoders.Google.html @@ -1,11 +1,11 @@ Google | leaflet-control-geocoder

Class Google

An interface implemented to respond to geocoding queries

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode reverse -

Constructors

constructor

Properties

options

options: GoogleOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: GoogleOptions = ...

Methods

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.HERE.html b/docs/classes/geocoders.HERE.html index a83f889..8df6f1a 100644 --- a/docs/classes/geocoders.HERE.html +++ b/docs/classes/geocoders.HERE.html @@ -1,12 +1,12 @@ HERE | leaflet-control-geocoder

Class HERE

Implementation of the HERE Geocoder API

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode getJSON reverse -

Constructors

constructor

Properties

options

options: HereOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: HereOptions = ...

Methods

geocode

getJSON

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

getJSON

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.HEREv2.html b/docs/classes/geocoders.HEREv2.html index ccff915..71e7da5 100644 --- a/docs/classes/geocoders.HEREv2.html +++ b/docs/classes/geocoders.HEREv2.html @@ -1,12 +1,12 @@ HEREv2 | leaflet-control-geocoder

Class HEREv2

Implementation of the new HERE Geocoder API

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode getJSON reverse -

Constructors

constructor

Properties

options

options: HereOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: HereOptions = ...

Methods

geocode

getJSON

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

getJSON

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.LatLng.html b/docs/classes/geocoders.LatLng.html index c2bd822..26cf655 100644 --- a/docs/classes/geocoders.LatLng.html +++ b/docs/classes/geocoders.LatLng.html @@ -1,7 +1,7 @@ LatLng | leaflet-control-geocoder

Class LatLng

Parses basic latitude/longitude strings such as '50.06773 14.37742', 'N50.06773 W14.37742', 'S 50° 04.064 E 014° 22.645', or 'S 50° 4′ 03.828″, W 14° 22′ 38.712″'

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode -

Constructors

constructor

Properties

options

options: LatLngOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: LatLngOptions = ...

Methods

geocode

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.MapQuest.html b/docs/classes/geocoders.MapQuest.html index 5fcb913..4ec4698 100644 --- a/docs/classes/geocoders.MapQuest.html +++ b/docs/classes/geocoders.MapQuest.html @@ -1,12 +1,12 @@ MapQuest | leaflet-control-geocoder

Class MapQuest

Implementation of the MapQuest Geocoding API

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

_formatName geocode reverse -

Constructors

constructor

Properties

options

options: MapQuestOptions = ...

Methods

_formatName

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: MapQuestOptions = ...

Methods

_formatName

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.Mapbox.html b/docs/classes/geocoders.Mapbox.html index 4b4d9ae..67d1c44 100644 --- a/docs/classes/geocoders.Mapbox.html +++ b/docs/classes/geocoders.Mapbox.html @@ -1,15 +1,15 @@ Mapbox | leaflet-control-geocoder

Class Mapbox

Implementation of the Mapbox Geocoding

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

_getProperties geocode reverse suggest -

Constructors

constructor

Properties

options

options: MapboxOptions = ...

Methods

_getProperties

  • _getProperties(loc: Feature): { address: string; text: string }

  • Parameters

    • loc: Feature

    Returns { address: string; text: string }

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: MapboxOptions = ...

Methods

_getProperties

  • _getProperties(loc: Feature): { address: string; text: string }

  • Parameters

    • loc: Feature

    Returns { address: string; text: string }

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

suggest

  • suggest(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

suggest

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.Neutrino.html b/docs/classes/geocoders.Neutrino.html index 6c39cad..b4b9a12 100644 --- a/docs/classes/geocoders.Neutrino.html +++ b/docs/classes/geocoders.Neutrino.html @@ -1,14 +1,14 @@ Neutrino | leaflet-control-geocoder

Class Neutrino

Implementation of the Neutrino API

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode reverse suggest -

Constructors

constructor

Properties

options

options: NeutrinoOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: NeutrinoOptions = ...

Methods

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

suggest

  • suggest(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

suggest

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.Nominatim.html b/docs/classes/geocoders.Nominatim.html index 1b25c74..feee8ca 100644 --- a/docs/classes/geocoders.Nominatim.html +++ b/docs/classes/geocoders.Nominatim.html @@ -1,13 +1,13 @@ Nominatim | leaflet-control-geocoder

Class Nominatim

Implementation of the Nominatim geocoder.

This is the default geocoding service used by the control, unless otherwise specified in the options.

Unless using your own Nominatim installation, please refer to the Nominatim usage policy.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode reverse -

Constructors

constructor

Properties

options

options: NominatimOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: NominatimOptions = ...

Methods

geocode

reverse

  • reverse(
        location: LatLngLiteral,
        scale: number,
    ): Promise<
        {
            bbox: LatLngBounds;
            center: LatLng;
            html: undefined
            | string;
            name: string;
            properties: NominatimResult;
        }[],
    >

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(
        location: LatLngLiteral,
        scale: number,
    ): Promise<
        {
            bbox: LatLngBounds;
            center: LatLng;
            html: undefined
            | string;
            name: string;
            properties: NominatimResult;
        }[],
    >

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<
        {
            bbox: LatLngBounds;
            center: LatLng;
            html: undefined
            | string;
            name: string;
            properties: NominatimResult;
        }[],
    >

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<
    {
        bbox: LatLngBounds;
        center: LatLng;
        html: undefined
        | string;
        name: string;
        properties: NominatimResult;
    }[],
>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.OpenCage.html b/docs/classes/geocoders.OpenCage.html index f65bd4d..1eb48a1 100644 --- a/docs/classes/geocoders.OpenCage.html +++ b/docs/classes/geocoders.OpenCage.html @@ -1,14 +1,14 @@ OpenCage | leaflet-control-geocoder

Class OpenCage

Implementation of the OpenCage Data API

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode reverse suggest -

Constructors

constructor

Properties

options

options: OpenCageOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: OpenCageOptions = ...

Methods

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

suggest

  • suggest(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

suggest

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.OpenLocationCode.html b/docs/classes/geocoders.OpenLocationCode.html index 6b7d40d..5fa56ee 100644 --- a/docs/classes/geocoders.OpenLocationCode.html +++ b/docs/classes/geocoders.OpenLocationCode.html @@ -1,11 +1,11 @@ OpenLocationCode | leaflet-control-geocoder

Class OpenLocationCode

Implementation of the Plus codes (formerly OpenLocationCode) (requires open-location-code)

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode reverse -

Constructors

constructor

Properties

options

options: OpenLocationCodeOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: OpenLocationCodeOptions = ...

Methods

geocode

reverse

  • reverse(
        location: LatLngLiteral,
        scale: number,
    ): Promise<{ bbox: LatLngBounds; center: LatLng; name: string }[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(
        location: LatLngLiteral,
        scale: number,
    ): Promise<{ bbox: LatLngBounds; center: LatLng; name: string }[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<{ bbox: LatLngBounds; center: LatLng; name: string }[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<{ bbox: LatLngBounds; center: LatLng; name: string }[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.Openrouteservice.html b/docs/classes/geocoders.Openrouteservice.html index 6afc817..b53b53c 100644 --- a/docs/classes/geocoders.Openrouteservice.html +++ b/docs/classes/geocoders.Openrouteservice.html @@ -1,15 +1,15 @@ Openrouteservice | leaflet-control-geocoder

Class Openrouteservice

Implementation of the Openrouteservice geocoder

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Properties

options

Methods

_parseResults geocode reverse suggest -

Constructors

constructor

Properties

options

options: PeliasOptions = ...

Methods

_parseResults

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: PeliasOptions = ...

Methods

_parseResults

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

suggest

  • suggest(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

suggest

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.Pelias.html b/docs/classes/geocoders.Pelias.html index 56dedff..2e426ad 100644 --- a/docs/classes/geocoders.Pelias.html +++ b/docs/classes/geocoders.Pelias.html @@ -1,15 +1,15 @@ Pelias | leaflet-control-geocoder

Class Pelias

Implementation of the Pelias, geocode.earth geocoder (formerly Mapzen Search)

-

Hierarchy (View Summary)

Implements

Constructors

constructor +

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

options

Methods

_parseResults geocode reverse suggest -

Constructors

constructor

Properties

options

options: PeliasOptions = ...

Methods

_parseResults

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: PeliasOptions = ...

Methods

_parseResults

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

suggest

  • suggest(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

suggest

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.Photon.html b/docs/classes/geocoders.Photon.html index 8972c79..6de5c51 100644 --- a/docs/classes/geocoders.Photon.html +++ b/docs/classes/geocoders.Photon.html @@ -1,16 +1,16 @@ Photon | leaflet-control-geocoder

Class Photon

Implementation of the Photon geocoder

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

_decodeFeatureName _parseResults geocode reverse suggest -

Constructors

constructor

Properties

options

options: PhotonOptions = ...

Methods

_decodeFeatureName

  • _decodeFeatureName(f: Feature<Geometry, GeoJsonProperties>): string

  • Parameters

    • f: Feature<Geometry, GeoJsonProperties>

    Returns string

_parseResults

geocode

Constructors

constructor

Properties

options

options: PhotonOptions = ...

Methods

_decodeFeatureName

  • _decodeFeatureName(f: Feature<Geometry, GeoJsonProperties>): string

  • Parameters

    • f: Feature<Geometry, GeoJsonProperties>

    Returns string

_parseResults

geocode

reverse

  • reverse(latLng: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

suggest

  • suggest(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

suggest

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/geocoders.What3Words.html b/docs/classes/geocoders.What3Words.html index bf43a6e..c1900bf 100644 --- a/docs/classes/geocoders.What3Words.html +++ b/docs/classes/geocoders.What3Words.html @@ -1,14 +1,14 @@ What3Words | leaflet-control-geocoder

Class What3Words

Implementation of the What3Words service

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

options

Methods

geocode reverse suggest -

Constructors

constructor

Properties

options

options: What3WordsOptions = ...

Methods

geocode

  • geocode(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query and returns the results as promise

    +

Constructors

constructor

Properties

options

options: What3WordsOptions = ...

Methods

geocode

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

reverse

  • reverse(location: LatLngLiteral, scale: number): Promise<GeocodingResult[]>

  • Performs a reverse geocoding query and returns the results as promise

    Parameters

    • location: LatLngLiteral

      the coordinate to reverse geocode

    • scale: number

      the map scale possibly used for reverse geocoding

      -

    Returns Promise<GeocodingResult[]>

suggest

  • suggest(query: string): Promise<GeocodingResult[]>

  • Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

    +

Returns Promise<GeocodingResult[]>

suggest

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/functions/geocoder-1.html b/docs/functions/geocoder-1.html index 03a6ae4..a15e2ed 100644 --- a/docs/functions/geocoder-1.html +++ b/docs/functions/geocoder-1.html @@ -1,3 +1,3 @@ geocoder | leaflet-control-geocoder

Function geocoder

Settings

Member Visibility
+

Returns Geocoder

Settings

Member Visibility
diff --git a/docs/functions/geocoders.arcgis-1.html b/docs/functions/geocoders.arcgis-1.html index 639e09d..8f83df9 100644 --- a/docs/functions/geocoders.arcgis-1.html +++ b/docs/functions/geocoders.arcgis-1.html @@ -1,3 +1,3 @@ arcgis | leaflet-control-geocoder

Function arcgis

Settings

Member Visibility
+

Returns ArcGis

Settings

Member Visibility
diff --git a/docs/functions/geocoders.azure.html b/docs/functions/geocoders.azure.html index 94b58c8..6ebbcbe 100644 --- a/docs/functions/geocoders.azure.html +++ b/docs/functions/geocoders.azure.html @@ -1,3 +1,3 @@ azure | leaflet-control-geocoder

Function azure

Settings

Member Visibility
+

Returns AzureMaps

Settings

Member Visibility
diff --git a/docs/functions/geocoders.bing-1.html b/docs/functions/geocoders.bing-1.html index 7fba3a5..3cf014f 100644 --- a/docs/functions/geocoders.bing-1.html +++ b/docs/functions/geocoders.bing-1.html @@ -1,3 +1,3 @@ bing | leaflet-control-geocoder

Function bing

Settings

Member Visibility
+

Returns Bing

Settings

Member Visibility
diff --git a/docs/functions/geocoders.geocodeEarth-1.html b/docs/functions/geocoders.geocodeEarth-1.html index a847627..e12849c 100644 --- a/docs/functions/geocoders.geocodeEarth-1.html +++ b/docs/functions/geocoders.geocodeEarth-1.html @@ -1,3 +1,3 @@ geocodeEarth | leaflet-control-geocoder

Function geocodeEarth

Settings

Member Visibility
+

Returns Pelias

Settings

Member Visibility
diff --git a/docs/functions/geocoders.geocodingParams.html b/docs/functions/geocoders.geocodingParams.html index 864d9a0..a4908a5 100644 --- a/docs/functions/geocoders.geocodingParams.html +++ b/docs/functions/geocoders.geocodingParams.html @@ -1 +1 @@ -geocodingParams | leaflet-control-geocoder

Function geocodingParams

Settings

Member Visibility
+geocodingParams | leaflet-control-geocoder

Function geocodingParams

Settings

Member Visibility
diff --git a/docs/functions/geocoders.google-1.html b/docs/functions/geocoders.google-1.html index 68d6eee..c5b8262 100644 --- a/docs/functions/geocoders.google-1.html +++ b/docs/functions/geocoders.google-1.html @@ -1,3 +1,3 @@ google | leaflet-control-geocoder

Function google

Settings

Member Visibility
+

Returns Google

Settings

Member Visibility
diff --git a/docs/functions/geocoders.here-1.html b/docs/functions/geocoders.here-1.html index 5f09c6b..70015e9 100644 --- a/docs/functions/geocoders.here-1.html +++ b/docs/functions/geocoders.here-1.html @@ -1,3 +1,3 @@ here | leaflet-control-geocoder

Function here

Settings

Member Visibility
+

Returns HERE | HEREv2

Settings

Member Visibility
diff --git a/docs/functions/geocoders.latLng-1.html b/docs/functions/geocoders.latLng-1.html index a037a78..65cb55d 100644 --- a/docs/functions/geocoders.latLng-1.html +++ b/docs/functions/geocoders.latLng-1.html @@ -1,3 +1,3 @@ latLng | leaflet-control-geocoder

Function latLng

Settings

Member Visibility
+

Returns LatLng

Settings

Member Visibility
diff --git a/docs/functions/geocoders.mapQuest-1.html b/docs/functions/geocoders.mapQuest-1.html index 00a8b0f..54b9088 100644 --- a/docs/functions/geocoders.mapQuest-1.html +++ b/docs/functions/geocoders.mapQuest-1.html @@ -1,3 +1,3 @@ mapQuest | leaflet-control-geocoder

Function mapQuest

Settings

Member Visibility
+

Returns MapQuest

Settings

Member Visibility
diff --git a/docs/functions/geocoders.mapbox-1.html b/docs/functions/geocoders.mapbox-1.html index 7fb790b..816c471 100644 --- a/docs/functions/geocoders.mapbox-1.html +++ b/docs/functions/geocoders.mapbox-1.html @@ -1,3 +1,3 @@ mapbox | leaflet-control-geocoder

Function mapbox

Settings

Member Visibility
+

Returns Mapbox

Settings

Member Visibility
diff --git a/docs/functions/geocoders.mapzen-1.html b/docs/functions/geocoders.mapzen-1.html index a3dd856..6ca4e19 100644 --- a/docs/functions/geocoders.mapzen-1.html +++ b/docs/functions/geocoders.mapzen-1.html @@ -1,4 +1,4 @@ mapzen | leaflet-control-geocoder

Function mapzen

r.i.p.

Deprecated

Settings

Member Visibility
+

Returns Pelias

Settings

Member Visibility
diff --git a/docs/functions/geocoders.neutrino-1.html b/docs/functions/geocoders.neutrino-1.html index 20e88cd..c0f051f 100644 --- a/docs/functions/geocoders.neutrino-1.html +++ b/docs/functions/geocoders.neutrino-1.html @@ -1,3 +1,3 @@ neutrino | leaflet-control-geocoder

Function neutrino

Settings

Member Visibility
+

Returns Neutrino

Settings

Member Visibility
diff --git a/docs/functions/geocoders.nominatim-1.html b/docs/functions/geocoders.nominatim-1.html index 4971ee7..36d306d 100644 --- a/docs/functions/geocoders.nominatim-1.html +++ b/docs/functions/geocoders.nominatim-1.html @@ -1,3 +1,3 @@ nominatim | leaflet-control-geocoder

Function nominatim

Settings

Member Visibility
+

Returns Nominatim

Settings

Member Visibility
diff --git a/docs/functions/geocoders.openLocationCode-1.html b/docs/functions/geocoders.openLocationCode-1.html index ff63ec4..403546e 100644 --- a/docs/functions/geocoders.openLocationCode-1.html +++ b/docs/functions/geocoders.openLocationCode-1.html @@ -1,3 +1,3 @@ openLocationCode | leaflet-control-geocoder

Function openLocationCode

Settings

Member Visibility
+

Returns OpenLocationCode

Settings

Member Visibility
diff --git a/docs/functions/geocoders.opencage-1.html b/docs/functions/geocoders.opencage-1.html index dffb431..3537b80 100644 --- a/docs/functions/geocoders.opencage-1.html +++ b/docs/functions/geocoders.opencage-1.html @@ -1 +1 @@ -opencage | leaflet-control-geocoder

Function opencage

Settings

Member Visibility
+opencage | leaflet-control-geocoder

Function opencage

Settings

Member Visibility
diff --git a/docs/functions/geocoders.openrouteservice-1.html b/docs/functions/geocoders.openrouteservice-1.html index 595db57..9a8f357 100644 --- a/docs/functions/geocoders.openrouteservice-1.html +++ b/docs/functions/geocoders.openrouteservice-1.html @@ -1,3 +1,3 @@ openrouteservice | leaflet-control-geocoder

Function openrouteservice

Settings

Member Visibility
+

Returns Openrouteservice

Settings

Member Visibility
diff --git a/docs/functions/geocoders.parseLatLng.html b/docs/functions/geocoders.parseLatLng.html index f8cf02c..9665bf0 100644 --- a/docs/functions/geocoders.parseLatLng.html +++ b/docs/functions/geocoders.parseLatLng.html @@ -1,4 +1,4 @@ parseLatLng | leaflet-control-geocoder

Function parseLatLng

  • parseLatLng(query: string): L.LatLng | undefined

  • Parses basic latitude/longitude strings such as '50.06773 14.37742', 'N50.06773 W14.37742', 'S 50° 04.064 E 014° 22.645', or 'S 50° 4′ 03.828″, W 14° 22′ 38.712″'

    Parameters

    • query: string

      the latitude/longitude string to parse

    Returns L.LatLng | undefined

    the parsed latitude/longitude

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/geocoders.pelias-1.html b/docs/functions/geocoders.pelias-1.html index 0d91ea0..2066a48 100644 --- a/docs/functions/geocoders.pelias-1.html +++ b/docs/functions/geocoders.pelias-1.html @@ -1,3 +1,3 @@ pelias | leaflet-control-geocoder

Function pelias

Settings

Member Visibility
+

Returns Pelias

Settings

Member Visibility
diff --git a/docs/functions/geocoders.photon-1.html b/docs/functions/geocoders.photon-1.html index 022826e..1844557 100644 --- a/docs/functions/geocoders.photon-1.html +++ b/docs/functions/geocoders.photon-1.html @@ -1,3 +1,3 @@ photon | leaflet-control-geocoder

Function photon

Settings

Member Visibility
+

Returns Photon

Settings

Member Visibility
diff --git a/docs/functions/geocoders.reverseParams.html b/docs/functions/geocoders.reverseParams.html index 9bc1b09..cbedf51 100644 --- a/docs/functions/geocoders.reverseParams.html +++ b/docs/functions/geocoders.reverseParams.html @@ -1 +1 @@ -reverseParams | leaflet-control-geocoder

Function reverseParams

Settings

Member Visibility
+reverseParams | leaflet-control-geocoder

Function reverseParams

Settings

Member Visibility
diff --git a/docs/functions/geocoders.what3words-1.html b/docs/functions/geocoders.what3words-1.html index a9f76dd..c310e37 100644 --- a/docs/functions/geocoders.what3words-1.html +++ b/docs/functions/geocoders.what3words-1.html @@ -1,3 +1,3 @@ what3words | leaflet-control-geocoder

Function what3words

Settings

Member Visibility
+

Returns What3Words

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 2a6b0f3..ba8dea3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,6 +22,7 @@

The plugin can easily be extended to support other providers. Current extensions:

Demos

Optionalreverse

Optionalsuggest

Returns Promise<GeocodingResult[]>

Optionalsuggest

Settings

Member Visibility

On This Page

Methods
+

Returns Promise<GeocodingResult[]>

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/geocoders.LatLngOptions.html b/docs/interfaces/geocoders.LatLngOptions.html index 548db77..93ce83a 100644 --- a/docs/interfaces/geocoders.LatLngOptions.html +++ b/docs/interfaces/geocoders.LatLngOptions.html @@ -1,5 +1,5 @@ -LatLngOptions | leaflet-control-geocoder

Interface LatLngOptions

interface LatLngOptions {
    next?: IGeocoder;
    sizeInMeters: number;
}

Properties

next? +LatLngOptions | leaflet-control-geocoder

Interface LatLngOptions

interface LatLngOptions {
    next?: IGeocoder;
    sizeInMeters: number;
}

Properties

next? sizeInMeters

Properties

Optionalnext

next?: IGeocoder

The next geocoder to use for non-supported queries

-

sizeInMeters

sizeInMeters: number

The size in meters used for passing to LatLng.toBounds

-

Settings

Member Visibility

On This Page

Properties
+

sizeInMeters

sizeInMeters: number

The size in meters used for passing to LatLng.toBounds

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.MapQuestOptions.html b/docs/interfaces/geocoders.MapQuestOptions.html index 68653f6..bbee46a 100644 --- a/docs/interfaces/geocoders.MapQuestOptions.html +++ b/docs/interfaces/geocoders.MapQuestOptions.html @@ -1,9 +1,9 @@ -MapQuestOptions | leaflet-control-geocoder

Interface MapQuestOptions

interface MapQuestOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? +MapQuestOptions | leaflet-control-geocoder

Interface MapQuestOptions

interface MapQuestOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? geocodingQueryParams? reverseQueryParams? serviceUrl

Properties

OptionalapiKey

apiKey?: string

API key to use this service

-

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

-

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

-

serviceUrl

serviceUrl: string

URL of the service

-

Settings

Member Visibility

On This Page

Properties
+

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

+

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

+

serviceUrl

serviceUrl: string

URL of the service

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.MapboxOptions.html b/docs/interfaces/geocoders.MapboxOptions.html index 191f06e..7643f5c 100644 --- a/docs/interfaces/geocoders.MapboxOptions.html +++ b/docs/interfaces/geocoders.MapboxOptions.html @@ -1,9 +1,9 @@ -MapboxOptions | leaflet-control-geocoder

Interface MapboxOptions

interface MapboxOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? +MapboxOptions | leaflet-control-geocoder

Interface MapboxOptions

interface MapboxOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? geocodingQueryParams? reverseQueryParams? serviceUrl

Properties

OptionalapiKey

apiKey?: string

API key to use this service

-

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

-

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

-

serviceUrl

serviceUrl: string

URL of the service

-

Settings

Member Visibility

On This Page

Properties
+

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

+

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

+

serviceUrl

serviceUrl: string

URL of the service

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.MapboxResponse.html b/docs/interfaces/geocoders.MapboxResponse.html index b0ef48d..898bf18 100644 --- a/docs/interfaces/geocoders.MapboxResponse.html +++ b/docs/interfaces/geocoders.MapboxResponse.html @@ -1,5 +1,5 @@ -MapboxResponse | leaflet-control-geocoder

Interface MapboxResponseInternal

interface MapboxResponse {
    attribution: string;
    features: Feature[];
    query: string[];
    type: string;
}

Properties

attribution +MapboxResponse | leaflet-control-geocoder

Interface MapboxResponseInternal

interface MapboxResponse {
    attribution: string;
    features: Feature[];
    query: string[];
    type: string;
}

Properties

attribution features query type -

Properties

attribution

attribution: string

features

features: Feature[]

query

query: string[]

type

type: string

Settings

Member Visibility

On This Page

Properties
+

Properties

attribution

attribution: string

features

features: Feature[]

query

query: string[]

type

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.NeutrinoOptions.html b/docs/interfaces/geocoders.NeutrinoOptions.html index 98d5168..1b8af65 100644 --- a/docs/interfaces/geocoders.NeutrinoOptions.html +++ b/docs/interfaces/geocoders.NeutrinoOptions.html @@ -1,10 +1,10 @@ -NeutrinoOptions | leaflet-control-geocoder

Interface NeutrinoOptions

interface NeutrinoOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
    userId: string;
}

Hierarchy (View Summary)

Properties

apiKey? +NeutrinoOptions | leaflet-control-geocoder

Interface NeutrinoOptions

interface NeutrinoOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
    userId: string;
}

Hierarchy (View Summary)

Properties

apiKey? geocodingQueryParams? reverseQueryParams? serviceUrl userId

Properties

OptionalapiKey

apiKey?: string

API key to use this service

-

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

-

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

-

serviceUrl

serviceUrl: string

URL of the service

-

userId

userId: string

Settings

Member Visibility

On This Page

Properties
+

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

+

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

+

serviceUrl

serviceUrl: string

URL of the service

+

userId

userId: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.NominatimAddress.html b/docs/interfaces/geocoders.NominatimAddress.html index b75767c..19d6b4b 100644 --- a/docs/interfaces/geocoders.NominatimAddress.html +++ b/docs/interfaces/geocoders.NominatimAddress.html @@ -1,4 +1,4 @@ -NominatimAddress | leaflet-control-geocoder

Interface NominatimAddress

interface NominatimAddress {
    building?: string;
    city?: string;
    city_district?: string;
    country?: string;
    country_code?: string;
    county?: string;
    hamlet?: string;
    house_number?: string;
    neighbourhood?: string;
    postcode?: string;
    road?: string;
    state?: string;
    state_district?: string;
    suburb?: string;
    village?: string;
}

Properties

building? +NominatimAddress | leaflet-control-geocoder

Interface NominatimAddress

interface NominatimAddress {
    building?: string;
    city?: string;
    city_district?: string;
    country?: string;
    country_code?: string;
    county?: string;
    hamlet?: string;
    house_number?: string;
    neighbourhood?: string;
    postcode?: string;
    road?: string;
    state?: string;
    state_district?: string;
    suburb?: string;
    village?: string;
}

Properties

building? city? city_district? country? @@ -13,4 +13,4 @@ state_district? suburb? village? -

Properties

Optionalbuilding

building?: string

Optionalcity

city?: string

Optionalcity_district

city_district?: string

Optionalcountry

country?: string

Optionalcountry_code

country_code?: string

Optionalcounty

county?: string

Optionalhamlet

hamlet?: string

Optionalhouse_number

house_number?: string

Optionalneighbourhood

neighbourhood?: string

Optionalpostcode

postcode?: string

Optionalroad

road?: string

Optionalstate

state?: string

Optionalstate_district

state_district?: string

Optionalsuburb

suburb?: string

Optionalvillage

village?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalbuilding

building?: string

Optionalcity

city?: string

Optionalcity_district

city_district?: string

Optionalcountry

country?: string

Optionalcountry_code

country_code?: string

Optionalcounty

county?: string

Optionalhamlet

hamlet?: string

Optionalhouse_number

house_number?: string

Optionalneighbourhood

neighbourhood?: string

Optionalpostcode

postcode?: string

Optionalroad

road?: string

Optionalstate

state?: string

Optionalstate_district

state_district?: string

Optionalsuburb

suburb?: string

Optionalvillage

village?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.NominatimOptions.html b/docs/interfaces/geocoders.NominatimOptions.html index 10a8bc1..6456c37 100644 --- a/docs/interfaces/geocoders.NominatimOptions.html +++ b/docs/interfaces/geocoders.NominatimOptions.html @@ -1,11 +1,11 @@ -NominatimOptions | leaflet-control-geocoder

Interface NominatimOptions

interface NominatimOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    htmlTemplate: (r: NominatimResult) => string;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? +NominatimOptions | leaflet-control-geocoder

Interface NominatimOptions

interface NominatimOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    htmlTemplate: (r: NominatimResult) => string;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? geocodingQueryParams? htmlTemplate reverseQueryParams? serviceUrl

Properties

OptionalapiKey

apiKey?: string

API key to use this service

-

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests; can be used to restrict results to a specific country for example, by providing the countrycodes parameter to Nominatim

-

htmlTemplate

htmlTemplate: (r: NominatimResult) => string

A function that takes an GeocodingResult as argument and returns an HTML formatted string that represents the result. Default function breaks up address in parts from most to least specific, in attempt to increase readability compared to Nominatim's naming

-

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

-

serviceUrl

serviceUrl: string

URL of the service

-

Settings

Member Visibility

On This Page

Properties
+

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests; can be used to restrict results to a specific country for example, by providing the countrycodes parameter to Nominatim

+

htmlTemplate

htmlTemplate: (r: NominatimResult) => string

A function that takes an GeocodingResult as argument and returns an HTML formatted string that represents the result. Default function breaks up address in parts from most to least specific, in attempt to increase readability compared to Nominatim's naming

+

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

+

serviceUrl

serviceUrl: string

URL of the service

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.NominatimResult.html b/docs/interfaces/geocoders.NominatimResult.html index 831c6f9..210c9d2 100644 --- a/docs/interfaces/geocoders.NominatimResult.html +++ b/docs/interfaces/geocoders.NominatimResult.html @@ -1,4 +1,4 @@ -NominatimResult | leaflet-control-geocoder

Interface NominatimResult

interface NominatimResult {
    address: NominatimAddress;
    boundingbox: string[];
    class?: string;
    display_name: string;
    icon?: string;
    importance?: number;
    lat: string;
    licence: string;
    lon: string;
    osm_id: number;
    osm_type: string;
    place_id: number;
    type?: string;
}

Properties

address +NominatimResult | leaflet-control-geocoder

Interface NominatimResult

interface NominatimResult {
    address: NominatimAddress;
    boundingbox: string[];
    class?: string;
    display_name: string;
    icon?: string;
    importance?: number;
    lat: string;
    licence: string;
    lon: string;
    osm_id: number;
    osm_type: string;
    place_id: number;
    type?: string;
}

Properties

address boundingbox class? display_name @@ -11,4 +11,4 @@ osm_type place_id type? -

Properties

address

address: NominatimAddress

boundingbox

boundingbox: string[]

Optionalclass

class?: string

display_name

display_name: string

Optionalicon

icon?: string

Optionalimportance

importance?: number

lat

lat: string

licence

licence: string

lon

lon: string

osm_id

osm_id: number

osm_type

osm_type: string

place_id

place_id: number

Optionaltype

type?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

address

address: NominatimAddress

boundingbox

boundingbox: string[]

Optionalclass

class?: string

display_name

display_name: string

Optionalicon

icon?: string

Optionalimportance

importance?: number

lat

lat: string

licence

licence: string

lon

lon: string

osm_id

osm_id: number

osm_type

osm_type: string

place_id

place_id: number

Optionaltype

type?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.OpenCageOptions.html b/docs/interfaces/geocoders.OpenCageOptions.html index 184f1ef..e95673d 100644 --- a/docs/interfaces/geocoders.OpenCageOptions.html +++ b/docs/interfaces/geocoders.OpenCageOptions.html @@ -1,9 +1,9 @@ -OpenCageOptions | leaflet-control-geocoder

Interface OpenCageOptions

interface OpenCageOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? +OpenCageOptions | leaflet-control-geocoder

Interface OpenCageOptions

interface OpenCageOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? geocodingQueryParams? reverseQueryParams? serviceUrl

Properties

OptionalapiKey

apiKey?: string

API key to use this service

-

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

-

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

-

serviceUrl

serviceUrl: string

URL of the service

-

Settings

Member Visibility

On This Page

Properties
+

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

+

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

+

serviceUrl

serviceUrl: string

URL of the service

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.OpenLocationCodeApi.html b/docs/interfaces/geocoders.OpenLocationCodeApi.html index a20c245..9993880 100644 --- a/docs/interfaces/geocoders.OpenLocationCodeApi.html +++ b/docs/interfaces/geocoders.OpenLocationCodeApi.html @@ -1,3 +1,3 @@ -OpenLocationCodeApi | leaflet-control-geocoder

Interface OpenLocationCodeApi

interface OpenLocationCodeApi {
    decode(code: string): CodeArea;
    encode(latitude: number, longitude: number, codeLength?: number): string;
}

Methods

decode +OpenLocationCodeApi | leaflet-control-geocoder

Interface OpenLocationCodeApi

interface OpenLocationCodeApi {
    decode(code: string): CodeArea;
    encode(latitude: number, longitude: number, codeLength?: number): string;
}

Methods

decode encode -

Methods

decode

encode

  • encode(latitude: number, longitude: number, codeLength?: number): string

  • Parameters

    • latitude: number
    • longitude: number
    • OptionalcodeLength: number

    Returns string

Settings

Member Visibility

On This Page

Methods
+

Methods

decode

encode

  • encode(latitude: number, longitude: number, codeLength?: number): string

  • Parameters

    • latitude: number
    • longitude: number
    • OptionalcodeLength: number

    Returns string

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/geocoders.OpenLocationCodeOptions.html b/docs/interfaces/geocoders.OpenLocationCodeOptions.html index a478419..290c8ce 100644 --- a/docs/interfaces/geocoders.OpenLocationCodeOptions.html +++ b/docs/interfaces/geocoders.OpenLocationCodeOptions.html @@ -1,3 +1,3 @@ -OpenLocationCodeOptions | leaflet-control-geocoder

Interface OpenLocationCodeOptions

interface OpenLocationCodeOptions {
    codeLength?: number;
    OpenLocationCode: OpenLocationCodeApi;
}

Properties

codeLength? +OpenLocationCodeOptions | leaflet-control-geocoder

Interface OpenLocationCodeOptions

interface OpenLocationCodeOptions {
    codeLength?: number;
    OpenLocationCode: OpenLocationCodeApi;
}

Properties

codeLength? OpenLocationCode -

Properties

OptionalcodeLength

codeLength?: number

OpenLocationCode

OpenLocationCode: OpenLocationCodeApi

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalcodeLength

codeLength?: number

OpenLocationCode

OpenLocationCode: OpenLocationCodeApi

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.PeliasOptions.html b/docs/interfaces/geocoders.PeliasOptions.html index 9cb48ba..179cd1f 100644 --- a/docs/interfaces/geocoders.PeliasOptions.html +++ b/docs/interfaces/geocoders.PeliasOptions.html @@ -1,9 +1,9 @@ -PeliasOptions | leaflet-control-geocoder

Interface PeliasOptions

interface PeliasOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? +PeliasOptions | leaflet-control-geocoder

Interface PeliasOptions

interface PeliasOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? geocodingQueryParams? reverseQueryParams? serviceUrl

Properties

OptionalapiKey

apiKey?: string

API key to use this service

-

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

-

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

-

serviceUrl

serviceUrl: string

URL of the service

-

Settings

Member Visibility

On This Page

Properties
+

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

+

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

+

serviceUrl

serviceUrl: string

URL of the service

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.PhotonOptions.html b/docs/interfaces/geocoders.PhotonOptions.html index 5e12c75..df3f6b4 100644 --- a/docs/interfaces/geocoders.PhotonOptions.html +++ b/docs/interfaces/geocoders.PhotonOptions.html @@ -1,4 +1,4 @@ -PhotonOptions | leaflet-control-geocoder

Interface PhotonOptions

interface PhotonOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    htmlTemplate?: (r: any) => string;
    nameProperties: string[];
    reverseQueryParams?: Record<string, unknown>;
    reverseUrl: string;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? +PhotonOptions | leaflet-control-geocoder

Interface PhotonOptions

interface PhotonOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    htmlTemplate?: (r: any) => string;
    nameProperties: string[];
    reverseQueryParams?: Record<string, unknown>;
    reverseUrl: string;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? geocodingQueryParams? htmlTemplate? nameProperties @@ -6,7 +6,7 @@ reverseUrl serviceUrl

Properties

OptionalapiKey

apiKey?: string

API key to use this service

-

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

-

OptionalhtmlTemplate

htmlTemplate?: (r: any) => string

nameProperties

nameProperties: string[]

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

-

reverseUrl

reverseUrl: string

serviceUrl

serviceUrl: string

URL of the service

-

Settings

Member Visibility

On This Page

Properties
+

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

+

OptionalhtmlTemplate

htmlTemplate?: (r: any) => string

nameProperties

nameProperties: string[]

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

+

reverseUrl

reverseUrl: string

serviceUrl

serviceUrl: string

URL of the service

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/geocoders.What3WordsOptions.html b/docs/interfaces/geocoders.What3WordsOptions.html index 2153d93..01b98d9 100644 --- a/docs/interfaces/geocoders.What3WordsOptions.html +++ b/docs/interfaces/geocoders.What3WordsOptions.html @@ -1,9 +1,9 @@ -What3WordsOptions | leaflet-control-geocoder

Interface What3WordsOptions

interface What3WordsOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? +What3WordsOptions | leaflet-control-geocoder

Interface What3WordsOptions

interface What3WordsOptions {
    apiKey?: string;
    geocodingQueryParams?: Record<string, unknown>;
    reverseQueryParams?: Record<string, unknown>;
    serviceUrl: string;
}

Hierarchy (View Summary)

Properties

apiKey? geocodingQueryParams? reverseQueryParams? serviceUrl

Properties

OptionalapiKey

apiKey?: string

API key to use this service

-

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

-

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

-

serviceUrl

serviceUrl: string

URL of the service

-

Settings

Member Visibility

On This Page

Properties
+

OptionalgeocodingQueryParams

geocodingQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to geocoding requests

+

OptionalreverseQueryParams

reverseQueryParams?: Record<string, unknown>

Additional URL parameters (strings) that will be added to reverse geocoding requests

+

serviceUrl

serviceUrl: string

URL of the service

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/types/geocoders.NominatimResponse.html b/docs/types/geocoders.NominatimResponse.html index a23f1fb..a59416b 100644 --- a/docs/types/geocoders.NominatimResponse.html +++ b/docs/types/geocoders.NominatimResponse.html @@ -1 +1 @@ -NominatimResponse | leaflet-control-geocoder

Type Alias NominatimResponse

NominatimResponse: NominatimResult[]

Settings

Member Visibility
+NominatimResponse | leaflet-control-geocoder

Type Alias NominatimResponse

NominatimResponse: NominatimResult[]

Settings

Member Visibility
diff --git a/docs/types/geocoders.PeliasResponse.html b/docs/types/geocoders.PeliasResponse.html index c7c8d3d..40d7639 100644 --- a/docs/types/geocoders.PeliasResponse.html +++ b/docs/types/geocoders.PeliasResponse.html @@ -1 +1 @@ -PeliasResponse | leaflet-control-geocoder

Type Alias PeliasResponseInternal

PeliasResponse: GeoJSON.FeatureCollection<GeoJSON.Geometry, Properties> & {
    geocoding: Geocoding;
}

Settings

Member Visibility
+PeliasResponse | leaflet-control-geocoder

Type Alias PeliasResponseInternal

PeliasResponse: GeoJSON.FeatureCollection<GeoJSON.Geometry, Properties> & {
    geocoding: Geocoding;
}

Settings

Member Visibility
diff --git a/docs/types/geocoders.PhotonResponse.html b/docs/types/geocoders.PhotonResponse.html index ab2ea2f..e781ae9 100644 --- a/docs/types/geocoders.PhotonResponse.html +++ b/docs/types/geocoders.PhotonResponse.html @@ -1 +1 @@ -PhotonResponse | leaflet-control-geocoder

Type Alias PhotonResponseInternal

PhotonResponse: GeoJSON.FeatureCollection<GeoJSON.Geometry, PhotonProperties>

Settings

Member Visibility
+PhotonResponse | leaflet-control-geocoder

Type Alias PhotonResponseInternal

PhotonResponse: GeoJSON.FeatureCollection<GeoJSON.Geometry, PhotonProperties>

Settings

Member Visibility
diff --git a/docs/variables/geocoders.GeocodeEarth.html b/docs/variables/geocoders.GeocodeEarth.html index ecbc744..6752456 100644 --- a/docs/variables/geocoders.GeocodeEarth.html +++ b/docs/variables/geocoders.GeocodeEarth.html @@ -1 +1 @@ -GeocodeEarth | leaflet-control-geocoder

Variable GeocodeEarthConst

GeocodeEarth: typeof Pelias = Pelias

Settings

Member Visibility
+GeocodeEarth | leaflet-control-geocoder

Variable GeocodeEarthConst

GeocodeEarth: typeof Pelias = Pelias

Settings

Member Visibility
diff --git a/docs/variables/geocoders.Mapzen.html b/docs/variables/geocoders.Mapzen.html index 5052d23..db3242d 100644 --- a/docs/variables/geocoders.Mapzen.html +++ b/docs/variables/geocoders.Mapzen.html @@ -1,2 +1,2 @@ Mapzen | leaflet-control-geocoder

Variable MapzenConst

Mapzen: typeof Pelias = Pelias

r.i.p.

-

Deprecated

Settings

Member Visibility
+

Deprecated

Settings

Member Visibility