E

LabelAlongEdgePlacements
flags

Show Usages
Specifies preferred placement positions for edge labels along the edge path in a graph layout.

Remarks

The LabelAlongEdgePlacements enum offers several predefined constants that indicate where an edge label should be placed relative to an edge's source, target, or along its path. This flexibility allows for precise control over label positioning in complex graph layouts.

See Also

API

createSharedPlacement, placementAlongEdge

Members

No filters for this type

Constants

ANYWHERE

static
Preferred placement specifier for edge labels which expresses that the label can be placed anywhere along the edge.

AT_CENTER

static
Preferred placement specifier for edge labels which expresses that the label should be placed near the center of the edge path.
static

Sample Graphs

AT_SOURCE

static
Preferred placement specifier for edge labels which expresses that the label should be placed near the source node of an edge.
static

Sample Graphs

AT_SOURCE_PORT

static
Preferred placement specifier for edge labels which expresses that the label should be placed directly at the source port of the edge.
Placement at the source port is currently only supported by HierarchicalLayout with edgeLabelPlacement set to INTEGRATED edge labeling. In some cases the labels may be treated as labels with the specifier AT_SOURCE:
  • if there is not enough space at the source node,
  • if there are aligned ports at the source node, or
  • if the source node is part of a tabular group.
static

Sample Graphs

ShownSetting: Source port label right of the edge

AT_TARGET

static
Preferred placement specifier for edge labels which expresses that the label should be placed near the target node of an edge.
static

Sample Graphs

AT_TARGET_PORT

static
Preferred placement specifier for edge labels which expresses that the label should be placed directly at the target port of the edge.
Placement at the target port is currently only supported by HierarchicalLayout with edgeLabelPlacement set to INTEGRATED edge labeling. In some cases the labels may be treated as labels with the specifier AT_TARGET:
  • if there is not enough space at the target node,
  • if there are aligned ports at the target node, or
  • if the target node is part of a tabular group.
static

Sample Graphs

ShownSetting: Target port label right of the edge

Static Methods

from

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

Return Value

LabelAlongEdgePlacements
The enum constant that corresponds to the given argument.

getName

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

Parameters

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