Documentation

IHierarchyDataItem

Type interface

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

Type undefined | number

Inherited from ISeriesDataItem
customValueChange
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangePercent
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangePrevious
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangePreviousPercent
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangeSelection
#

Type undefined | number

Inherited from ISeriesDataItem
customValueChangeSelectionPercent
#

Type undefined | number

Inherited from ISeriesDataItem
customValueWorking
#

Type undefined | number

Inherited from ISeriesDataItem
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 Pattern

Node's auto-assigned pattern.

Click here for more info
@since 5.10.0

id
#

Type undefined | string

Inherited from ISeriesDataItem
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.
url
#

Type undefined | string

Inherited from ISeriesDataItem

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

@since 5.20.7

value
#

Type number

Value of the node as set in data.
valueChange
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangePercent
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangePrevious
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangePreviousPercent
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangeSelection
#

Type undefined | number

Inherited from ISeriesDataItem
valueChangeSelectionPercent
#

Type undefined | number

Inherited from ISeriesDataItem
valuePercent
#

Type number

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

@since 5.2.21

valuePercentTotal
#

Type number

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

Type undefined | number

Inherited from ISeriesDataItem
valueWorkingOpen
#

Type undefined | number

Inherited from ISeriesDataItem
visible
#

Type undefined | false | true

Inherited from IComponentDataItem
There are 19 inherited items currently hidden from this list.