Class default

A geocoder component that works with maplibre

Constructors

constructor

new default(
geocoderApi: MaplibreGeocoderApi,
options: MaplibreGeocoderOptions,
): default
Parameters
- geocoderApi: MaplibreGeocoderApi
- options: MaplibreGeocoderOptions
Returns default
- Defined in index.ts:363

Methods

_collapse

_collapse(): void
Returns void
- Defined in index.ts:1034

_geocode

_geocode(
    searchInput: string,
    isSuggestion?: boolean,
    isPlaceId?: boolean,
): Promise<MaplibreGeocoderResults>
Parameters
- searchInput: string
- isSuggestion: boolean = false
- isPlaceId: boolean = false
Returns Promise<MaplibreGeocoderResults>
- Defined in index.ts:799

_getConfigForRequest

_getConfigForRequest(): MaplibreGeocoderApiConfig
Returns MaplibreGeocoderApiConfig
- Defined in index.ts:761

_hideButton

_hideButton(): void
Returns void
- Defined in index.ts:670

_onBlur

_onBlur(e: any): void
Parameters
- e: any
Returns void
- Defined in index.ts:674

_onChange

_onChange(): void
Returns void
- Defined in index.ts:686

_onKeyDown

_onKeyDown(e: any): void | "none"
Parameters
- e: any
Returns void | "none"
- Defined in index.ts:607

_onPaste

_onPaste(e: any): void
Parameters
- e: any
Returns void
- Defined in index.ts:597

_onQueryResult

_onQueryResult(results: MaplibreGeocoderResults): void
Parameters
- results: MaplibreGeocoderResults
Returns void
- Defined in index.ts:1009

_renderError

_renderError(): void
Returns void
- Defined in index.ts:1057

_renderMessage

_renderMessage(msg: any): void
Parameters
- msg: any
Returns void
- Defined in index.ts:1070

_renderNoResults

_renderNoResults(): void
Returns void
- Defined in index.ts:1063

_showButton

_showButton(): void
Returns void
- Defined in index.ts:666

_unCollapse

_unCollapse(): void
Returns void
- Defined in index.ts:1042

_updateProximity

_updateProximity(): void
Returns void
- Defined in index.ts:1020

addTo

addTo(container: string | Map$1 | HTMLElement): void
Add the geocoder to a container. The container can be either a Map, an HTMLElement or a CSS selector string.

If the container is a Map, this function will behave identically to Map.addControl(geocoder). If the container is an instance of HTMLElement, then the geocoder will be appended as a child of that HTMLElement. If the container is a CSS selector string, the geocoder will be appended to the element returned from the query.

This function will throw an error if the container is none of the above. It will also throw an error if the referenced HTML element cannot be found in the document.body.

For example, if the HTML body contains the element <div id='geocoder-container'></div>, the following script will append the geocoder to #geocoder-container:
Parameters
- container: string | Map$1 | HTMLElement
  A reference to the container to which to add the geocoder
Returns void
Example
```
const GeoApi = {
  forwardGeocode: (config) => { return { features: [] } },
  reverseGeocode: (config) => { return { features: [] } }
}
const geocoder = new MaplibreGeocoder(GeoAPI, {});
geocoder.addTo('#geocoder-container');
```
- Defined in index.ts:393

clear

clear(ev?: Event): void
Clear and then focus the input.
Parameters
- Optionalev: Event
  the event that triggered the clear, if available
Returns void
- Defined in index.ts:984

createIcon

createIcon(name: string, path: string): SVGSVGElement
Parameters
- name: string
- path: string
Returns SVGSVGElement
- Defined in index.ts:559

getBbox

getBbox(): number[]
Get the bounding box used by the plugin

Returns number[]
the bounding box, if any
- Defined in index.ts:1255

getCountries

getCountries(): string
Get a list of the countries to limit search results to

Returns string
a comma separated list of countries to limit to, if any
- Defined in index.ts:1272

getFilter

getFilter(): (feature: CarmenGeojsonFeature) => boolean
Get the filter function used by the plugin

Returns (feature: CarmenGeojsonFeature) => boolean
the filter function
- Defined in index.ts:1342

getFlyTo

