Skip to content

Interface: TidyTreeOptions ​

Options of tidyTreeLayout. Lengths are layout units (CSS px).

Extends ​

Properties ​

PropertyModifierTypeDescriptionInherited from
collapsed?readonlyCollapsedInputCollapsed nodes: node indices (any iterable), or a Uint8Array with one byte per node, non-zero for a collapsed one. The descendants of a collapsed node are left out of the layout (TreeLayoutResult.hidden), take no room, and are given the position of their nearest visible ancestor. Default none.TreeOptions.collapsed
links?readonlyTreeLinkShapeShape of the tree edges: see the file header. Default 'straight'.-
nodesep?readonlynumberRoom between two siblings, on top of their sizes. Default 20.-
orientation?readonlyTreeOrientationWhere the root is. Default 'TB' (root at the top).-
ranksep?readonlynumberRoom between two levels, on top of their thickest nodes. Default 50.-
sort?readonlyTreeSortOrder of siblings: 'input' (node order for a tree input, link order otherwise), 'size' (by the number of nodes in the subtree, hidden ones included) or 'value' (by graph.value, nodes without one last). Default 'input'.TreeOptions.sort
sortOrder?readonly"descending" | "ascending"Which way 'size' and 'value' sort. Default 'descending' (largest first).TreeOptions.sortOrder
subtreesep?readonlynumberRoom between two neighbours that are not siblings (the ends of two subtrees, two trees of a forest), on top of their sizes. Default: nodesep.-

Released under the MIT License.