Layer parameters

Layer

We extend the OpenLayers' Layer definition object with the following parametres:

abstract: String - abstract information about the layer
active: Boolean (TODO: describe)
attribution: Object - object of type
- logoUrl: Object - containing image format and URL path to the image
  - format: String - image format
  - onlineResource: String - image URL path
- onlineResource: String - URL to resource domain
- title: String - attribution title
base: Boolean - layer will act as base layer for the map
cluster: Boolean - layer containing features will be grouped into clusters based on the viewing distance
customInfoTemplate: String (TODO: describe)
declutter: Boolean - layer containing features that will overlap will be hidden based on the viewing distance
definition: Object - object of type (TODO: describe)
- format: String
- url: String
dimensions: Object - object of type
- time: Object - object of type
  - value: Date (TODO: can't be Date because of "Expression has changed after it was checked" error)
  - values
  - type: 'date' | 'datetime'
  - format
  - default
dimensions_time: Object | Array<Object> (TODO: remove in favor of dimensions.time which is more in line with WMS-T spec)
editor: Object - object of type
- editable: Boolean
- defaultAttributes - directory of attribute names as keys and values describing the default values to be set for new features.
enableProxy: Boolean
eventsSuspended: Number (readonly)
exclusive: Boolean
featureInfoLang
fromComposition: Boolean - layer loaded from composition
getFeatureInfoTarget: String - name of the component responsible for displaying layer information. If we want the results be displayed in hslayers Info panel then set getFeatureInfoTarget='info-panel', otherwise the element will be searched using this query 'ol-popup ' + layer.get('popupClass')
hsOriginalStyle (readonly) - Holds original Openlayers Style object or function which is used in feature clusters when theres only one feature in cluster or as layer style when clustering is turned off)
hsLaymanSynchronizing: Boolean (readonly) Used internally to display loading icon while features are synchronized with Laymans WFS endpoint.
infoFormat
inlineLegend: Boolean - layer legend will be visible inside layer editor tab
laymanLayerDescriptor: HsLaymanLayerDescriptor
legends: Array<String> - array of legend URLs (Explore how it relates to styles and if we need a more complex structure because legends map to wms layer styles where there can be more than one and with a specific name. see: this.setOrUpdate(layer, 'Layer', layers); this.setOrUpdate(layer, 'Legends', legends); this.setOrUpdate(layer, 'MetadataURL')
maxScaleDenominator: Number
metadata: Object - URL to layers metadata
minimumTerrainLevel: Number - Used in cesium to display layer only from certain terrain level (we can use minResolution because the surface can be looked uppon from an angle)
name: String
onFeatureSelected: Function - custom action for clicked feature on the map
path: String
popUp: Object - object of type
- attributes: Array<String> | Array<Object> - containing either names of attributes to display or objects of type
  - attribute: String - name of the attribute
  - displayFunction?: Function - alternative function to format the attribute value
  - label?: String - alternative label to display instead of the attribute name
popupClass
queryable: Boolean
queryCapabilities: Boolean
queryFilter
removable: Boolean
showInLayerManager: Boolean - layer is visible inside Layermanager panel
sublayers: Array<Object> - array of layer sub-layers
thumbnail: Object - object of type
title: String - layer title
virtualAttributes: Object

Feature

Additionally, we extend OpenLayers' Feature with these parametres:

features: Array<Feature> - array of features when the source is clustered, undefined otherwise
highlighted: Boolean - feature is currently selected
hstemplate: (TODO: deprecate or create the custom template functionality since, it's not supported currently)
label: String
name: String
record
title: String
unitId: String | Number - sensor unit identity
wp: Waypoint