Class Leaflet

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

Hierarchy

  • AbstractPlaces
    • Leaflet

Constructors

constructor

Methods

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

Constructors

constructor

Methods

addTo

attachMap

  • attachMap(map): Leaflet

  • When Jawg Places is not used as a control within your map, you will need to call this function.

    Parameters

    Returns Leaflet

    itself

close

  • close(): void

  • Close the result list.

    Returns void

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

getPosition

  • getPosition(): string

  • The current position of the control in the map.

    Returns string

getValue

  • getValue(): string

  • Returns string

    The value of the <input>.

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

    Returns void

search

setValue

  • setValue(value): void

  • Parameters

    • value: string

      The new value for the <input>.

    Returns void

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

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

    Returns void

submit

Settings

Member Visibility

On This Page

Constructors
Methods