Gazetteer

ol-ishare/control/gazetteer~ Gazetteer

Auto-complete address search control for use with an OpenLayers map

Constructor

new Gazetteer(options)

Autocomplete Gazetteer search map control

Parameters:
Name Type Description
options Object

Gazetteer options

Properties
Name Type Description
target String

DOM element that the control will be created within

iShareUrl String

Base URL for iShare Web app. If iShareUrl and profile options are not supplied then one or more module:ol-ishare/ui/gazetteer~GazetteerSource instances must be specified via the sources option.

profile String

Name of profile that the search is associated with. If iShareUrl and profile options are not supplied then one or more module:ol-ishare/ui/gazetteer~GazetteerSource instances must be specified via the sources option.

sources Array.<module:ol-ishare/ui/gazetteer~GazetteerSource>

List of GazetteerSource instances that will be queried for results. See module:ol-ishare/search~AddressSearch and module:ol-ishare/search~LayerSearch for examples of classes that implement GazetteerSource

placeholder String

Placeholder text displayed by the input