ol-ext

Class: Search

ol.control. Search

Search Control. This is the base class for search controls. You can use it for simple custom search or as base to new class.

Parameters:
Name Type Argument Description
options Object <optional>
Properties
Name Type Description
className string

control class name
target Element | string | undefined

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

Text label to use for the search button, default "search"
placeholder string | undefined

placeholder, default "Search..."
inputLabel string | undefined

label for the input, default none
noCollapse string | undefined

prevent collapsing on input blur, default false
typing number | undefined

a delay on each typing to start searching (ms) use -1 to prevent autocompletion, default 300.
minLength integer | undefined

minimum length to start searching, default 1
maxItems integer | undefined

maximum number of items to display in the autocomplete list, default 10
maxHistory integer | undefined

maximum number of items to display in history. Set -1 if you don't want history, default maxItems
getTitle function

a function that takes a feature and return the name to display in the index.
autocomplete function

a function that take a search string and callback function to send an array
See:
Fires:
  • event:select
  • change:input

Extends

Methods

autocomplete(s, cback)

Autocomplete function

Parameters:
Name Type Description
s string

search string
cback function

a callback function that takes an array to display in the autocomplete field (for asynchronous search)
Returns:

an array of search solutions or false if the array is send with the cback argument (asnchronous)

Type
Array | false

clearHistory()

Remove previous history

equalFeatures(f1, f2)

Test if 2 features are equal

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

getHistory()

Get history table

getTitle(f)

Returns the text to be displayed in the menu

Parameters:
Name Type Description
f any

feature to be displayed
Returns:

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

Type
string

restoreHistory()

Restore history (from the localstorage)

saveHistory()

Save history (in the localstorage)

Force search to refresh

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

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