TreeLayout$Typings extension

on

• TreeLayout

Properties

alignment ↔ EnumValue

Gets or sets the default alignment of parents relative to their children. Must be a static constant of TreeLayout whose name starts with "Alignment".

getter/setter pair

alternateAlignment ↔ EnumValue

Gets or sets the alternate alignment of parents relative to their children. Must be a static constant of TreeLayout whose name starts with "Alignment".

getter/setter pair

alternateAngle ↔ num

Gets or sets the alternate direction for tree growth.

getter/setter pair

alternateBreadthLimit ↔ num

Gets or sets an alternate limit on how broad a tree should be.

getter/setter pair

alternateChildPortSpot ↔ Spot

Gets or sets the alternate spot that children nodes' ports get as their ToSpot The default value is Spot.Default.

getter/setter pair

alternateCommentMargin ↔ num

Gets or sets the alternate distance between a node and its comments.

getter/setter pair

alternateCommentSpacing ↔ num

Gets or sets the alternate distance between comments.

getter/setter pair

alternateCompaction ↔ EnumValue

Gets or sets how closely to pack the child nodes of a subtree. Must be either TreeLayout.CompactionBlock or TreeLayout.CompactionNone.

getter/setter pair

alternateComparer ↔ num Function(TreeVertex, TreeVertex)

Gets or sets the alternate comparison function used for sorting the immediate children of a vertex.

getter/setter pair

alternateDefaults ↔ TreeVertex

Gets or sets the object holding the default values for alternate layer TreeVertexes, used when the #treeStyle is TreeLayout.StyleAlternating|StyleAlternating or TreeLayout.StyleLastParents|StyleLastParents.

getter/setter pair

alternateLayerSpacing ↔ num

Gets or sets the alternate distance between a parent node and its children.

getter/setter pair

alternateLayerSpacingParentOverlap ↔ num

Gets or sets the alternate fraction of the node's depth for which the children's layer starts overlapped with the parent's layer.

getter/setter pair

alternateNodeIndent ↔ num

Gets or sets the alternate indentation of the first child.

getter/setter pair

alternateNodeIndentPastParent ↔ num

Gets or sets the fraction of this node's breadth is added to #alternateNodeIndent to determine any spacing at the start of the children.

getter/setter pair

alternateNodeSpacing ↔ num

Gets or sets the alternate distance between child nodes.

getter/setter pair

alternatePortSpot ↔ Spot

Gets or sets the alternate spot that this node's port gets as its FromSpot.

getter/setter pair

alternateRowIndent ↔ num

Gets or sets the alternate indentation of the first child of each row, if the #alignment is not a "Center" alignment.

getter/setter pair

alternateRowSpacing ↔ num

Gets or sets the alternate distance between rows of children.

getter/setter pair

alternateSetsChildPortSpot ↔ bool

Gets or sets whether the TreeLayout should set the ToSpot for each child node port.

getter/setter pair

alternateSetsPortSpot ↔ bool

Gets or sets whether the TreeLayout should set the FromSpot for this parent node port.

getter/setter pair

alternateSorting ↔ EnumValue

Gets or sets the alternate sorting policy for ordering the immediate children of a vertex. Must be TreeLayout.SortingForwards, TreeLayout.SortingReverse, TreeLayout.SortingAscending, or TreeLayout.SortingDescending.

getter/setter pair

angle ↔ num

Gets or sets the default direction for tree growth.

getter/setter pair

arrangement ↔ EnumValue

Gets or sets how #arrangeTrees should lay out the separate trees. Must be TreeLayout.ArrangementVertical, TreeLayout.ArrangementHorizontal, or TreeLayout.ArrangementFixedRoots.

getter/setter pair

arrangementSpacing ↔ Size

Gets or sets the space between which #arrangeTrees will position the trees.

getter/setter pair

breadthLimit ↔ num

Gets or sets a limit on how broad a tree should be.

getter/setter pair

childPortSpot ↔ Spot

Gets or sets the spot that children nodes' ports get as their ToSpot.

getter/setter pair

commentMargin ↔ num

Gets or sets the distance between a node and its comments.

getter/setter pair

comments ↔ bool

Gets or sets whether this layout should find all Nodes whose category is "Comment" and whose anchors are nodes represented in the network, and increase the size of the corresponding TreeVertex to make room for the comment nodes. The default value is true.

getter/setter pair

commentSpacing ↔ num

Gets or sets the distance between comments.

getter/setter pair

compaction ↔ EnumValue

Gets or sets how closely to pack the child nodes of a subtree. Must be either TreeLayout.CompactionBlock or TreeLayout.CompactionNone.

getter/setter pair

