Class: Address

Extends

• cercalia.control.Control

Methods

changed() inherited

src/ol/observable.js, line 58

Increases the revision counter and dispatches a 'change' event.

clean()

src/cercalia/control/address.js, line 371

closePopup()

src/cercalia/control/address.js, line 381

directionTo()

src/cercalia/control/address.js, line 115

Set destination current address.

disable() inherited

src/cercalia/control/control.js, line 130

dispatchEvent(event) inherited

src/ol/observable.js, line 75

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
event	Object | ol.events.Event | string	Event object.

enable() inherited

src/cercalia/control/control.js, line 123

get(key){*} inherited

src/ol/object.js, line 101

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getCercaliaMap(){cercalia.Map} inherited

src/cercalia/control/control.js, line 82

Returns:

Cercalia map.

getClass(){string} inherited

src/cercalia/control/control.js, line 65

Get class name.

Returns:

Class name.

getCurrentAddress(){cercaliax.GeEntity}

src/cercalia/control/address.js, line 446

Returns:

ge GeEntity.

getDirection(evnt, lonLat, hideMarker, hidePopup)

src/cercalia/control/address.js, line 232

Name	Type	Description
evnt	Event | null	Event.
lonLat	cercalia.LonLat	Position
hideMarker	boolean	Disables the default option to create a marker on the position
hidePopup	boolean	Disables the default option to show a popup with the position information

getId(){string} inherited

src/cercalia/control/control.js, line 56

Get Id

Returns:

Id.

getKeys(){} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:

List of property names.

getMap(){ol.PluggableMap} inherited

src/ol/control/control.js, line 94

Get the map associated with this control.

Returns:

Map.

getName(){string|null} inherited

src/cercalia/control/control.js, line 74

Get control name. Null if control has not defined name.

Returns:

Class name.

getProperties(){} inherited

src/ol/object.js, line 125

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited

src/ol/observable.js, line 84

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getViewInterface(){cercalia.control.ViewInterface} inherited

src/cercalia/control/control.js, line 100

Returns:

Interface

goToCoordinates(lonLat, opt_panTo)

src/cercalia/control/address.js, line 307

Name	Type	Description
lonLat	cercalia.LonLat	Position.
panTo	boolean	Pan Zoom to position.

goToGeEntity(ge, opt_panTo)

src/cercalia/control/address.js, line 150

Open a direction using GeEntity from server response.

Name	Type	Description
ge	GeEntity. Name Type Description article string | null | undefined city cercaliax.ObjectJSON | null | undefined coord cercaliax.Coord | null | undefined country cercaliax.ObjectJSON | null | undefined dist string | null | undefined frc string | null | undefined housenumber cercaliax.ObjectJSON | null | undefined id string | null | undefined intersection cercaliax.ObjectJSON | null | undefined kmh string | null | undefined label string | null | undefined municipality cercaliax.ObjectJSON | null | undefined name cercaliax.ObjectJSON | null | undefined pos string | null | undefined postalcode cercaliax.ObjectJSON | null | undefined prefix string | null | undefined region cercaliax.ObjectJSON | null | undefined sname string | null | undefined subcategory_id cercaliax.ObjectJSON | null | undefined subregion cercaliax.ObjectJSON | null | undefined zonename string | null | undefined zonetype string | null | undefined
panTo	boolean	Pan Zoom to position.

goToPostalcode(countryId, pcode, opt_panTo)

src/cercalia/control/address.js, line 326

Name	Type	Description
countryId	string	Country Id. For example: ESP or FRA.
pcode	string	Postal code.
panTo	boolean	Optional pan to location.

hide() inherited

src/cercalia/control/control.js, line 108

Hide control.

on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

Listen for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

Listen once for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited

src/ol/object.js, line 150

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean	Update without triggering an event.

setMap(map) inherited

src/ol/control/control.js, line 107

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.

Name	Type	Description
map	ol.PluggableMap	Map.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
values		Values.
silent	boolean	Update without triggering an event.

setSearchAddressCallbackFunction(callbackFn)

src/cercalia/control/address.js, line 258

Add a custom callback function called when a address is searched via context menu map. This function will receive LonLat and ProximityResult

Name	Type	Description
callbackFn	function | null	Callback function

setTarget(target) inherited

src/ol/control/control.js, line 138

This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.

Name	Type	Description
target	Element | string	Target.

setViewInterface(viewInterface) inherited

src/cercalia/control/control.js, line 92

Name	Type	Description
viewInterface	cercalia.control.ViewInterface	Interface control.

show() inherited

src/cercalia/control/control.js, line 116

Show control.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

Unlisten for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object which was used as this by the listener.

unset(key, opt_silent) inherited

src/ol/object.js, line 184

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean	Unset without triggering an event.