Class: SearchEngine

new SearchEngine(options)

Ol3/Controls/SearchEngine.js, line 67

Name

Type

Description

options

Object

control options

Name

Type

Default

Description

apiKey

String

optional

API key, mandatory if autoconf service has not been charged in advance

collapsed

Boolean

true

optional

collapse mode, true by default

resources

Object

optional

resources to be used by geocode and autocompletion services :

Name	Type	Description
geocode	Array	optional resources geocoding, by default : ["PositionOfInterest", "StreetAddress"]
autocomplete	Array	optional resources autocompletion, by default : ["PositionOfInterest", "StreetAddress"]

displayAdvancedSearch

Boolean

true

optional

False to disable advanced search tools (it will not be displayed). Default is true (displayed)

advancedSearch

Object

optional

advanced search options for geocoding (filters). Properties can be found among geocode options.filterOptions (see Gp.Services.geocode)

geocodeOptions

Object

{}

optional

options of geocode service (see Gp.Services.geocode)

autocompleteOptions

Object

{}

optional

options of autocomplete service (see Gp.Services.autoComplete

zoomTo

Sting | Numeric | function

optional

zoom to results, by default, current zoom.
Value possible : auto or zoom level.
Possible to overload it with a function :
zoomTo : function (info) {
// do some stuff...
return zoom;
}

Example

var SearchEngine = ol.control.SearchEngine({
     apiKey : "CLEAPI",
     collapsed : true,
     resources : {
         geocode : ["StreetAddress", "PositionOfInterest"],
         autocomplete : ["StreetAddress"]
     },
     advancedSearch : {
         PositionOfInterest : [{name : "municipality", title : "Ville"}],
         StreetAddress : [{...}]
     },
     geocodeOptions : {},
     autocompleteOptions : {}
 });

Extends

ol.control.Control

Members

collapsed

{Boolean} specify if searchEngine control is collapsed (true) or not (false)

Methods

getCollapsed(){Boolean} Ol3/Controls/SearchEngine.js, line 128

Returns true if widget is collapsed (minimized), false otherwise

Returns:

- true if widget is collapsed

setCollapsed(collapsed) Ol3/Controls/SearchEngine.js, line 137

Collapse or display widget main container

Name	Type	Description
collapsed	Boolean	True to collapse widget, False to display it