Class: ViewInterface

cercalia.control.ViewInterface


Hidden control. It is usefull to manager other controls.

new cercalia.control.ViewInterface(opt_options)

src/cercalia/control/viewinterface.js, line 32
Name Type Description
options

View interface options

Name Type Description
mapLayers Array.<string> | undefined

Maps array to be painted. Admitted values: cercalia.MapTypes.CERCALIA
cercalia.MapTypes.OSM
cercalia.MapTypes.SATELLITE

showCoordinatesInDMS boolean | undefined

Show coordinates in DMS (Degree, minutes, seconds). Default false.

scaleUnits string | undefined

Scale units. Available values cercalia.MetricSystem.METRIC|cercalia.MetricSystem.IMPERIAL|cercalia.MetricSystem.NAUTIC_MILES. Default cercalia.MetricSystem.METRIC.

Fires:

Extends

Methods

addControl(control)

src/cercalia/control/viewinterface.js, line 380
Name Type Description
control cercalia.control.Control

Control.

changed() inherited

src/ol/observable.js, line 58

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

closeAll()

src/cercalia/control/viewinterface.js, line 319

Close all windows and reset navbar.

closeDialogs(opt_control)

src/cercalia/control/viewinterface.js, line 407

Close and disable controls with dialog. Only one control can be enabled.

Name Type Description
control cercalia.control.Control

Control.

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.

getAddressControl(){cercalia.control.Address}

src/cercalia/control/viewinterface.js, line 458
Returns:
Address control.

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.

getControls(){}

src/cercalia/control/viewinterface.js, line 398

Get the map controls.

Returns:
Controls.

getControlsByClassName(className){}

src/cercalia/control/viewinterface.js, line 423

Get control by class name.

Name Type Description
className string

Classname.

Returns:
control Control. null if not found.

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.

getTopContainer(){Element}

src/cercalia/control/viewinterface.js, line 491

Get controls container.

Returns:
Element.

getViewInterface(){cercalia.control.ViewInterface} inherited

src/cercalia/control/control.js, line 100
Returns:
Interface

hide() inherited

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

Hide control.

hideAll()

src/cercalia/control/viewinterface.js, line 474

Hide all controls.

initializeMapControls(options)

src/cercalia/control/viewinterface.js, line 187
Name Type Description
options Array.<string> | null

Options

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.

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.

showAll()

src/cercalia/control/viewinterface.js, line 482

Show all controls.

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.