E

HierarchicalLayoutPortAssignmentMode

Show Usages
Specifies different strategies for assigning ports to nodes in a HierarchicalLayout.

Remarks

This enumeration defines how ports are allocated to nodes, which affects how edges connect to nodes. The chosen strategy can influence the visual clarity and organization of the layout.

Members

No filters for this type

Constants

DEFAULT

static
A port assignment strategy that distributes ports evenly along the border of the node.
This is the default port assignment strategy of HierarchicalLayout.
static

Sample Graphs

See Also

Developer's Guide
API
portAssignment

ON_GRID

static
A port assignment strategy that places all edges on grid lines.
If there are not enough grid lines for each port, ports may overlap. In case there is no grid line available at the side of a node, the ports are placed centered at that side.
This port assignment can only be used if the gridSpacing is greater than 0.
static

Sample Graphs

ShownSetting: Grid size 20

See Also

Developer's Guide
API
portAssignment

ON_SUBGRID

static
A port assignment strategy that places all edges on grid lines or sub-grid lines.
If there are not enough grid lines for each port, the grid gets subdivided with sub-grid lines until each edge has space for its port.
This port assignment can only be used if the gridSpacing is greater than 0.
static

Sample Graphs

ShownSetting: Major grid size 20 - sub-grid 10

See Also

Developer's Guide
API
portAssignment

Static Methods

from

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

Return Value

HierarchicalLayoutPortAssignmentMode
The enum constant that corresponds to the given argument.

getName

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

Parameters

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