Class: Layer

Core.ModelList.Layer Layer

Layer

abstractnew Layer()

modules/core/modelList/layer/model.js, line 77
Module to represent any layer
Properties:
Name Type Default Description
channel Radio.channel Radio.channel("Layer") Radio channel of layer
isVisibleInMap Boolean false Flag if layer is visible in map
isSelected Boolean false Flag if model is selected in layer tree
isSettingVisible Boolean false Flag if settings (transparency,...) are visible in tree
transparency Number 0 Transparency in percent
layerOrder Number 0 Layer order
layerInfoClicked Boolean false Flag if layerInfo was clicked
singleBaselayer Boolean false Flag if only a single baselayer should be selectable at once
minScale String "0" Minimum scale for layer to be displayed
maxScale String "1000000" Maximum scale for layer to be displayed
legendURL String "" LegendURL to request legend from
supported Array.<String> ["2D" Array of Strings to show supported modes "2D" and "3D"
showSettings Boolean true Flag if layer settings have to be shown
hitTolerance Number 0 Hit tolerance used by layer for map interaction
previewURL String URL for the static backgroundSwitcher image.
styleable Boolean false Flag if wms layer can be styleable via stylewms tool
isNeverVisibleInTree Boolean false Flag if layer is never visible in layertree
Fires:
Listens to Events:

Extends

Methods

checkForScale(options){void}

modules/core/modelList/layer/model.js, line 123
Prüft anhand der Scale ob der Layer sichtbar ist oder nicht
Name Type Description
options object -

checkIfDataLayer(dataLayerId, layerId){Boolean}

modules/core/modelList/layer/model.js, line 110
Checks if dataLayerId matches the given layer id.
Name Type Description
dataLayerId String Id of dataLayer whose features are requested.
layerId String Id of current layer.
Returns:
flag if dataLayerId matches given layer id.

decTransparency(){void}

modules/core/modelList/layer/model.js, line 398
Decreases layer transparency by 10 percent

featuresLoaded(features){void}

modules/core/modelList/layer/model.js, line 138
Triggers event if vector features are loaded
Name Type Description
features Array.<ol.Feature> Loaded vector features
Fires:

featureUpdated(feature){void}

modules/core/modelList/layer/model.js, line 243
Triggers event if vector feature is loaded
Name Type Description
feature ol.Feature Updated vector feature
Fires:

getResolutions(){void}

modules/core/modelList/layer/model.js, line 376
Sets visible min and max resolution on layer.
Fires:

incTransparency(){void}

modules/core/modelList/layer/model.js, line 388
Increases layer transparency by 10 percent

intervalHandler(){void}

modules/core/modelList/layer/model.js, line 366
Callback for layer interval

isLayerSourceValid(){Boolean}

modules/core/modelList/layer/model.js, line 584
Checks if the layerSource has been setup and a layersource object exist

isLayerValid(){Boolean}

modules/core/modelList/layer/model.js, line 576
Checks if the layer has been setup and a layer object exist

prepareFeaturesFor3D(features){void}

modules/core/modelList/layer/model.js, line 147
Prepares the given features and sets or/and overwrites the coordinates based on the configuration of "altitude" and "altitudeOffset".
Name Type Description
features Array.<ol/Feature> The olFeatures.

prepareLayerObject(){void}

modules/core/modelList/layer/model.js, line 251
Process function. Calls smaller function to prepare and create layer object

registerInteractionMapViewListeners(){void}

modules/core/modelList/layer/model.js, line 343
Register interaction with map view.
Listens to Events:

registerInteractionTreeListeners(channel){void}

modules/core/modelList/layer/model.js, line 274
Register interaction with layer tree.
Name Type Description
channel Radio.channel Radio channel of this module
Listens to Events:

removeLayer(){void}

modules/core/modelList/layer/model.js, line 759
Removes the layer from the map and the collection

resetLayerOrder(){void}

modules/core/modelList/layer/model.js, line 603
Resets layerOrder property; 0 is defined as initial value and the layer will be acknowledged as newly added for the sake of initial positioning

setAltitudeOnGeometry(geometry, altitude, altitudeOffset){ol/geom}

modules/core/modelList/layer/model.js, line 168
Sets the altitude and AltitudeOffset as z coordinate.
Name Type Description
geometry ol/geom Geometry of feature.
altitude Number Altitude. Overwrites the given z coord if available.
altitudeOffset Number Altitude offset.
Returns:
The geometry with newly set coordinates.

setAltitudeOnMultiPoint(coords, altitude, altitudeOffset){Array.<Number>}

modules/core/modelList/layer/model.js, line 196
Sets the altitude on multipoint coordinates.
Name Type Description
coords Array.<Number> Coordinates.
altitude Number Altitude. Overwrites the given z coord if available.
altitudeOffset Number Altitude offset.
Returns:
newly set cooordinates.

setAltitudeOnPoint(coords, altitude, altitudeOffset){Array.<Number>}

modules/core/modelList/layer/model.js, line 213
Sets the altitude on point coordinates.
Name Type Description
coords Array.<Number> Coordinates.
altitude Number Altitude. Overwrites the given z coord if available.
altitudeOffset Number Altitude offset.
Returns:
newly set cooordinates.

inherited setGlyphicon(value){void}

modules/core/modelList/item.js, line 69
Setter for glyphicon
Name Type Description
value String Glyphicon

inherited setId(value){void}

modules/core/modelList/item.js, line 34
Setter for id
Name Type Description
value String Id

inherited setIsInThemen(value){void}

modules/core/modelList/item.js, line 78
Setter for isInThemen
Name Type Description
value Boolean Flag if item is in themen

setIsJustAdded(value){void}

modules/core/modelList/layer/model.js, line 751
Setter for isJustAdded (currently only used in uiStyle = table)
Name Type Description
value Boolean Flag if layer has just been added to the tree

setIsOutOfRange(value){void}

modules/core/modelList/layer/model.js, line 676
Setter for isOutOfRange
Name Type Description
value Boolean Flag if map Scale is out of defined layer minScale and maxScale

setIsRemovable(value){void}

modules/core/modelList/layer/model.js, line 740
Setter for isRemovable
Name Type Description
value Boolean Flag if layer is removable from the tree

setIsSelected(value){void}

modules/core/modelList/layer/model.js, line 649
Setter for isSelected
Name Type Description
value Boolean Flag if layer is selected

setIsSettingVisible(value){void}

modules/core/modelList/layer/model.js, line 658
Setter for isSettingVisible
Name Type Description
value Boolean Flag if layer settings are visible

setIsVisibleInMap(value){void}

modules/core/modelList/layer/model.js, line 639
Setter for isVisibleInMap and setter for layer.setVisible
Name Type Description
value Boolean Flag if layer is visible in map

inherited setIsVisibleInMenu(value){void}

modules/core/modelList/item.js, line 105
Setter for setIsVisibleInMenu
Name Type Description
value Boolean Flag if item is visible in menu

setIsVisibleInTree(value){void}

modules/core/modelList/layer/model.js, line 721
Setter for isVisibleInTree
Name Type Description
value Boolean Flag if layer is visible in tree

setLayer(value){void}

modules/core/modelList/layer/model.js, line 630
Setter for layer
Name Type Description
value ol/layer Layer

setLayerInfoChecked(value){void}

modules/core/modelList/layer/model.js, line 612
Setter for layerInfoChecked
Name Type Description
value Boolean Flag if layerInfo was checked

setLayerOrder(value){void}

modules/core/modelList/layer/model.js, line 594
Setter for layerOrder
Name Type Description
value String layerOrder

setLayerSource(value){void}

modules/core/modelList/layer/model.js, line 621
Setter for layerSource
Name Type Description
value ol/source LayerSource

setLegendURL(value){void}

modules/core/modelList/layer/model.js, line 712
Setter for legendURL
Name Type Description
value String legendURL

inherited setLevel(value){void}

modules/core/modelList/item.js, line 87
Setter for level
Name Type Description
value String Level

setMaxResolution(value){void}

modules/core/modelList/layer/model.js, line 685
Setter for ol/layer.setMaxResolution
Name Type Description
value Number Maximum resolution of layer

setMinResolution(value){void}

modules/core/modelList/layer/model.js, line 694
Setter for ol/layer.setMinResolution
Name Type Description
value Number Minimum resolution of layer

setName(value){void}

modules/core/modelList/layer/model.js, line 703
Setter for name
Name Type Description
value String Name of layer

inherited setParentId(value){void}

modules/core/modelList/item.js, line 43
Setter for parentId
Name Type Description
value String ParentId

setSingleBaselayer(value){void}

modules/core/modelList/layer/model.js, line 731
Setter for the singleBaselayer
Name Type Description
value Boolean Flag if only a single baselayer should be selectable at once

setTransparency(value){void}

modules/core/modelList/layer/model.js, line 667
Setter for transparency
Name Type Description
value Number Tranparency in percent

inherited setType(value){void}

modules/core/modelList/item.js, line 60
Setter for type
Name Type Description
value String Type

setVisible(value){void}

modules/core/modelList/layer/model.js, line 773
Setter for the layer visibility
Name Type Description
value Boolean new visibility value

setWindowsInterval(func, autorefreshInterval){void}

modules/core/modelList/layer/model.js, line 358
Setter of window interval. Binds this to func.
Name Type Description
func function Function, to be executed in this
autorefreshInterval integer Intervall in ms

showLayerInformation(){void}

modules/core/modelList/layer/model.js, line 545
Initiates the presentation of layer information.
Fires:

toggleAttributionsInterval(){void}

modules/core/modelList/layer/model.js, line 506
If attribution is defined as an object, then the attribution are requested in given intervals, as long as "isVisibleInMap" is true Is used for Verkehrslage auf den Autobahnen

toggleIsSelected(){void}

modules/core/modelList/layer/model.js, line 410
Toggles the attribute isSelected. If the layer is a baselayer, the other selected baselayers are deselected.

toggleIsSettingVisible(){void}

modules/core/modelList/layer/model.js, line 470
Toggles the attribute isSettingVisible

toggleIsVisibleInMap(){void}

modules/core/modelList/layer/model.js, line 438
Toggles the attribute isVisibleInMap

toggleLayerOnMap(){void}

modules/core/modelList/layer/model.js, line 484
Adds or removes layer from map, depending on attribute isSelected

toggleWindowsInterval(){void}

modules/core/modelList/layer/model.js, line 453
Toggles the layer interval based on attribute isVisibleInMap The autoRefresh interval has to be >500 , because of performance issues

updateLayerSource(){void}

modules/core/modelList/layer/model.js, line 782
refresh layerSource when updated e.g. needed because wmts source is created asynchronously

updateLayerTransparency(){void}

modules/core/modelList/layer/model.js, line 531
Transforms transparency into opacity and sets opacity on layer

Events

changeIsOutOfRange

devtools/jsdoc/events.js, line 398
Fired if attribute isOutOfRange has changed
Name Type Description
model Backbone.Model The model whose attribute hat changed.
value Boolean The attribute value that has changed.
Listeners of This Event:

changeIsSelected

devtools/jsdoc/events.js, line 363
Fired if attribute isSelected has changed
Name Type Description
model Backbone.Model The model whose attribute hat changed.
value Boolean The attribute value that has changed.
Listeners of This Event:

changeIsSettingVisible

devtools/jsdoc/events.js, line 384
Fired if attribute isSettingVisible has changed
Name Type Description
model Backbone.Model The model whose attribute hat changed.
value Boolean The attribute value that has changed.
Listeners of This Event:

changeIsVisibleInMap

devtools/jsdoc/events.js, line 370
Fired if attribute isVisibleInMap has changed
Name Type Description
model Backbone.Model The model whose attribute hat changed.
value Boolean The attribute value that has changed.
Listeners of This Event:

changeIsVisibleInTree

devtools/jsdoc/events.js, line 391
Fired if attribute isVisibleInTree has changed
Name Type Description
model Backbone.Model The model whose attribute hat changed.
value Boolean The attribute value that has changed.
Listeners of This Event:

changeTransparency

devtools/jsdoc/events.js, line 377
Fired if attribute transparency has changed
Name Type Description
model Backbone.Model The model whose attribute hat changed.
value Boolean The attribute value that has changed.
Listeners of This Event:

RadioRequestVectorLayerGetFeatures

devtools/jsdoc/events.js, line 439
Name Type Description
id String Id of vector layer.
Listeners of This Event:
Example
Radio.request("VectorLayer", "getFeatures", id)

RadioTriggerLayerSetLayerInfoChecked

devtools/jsdoc/events.js, line 411
Name Type Description
value Boolean Flag that signs that the layer informations has been checked.
Listeners of This Event:
Example
Radio.trigger("Layer", "setLayerInfoChecked", value)

RadioTriggerLayerUpdateLayerInfo

devtools/jsdoc/events.js, line 405
Name Type Description
name String The name of the layer.
Listeners of This Event:
Example
Radio.trigger("Layer", "updateLayerInfo", name)

RadioTriggerVectorLayerFeaturesLoaded

devtools/jsdoc/events.js, line 417
Name Type Description
id String Id of vector layer.
features Array.<ol/Feature> Features that have been loaded.
Listeners of This Event:
Example
Radio.trigger("VectorLayer", "featuresLoaded", id, features)

RadioTriggerVectorLayerFeatureUpdated

devtools/jsdoc/events.js, line 424
Name Type Description
id String Id of vector layer.
features Array.<ol/Feature> Features that have been loaded.
Listeners of This Event:
Example
Radio.trigger("VectorLayer", "featureUpdated", id, features)

RadioTriggerVectorLayerResetFeatures

devtools/jsdoc/events.js, line 431
Triggers an event with the features that are shown. Used for updates in heatmap after filter.
Name Type Description
id String Id of vector layer.
features Array.<ol/Feature> Features that are visible.
Listeners of This Event:
Example
Radio.trigger("VectorLayer", "resetFeatures", id, features)