E

SeriesParallelLayoutPortAssignmentMode

Show Usages
Specifies how ports are positioned on nodes for incoming and outgoing edges in a SeriesParallelLayout.

Members

No filters for this type

Constants

CENTER

static
All ports are reset to the center of their nodes, and the edges leave the nodes on the top/bottom.
Incoming edges enter the node on the top, and outgoing edges leave the node on the bottom.
Ports that are restricted by fixed LayoutPortCandidates are excluded. They will keep their current locations on the node.
static

Sample Graphs

ShownSetting: Centered ports; the edges enter and leave the ports in the flow direction

See Also

API
ports

CENTER_ON_SIDE

static
All ports are reset to the center of their nodes, and the edges may enter and leave the nodes on all sides.
In the default flow direction from top to bottom, the direction in which the edges enter and leave the nodes is determined as follows. If an outgoing edge can be drawn straight (without any bends) or it is the only outgoing edge of its source, it leaves its source at the bottom. Otherwise, it leaves its source on the right or left side. Similarly, if an incoming edge can be drawn straight (without any bends) or it is the only incoming edge of its target, it enters its target at the top. Otherwise, it enters its target on the right or left side.
Ports that are restricted by fixed LayoutPortCandidates are excluded. They will keep their current locations on the node.
static

Sample Graphs

ShownSetting: Ports are centered, and edges may enter and leave the nodes to the side

See Also

API
ports

DISTRIBUTED

static
The ports of incoming and outgoing edges are distributed evenly and enter and leave the nodes in the flow direction.

In the default flow direction from top to bottom incoming edges enter the node on the top, and outgoing edges leave the node on the bottom.

The source ports of edges without LayoutPortCandidates will be distributed at the sides of their source and target nodes. Edges with free LayoutPortCandidates are distributed at the side of the nodes which is specified in the LayoutPortCandidate.

Grouped edges will get the same port location.

Ports that are restricted by fixed LayoutPortCandidates are excluded. They will keep their current locations on the node.
static

Sample Graphs

ShownSetting: Distributed Ports at the top and bottom

See Also

API
ports, sourceGroupIds, targetGroupIds

DISTRIBUTED_ON_SIDE

static
Ports are assigned to the sides of the node, and ports at the same side are distributed evenly.

In the default flow direction from top to bottom, the direction in which the edges enter and leave the nodes is determined as follows. If an outgoing edge can be drawn straight (without any bends) or it is the only outgoing edge of its source, it leaves its source at the bottom. Otherwise, it leaves its source on the right or left side. Similarly, if an incoming edge can be drawn straight (without any bends) or it is the only incoming edge of its target, it enters its target at the top. Otherwise, it enters its target on the right or left side.

The source ports of edges without LayoutPortCandidates will be distributed at the sides of their source and target nodes. Edges with free LayoutPortCandidates are distributed at the side of the nodes which is specified in the LayoutPortCandidate.

Grouped edges will get the same port location.

Ports that are restricted by fixed LayoutPortCandidates are excluded. They will keep their current locations on the node.
static

Sample Graphs

ShownSetting: Ports are distributed on all sides

See Also

API
ports, sourceGroupIds, targetGroupIds

Static Methods

from

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

Return Value

SeriesParallelLayoutPortAssignmentMode
The enum constant that corresponds to the given argument.

getName

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

Parameters

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