# Class: PlanningClusterItem

## vcs.vcm.widgets.legend.PlanningClusterItem

#### new vcs.vcm.widgets.legend.PlanningClusterItem(options)

  Name | Type | Description
  --- | --- | ---
  `options` | vcs.vcm.widgets.legend.ClusterItem.Options |

### Extends

- vcs.vcm.widgets.legend.ClusterItem

### 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}

#### 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

#### vcs.vcm.widgets.legend.PlanningClusterItem.getPlanningClusterItem(){vcs.vcm.widgets.legend.PlanningClusterItem|undefined}

  gets the planning cluster item, if one was created

#### 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