Class: HeatmapLayer

Core.ModelList.Layer HeatmapLayer

HeatmapLayer

new HeatmapLayer()

modules/core/modelList/layer/heatmap.js, line 35
This layer is used to generate a heatmap. It uses the features of a already configured vector layer such as WFS or Sensor.
Properties:
Name Type Default Description
attribute String ["" Attribute to filter by.
value String ["" Value to filter by.
radius Number 10 Radius to calculate the heatmap.
blur Number 15 Blur for heatmap.
gradient Array.<String> ["#00f","#0ff","#0f0","#ff0","#f00" Gradient of colors for heatmap.
Fires:
Listens to Events:

Extends

Methods

checkDataLayerId(layerId){Boolean}

modules/core/modelList/layer/heatmap.js, line 147
Checks if triggered layer id equals the id of current heatmap-layer.
Name Type Description
layerId String id from layer
Returns:
Flag if layerId matches the dataLayerId

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.

countStates(feature, heatmapAttribute, heatmapValue){Array.<String>}

modules/core/modelList/layer/heatmap.js, line 267
Counts the given states of a feature.
Name Type Description
feature ol/Feature Feature.
heatmapAttribute string Attribute that contains the value.
heatmapValue string Value.
Returns:
count.

createLayer(){void}

modules/core/modelList/layer/heatmap.js, line 123
Creates the heatmap layer.

createLayerSource(){void}

modules/core/modelList/layer/heatmap.js, line 114
Creates an empty vectorSource as the layer source.

createLegendURL(){void}

modules/core/modelList/layer/heatmap.js, line 196
overwrites createlegendURL from class Layer. Is not yet implemented in heatmap layer.

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:

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

initializeHeatmap(features){void}

modules/core/modelList/layer/heatmap.js, line 156
Draws the heatmap with initialize features
Name Type Description
features Array.<ol/Feature> All features from associated sensorLayer

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

loadInitialData(layerId, features){void}

modules/core/modelList/layer/heatmap.js, line 72
Loads the initial heatmap features.
Name Type Description
layerId String Id of layer whose data has to be loaded.
features Array.<ol/Feature> Features that have to be used for heatmap layer.
Fires:

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

normalizeWeight(featuresWithValue){void}

modules/core/modelList/layer/heatmap.js, line 250
Normalizes the values to a scale from 0 to 1.
Name Type Description
featuresWithValue Array.<ol/Feature> Features that have a value.

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

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:

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

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

setLayer(value){void}

modules/core/modelList/layer/heatmap.js, line 292
Setter for attribute "layer".
Name Type Description
value ol/Layer HeatmapLayer.

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

setLayerSource(value){void}

modules/core/modelList/layer/heatmap.js, line 301
Setter for attribute "layerSource"
Name Type Description
value ol/Source HeatmapLayerSource.

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

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

updateFeature(layerId, feature){void}

modules/core/modelList/layer/heatmap.js, line 104
Loads or updates the feature in the heatmap.
Name Type Description
layerId String Id of layer whose data data has to be loaded
feature ol/feature Feature that was updated.

updateHeatmap(feature){void}

modules/core/modelList/layer/heatmap.js, line 205
Updates the heatmap with given feature.
Name Type Description
feature ol/Feature Feature to be updated.

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)