Specifies preferred placement positions for edge labels relative to the edge path in a graph layout.
Remarks
The LabelEdgeSides enum allows for specifying where an edge label should be placed relative to the edge path, whether it be directly on the edge, or on one side of the edge. This flexibility is useful for controlling the layout and readability of labels in complex graph structures.
Type Details
- yFiles module
- algorithms
See Also
Constants
Preferred placement specifier for edge labels which expresses that the label should be placed on the left-hand side of the edge path.
Remarks
The side is interpreted relative to the direction of the edge, if no different sideReference is defined.
Sample Graphs
Preferred placement specifier for edge labels which expresses that the label should be placed on the right-hand side of the edge path.
Remarks
The side is interpreted relative to the direction of the edge, if no different sideReference is defined.
Sample Graphs
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 - LabelEdgeSides
- The value to convert to an enum constant.
Returns
- ↪LabelEdgeSides
- 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 - LabelEdgeSides
- 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.