Represents the analysis result computed by TreeAnalysis.
Inheritance Hierarchy
TreeAnalysisResult
Remarks
This class cannot be instantiated
Type Details
- yFiles module
- view-layout-bridge
Properties
Gets whether or not the analyzed structure is a directed, rooted tree.
Remarks
If
true, the tree structure is directed and no edges were reversed (i.e. reversedEdges is empty). If false, the analyzed graph is an undirected tree where it was necessary to reverse some edges in order to view it as a directed tree rooted at root.Gets all leaf nodes of the tree.
Remarks
Leaf nodes are nodes without outgoing edges.
Property Value
An IEnumerable<T> of leaf nodes in the tree.
Complexity
O(|V|)
Gets the edges that would need to be reversed in order to make the graph a directed, rooted tree.
Remarks
Note that the direction that yields a directed tree is the one which is considered for other queries on this result. For example, when querying the getParent of a certain node and if the edge to the parent is a reversed one, then the direction in the original graph is actually such that the parent is a successor of the node.
Gets the root of the tree.
Methods
Gets the child nodes of the given node in the tree.
Complexity
O(|V|)
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- node - INode
- The parent node to get children from.
Returns
- ↪ResultItemCollection<INode>
- An IEnumerable<T> of
node's children.
Throws
- Exception({ name: 'ArgumentError' })
- If the given node was not part of the graph at the time the analysis was invoked via run
If the edge connecting a child with
node is part of the reversedEdges, then the original edge direction is such that the child is actually a predecessor of node.Gets the depth of the node, that is, the length of the path between the root and node.
Remarks
Nodes with the same depth are commonly drawn in the same layers in typical tree visualizations.
Complexity
O(1)
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- node - INode
- The node to determine the depth for.
Returns
- ↪number
- The distance between the root node and
node.
Throws
Gets all nodes that are descendants of root, including the edges that connect the descendants.
Remarks
The result's nodes collection does not contain the given root node itself. If this is desired, use method getSubtree instead. Note that the result elements provided by this method do not yield a connected graph structure if the given root node has multiple direct child nodes.
Complexity
O(|V|)
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- root - INode
- The root node for which the descendants should be queried.
Returns
Throws
Determines the nearest common ancestor for the given nodes.
Remarks
Note that each node is considered to be its own ancestor so the returned node may be one of
nodes. Another way to look at this is to picture the result to be the root of the smallest subtree that contains all nodes.Complexity
O(|V|)
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- nodes - INode
- The nodes for which to find the nearest common ancestor.
Returns
- ↪INode?
- The nearest ancestor of all given nodes or
nullifnodesis empty.
Throws
Determines the nearest common ancestor for the given nodes.
Remarks
Note that each node is considered to be its own ancestor so the returned node may be one of
nodes. Another way to look at this is to picture the result to be the root of the smallest subtree that contains all nodes.Complexity
O(|V|)
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- nodes - IEnumerable<INode>
- The nodes for which to find the nearest common ancestor.
Returns
- ↪INode?
- The nearest ancestor of all given nodes or
nullifnodesis empty.
Throws
Gets the parent node of the given tree node.
Complexity
O(1)
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- node - INode
- The child node to determine the parent of.
Returns
- ↪INode?
- The parent node of
nodeornullifnodeis the root of the tree.
Throws
- Exception({ name: 'ArgumentError' })
- If the given node was not part of the graph at the time the analysis was invoked via run
If the edge connecting the node with its parent is part of the reversedEdges, then the original edge direction is such that the parent is a successor of the node.
Gets all nodes and edges of the subtree that has subtreeRoot as root.
Remarks
The result contains the root node itself and the edges adjacent to it. To only get all descendants of the given node, use method getDescendants instead.
Complexity
O(|V|)
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- subtreeRoot - INode
- The subtree root node.