The associated data, as specified to the constructor.
Zero for the root node, and increasing by one for each descendant generation.
Zero for leaf nodes, and the greatest distance from any descendant leaf for internal nodes.
Optional node id string set by StratifyOperator, if hierarchical data was created from tabular data using stratify().
The parent node, or null for the root node.
Aggregated numeric value as calculated by sum(value) or count(), if previously invoked.
Returns the array of ancestors nodes, starting with this node, then followed by each parent up to the root.
Return a deep copy of the subtree starting at this node. The returned deep copy shares the same data, however. The returned node is the root of a new tree; the returned node’s parent is always null and its depth is always zero.
Computes the number of leaves under this node and assigns it to node.value, and similarly for every descendant of node.
If this node is a leaf, its count is one. Returns this node.
Returns the array of descendant nodes, starting with this node, then followed by each child in topological order.
Invokes the specified function for node and each descendant in breadth-first order, such that a given node is only visited if all nodes of lesser depth have already been visited, as well as all preceding nodes of the same depth.
The specified function is passed the current node.
Invokes the specified function for node and each descendant in post-order traversal, such that a given node is only visited after all of its descendants have already been visited.
The specified function is passed the current node.
Invokes the specified function for node and each descendant in pre-order traversal, such that a given node is only visited after all of its ancestors have already been visited.
The specified function is passed the current node.
Returns the array of leaf nodes in traversal order; leaves are nodes with no children.
Returns an array of links for this node, where each link is an object that defines source and target properties. The source of each link is the parent node, and the target is a child node.
Returns the shortest path through the hierarchy from this node to the specified target node. The path starts at this node, ascends to the least common ancestor of this node and the target node, and then descends to the target node.
The target node.
Sorts the children of this node, if any, and each of this node’s descendants’ children, in pre-order traversal using the specified compare function, and returns this node.
The compare function is passed two nodes a and b to compare.
If a should be before b, the function must return a value less than zero;
if b should be before a, the function must return a value greater than zero;
otherwise, the relative order of a and b are not specified. See array.sort for more.
Evaluates the specified value function for this node and each descendant in post-order traversal, and returns this node.
The node.value property of each node is set to the numeric value returned by the specified function plus the combined value of all descendants.
The value function is passed the node’s data, and must return a non-negative number.
Generated using TypeDoc
An array of child nodes, if any; undefined for leaf nodes.