leaflet-control-geocoder

Index

Modules

"leaflet"

Classes

Type aliases

Variables

Functions

Type aliases

FinishGeocodeEvent

FinishGeocodeEvent: { input: string; results: GeocodingResult[] }

Event is fired before after receiving results from IGeocoder.geocode (or IGeocoder.suggest). The event data contains the query string as input and the geocoding results.

Type declaration

input: string
results: GeocodingResult[]

FinishGeocodeEventHandlerFn

FinishGeocodeEventHandlerFn: (event: FinishGeocodeEvent) => void

Type declaration

- (event: FinishGeocodeEvent): void
- Parameters
  - event: FinishGeocodeEvent
  Returns void

GeocodingCallback

GeocodingCallback: (result: GeocodingResult[]) => void

A callback function used in IGeocoder.geocode and IGeocoder.suggest and IGeocoder.reverse

Type declaration

- (result: GeocodingResult[]): void
- Parameters
  - result: GeocodingResult[]
  Returns void

MarkGeocodeEvent

MarkGeocodeEvent: { geocode: GeocodingResult }

Event is fired when selecting a geocode result. By default, the control will center the map on it and place a marker at its location. To remove the control's default handler for marking a result, set GeocoderControlOptions.defaultMarkGeocode to false.

Type declaration

geocode: GeocodingResult

MarkGeocodeEventHandlerFn

MarkGeocodeEventHandlerFn: (event: MarkGeocodeEvent) => void

Type declaration

- (event: MarkGeocodeEvent): void
- Parameters
  - event: MarkGeocodeEvent
  Returns void

StartGeocodeEvent

StartGeocodeEvent: { input: string }

Event is fired before invoking IGeocoder.geocode (or IGeocoder.suggest). The event data contains the query string as input.

Type declaration

input: string

StartGeocodeEventHandlerFn

StartGeocodeEventHandlerFn: (event: StartGeocodeEvent) => void

Type declaration

- (event: StartGeocodeEvent): void
- Parameters
  - event: StartGeocodeEvent
  Returns void

Variables

Const GeocodeEarth

GeocodeEarth: Pelias = Pelias

Const Mapzen

Mapzen: Pelias = Pelias

r.i.p.

deprecated

Const geocodeEarth

geocodeEarth: pelias = pelias

Const mapzen

mapzen: pelias = pelias

r.i.p.

deprecated

Functions

arcgis

arcgis(options?: Partial<ArcGisOptions>): ArcGis

- Defined in src/geocoders/arcgis.ts:90
Class factory method for ArcGis

Parameters
- Optional options: Partial<ArcGisOptions>
  
  the options
Returns ArcGis

bing

bing(options?: Partial<BingOptions>): Bing

- Defined in src/geocoders/bing.ts:84
Class factory method for Bing

Parameters
- Optional options: Partial<BingOptions>
  
  the options
Returns Bing

geocoder

geocoder(options?: Partial<GeocoderControlOptions>): GeocoderControl

- Defined in src/control.ts:489
Class factory method for GeocoderControl

Parameters
- Optional options: Partial<GeocoderControlOptions>
  
  the options
Returns GeocoderControl

google

google(options?: Partial<GoogleOptions>): Google

- Defined in src/geocoders/google.ts:87
Class factory method for Google

Parameters
- Optional options: Partial<GoogleOptions>
  
  the options
Returns Google

here

here(options?: Partial<HereOptions>): HERE | HEREv2

- Defined in src/geocoders/here.ts:178
Class factory method for HERE

Parameters
- Optional options: Partial<HereOptions>
  
  the options
Returns HERE | HEREv2

latLng

latLng(options?: Partial<LatLngOptions>): LatLng

- Defined in src/geocoders/latlng.ts:116
Class factory method for LatLng

Parameters
- Optional options: Partial<LatLngOptions>
  
  the options
Returns LatLng

mapQuest

mapQuest(options?: Partial<MapQuestOptions>): MapQuest

- Defined in src/geocoders/mapquest.ts:95
Class factory method for MapQuest

Parameters
- Optional options: Partial<MapQuestOptions>
  
  the options
Returns MapQuest

