virtualcityMAP 3.6

Class: ClusterItem

vcs.vcm.widgets.legend.ClusterItem

Class representing a Cluster node within a legend widget, managing an arbitrary number of children TreeItems.

new vcs.vcm.widgets.legend.ClusterItem()

Subclasses

Extends

Members

breakAfter{boolean}

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

The children items of this group item

className{string}

class Name of the Object

clickable{boolean}

disabled{boolean}

Whether the item should be shown disabled in the ui, can be set programmatically

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}

Translatable 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) inherited

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

    vcs.vcm.widgets.legend~ClusterItem

    Class representing a Cluster node within a legend widget, managing an arbitrary number of children TreeItems.

    new ClusterItem(options)

    Name Type Description
    options vcs.vcm.widgets.legend.ClusterItem.Options

    Subclasses

    Extends

    Members

    breakAfter{boolean}

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

    The children items of this group item

    className{string}

    class Name of the Object

    clickable{boolean}

    disabled{boolean}

    Whether the item should be shown disabled in the ui, can be set programmatically

    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}

    Translatable 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) inherited

    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