ol-ext

Class: SearchGeoportail

ol.control. SearchGeoportail

Search places using the French National Base Address (BAN) API.

new SearchGeoportail(options)

Parameters:
Name Type Description
options any

extend ol.control.SearchJSON options

Properties
Name Type Argument Description
className string

control class name
apiKey string | undefined <optional>

the service api key.
version string | undefined <optional>

API version 1 or 2 or geoplateforme (latest), default latest
authentication: string | undefined

basic authentication for the service API as btoa("login:pwd")
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"
reverse boolean | undefined

enable reverse geocoding, default false
placeholder string | undefined

placeholder, default "Search..."
typing number | undefined

a delay on each typing to start searching (ms), default 500.
minLength integer | undefined

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

maximum number of items to display in the autocomplete list, default 10
type StreetAddress | PositionOfInterest | CadastralParcel | Commune <optional>

type of search. Using Commune will return the INSEE code, default StreetAddress,PositionOfInterest
terr string <optional>

territory METROPOLE|DOMTOM|dep code
position boolean <optional>

Search, with priority to geo position (map center), default false
bbox ol.extent <optional>

if set search inside the bbox (in map projection)
useExtent boolean <optional>

returns candidates inside the current map extent, default false
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 display 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, options)

Reverse geocode

Parameters:
Name Type Description
coord ol.coordinate
options function | *

callback function called when revers located or options passed to the select event
Overrides:

saveHistory()

Save history (in the localstorage)

Inherited From:
Overrides:

Force search to refresh

Inherited From:
Overrides:

searchCommune(s)

Search if no position and get the INSEE code

Parameters:
Name Type Description
s string

le nom de la commune

select(f, reverse, coord, options)

A ligne has been clicked in the menu > dispatch event

Parameters:
Name Type Description
f any

the feature, as passed in the autocomplete
reverse boolean

true if reverse geocode
coord ol.coordinate
options *

options passed to the event
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:

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: