E

ChildAlignmentPolicy

Show Usages
Specifies the alignment policies for child nodes under the same parent in a TreeLayout.

Remarks

This enumeration provides different strategies for aligning child nodes with respect to their parent node. Each policy impacts how child nodes are distributed around the parent node, affecting the overall layout and compactness of the tree. The alignment strategies include placing nodes at equal distances from the parent, adjusting for edge labels, or balancing between symmetry and compactness.

Members

No filters for this type

Constants

COMPACT

static
Alignment policy for aligning child nodes such that the distances to their parent are kept short and drawings can potentially become more compact.

This policy realizes the exact same child alignment as PLAIN if there are no edge labels associated with edges going to child nodes or if edgeLabelPlacement is not set to INTEGRATED.

If edge labels need to be considered, edge labels will be added to the convex hull of the child node to which the edge connects. This means that child nodes connected with a labeled edge will be aligned at the border where the edge label begins. In consequence, edge labels will be aligned with neighboring edge labels as well as neighboring child nodes if a child node has no edge label at its incoming edge.

This alignment strategy is especially effective if large edge labels need to be considered while drawings should still be compact and distances from parent to child nodes short.

Since compactness is prioritized in conjunction with large edge labels, drawings may lack symmetry regarding node distances.
static

Sample Graphs

ShownSetting: Compact alignment of child nodes

See Also

Developer's Guide
API
childAlignmentPolicy

PLAIN

static
Alignment policy to align child nodes rooted at the same parent such that the border of their convex hull has the same distance to the parent node's center.
Convex hulls of nodes are always defined as circles.
Two different distances will be realized, if the nodes shall be interleaved .
static

Sample Graphs

ShownSetting: All child nodes with equal distance between their convex hull border and the parent

See Also

Developer's Guide
API
childAlignmentPolicy

SAME_CENTER

static
Alignment policy to align child nodes rooted at the same parent such that each child has the same center-to-center distance to the parent node.
All nodes will be placed on a common radius around their parent, respective to their center coordinates.
Two different radii will be realized, if the nodes shall be interleaved .
static

Sample Graphs

ShownSetting: All child nodes with equal center-to-center distance to the parent

See Also

Developer's Guide
API
childAlignmentPolicy

SMART

static
Alignment policy to align child nodes rooted at the same parent using a mixture of the other policies and aiming to achieve symmetry and compactness at the same time.
Similar to SAME_CENTER, this policy aims to achieve alignments featuring equal distances between parent and child node centers. However, a much larger distance for all child nodes caused by single large subtrees is avoided by this policy. In such cases, the smaller subtrees may be placed on a common radius and the large subtrees are placed with different distances.
Has no effect if the nodes shall be interleaved . In that case, a PLAIN child alignment will be applied instead.
static

See Also

Developer's Guide
API
childAlignmentPolicy

Static Methods

from

(value: ChildAlignmentPolicy): ChildAlignmentPolicy
static
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: ChildAlignmentPolicy
The value to convert to an enum constant.

Return Value

ChildAlignmentPolicy
The enum constant that corresponds to the given argument.

getName

(value: ChildAlignmentPolicy): string
static
Returns the name of the given enum constant.
static

Parameters

value: ChildAlignmentPolicy
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.