TreeLayout class

This layout positions nodes of a tree-structured graph in layers (rows or columns).

For a discussion and examples of the most commonly used properties, see Trees page in the Introduction. If you want to experiment interactively with most of the properties, try the Tree Layout sample. See samples that make use of TreeLayout in the samples index.

This layout makes use of a LayoutNetwork of TreeVertexes and TreeEdges that normally correspond to the Nodes and Links of the Diagram.

The most commonly set properties for controlling the results of a TreeLayout are:

• #angle: the direction in which the tree grows, from parent to child; the default value of zero means that the tree grows towards the right, with the children of a node arranged in a layer that is a column. An angle of 0 or 180 means that children form vertical layers -- breadth is height and depth is width; an angle of 90 or 270 means that children form horizontal layers -- breadth is width and depth is height.
• #layerSpacing: the distance between layers -- between a parent node and its child nodes.
• #nodeSpacing: the distance between nodes within a layer -- between siblings.
• #alignment: the relative position of a parent node with its children.
• #sorting and #comparer: specify the order of the immediate children of a parent node.
• #compaction: whether subtrees should be packed closer together if there is room.
• #layerStyle: whether the children of one node are aligned with the children of a sibling node.
• #setsPortSpot, #portSpot, #setsChildPortSpot, and #childPortSpot: this controls whether to set the Link#fromSpot and Link#toSpot to be sensible for the #angle.
• #nodeIndent and #nodeIndentPastParent: if the #alignment is TreeLayout.AlignmentStart or TreeLayout.AlignmentEnd, control how much extra space the first child is given when positioned.
• #breadthLimit, #rowSpacing: try to limit the total breadth of a subtree to a certain distance; when there are too many children or when they are too broad, this puts children into additional rows (or columns, depending on the angle) thereby limiting the breadth while increasing the depth of the tree.

When you set one of the TreeLayout properties listed above, that property normally applies to all of the nodes in the tree. What if you want #alignment to be TreeLayout.AlignmentCenterChildren for the root node but TreeLayout.AlignmentBus for the other nodes in the tree? Or what if you want want #layerSpacing to be 50 for all layers except for the layer separating "leaf" nodes from their parent?

One common solution is to set #treeStyle. For the former scenario, you could set #treeStyle to TreeLayout.StyleRootOnly; the value of #alignment would only apply to the root node. For the latter scenario, you could set it to TreeLayout.StyleLastParents; the value of #layerSpacing would apply to all nodes except those that have children but that do not have grandchildren. How do you then set the alignment or layerSpacing for the other nodes? By setting the TreeLayout properties whose names start with "alternate...". In these cases that would mean setting #alternateAlignment or #alternateLayerSpacing.

These TreeLayout properties actually apply to the TreeVertex that the TreeLayout uses to represent a Node within the LayoutNetwork. All of those TreeLayout properties are actually stored in #rootDefaults; all of the "alternate..." properties are stored in #alternateDefaults. Depending on the value of #treeStyle, the actual TreeVertex properties for each Node are copied appropriately from either rootDefaults or alternateDefaults. In the default case where treeStyle is TreeLayout.StyleLayered, the alternateDefaults are ignored. (Note that treeStyle, and a few other properties such as #path and #arrangement, apply to the whole layout, not to an individual node/vertex.)

The use of #treeStyle and "alternate..." TreeLayout properties will cover a lot of common needs for tree layout customization. However, there may be times when that is not enough. Imagine a situation where you want a special TreeVertex property value for a particular Node. The solution is to override #assignTreeVertexValues, where you can examine the given TreeVertex, including its corresponding LayoutVertex#node, to decide what TreeVertex property values should apply.

Implemented types

• Layout

Available extensions

• Layout$Typings
• TreeLayout$Typings

Annotations

• @JS()
• @staticInterop

Constructors

TreeLayout([dynamic init])

factory

Properties

alignment ↔ EnumValue

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the alternate direction for tree growth.

getter/setter pair

alternateBreadthLimit ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

