Class Leaflet

This class will help you to add or use search bar for geocoding with a Leaflet map.

Hierarchy

AbstractPlaces
- Leaflet

Index

Constructors

constructor

Methods

addTo attachMap close destroy getPosition getValue onAdd search setValue showError showResults submit

Constructors

constructor

new Leaflet(options): Leaflet
Parameters
- options: JawgPlacesLeafletOptions
Returns Leaflet
Overrides AbstractPlaces.constructor
- Defined in src/places-js.d.ts:543

Methods

addTo

addTo(map): void
Adds the control to the given map.
Parameters
- map: Map
  from Leaflet
Returns void
- Defined in src/places-js.d.ts:558

attachMap

attachMap(map): Leaflet
When Jawg Places is not used as a control within your map, you will need to call this function.
Parameters
- map: Map
  from Leaflet
Returns Leaflet
itself
- Defined in src/places-js.d.ts:564

close

close(): void
Close the result list.

Returns void
Inherited from AbstractPlaces.close
- Defined in src/places-js.d.ts:46

destroy

destroy(): void
Clear created DOM elements and listeners. This could be usefull when you recreate a JawgPlace object for the same input.

Returns void
Inherited from AbstractPlaces.destroy
- Defined in src/places-js.d.ts:51

getPosition

getPosition(): string
The current position of the control in the map.

Returns string
- Defined in src/places-js.d.ts:553

getValue

getValue(): string
Returns string
The value of the <input>.
Inherited from AbstractPlaces.getValue
- Defined in src/places-js.d.ts:27

onAdd

onAdd(map): void
This is the function used by Leaflet when you add a L.Control. Adds the control to the given map.
Parameters
- map: Map
  The map from Leaflet
Returns void
- Defined in src/places-js.d.ts:549

search

search(text): Promise<FeatureCollection>
Search a random text or lat/lon using Jawg Places.

All features are points with properties, more details on our documentation.

See JawgPlacesOptions.reverse for lat/lon search.
Parameters
- text: string
  The text to search using Jawg Places
Returns Promise<FeatureCollection>
A promise with the feature collection received from Jawg Places
Inherited from AbstractPlaces.search
- Defined in src/places-js.d.ts:19

setValue

setValue(value): void
Parameters
- value: string
  The new value for the <input>.
Returns void
Inherited from AbstractPlaces.setValue
- Defined in src/places-js.d.ts:31

showError

showError(error): void
Open the result list with the error message. This will trigger JawgPlacesOptions.onError.
Parameters
- error: any
  The error to show, can be a string or an object.
Returns void
Inherited from AbstractPlaces.showError
- Defined in src/places-js.d.ts:36

showResults

showResults(results): void
Open the result list with elements from the FeatureCollection. We use the properties.label field of each features. This will trigger JawgPlacesOptions.onFeatures.
Parameters
- results: FeatureCollection
  Feature Collection of geocoded points.
Returns void
Inherited from AbstractPlaces.showResults
- Defined in src/places-js.d.ts:42

submit

submit(): void
Submit the search using the value of the <input>. This will trigger JawgPlacesOptions.onFeatures.

Returns void
Inherited from AbstractPlaces.submit
- Defined in src/places-js.d.ts:23

Class Leaflet

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

options: JawgPlacesLeafletOptions

Returns Leaflet

Methods

addTo

Parameters

map: Map

Returns void

attachMap

Parameters

map: Map

Returns Leaflet

close

Returns void

destroy

Returns void

getPosition

Returns string

getValue

Returns string

onAdd

Parameters

map: Map

Returns void

search

Parameters

text: string

Returns Promise<FeatureCollection>

setValue

Parameters

value: string

Returns void

showError

Parameters

error: any

Returns void

showResults

Parameters

results: FeatureCollection

Returns void

submit

Returns void

Settings

Member Visibility

Theme

On This Page