mapbox

mapbox(options?: Partial<MapboxOptions>): Mapbox

- Defined in src/geocoders/mapbox.ts:126
Class factory method for Mapbox

Parameters
- Optional options: Partial<MapboxOptions>
  
  the options
Returns Mapbox

neutrino

neutrino(options?: Partial<NeutrinoOptions>): Neutrino

- Defined in src/geocoders/neutrino.ts:87
Class factory method for Neutrino

Parameters
- Optional options: Partial<NeutrinoOptions>
  
  the options
Returns Neutrino

nominatim

nominatim(options?: Partial<NominatimOptions>): Nominatim

- Defined in src/geocoders/nominatim.ts:150
Class factory method for Nominatim

Parameters
- Optional options: Partial<NominatimOptions>
  
  the options
Returns Nominatim

openLocationCode

openLocationCode(options?: Partial<OpenLocationCodeOptions>): OpenLocationCode

- Defined in src/geocoders/open-location-code.ts:77
Class factory method for OpenLocationCode

Parameters
- Optional options: Partial<OpenLocationCodeOptions>
  
  the options
Returns OpenLocationCode

opencage

opencage(options?: Partial<OpenCageOptions>): OpenCage

- Defined in src/geocoders/opencage.ts:93
Parameters
- Optional options: Partial<OpenCageOptions>
Returns OpenCage

openrouteservice

openrouteservice(options?: Partial<PeliasOptions>): Openrouteservice

- Defined in src/geocoders/pelias.ts:140
Class factory method for Openrouteservice

Parameters
- Optional options: Partial<PeliasOptions>
  
  the options
Returns Openrouteservice

parseLatLng

parseLatLng(query: string): LatLng | undefined

- Defined in src/geocoders/latlng.ts:20
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 LatLng | undefined

the parsed latitude/longitude

pelias

pelias(options?: Partial<PeliasOptions>): Pelias

- Defined in src/geocoders/pelias.ts:102
Class factory method for Pelias

Parameters
- Optional options: Partial<PeliasOptions>
  
  the options
Returns Pelias

photon

photon(options?: Partial<PhotonOptions>): Photon

- Defined in src/geocoders/photon.ts:104
Class factory method for Photon

Parameters
- Optional options: Partial<PhotonOptions>
  
  the options
Returns Photon

what3words

what3words(options: Partial<What3WordsOptions>): What3Words

- Defined in src/geocoders/what3words.ts:83
Class factory method for What3Words

Parameters
- options: Partial<What3WordsOptions>
  
  the options
Returns What3Words

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

FinishGeocodeEvent

Type declaration

input: string

results: GeocodingResult[]

FinishGeocodeEventHandlerFn

Type declaration

Parameters

event: FinishGeocodeEvent

Returns void

GeocodingCallback

Type declaration

Parameters

result: GeocodingResult[]

Returns void

MarkGeocodeEvent

Type declaration

geocode: GeocodingResult

MarkGeocodeEventHandlerFn

Type declaration

Parameters

event: MarkGeocodeEvent

Returns void

StartGeocodeEvent

Type declaration

input: string

StartGeocodeEventHandlerFn

Type declaration

Parameters

event: StartGeocodeEvent

Returns void

Variables

Const GeocodeEarth

Const Mapzen

Const geocodeEarth

Const mapzen

Functions

arcgis

Parameters

Optional options: Partial<ArcGisOptions>

Returns ArcGis

bing

Parameters

Optional options: Partial<BingOptions>

Returns Bing

geocoder

Parameters

Optional options: Partial<GeocoderControlOptions>

Returns GeocoderControl

google

Parameters

Optional options: Partial<GoogleOptions>

Returns Google

here

Parameters

Optional options: Partial<HereOptions>

Returns HERE | HEREv2

latLng

Parameters

Optional options: Partial<LatLngOptions>

Returns LatLng

mapQuest

Parameters

Optional options: Partial<MapQuestOptions>

Returns MapQuest

mapbox

Parameters

Optional options: Partial<MapboxOptions>

Returns Mapbox

neutrino

Parameters

Optional options: Partial<NeutrinoOptions>

Returns Neutrino