Class: WMTSLayer

Core.ModelList.Layer WMTSLayer

WMTSLayer

new WMTSLayer()

modules/core/modelList/layer/wmts.js, line 29
Properties:
Name Type Default Description
infoFormat String "text/xml Format of provided information."
supported Array.<String> ["2D", "3D"] Supported map modes.
showSettings Boolean true Flag if settings selectable.
Listens to Events:

Extends

Methods

inherited checkForScale(options){void}

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

inherited checkIfDataLayer(dataLayerId, layerId){Boolean}

modules/core/modelList/layer/model.js, line 106
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.

createLayer(){void}

modules/core/modelList/layer/wmts.js, line 226
Creates the WMTSLayer.

createLayerSource(){void}

modules/core/modelList/layer/wmts.js, line 52
Creates the LayerSource for this WMTSLayer.

createLegendURL(){void}

modules/core/modelList/layer/wmts.js, line 246
If no legendURL is set an Error is written on the console. For the OptionsFromCapabilities way: If legendURL is empty, WMTS-Capabilities will be searched for a legendURL (OGC Standard) If a legendURL is found, legend will be rebuild

inherited decTransparency(){void}

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

inherited featuresLoaded(features){void}

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

inherited featureUpdated(feature){void}

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

fetchWMTSCapabilities(url, credentials){promise}

modules/core/modelList/layer/wmts.js, line 185
Fetch the WMTS-GetCapabilities document and parse it
Name Type Description
url string url to fetch
credentials string fetch option for credentials
Returns:
resolves to parsed WMTS-GetCapabilities object

generateArrays(resolutions, matrixIds, length, size){void}

modules/core/modelList/layer/wmts.js, line 172
Generates resolutions and matrixIds arrays for the WMTS LayerSource.
Name Type Description
resolutions Array The resolutions array for the LayerSource.
matrixIds Array The matrixIds array for the LayerSource.
length Number The length of the given arrays.
size Number The tileSize depending on the extent.

getExtent(){Array}

modules/core/modelList/layer/wmts.js, line 339
If the WMTS-Layer has an extent defined, then this is returned. Else, the extent of the projection is returned.
Returns:
The extent of the Layer.

getLayer(){Object}

modules/core/modelList/layer/wmts.js, line 364
Returns the WMTS-Layer.
Returns:
The WMTS-Layer

inherited getResolutions(){void}

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

inherited incTransparency(){void}

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

inherited intervalHandler(){void}

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

inherited isLayerSourceValid(){Boolean}

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

inherited isLayerValid(){Boolean}

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

inherited moveDown(){void}

modules/core/modelList/layer/model.js, line 602
Calls Collection function moveModelDown

inherited moveUp(){void}

modules/core/modelList/layer/model.js, line 610
Calls Collection function moveModelUp

inherited prepareFeaturesFor3D(features){void}

modules/core/modelList/layer/model.js, line 143
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.

inherited prepareLayerObject(){void}

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

registerErrorListener(){void}

modules/core/modelList/layer/wmts.js, line 329
Reigsters the LayerLoad-Event for Errors.

inherited registerInteractionMapViewListeners(){void}

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

inherited registerInteractionTreeListeners(channel){void}

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

registerLoadingListeners(){void}

modules/core/modelList/layer/wmts.js, line 302
Registers the LayerLoad-Events. These are dispatched to core/map, which then either adds or removes a Loading Layer.

inherited removeLayer(){void}

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

inherited resetSelectionIDX(){void}

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

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

modules/core/modelList/layer/model.js, line 164
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.

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

modules/core/modelList/layer/model.js, line 192
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.

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

modules/core/modelList/layer/model.js, line 209
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

setInfoFormat(infoFormat){void}

modules/core/modelList/layer/wmts.js, line 355
Sets the infoFormat to the given Parameter.
Name Type Description
infoFormat * The value for the infoFormat to be set.

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

inherited setIsJustAdded(value){void}

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

inherited setIsOutOfRange(value){void}

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

inherited setIsRemovable(value){void}

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

inherited setIsSelected(value){void}

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

inherited setIsSettingVisible(value){void}

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

inherited setIsVisibleInMap(value){void}

modules/core/modelList/layer/model.js, line 664
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

inherited setIsVisibleInTree(value){void}

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

inherited setLayer(value){void}

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

inherited setLayerInfoChecked(value){void}

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

inherited setLayerSource(value){void}

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

inherited setLegendURL(value){void}

modules/core/modelList/layer/model.js, line 737
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

inherited setMaxResolution(value){void}

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

inherited setMinResolution(value){void}

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

inherited setName(value){void}

modules/core/modelList/layer/model.js, line 728
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

inherited setSelectionIDX(value){void}

modules/core/modelList/layer/model.js, line 619
Setter for selectionIDX
Name Type Description
value String SelectionIDX

inherited setSingleBaselayer(value){void}

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

inherited setTransparency(value){void}

modules/core/modelList/layer/model.js, line 692
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

inherited setVisible(value){void}

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

inherited setWindowsInterval(func, autorefreshInterval){void}

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

showErrorMessage(errorMessage, layerName){void}

modules/core/modelList/layer/wmts.js, line 214
shows error message when WMTS-GetCapabilities cannot be parsed
Name Type Description
errorMessage string error message
layerName string layerName

inherited showLayerInformation(){void}

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

inherited toggleAttributionsInterval(){void}

modules/core/modelList/layer/model.js, line 516
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

inherited toggleIsSelected(){void}

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

inherited toggleIsSettingVisible(){void}

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

inherited toggleIsVisibleInMap(){void}

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

inherited toggleLayerOnMap(){void}

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

inherited toggleWindowsInterval(){void}

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

inherited updateLayerSource(){void}

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

inherited updateLayerTransparency(){void}

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

Events

inherited 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.

inherited 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.

inherited 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.

inherited 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.

inherited 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.

inherited 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.

inherited RadioRequestVectorLayerGetFeatures

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

inherited RadioTriggerLayerSetLayerInfoChecked

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

inherited RadioTriggerLayerUpdateLayerInfo

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

inherited 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.
Example
Radio.trigger("VectorLayer", "featuresLoaded", id, features)

inherited 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.
Example
Radio.trigger("VectorLayer", "featureUpdated", id, features)

inherited 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.
Example
Radio.trigger("VectorLayer", "resetFeatures", id, features)