ol-ext

Class: SearchWikipedia

ol.control. SearchWikipedia

Search places using the MediaWiki API.

new SearchWikipedia( [Control])

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 1000.
options.minLength integer | undefined

minimum length to start searching, default 3
options.maxItems integer | undefined

maximum number of items to display in the autocomplete list, default 10
options.handleResponse function | undefined

Handle server response to pass the features array to the list
options.lang string | undefined

API language, default none
See:
Fires:
  • event:select

Extends

Members

_history

Current history

Inherited From:
Overrides:

Methods

_getTitleTxt(f)

Returns title as text

Parameters:
Name Type Description
f any

feature to be displayed
Inherited From:
Overrides:
Returns:
Type
string

ajax(url, data, cback)

Send ajax request

Parameters:
Name Type Description
url string
data *
cback function

a callback function that takes an array of {name, feature} to display in the autocomplete field
Inherited From:
Overrides:

autocomplete(s, cback)

Autocomplete function (ajax request to the server)

Parameters:
Name Type Description
s string

search string
cback function

a callback function that takes an array of {name, feature} to display in the autocomplete field
Inherited From:
Overrides:

clearHistory()

Remove previous history

Inherited From:
Overrides:

collapse( [b])

Collapse the search

Parameters:
Name Type Argument Default Description
b boolean <optional>
 true
Inherited From:
Overrides:

equalFeatures(f1, f2)

Test if 2 features are equal

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

getHistory()

Get history table

Inherited From:
Overrides:

getInputField()

Get the input field

Inherited From:
Overrides:
Returns:
Type
Element

getTitle(f)

Returns the text to be displayed in the menu

Parameters:
Name Type Description
f ol.Feature

the feature
Overrides:
Returns:

the text to be displayed in the index

Type
string

handleResponse(response)

Handle server response to pass the features array to the list

Parameters:
Name Type Description
response any

server response
Overrides:
Returns:

an array of feature

Type
Array.<any>

requestData(s)

Parameters:
Name Type Description
s string

the search string
Overrides:
Returns:

request data (as key:value)

Type
Object

restoreHistory()

Restore history (from the localstorage)

Inherited From:
Overrides:

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:
Overrides:

saveHistory()

Save history (in the localstorage)

Inherited From:
Overrides:

Force search to refresh

Inherited From:
Overrides:

select(f)

A ligne has been clicked in the menu query for more info and disatch event

Parameters:
Name Type Description
f any

the feature, as passed in the autocomplete
Overrides:

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:
Overrides:

setLang(lang)

Set the current language

Parameters:
Name Type Description
lang string

the current language as ISO string (en, fr, de, es, it, ja, ...)

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:
Overrides: