Enum constants that specify how an edge is affected by the EdgeRouter.
Type Details
- yFiles module
- algorithms
See Also
Constants
A scope specifier that defines that the edge should not be routed by the EdgeRouter.
A scope specifier that defines that based on the current path it is automatically determined whether an edge is routed, and if so, the edge gets a whole new path.
Remarks
The automatic selection examines the existing, given path of an edge. Based on various criteria it heuristically determines whether or not it needs to be routed. For example, intersections with other elements or a routing style violation are clear indicators. A further criterion is when the port constraints/candidates are not properly satisfied. Edges deemed to be 'good' are not changed.
This policy is convenient for cases where it is not clear which edges the algorithm should route. For example, after a user interaction (moving a node, inserting new elements etc.), routing of edges might become necessary but depending on the action it can not definitely be said which edges need to be corrected.
Sample Graphs
A scope specifier that defines that based on the current path it is automatically determined whether the edge is routed, and if so, only the necessary segments are changed.
Remarks
This policy follows the same approach as PATH_AS_NEEDED for determining whether or not an edge is even routed. However, during routing, the changes are kept local. This means that only certain segments are changed, keeping the rest of the route, wherever appropriate. Edges deemed to be 'good' are not changed at all.
This policy is convenient for cases where it is not clear which edges the algorithm should route. For example, after a user interaction (moving a node, inserting new elements etc.), routing of edges might become necessary but depending on the action it can not definitely be said which edges need to be corrected.
Sample Graphs
Static Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Parameters
A map of options to pass to the method.
- value - EdgeRouterScope
- The value to convert to an enum constant.
Returns
- ↪EdgeRouterScope
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
A map of options to pass to the method.
- value - EdgeRouterScope
- 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.