comparer ↔ num Function(TreeVertex, TreeVertex)

Gets or sets the default comparison function used for sorting the immediate children of a vertex.

getter/setter pair

layerSpacing ↔ num

Gets or sets the distance between a parent node and its children.

getter/setter pair

layerSpacingParentOverlap ↔ num

Gets or sets the fraction of the node's depth for which the children's layer starts overlapped with the parent's layer.

getter/setter pair

layerStyle ↔ EnumValue

Gets or sets the manner in which the nodes are aligned in layers. Must be TreeLayout.LayerIndividual, TreeLayout.LayerSiblings, or TreeLayout.LayerUniform.

getter/setter pair

nodeIndent ↔ num

Gets or sets the default indentation of the first child.

getter/setter pair

nodeIndentPastParent ↔ num

Gets or sets the fraction of this node's breadth is added to #nodeIndent to determine any spacing at the start of the children.

getter/setter pair

nodeSpacing ↔ num

Gets or sets the distance between child nodes.

getter/setter pair

path ↔ EnumValue

Gets or sets how the tree should be constructed from the TreeEdges connecting TreeVertexes. Must be TreeLayout.PathDestination or TreeLayout.PathSource or TreeLayout.PathDefault.

getter/setter pair

portSpot ↔ Spot

Gets or sets the spot that this node's port gets as its FromSpot.

getter/setter pair

rootDefaults ↔ TreeVertex

Gets or sets the object holding the default values for root TreeVertexes.

getter/setter pair

roots ↔ Set<Object>

Gets or sets the collection of root vertexes.

getter/setter pair

rowIndent ↔ num

Gets or sets the default indentation of the first child of each row, if the #alignment is not a "Center" alignment.

getter/setter pair

rowSpacing ↔ num

Gets or sets the distance between rows or columns of a parent node's immediate children.

getter/setter pair

setsChildPortSpot ↔ bool

Gets or sets whether the TreeLayout should set the ToSpot for each child node port.

getter/setter pair

setsPortSpot ↔ bool

Gets or sets whether the TreeLayout should set the FromSpot for this parent node port.

getter/setter pair

sorting ↔ EnumValue

Gets or sets the default sorting policy for ordering the immediate children of a vertex. Must be TreeLayout.SortingForwards, TreeLayout.SortingReverse, TreeLayout.SortingAscending, or TreeLayout.SortingDescending.

getter/setter pair

treeStyle ↔ EnumValue

Gets or sets the Style for the resulting trees. Must be TreeLayout.StyleLayered, TreeLayout.StyleAlternating, TreeLayout.StyleLastParents, or TreeLayout.StyleRootOnly.

getter/setter pair

Methods

addComments(TreeVertex v) → void

Find any associated objects to be positioned along with the LayoutVertex#node.

arrangeTrees() → void

Position each separate tree.

assignTreeVertexValues(TreeVertex v) → void

Assign final property values for a TreeVertex.

commitLayers(Array<Rect> layerRects, Point offset) → void

This overridable method is called by #commitLayout if #layerStyle is LayerUniform to support custom arrangement of bands or labels across each layout layer. By default this method does nothing.

commitLayout() → void

Set the fromSpot and toSpot on each Link, position each Node according to the vertex position, and then position/route the Links.

commitLinks() → void

Routes the links.

commitNodes() → void

Commit the position of all nodes.

computeBusLastRowSpacing(TreeVertex lastchild, num dist) → num

Get the amound of space to leave between the sibling child vertexes and this last odd vertex when the parent's TreeVertex#alignment is Bus or BusBranching.

computeBusNodeSpacing(TreeVertex child) → num

Get the amount of space to insert between a child vertex and its parent spine when the parent's TreeVertex#alignment is Bus or BusBranching.

computeLayerSpacing(TreeVertex v) → num

@expose @param {TreeVertex} v @return {number}

computeNodeIndent(TreeVertex v) → num

@expose @param {TreeVertex} v @return {number}

createNetwork() → TreeNetwork

Create a new LayoutNetwork of TreeVertexes and TreeEdges. @return {TreeNetwork} a new LayoutNetwork.

customAlignment(TreeVertex v, num offx, num offy, num subw, num subh) → Array<num>

(Undocumented) @expose @param v @param offx @param offy @param subw @param subh @returns

doLayout(Object coll) → void

Perform the tree layout.

initializeTreeVertexValues(TreeVertex v) → void

Assign initial property values for a TreeVertex.

layoutComments(TreeVertex v) → void

Position and TreeVertex#comments around the vertex.

makeNetwork(Object coll) → LayoutNetwork

Create and initialize a LayoutNetwork with the given nodes and links.