alternateChildPortSpot ↔ Spot

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

alternateCommentSpacing ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the alternate distance between comments.

getter/setter pair

alternateCompaction ↔ EnumValue

Available on TreeLayout, provided by the TreeLayout$Typings extension

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)

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

alternateDefaults ↔ TreeVertex

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

alternateLayerSpacingParentOverlap ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the alternate indentation of the first child.

getter/setter pair

alternateNodeIndentPastParent ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the alternate distance between child nodes.

getter/setter pair

alternatePortSpot ↔ Spot

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

alternateRowIndent ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the alternate distance between rows of children.

getter/setter pair

alternateSetsChildPortSpot ↔ bool

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

alternateSetsPortSpot ↔ bool

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

alternateSorting ↔ EnumValue

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the default direction for tree growth.

getter/setter pair

arrangement ↔ EnumValue

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

arrangementOrigin ↔ Point

Available on Layout, provided by the Layout$Typings extension

Gets or sets the top-left point for where the graph should be positioned when laid out. The default value for this property is the Point(0, 0). Setting this property to a new value invalidates this layout. This property is likely to be set by many Layouts that belong to a Group when the layout is performed.

getter/setter pair

arrangementSpacing ↔ Size

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

boundsComputation ↔ Rect Function(Part, Layout, Rect)?

Available on Layout, provided by the Layout$Typings extension

Gets or sets a function that determines the initial size and position in document coordinates of a LayoutVertex corresponding to a Node. This function is called by #getLayoutBounds. The default value for this property is null, in which case the GraphObject#actualBounds of the Node is used. Setting this property to a new value invalidates this layout.

getter/setter pair

breadthLimit ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

childPortSpot ↔ Spot

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

commentMargin ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

comments ↔ bool

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the distance between comments.

getter/setter pair

compaction ↔ EnumValue

Available on TreeLayout, provided by the TreeLayout$Typings extension

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)

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

diagram ↔ Diagram?

Available on Layout, provided by the Layout$Typings extension

Gets the Diagram that owns this layout, if it is the value of Diagram#layout.

getter/setter pair

group ↔ Group?

Available on Layout, provided by the Layout$Typings extension

Gets the Group that uses this layout, if it is the value of a group's Group#layout.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isInitial ↔ bool

Available on Layout, provided by the Layout$Typings extension

Gets or sets whether this layout is performed on an initial layout. The default value is true. Setting this property to false causes #isValidLayout to be set to true so that the diagram does not perform this layout.

getter/setter pair

isOngoing ↔ bool

Available on Layout, provided by the Layout$Typings extension

Gets or sets whether this layout can be invalidated by #invalidateLayout. Set this to false to prevent actions such as adding or removing Parts from invalidating this layout. The default value is true. Setting this property does not invalidate this layout.

getter/setter pair

isRealtime ↔ bool?

Available on Layout, provided by the Layout$Typings extension

Gets or sets whether this layout be performed in real-time, before the end of a transaction. All layouts that are invalidated will be performed at the end of a transaction. The default value is null. A null value is treated as true for a Diagram#layout but false for a Group#layout. Setting this property does not invalidate this layout.

getter/setter pair

isRouting ↔ bool

Available on Layout, provided by the Layout$Typings extension

Gets or sets whether this layout routes Links. The default value is true. When false, this layout will not explicitly set the Link#points, and the default routing of each individual Link will take place after the Nodes are moved by #commitLayout. Setting this property does not invalidate this layout.

getter/setter pair

isValidLayout ↔ bool

Available on Layout, provided by the Layout$Typings extension

Gets or sets whether this layout needs to be performed again (if false). Instead of setting this property directly, it is normal to set it to false by calling #invalidateLayout, since that also requests performing a layout in the near future.

getter/setter pair

isViewportSized ↔ bool

Available on Layout, provided by the Layout$Typings extension

Gets or sets whether this layout depends on the Diagram#viewportBounds's size. If set to true, the layout will invalidate when the Diagram's viewport changes size. This only applies to diagram layouts, not to group layouts, and only when Diagram#autoScale is set to Diagram.None.