getFlyTo(): boolean | FlyToOptions
Get the parameters used to fly to the selected response, if any

Returns boolean | FlyToOptions
The flyTo option
- Defined in index.ts:1219

getGeocoderApi

getGeocoderApi(): MaplibreGeocoderApi
Get the geocoding endpoint the plugin is currently set to

Returns MaplibreGeocoderApi
the geocoding API
- Defined in index.ts:1367

getLanguage

getLanguage(): string
Get the language to use in UI elements and when making search requests

Returns string
The language(s) used by the plugin, if any
- Defined in index.ts:1193

getLimit

getLimit(): number
Get the limit value for the number of results to display used by the plugin

Returns number
The limit value for the number of results to display used by the plugin
- Defined in index.ts:1324

getMinLength

getMinLength(): number
Get the minimum number of characters typed to trigger results used in the plugin

Returns number
The minimum length in characters before a search is triggered
- Defined in index.ts:1306

getPlaceholder

getPlaceholder(): string
Get the value of the placeholder string

Returns string
The input element's placeholder value
- Defined in index.ts:1236

getProximity

getProximity(): { latitude: number; longitude: number }
Get proximity

Returns { latitude: number; longitude: number }
The geocoder proximity
- Defined in index.ts:1154

getRenderFunction

getRenderFunction(): (feature: CarmenGeojsonFeature) => string
Get the function used to render the results dropdown

Returns (feature: CarmenGeojsonFeature) => string
the render function
- Defined in index.ts:1174

getTypes

getTypes(): string
Get a list of the types to limit search results to

Returns string
a comma separated list of types to limit to
- Defined in index.ts:1289

getZoom

getZoom(): number
Get the zoom level the map will move to when there is no bounding box on the selected result

Returns number
the map zoom
- Defined in index.ts:1201

off

off(type: string, fn: (e: any) => void): this
Remove an event
Parameters
- type: string
  Event name.
- fn: (e: any) => void
  Function that should unsubscribe to the event emitted.
Returns this
- Defined in index.ts:1538

on

on(type: string, fn: (e: any) => void): this
Subscribe to events that happen within the plugin.
Parameters
- type: string
  name of event. Available events and the data passed into their respective event objects are:
  
  clear Emitted when the input is cleared
  
  loading { query } Emitted when the geocoder is looking up a query
  
  results { results } Fired when the geocoder returns a response
  
  result { result } Fired when input is set
  
  error { error } Error as string
- fn: (e: any) => void
  function that's called when the event is emitted.
Returns this
- Defined in index.ts:1510

onAdd

onAdd(map?: Map$1): HTMLElement
Parameters
- Optionalmap: Map$1
Returns HTMLElement
- Defined in index.ts:432

once

once(type: string): Promise<any>
Subscribe to events that happen within the plugin only once.
Parameters
- type: string
  Event name. Available events and the data passed into their respective event objects are:
  
  clear Emitted when the input is cleared
  
  loading { query } Emitted when the geocoder is looking up a query
  
  results { results } Fired when the geocoder returns a response
  
  result { result } Fired when input is set
  
  error { error } Error as string
Returns Promise<any>
a Promise that resolves when the event is emitted.
- Defined in index.ts:1527

onRemove

onRemove(): default
Returns default
- Defined in index.ts:583

query

query(searchInput: string): Promise<void>
Set & query the input
Parameters
- searchInput: string
  location name or other search input
Returns Promise<void>
- Defined in index.ts:1052

setBbox

setBbox(bbox: [number, number, number, number]): this
Set the bounding box to limit search results to
Parameters
- bbox: [number, number, number, number]
  a bounding box given as an array in the format [minX, minY, maxX, maxY].
Returns this
- Defined in index.ts:1263

setCountries

setCountries(countries: string): this
Set the countries to limit search results to
Parameters
- countries: string
  a comma separated list of countries to limit to
Returns this
- Defined in index.ts:1280

setFilter

setFilter(filter: (feature: CarmenGeojsonFeature) => boolean): this
Set the filter function used by the plugin.
Parameters
- filter: (feature: CarmenGeojsonFeature) => boolean
  A function which accepts a CarmenGeojsonFeature to filter out results from the Geocoding API response before they are included in the suggestions list. Return true to keep the item, false otherwise.
