new cercalia.control.Address()
Fires:
-
change
(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
propertychange
(ol.Object.Event) - Triggered when a property is changed.
Extends
Methods
-
Increases the revision counter and dispatches a 'change' event.
-
clean()
src/cercalia/control/address.js, line 304 -
-
closePopup()
src/cercalia/control/address.js, line 314 -
-
directionTo()
src/cercalia/control/address.js, line 96 -
Set destination current address.
-
-
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.
-
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
Returns:
Cercalia map.
-
Get class name.
Returns:
Class name.
-
Returns:
ge GeEntity.
-
getDirection(evnt, lonLat, hideMarker, hidePopup)
src/cercalia/control/address.js, line 187 -
Name Type Description evnt
Event | null Event.
lonLat
cercalia.LonLat Position
hideMarker
boolean Disables the default option to create a marker on the position, false by default
hidePopup
boolean Disables the default option to show a popup with the position information, false by default
-
Get Id
Returns:
Id.
-
Get a list of object property names.
Returns:
List of property names.
-
Get the map associated with this control.
Returns:
Map.
-
Get control name. Null if control has not defined name.
Returns:
Class name.
-
Get an object of all property names and values.
Returns:
Object.
-
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 240 -
Name Type Description lonLat
cercalia.LonLat Position.
panTo
boolean Pan Zoom to position.
-
goToGeEntity(ge, opt_panTo)
src/cercalia/control/address.js, line 131 -
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 259 -
Name Type Description countryId
string Country Id. For example:
ESP
orFRA
.pcode
string Postal code.
panTo
boolean Optional pan to location.
-
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
inlistener
.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
inlistener
.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.
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean Update without triggering an event.
-
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.
-
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
Object.<string, *> Values.
silent
boolean Update without triggering an event.
-
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 notarget
is set in the options passed to the control constructor and ifsetTarget
is not called then the control is added to the map's overlay container.Name Type Description target
Element | string Target.
-
Name Type Description viewInterface
cercalia.control.ViewInterface Interface control.
-
Show control.
-
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 thelistener
. -
Unsets a property.
Name Type Description key
string Key name.
silent
boolean Unset without triggering an event.