Class: VectorCluster

Extends

• vcs.vcm.layer.Vector

Members

altitudeMode{string}

classificationType

className{string}

class Name of the Object

heightAboveGround{number}

height above ground for all point vector objects -> altitudeMode must be set to: "relativeToGround" either on the feature (precedence) or the layer

hiddenObjectIds{Array.<string>}

array of object Ids which should be hidden global, if this layer is active

name{string}

unique Name

skirt{number}

storeyHeight{number}

visibility{boolean}

zCoordinateEyeOffset{number}

All point vector objects become billboards in cesium which can contain an eyeOffset see: https://cesiumjs.org/Cesium/Build/Documentation/Billboard.html?classFilter=billboard

Methods

addFeatures(features){Array.<string>} inherited

add features to the vector layer and return an array with their ids. The geometry will be mutated and transformed to EPSG 3857 mercator coordinate system

Name	Type	Description
features	Array.<ol.Feature>

TODO

• mechanism to enforce XYZ coordinate layout for internal usage

addGenericFeatureProperties(properties) inherited

Set properties, which are always added to the generic object, eg. for use in balloons

Name	Type	Description
properties	Object

addLayers(layerItems)

Adds a layer or array of layers to the current cluster

Name	Type	Description
layerItems	vcs.vcm.layer.VectorCluster.layerItem | Array.<vcs.vcm.layer.VectorCluster.layerItem>

clearHiddenObjects() inherited

clears all the hidden objects

clearHighlighting() inherited

clears all highlighted objects

clearStyle() inherited

Clears the style of this layer

contains(layerName){boolean}

Checks if a layer is contained in the cluster

Name	Type	Description
layerName	string

dispose() inherited

disposes of this layer, removes instances from the current maps and the framework

getAltitudeMode(){string} inherited

returns the altitudeMode of the layer

Deprecated

• Yes

getClassName(){string} inherited

returns the class name of this object.

Deprecated

• Yes

Returns:

className

getConfigObject(){Object} inherited

getExclusiveGroup(){string} inherited

returns the exclusive group of this layer

Deprecated

• Yes

getExtent(){vcs.vcm.util.Extent} inherited

returns the Extent of this layer

Deprecated

• Yes

getFeatureById(id){ol.Feature} inherited

returns an feature if found, otherwise null feature geometries are always in EPSG 3857 mercator coordinate system

Name	Type	Description
id	string | number

getFeatures(){Array.<ol.Feature>} inherited

returns an array with features Feature geometries are always in EPSG 3857 mercator coordinate system

getFeaturesById(ids){Array.<ol.Feature>} inherited

returns an array with features feature geometries are always in EPSG 3857 mercator coordinate system

Name	Type	Description
ids	Array.<string>

getHeightAboveGround(){number} inherited

returns the height above ground

Deprecated

• Yes

getId(){string} inherited

returns the id of this object

Deprecated

• Yes

getMaxResolution(){number} inherited

returns the maximum resolution (exclusive) below which this layer will be visible.

Deprecated

• 3.5

getMinResolution(){number} inherited

returns the minimum resolution (inclusive) at which this layer will be visible.

Deprecated

• 3.5

getName(){string} inherited

returns the name of the Object, the name is either given by the config Object or a uuid is generated

Deprecated

• Yes

getProjection(){vcs.vcm.util.Projection} inherited

returns the source Projection

Deprecated

• 3.5

getScaleByDistance(){Array.<number>} inherited

returns the scale By Distance

Deprecated

• Yes

getSource(){ol.source.Vector} inherited

returns the ol3 vector source

getStyle(){vcs.vcm.util.style.VectorStyleItem} inherited

returns the style of the layer

Deprecated

• 3.5

getType(){number} inherited

returns the type of this layer

Deprecated

• Yes

getVcsMeta(options){vcs.vcm.layer.VcsMeta} inherited

Returns the layers vcsMeta object

Name	Type	Description
options	vcs.vcm.layer.GeoJSON.writeOptions

getZCoordinateEyeOffset(){number} inherited

returns the amount of meters the features are being pulled forward in the direction of the viewer (in 3D)

Deprecated

• Yes

getZIndex(){number} inherited

returns the zIndex of the layer

Deprecated

• Yes

hideObjects(toHide) inherited

hides a number of objects

Name	Type	Description
toHide	Array.<(string|number)>	A list of Object Ids which will be hidden

