E

OrthogonalLayoutTreeSubstructureStyle

Show Usages
Specifies the various styles for arranging tree-like structures within an OrthogonalLayout.

Members

No filters for this type

Constants

ASPECT_RATIO

static
A style that yields tree layouts with an aspect ratio close to 1:1 that are generated by AspectRatioSubtreePlacer.
To achieve the aspect ratio, tree child nodes are organized in as many rows/columns as needed. Edges are routed orthogonally along the rows/columns. The parent node of the children is placed in a corner besides the child nodes depending on the tree layout orientation, e.g., left above the child nodes for top-to-bottom orientation.
static

Sample Graphs

ShownSetting: Tree style ASPECT_RATIO

See Also

Developer's Guide
API
treeSubstructureStyle

COMPACT

static
A style that aims to create maximally compact layouts for the subtrees by using the CompactSubtreePlacer for the tree layout algorithm.
The algorithm applied to the subtrees tries to combine different placement strategies such that the overall area required by subtrees is small. This means that the style of different tree structures can vary within the same layout.
static

Sample Graphs

ShownSetting: Tree style COMPACT

See Also

Developer's Guide
API
treeSubstructureStyle

DEFAULT

static
A style that arranges subtrees in a layered tree fashion with grouped edge routes, generated by a SingleLayerSubtreePlacer with routing style ORTHOGONAL and alignment setting CENTER.

Child nodes sharing the same parent node are placed next to each other above/below the root (vertical orientation) or above each other left/right of the root (horizontal orientation).

In contrast to INTEGRATED this style produces more compact layout results. However, the overall layout may be less homogeneous because the subtrees are separately arranged by a dedicated tree layout algorithm which does e.g., not consider the specified grid.

static

Sample Graphs

ShownSetting: Tree style DEFAULT

See Also

Developer's Guide
API
treeSubstructureStyle

INTEGRATED

static
A style that arranges subtrees in a layered tree fashion with grouped edge routes and integrates the tree elements into the orthogonal layout framework.

Child nodes sharing the same parent node are placed next to each other above/below the root (vertical orientation) or above each other left/right of the root (horizontal orientation).

In contrast to DEFAULT, the subtree elements are handled by the orthogonal layout framework internally. This makes the final layout more homogeneous, but potentially less compact. Furthermore, the grid will be correctly obeyed also for tree nodes.

static

Sample Graphs

ShownSetting: Tree style INTEGRATED

See Also

Developer's Guide
API
treeSubstructureStyle

NONE

static
A style that defines that subtrees should not be handled specifically.
Subtrees are not detected and will be arranged without specific emphasis of the tree structure.
static

Sample Graphs

ShownSetting: Tree style NONE

See Also

Developer's Guide
API
treeSubstructureStyle

Static Methods

from

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

Return Value

OrthogonalLayoutTreeSubstructureStyle
The enum constant that corresponds to the given argument.

getName

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

Parameters

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