virtualcityMAP 3.6

Class: AbstractGroupItem

vcs.vcm.widgets.legend.AbstractGroupItem

Class representing a group node within a tree widget, managing an arbitrary number of children being either another group item or a layer item with layer information.

Subclasses

Extends

Members

children{Array.<vcs.vcm.widgets.legend.TreeItem>}

The children items of this group item

className{string}

class Name of the Object

clickable{boolean}

id{string}

The unique id of the given item

level{number}

The nesting level of this tree item

open{boolean}

item ui state

startopen{boolean}

state{string}

Item loading state, can be inactive, active (aka loaded and showing), loading or indeterminate.

titleObject{Object}

Translateable title object. Where the key represents the local, and the value the translation for example: { en: 'Example', de: 'Beispiel' }

visible{boolean}

Whether the item should be displayed

Methods

activate(active, ignoreViewpoint)

Activates the group item

Name Type Description
active boolean
ignoreViewpoint boolean

getViewPoint(){vcs.vcm.util.ViewPoint|null} inherited

returns the viewpoint for this treeitem

Deprecated
  • v3.6

    gotoViewpoint() inherited

    Goes to this tree items viewpoint, if there is one defined

    Type Definitions

    vcs.vcm.widgets.legend.AbstractGroupItem.Options{vcs.vcm.widgets.legend.TreeItem.Options}

    Properties:
    Name Type Argument Default Description
    startOpen boolean <optional>
    		 false
    clickable boolean <optional>
    		 true
    children Array.<Object>

    options for the children of this group item, can be any option valid for a legend item
    clusterIcons string

    whether to cluster point features or not true creates a new cluster layer, a string should represent the name of an already configured cluster layer