Class: WMTSLayer

Core.ModelList.Layer WMTSLayer

WMTSLayer

new WMTSLayer()

modules/core/modelList/layer/wmts.js, line 35
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 125
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 112
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 233
Creates the WMTSLayer.

createLayerSource(){void}

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

createLegendURL(){void}

modules/core/modelList/layer/wmts.js, line 253
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 400
Decreases layer transparency by 10 percent

inherited featuresLoaded(features){void}

modules/core/modelList/layer/model.js, line 140
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 245
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 192
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 179
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 346
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 371
Returns the WMTS-Layer.
Returns:
The WMTS-Layer

inherited getResolutions(){void}

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

inherited incTransparency(){void}

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

inherited intervalHandler(){void}

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

inherited isLayerSourceValid(){Boolean}

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

inherited isLayerValid(){Boolean}

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

inherited prepareFeaturesFor3D(features){void}

modules/core/modelList/layer/model.js, line 149
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 253
Process function. Calls smaller function to prepare and create layer object

registerErrorListener(){void}

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

inherited registerInteractionMapViewListeners(){void}

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

inherited registerInteractionTreeListeners(channel){void}

modules/core/modelList/layer/model.js, line 276
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 309
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 767
Removes the layer from the map and the collection

inherited resetLayerOrder(){void}

modules/core/modelList/layer/model.js, line 611
Resets layerOrder 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 170
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 198
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 215
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 362
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 759
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 684
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 748
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 657
Setter for isSelected
Name Type Description
value Boolean Flag if layer is selected

inherited setIsSettingVisible(value){void}

modules/core/modelList/layer/model.js, line 666
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 647
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 729
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 638
Setter for layer
Name Type Description
value ol/layer Layer

inherited setLayerInfoChecked(value){void}

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

inherited setLayerOrder(value){void}

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

inherited setLayerSource(value){void}

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

inherited setLegendURL(value){void}

modules/core/modelList/layer/model.js, line 720
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 693
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 702
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 711
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 setSingleBaselayer(value){void}

modules/core/modelList/layer/model.js, line 739
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 675
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 781
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 360
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 221
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 553
Initiates the presentation of layer information.
Fires:

inherited toggleAttributionsInterval(){void}

modules/core/modelList/layer/model.js, line 514
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 412
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 472
Toggles the attribute isSettingVisible

inherited toggleIsVisibleInMap(){void}

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

inherited toggleLayerOnMap(){void}

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

inherited toggleWindowsInterval(){void}

modules/core/modelList/layer/model.js, line 455
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 790
refresh layerSource when updated e.g. needed because wmts source is created asynchronously

inherited updateLayerTransparency(){void}

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

Events

inherited changeIsOutOfRange

devtools/jsdoc/events.js, line 439
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 404
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 425
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 411
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 432
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 418
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 480
Name Type Description
id String Id of vector layer.
Example
Radio.request("VectorLayer", "getFeatures", id)

inherited RadioTriggerLayerSetLayerInfoChecked

devtools/jsdoc/events.js, line 452
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 446
Name Type Description
name String The name of the layer.
Example
Radio.trigger("Layer", "updateLayerInfo", name)

inherited RadioTriggerVectorLayerFeaturesLoaded

devtools/jsdoc/events.js, line 458
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 465
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 472
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)