IHierarchyDataItem

Type interface

Sources

IHierarchyDataItem is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IHierarchyDataItem extends ISeriesDataItem.

IHierarchyDataItem is extended by ILinkedHierarchyDataItem, IPackDataItem, IPartitionDataItem, ITreemapDataItem, IVoronoiTreemapDataItem.

Properties

#category

Type string

The node's category name.

#childData

Type Array

Raw data of the node's children.

#children

Type Array

List of child node data items.

#depth

Type number

Depth of the node in the hierarchy: 0 for the root.

#disabled

Type boolean

true while the node is collapsed, with its children hidden.

#fill

Type Color

The node's color: from data (fillField), or else the next of colors for a first-level node and the parent's color for a deeper one.

#fillPattern

Type PatternSince 5.10.0

Node's auto-assigned pattern.

More info: Patterns

#label

Type Label

The node's label.

#node

Type HierarchyNode

The node element.

#parent

Type DataItem

Data item of parent node.

#sum

Type number

The node's total: its own value if the data gives one, or else the sum of its children's.

#value

Type number

Value of the node as set in data.

#valuePercent

Type numberSince 5.2.21

The node's value as a percent of its parent's (25 for 25%).

#valuePercentTotal

Type number

The node's value as a percent of the root node's total (25 for 25%).

19 inherited items

#customValue

Type undefined | numberInherited from ISeriesDataItem

#customValueChange

Type undefined | numberInherited from ISeriesDataItem

#customValueChangePercent

Type undefined | numberInherited from ISeriesDataItem

#customValueChangePrevious

Type undefined | numberInherited from ISeriesDataItem

#customValueChangePreviousPercent

Type undefined | numberInherited from ISeriesDataItem

#customValueChangeSelection

Type undefined | numberInherited from ISeriesDataItem

#customValueChangeSelectionPercent

Type undefined | numberInherited from ISeriesDataItem

#customValueWorking

Type undefined | numberInherited from ISeriesDataItem

#id

Type undefined | stringInherited from ISeriesDataItem

#url

Type undefined | stringInherited from ISeriesDataItemSince 5.20.7

A URL to open when the data item's element is clicked.

#valueChange

Type undefined | numberInherited from ISeriesDataItem

#valueChangePercent

Type undefined | numberInherited from ISeriesDataItem

#valueChangePrevious

Type undefined | numberInherited from ISeriesDataItem

#valueChangePreviousPercent

Type undefined | numberInherited from ISeriesDataItem

#valueChangeSelection

Type undefined | numberInherited from ISeriesDataItem

#valueChangeSelectionPercent

Type undefined | numberInherited from ISeriesDataItem

#valueWorkingClose

Type undefined | numberInherited from ISeriesDataItem

#valueWorkingOpen

Type undefined | numberInherited from ISeriesDataItem

#visible

Type undefined | false | trueInherited from IComponentDataItem