highlight(toHighlight) inherited

highlights a number of building objects with the given color

Name	Type	Description
toHighlight	Object.<string, (vcs.vcm.util.style.VectorStyleItem|Cesium.Color|ol.style.Style)>

isActive(){boolean} inherited

checks if the layer is active

Deprecated

• Yes

isExclusive(){boolean} inherited

returns whether this layer can only be used exclusive

Deprecated

• Yes

isIconManagerInUse(){boolean} inherited

returns whether this layer is used by the iconmanager

Deprecated

• Yes

isInitialized(){boolean} inherited

returns true if the layer is initialized

Deprecated

• Yes

isSupported(opt_map){boolean} inherited

checks if the currently active map supports this layer

Name	Type	Description
map	vcs.vcm.maps.Map

removeAllFeatures() inherited

removes all features from the vector layer

removeFeaturesById(ids) inherited

removes features from the vector layer

Name	Type	Description
ids	Array.<(string|number)>

setHighlightStyle(style) inherited

sets the highlightstyle of this layer

Name	Type	Description
style	ol.style.Style | ol.StyleFunction | vcs.vcm.util.style.VectorStyleItem

setProjection(projection) inherited

Sets a new source Projection for the layer. All features added hereafter are assumed to be in this projection

Name	Type	Description
projection	vcs.vcm.util.Projection

Deprecated

• 3.5

showObjects(unHide) inherited

unHides a number of objects

Name	Type	Description
unHide	Array.<(string|number)>	A list of Object Ids which will be unHidden

unHighlight(toUnHighlight) inherited

unhighlights a number of building objects

Name	Type	Description
toUnHighlight	Array.<string>	Array with IDS to unhighlight

unSelect()

Unselects the currently selected cluster

Type Definitions

vcs.vcm.layer.VectorCluster.layerItem{Object}

Properties:

Name	Type	Description
name	string
title	Object | string | null | undefined
parent	Object | string | null | undefined
featureTemplate	string | function | null | undefined

vcs.vcm.layer.VectorCluster.layerOptions{vcs.vcm.layer.Vector.Options}

Properties:

Name	Type	Argument	Default	Description
heightAboveGround	number	<optional>	65
activeOnStartup	boolean	<optional>	true	cluster layers are always active, this cannot be changed
altitudeMode	string	<optional>	none
zCoordinateEyeOffset	number	<optional>	-200	The distance (m) by which the vector objects are being pulled towards the viewer (3D only)
clusterDistance	number	<optional>	40	the distance (pixels) to cluster points by
clusterLayers	Array.<vcs.vcm.layer.VectorCluster.layerItem>			the layers to cluser
defaultFeatureTemplate	string			an underscore template to render in the DOM when displaying a layerItem
showInContent	boolean	<optional>	true	whether to show the clusters layerItems in the content window
style	vcs.vcm.layer.VectorCluster.styleOptions

vcs.vcm.layer.VectorCluster.styleOptions{Object}

Properties:

Name	Type	Argument	Default	Description
icon	string	<optional>	images/clusterIcon.svg	the resource to use as a cluster item, must be an SVG
selectedIcon	string	<optional>	images/clusterSelectedIcon.svg	the resource to use as a selected cluster icon, must be an SVG
iconWidth	number	<optional>	40
iconHeight	number	<optional>	40
breaks	Array.<number>	<optional>	[2, 3, 4, 5, 10, 15, 20, 25]	the classes and their sizes
iconScaleFactor	number	<optional>	0.05	the factor by which to scale icons
zeroScaleOffset	number	<optional>	3	the number of icons NOT to scale (by default 2, 3, 4, 5 have the same size)
fontSize	number	<optional>	16	the font size of the numbers within the icon
textOffset	number	<optional>	-4	an offset to help center the text labels

Events

LAYER_ACTIVATED inherited

vcs.vcm.event.EventType.LAYER_ACTIVATED is triggered when a layer is activated.

Type:

• vcs.vcm.layer.Layer

LAYER_CHANGED inherited

vcs.vcm.event.EventType.LAYER_CHANGED is triggered when a layer is activated or deactivated.

Type:

• vcs.vcm.layer.Layer

LAYER_DEACTIVATED inherited

vcs.vcm.event.EventType.LAYER_DEACTIVATED is triggered when a layer is deactivated.

Type:

• vcs.vcm.layer.Layer