Returns this
- Defined in index.ts:1350

setFlyTo

setFlyTo(flyTo: boolean | FlyToOptions): this
Set the flyTo options
Parameters
- flyTo: boolean | FlyToOptions
  If false, animating the map to a selected result is disabled. If true, animating the map will use the default animation parameters. If an object, it will be passed as options to the map flyTo or fitBounds method providing control over the animation of the transition.
Returns this
- Defined in index.ts:1227

setGeocoderApi

setGeocoderApi(geocoderApi: MaplibreGeocoderApi): this
Set the geocoding api used by the plugin.
Parameters
- geocoderApi: MaplibreGeocoderApi
Returns this
- Defined in index.ts:1358

setInput

setInput(searchInput: string): this
Set input
Parameters
- searchInput: string
  location name or other search input
Returns this
- Defined in index.ts:1127

setLanguage

setLanguage(language?: string): this
Get the language to use in UI elements and when making search requests

Look first at the explicitly set options otherwise use the browser's language settings
Parameters
- Optionallanguage: string
  Specify the language to use for response text and query result weighting. Options are IETF language tags comprised of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas.
Returns this
- Defined in index.ts:1184

setLimit

setLimit(limit: number): this
Set the limit value for the number of results to display used by the plugin
Parameters
- limit: number
  the number of search results to return
Returns this
- Defined in index.ts:1332

setMinLength

setMinLength(minLength: number): this
Set the minimum number of characters typed to trigger results used by the plugin
Parameters
- minLength: number
  the minimum length in characters
Returns this
- Defined in index.ts:1314

setPlaceholder

setPlaceholder(placeholder?: string): this
Set the value of the input element's placeholder
Parameters
- Optionalplaceholder: string
  the text to use as the input element's placeholder
Returns this
- Defined in index.ts:1244

setProximity

setProximity(proximity: { latitude: number; longitude: number }): this
Set proximity
Parameters
- proximity: { latitude: number; longitude: number }
  The new options.proximity value. This is a geographical point given as an object with latitude and longitude properties.
Returns this
- Defined in index.ts:1145

setRenderFunction

setRenderFunction(fn: (feature: CarmenGeojsonFeature) => string): this
Set the render function used in the results dropdown
Parameters
- fn: (feature: CarmenGeojsonFeature) => string
  The function to use as a render function. This function accepts a single CarmenGeojsonFeature object as input and returns a string.
Returns this
- Defined in index.ts:1162

setTypes

setTypes(types: string): this
Set the types to limit search results to
Parameters
- types: string
  a comma separated list of types to limit to
Returns this
- Defined in index.ts:1297

setZoom

setZoom(zoom: number): this
Set the zoom level
Parameters
- zoom: number
  The zoom level that the map should animate to when a bbox isn't found in the response. If a bbox is found the map will fit to the bbox.
Returns this
this
- Defined in index.ts:1210

Class default

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

_collapse

Returns void

_geocode

Parameters

Returns Promise<MaplibreGeocoderResults>

_getConfigForRequest

Returns MaplibreGeocoderApiConfig

_hideButton

Returns void

_onBlur

Parameters

Returns void

_onChange

Returns void

_onKeyDown

Parameters

Returns void | "none"

_onPaste

Parameters

Returns void

_onQueryResult

Parameters

Returns void

_renderError

Returns void

_renderMessage

Parameters

Returns void

_renderNoResults

Returns void

_showButton

Returns void

_unCollapse

Returns void

_updateProximity

Returns void

addTo

Parameters

Returns void

Example

clear

Parameters

Returns void

createIcon

Parameters

Returns SVGSVGElement

getBbox

Returns number[]

getCountries

Returns string

getFilter

Returns (feature: CarmenGeojsonFeature) => boolean

getFlyTo

Returns boolean | FlyToOptions

getGeocoderApi

Returns MaplibreGeocoderApi

getLanguage

Returns string

getLimit

Returns number

getMinLength

Returns number

getPlaceholder

Returns string

getProximity

Returns { latitude: number; longitude: number }

getRenderFunction

Returns (feature: CarmenGeojsonFeature) => string

getTypes

Returns string

getZoom