Class: SearchGPS

ol.control. SearchGPS


new SearchGPS( [Control])

Search on GPS coordinate.

Parameters:
Name Type Argument Description
Control Object <optional>

options.

options.className string

control class name

options.target Element | string | undefined

Specify a target if you want the control to be rendered outside of the map's viewport.

options.label string | undefined

Text label to use for the search button, default "search"

options.placeholder string | undefined

placeholder, default "Search..."

options.typing number | undefined

a delay on each typing to start searching (ms), default 300.

options.minLength integer | undefined

minimum length to start searching, default 1

options.maxItems integer | undefined

maximum number of items to display in the autocomplete list, default 10

Fires:
  • event:select

Extends

Members


_history

Current history

Inherited From:

Methods


autocomplete(s)

Autocomplete function

Parameters:
Name Type Description
s string

search string

Overrides:
Returns:

an array of search solutions

Type
Array.<any> | false

clearHistory()

Remove previous history

Inherited From:

equalFeatures(f1, f2)

Test if 2 features are equal

Parameters:
Name Type Description
f1 any
f2 any
Inherited From:
Returns:
Type
boolean

getHistory()

Get history table

Inherited From:

getInputField()

Get the input field

Inherited From:
Returns:
Type
Element

getTitle(f)

Returns the text to be displayed in the menu

Parameters:
Name Type Description
f any

feature to be displayed

Inherited From:
Returns:

the text to be displayed in the index, default f.name

Type
string

restoreHistory()

Restore history (from the localstorage)

Inherited From:

reverseGeocode(coord, cback)

Reverse geocode

Parameters:
Name Type Description
coord ol.coordinate
cback function | undefined

a callback function, default trigger a select event

Inherited From:

saveHistory()

Save history (in the localstorage)

Inherited From:

Force search to refresh

Inherited From:

select(f)

A ligne has been clicked in the menu > dispatch event

Parameters:
Name Type Description
f any

the feature, as passed in the autocomplete

Inherited From:

setInput(value, search)

Set the input value in the form (for initialisation purpose)

Parameters:
Name Type Description
value string
search boolean

to start a search

Inherited From:

setMap(map)

Remove the control from its current map and attach it to the new map. Subclasses may set up event handlers to get notified about changes to the map here.

Parameters:
Name Type Description
map ol.Map

Map.

Inherited From: