Edge labeling policies defining how edge labels are handled by EdgeRouter.
Type Details
- yFiles module
- algorithms
Constants
The original placement of the edge labels that are marked as unaffected are considered, but relative positions to their owners are not changed.
Sample Graphs
The GenericLabeling algorithm is applied as a post-processing step of the main layout algorithm to the edge labels.
The layout algorithm's inbuilt edge labeling strategy is applied, which chooses label positions fitting the algorithm's layout style.
Remarks
If chosen, the routes of edges with labels can change significantly. The algorithm finds a position for labels and routes the edge near the label trying to consider the PreferredPlacementDescriptor. To do so, the route itself may need to take a detour that might otherwise not have been necessary. This especially holds true in cases where there is very little space for the labels and/or the labels are rather large.
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 - EdgeRouterEdgeLabelPlacement
- The value to convert to an enum constant.
Returns
- ↪EdgeRouterEdgeLabelPlacement
- 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 - EdgeRouterEdgeLabelPlacement
- 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.