A SubtreeRootAlignment describes how a local root node is arranged in relation to its children.
Remarks
The actual placement depends on the orientation of the subtree rooted at the current local root node. All descriptions of the provided alignments refer to the top-to-bottom orientation described by NONE. In this case, the subtrees are placed below the local root and the local root is aligned horizontally above them.
Members
No filters for this type
Constants
The centers of the root node and the target of the critical edge will be aligned.
Critical edges are marked using an IMapper<K, V> registered using criticalEdgePriorities.
The critical edge may not be straight if subtrees are rotated or port constraints are assigned.
static
See Also
The root node is placed centered over its direct children. To determine the alignment, only NodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.
static
Horizontal SubtreeRootAlignment at the center above the ports of the children.
Horizontal SubtreeRootAlignment at the center above the ports of the children.
The root node is placed above the center of the ports of its children. To determine the alignment, only NodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.
This alignment is only suited for ISubtreePlacers that place all children in a single row.
static
Horizontal SubtreeRootAlignment left of the children.
Horizontal SubtreeRootAlignment left of the children.
The local root node leaves a distance specified by the given spacing to the leftmost child. To determine the alignment, only NodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.
static
Horizontal SubtreeRootAlignment at the left side.
Horizontal SubtreeRootAlignment at the left side.
The root node is placed left-aligned with its leftmost child. To determine the alignment, only NodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.
static
Horizontal SubtreeRootAlignment at the median child node.
Horizontal SubtreeRootAlignment at the median child node.
The root node is placed above the median of its children. To determine the alignment, only NodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.
This alignment is only suited for ISubtreePlacers that place all children in a single row.
static
Horizontal SubtreeRootAlignment at the right side.
Horizontal SubtreeRootAlignment at the right side.
The root node is placed right-aligned with its rightmost child. To determine the alignment, only NodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.
static
Horizontal SubtreeRootAlignment right of the children.
Horizontal SubtreeRootAlignment right of the children.
The root node leaves a distance specified by the given spacing to the rightmost child. To determine the alignment, only NodeLayouts are considered. Node labels are not included although they are also contained in SubtreeShapes.
static
Static Methods
Converts the given argument to an enum constant of this enum type.
Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static
Parameters
- value: SubtreeRootAlignment
- The value to convert to an enum constant.
Return Value
- SubtreeRootAlignment
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Returns the name of the given enum constant.
static
Parameters
- value: SubtreeRootAlignment
- The numeric value of an enum constant.
Return Value
- string
- The name of the enum constant.
Throws
- Exception ({ name: 'Error' })
- If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.