Interface: TreeLayoutResult
What a tree layout returns on top of positions.
Extends
Extended by
Properties
| Property | Modifier | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|---|
clusters? | readonly | readonly LayoutCluster[] | - | - | LayoutResult.clusters |
depth | readonly | Int32Array | Links from the root, 0 for a root. | - | - |
hidden | readonly | Uint8Array | 1 where the node is below a collapsed node; it sits on its nearest visible ancestor. | LayoutResult.hidden | - |
parent | readonly | Int32Array | The forest that was drawn: each node's parent, -1 for a root. | - | - |
parentLink | readonly | Int32Array | The link that joins each node to its parent, -1 where there is none. | - | - |
parentRoutes? | readonly | readonly (LinkRoute | undefined)[] | The same routes by child node: the path from a node's parent to it (undefined: straight, hidden or a root). For a figure that gives a tree as ids / parents and has no links to hang LayoutResult.routes on. Absent when all links are straight. | - | - |
reversed? | readonly | Uint8Array<ArrayBufferLike> | Links the layout reversed to break cycles (layered): drawn in the back-edge style. | - | LayoutResult.reversed |
routes? | readonly | readonly (LinkRoute | undefined)[] | Routes of the links that are not straight, by link index (sparse: undefined or a missing entry is a straight link). Indices are those of LayoutGraph.source. | - | LayoutResult.routes |
treeLinks | readonly | Uint8Array | By link index: 1 where the link is a tree edge. The others (links that close a cycle, skip a level or repeat a tree edge) are not part of the layout and never have a route. | - | - |
x | readonly | Float64Array | Node centers, one per node. Always finite. | - | LayoutResult.x |
y | readonly | Float64Array | - | - | LayoutResult.y |
z? | readonly | Float64Array<ArrayBufferLike> | Only from a 3D layout. | - | LayoutResult.z |