getter/setter pair

layerSpacing ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

layerSpacingParentOverlap ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

network ↔ LayoutNetwork?

Available on Layout, provided by the Layout$Typings extension

Gets or sets the LayoutNetwork used by this Layout, if any. The default value is null. Setting this property does not invalidate this layout. Not all kinds of layout make use of a LayoutNetwork. Call #createNetwork or #makeNetwork to create a network.

getter/setter pair

nodeIndent ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the default indentation of the first child.

getter/setter pair

nodeIndentPastParent ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the distance between child nodes.

getter/setter pair

path ↔ EnumValue

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

rootDefaults ↔ TreeVertex

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

roots ↔ Set<Object>

Available on TreeLayout, provided by the TreeLayout$Typings extension

Gets or sets the collection of root vertexes.

getter/setter pair

rowIndent ↔ num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

setsChildPortSpot ↔ bool

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

setsPortSpot ↔ bool

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

getter/setter pair

sorting ↔ EnumValue

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

arrangeTrees() → void

Available on TreeLayout, provided by the TreeLayout$Typings extension

Position each separate tree.

assignTreeVertexValues(TreeVertex v) → void

Available on TreeLayout, provided by the TreeLayout$Typings extension

Assign final property values for a TreeVertex.

cloneProtected(Layout copy) → void

Available on Layout, provided by the Layout$Typings extension

Copies properties from this object to the given object, which is of the same class. This is called by #copy and should be overridden for each class that adds properties. There are examples of such overrides in the samples. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

collectParts(Object coll) → Set<Part>

Available on Layout, provided by the Layout$Typings extension

A convenient way of converting the Diagram|Group|Iterable argument to doLayout to an actual collection of eligible Parts. The resulting Set will not include any Nodes or Links for which Part#canLayout is false. If the argument includes a Group for which Group#layout is null, the resulting Set will include the member parts of that group rather than that group itself. You will not need to call collectParts if you call #makeNetwork, because that method does effectively the same thing when building the LayoutNetwork.

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on Layout, provided by the Layout$Typings extension

When using a LayoutNetwork, commit changes to the diagram by setting Node positions and by routing the Links. This is called by #updateParts within a transaction.

commitLayout() → void

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

commitLinks() → void

Available on TreeLayout, provided by the TreeLayout$Typings extension

Routes the links.

commitNodes() → void

Available on TreeLayout, provided by the TreeLayout$Typings extension

Commit the position of all nodes.

computeBusLastRowSpacing(TreeVertex lastchild, num dist) → num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

computeNodeIndent(TreeVertex v) → num

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

copy() → Layout

Available on Layout, provided by the Layout$Typings extension

Creates a copy of this Layout and returns it. When a Group is copied that has a Group#layout, the Layout must also be copied. This calls #cloneProtected on a newly constructed Layout. @expose @return {Layout}

createNetwork() → LayoutNetwork

Available on Layout, provided by the Layout$Typings extension

Create a new LayoutNetwork of LayoutVertexes and LayoutEdges. This may be overridden in Layout subclasses to create instances of subclasses of LayoutNetwork. Please read the Introduction page on Extensions for how to override methods and how to call this base method. @expose @return {LayoutNetwork} a new LayoutNetwork.

createNetwork() → TreeNetwork

Available on TreeLayout, provided by the TreeLayout$Typings extension

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>

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

doLayout(Object coll) → void

Available on Layout, provided by the Layout$Typings extension

Position all of the nodes that do not have an assigned Part#location in the manner of a simple rectangular array. The default implementation ignores all Groups and Links; many subclasses of Layout ignore all instances of Parts that are not Nodes or Links.

doLayout(Object coll) → void

Available on TreeLayout, provided by the TreeLayout$Typings extension

Perform the tree layout.

getLayoutBounds(Part part, [Rect? rect]) → Rect

Available on Layout, provided by the Layout$Typings extension

