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.
Type Details
- yFiles module
- algorithms
See Also
Constants
Preferred placement specifier for edge labels which expresses that the label should be placed directly at the source port of the edge.
Sample Graphs
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.
Preferred placement specifier for edge labels which expresses that the label should be placed directly at the target port of the edge.
Sample Graphs
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 Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Most notably, this method can convert an enum constant's name into the enum constant itself.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - LabelAlongEdgePlacements
- The value to convert to an enum constant.
Returns
- ↪LabelAlongEdgePlacements
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - LabelAlongEdgePlacements
- The numeric value of an enum constant.
Returns
- ↪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.