Interface AmHierarchyNode

One node of an am5hierarchy series, as the walk reaches it.

Carries the live data item alongside the values, because the highlight path needs the node the reader is on and the walk is the only place the two are known together — an am5hierarchy series keeps only its root in dataItems, and every other node is reachable only by descending from it.

interface AmHierarchyNode {
    dataItem: AmDataItem;
    name: string | number;
    path: (string | number)[];
    depth: number;
    value: number | null;
}

Index

Properties

dataItem name path depth value

Properties

dataItem

dataItem: AmDataItem

name

name: string | number

What the node is called.

path

path: (string | number)[]

Its ancestors' names, outermost first, excluding the node and the root.

depth

depth: number

Levels below the tree root — the row a MAIDR treemap addresses it by.

value

value: number | null

Its own declared magnitude, or null for a node that has none.

src

Interface AmHierarchyNode

Index

Properties

Properties

dataItem

name

path

depth

value

Settings

On This Page