Class Mapbox

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

Hierarchy (view full)

MapLibre
- Mapbox

Index

Constructors

Methods

attachMap close destroy getDefaultPosition getValue onAdd search setValue showError showResults submit

Constructors

constructor

new Mapbox(options?): Mapbox
Parameters
- Optional options: JawgPlacesMaplibreOptions
Returns Mapbox
Inherited from MapLibre.constructor
- Defined in src/places-js.d.ts:508

Methods

attachMap

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

close

close(): void
Close the result list.

Returns void
Inherited from MapLibre.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 MapLibre.destroy
- Defined in src/places-js.d.ts:51

getDefaultPosition

getDefaultPosition(): "top-left"
The default position of the control in the map.

Returns "top-left"
Inherited from MapLibre.getDefaultPosition
- Defined in src/places-js.d.ts:526

getValue

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

onAdd

onAdd(map): HTMLElement
This is the function used by MapLibre and Mapbox when you add a maplibre.IControl or mapboxgl.IControl. Adds the control to the given map.
Parameters
- map: Map | Map
  The map from MapLibre or Mapbox
Returns HTMLElement
The generated control container
Inherited from MapLibre.onAdd
- Defined in src/places-js.d.ts:516

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 MapLibre.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 MapLibre.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 MapLibre.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 MapLibre.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 MapLibre.submit
- Defined in src/places-js.d.ts:23

Generated using TypeDoc