Class MapLibre

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

const jawgPlaces = new JawgPlaces.MapLibre({
  accessToken: 'Access-Token',
})

Hierarchy (view full)

Constructors

constructor

Methods

attachMap close destroy getDefaultPosition getValue onAdd search setValue showError showResults submit

Constructors

constructor

Methods

attachMap

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

getDefaultPosition

  • getDefaultPosition(): "top-left"

  • The default position of the control in the map.

    Returns "top-left"

getValue

  • getValue(): string

  • Returns string

    The value of the <input>.

onAdd

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 callback.

    Parameters

    Returns void

submit

Settings

Member Visibility

On This Page

Constructors
Methods