This method is called by layouts to determine the size and initial position of the nodes that it is laying out. Normally this just returns the part's GraphObject#actualBounds. However, if #boundsComputation has been set to a function, that function will be called in order to return the bounds of the given Part in document coordinates that the layout should pretend it has. @param {Part} part the Part being laid out @param {Rect=} rect an optional Rect that will be modified and returned @return {Rect} a Rect in document coordinates @since 2.0

initializeTreeVertexValues(TreeVertex v) → void

Available on TreeLayout, provided by the TreeLayout$Typings extension

Assign initial property values for a TreeVertex.

initialOrigin(Point origin) → Point

Available on Layout, provided by the Layout$Typings extension

Compute the desired value of #arrangementOrigin if this Layout is being performed for a Group. This is typically called near the beginning of the implementation of #doLayout: this.arrangementOrigin = this.initialOrigin(this.arrangementOrigin); if the layout wants to respect the pre-layout location of the Group when deciding where to position its member nodes.

invalidateLayout() → void

Available on Layout, provided by the Layout$Typings extension

If #isOngoing is true and if an initial layout has not yet been performed, set the #isValidLayout property to false, and ask to perform another layout in the near future. If #isInitial is true, this layout is invalidated only when the Diagram#model is replaced, not under the normal circumstances such as when parts are added or removed or due to other calls to Layout#invalidateLayout.

layoutComments(TreeVertex v) → void

Available on TreeLayout, provided by the TreeLayout$Typings extension

Position and TreeVertex#comments around the vertex.

makeNetwork(Object coll) → LayoutNetwork

Available on Layout, provided by the Layout$Typings extension

Create and initialize a LayoutNetwork with the given nodes and links. This should be called by #doLayout when this layout uses a #network. This method calls #createNetwork to allocate the network. This may be overridden in Layout subclasses to customize the initialization. Please read the Introduction page on Extensions for how to override methods and how to call this base method. @expose @param {Diagram|Group|Iterable.

makeNetwork(Object coll) → LayoutNetwork

Available on TreeLayout, provided by the TreeLayout$Typings extension

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateParts() → void

Available on Layout, provided by the Layout$Typings extension

When using a LayoutNetwork, update the "physical" node positionings and link routings. This should be called by #doLayout when this layout uses a #network. This calls #commitLayout to actually set Node positions and route Links. This performs the changes within a transaction. Please read the Introduction page on Extensions for how to override methods and how to call this base method. @expose

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

alignmentBottomRightBus ↔ EnumValue

The children are positioned in a bus, only on the bottom or right side of the parent; this value is used for TreeLayout#alignment or TreeLayout#alternateAlignment.

getter/setter pair

alignmentBus ↔ EnumValue

The children are positioned in a bus on both sides of an "aisle" where the links to them go, with the last odd child (if any) placed at the end of the aisle in the middle; this value is used for TreeLayout#alignment or TreeLayout#alternateAlignment.

getter/setter pair

alignmentBusBranching ↔ EnumValue

Like TreeLayout.AlignmentBus with the children arranged on both sides of an "aisle" with any last odd child placed at the end of the aisle, but the children get an TreeVertex#angle that depends on which side of the aisle they were placed; this value is used for TreeLayout#alignment or TreeLayout#alternateAlignment.

getter/setter pair

alignmentCenterChildren ↔ EnumValue

The parent is centered at the middle of the range of its immediate child nodes; this value is used for TreeLayout#alignment or TreeLayout#alternateAlignment.

getter/setter pair

alignmentCenterSubtrees ↔ EnumValue

The parent is centered at the middle of the range of its child subtrees; this value is used for TreeLayout#alignment or TreeLayout#alternateAlignment.

getter/setter pair

alignmentEnd ↔ EnumValue

The parent is positioned near the last of its children; this value is used for TreeLayout#alignment or TreeLayout#alternateAlignment.

getter/setter pair

alignmentStart ↔ EnumValue

The parent is positioned near the first of its children; this value is used for TreeLayout#alignment or TreeLayout#alternateAlignment.

getter/setter pair

alignmentTopLeftBus ↔ EnumValue

The children are positioned in a bus, only on the top or left side of the parent; this value is used for TreeLayout#alignment or TreeLayout#alternateAlignment.

getter/setter pair

arrangementFixedRoots ↔ EnumValue

Do not move each root node, but position all of their descendants relative to their root; this value is used for TreeLayout#arrangement.

getter/setter pair

arrangementHorizontal ↔ EnumValue

Position each tree in a non-overlapping fashion by increasing X coordinates, starting at the Layout#arrangementOrigin; this value is used for TreeLayout#arrangement.

getter/setter pair

arrangementVertical ↔ EnumValue

Position each tree in a non-overlapping fashion by increasing Y coordinates, starting at the Layout#arrangementOrigin; this value is used for TreeLayout#arrangement.

getter/setter pair

compactionBlock ↔ EnumValue

A simple fitting of subtrees; this value is used for TreeLayout#compaction or TreeLayout#alternateCompaction.

getter/setter pair

compactionNone ↔ EnumValue

Only simple placement of children next to each other, as determined by their subtree breadth; this value is used for TreeLayout#compaction or TreeLayout#alternateCompaction.

getter/setter pair

layerIndividual ↔ EnumValue

The normal layer style, where each node takes up only the depth that it needs; this value is used for TreeLayout#layerStyle.

getter/setter pair

layerSiblings ↔ EnumValue

A layer style where all of the children of a parent node take up the same amount of depth -- this typically causes all cousins to be aligned; this value is used for TreeLayout#layerStyle.

getter/setter pair

layerUniform ↔ EnumValue

A layer style where all nodes with the same TreeVertex#level throughout the tree take up the same amount of depth -- if the TreeVertex#angle is the same for all nodes, this will result in all nodes in the same layer to be aligned; this value is used for TreeLayout#layerStyle.

getter/setter pair

pathDefault ↔ EnumValue

This value for TreeLayout#path causes the value of Diagram#isTreePathToChildren to effectively choose either TreeLayout.PathDestination (if true) or TreeLayout.PathSource (if false).

getter/setter pair

pathDestination ↔ EnumValue

The children of a TreeVertex are its LayoutVertex#destinationVertexes, the collection of connected LayoutEdge#toVertexes; this value is used for TreeLayout#path.

getter/setter pair

pathSource ↔ EnumValue

The children of a TreeVertex are its LayoutVertex#sourceVertexes, the collection of connected LayoutEdge#fromVertexes; this value is used for TreeLayout#path.

getter/setter pair

sortingAscending ↔ EnumValue

Lay out each child according to the sort order given by TreeVertex#comparer; this value is used for TreeLayout#sorting or TreeLayout#alternateSorting.

getter/setter pair

sortingDescending ↔ EnumValue

Lay out each child in reverse sort order given by TreeVertex#comparer; this value is used for TreeLayout#sorting or TreeLayout#alternateSorting.

getter/setter pair

sortingForwards ↔ EnumValue

Lay out each child in the order in which they were found; this value is used for TreeLayout#sorting or TreeLayout#alternateSorting.

getter/setter pair

sortingReverse ↔ EnumValue

Lay out each child in reverse order from which they were found; this value is used for TreeLayout#sorting or TreeLayout#alternateSorting.

getter/setter pair

styleAlternating ↔ EnumValue

Alternate layers of the tree have different properties, typically including the angle; this value is used for TreeLayout#treeStyle.

getter/setter pair

styleLastParents ↔ EnumValue

Just like the standard layered tree style, except that the nodes with children but no grandchildren have alternate properties; this value is used for TreeLayout#treeStyle.

getter/setter pair

styleLayered ↔ EnumValue

The normal tree style, where all of the children of each TreeVertex are lined up horizontally or vertically; this value is used for TreeLayout#treeStyle.

getter/setter pair

styleRootOnly ↔ EnumValue

All of the nodes get the alternate properties, except the root node gets the default properties; this value is used for TreeLayout#treeStyle.

getter/setter pair