Scope enumeration for various edge routing algorithms, used to define whether all edges are routed or only a subset.
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.router.Scope
See Also
Constants
A scope specifier which defines that only the selected edges of the input graph will be routed.
Remarks
The selection state of an edge is determined by a boolean value returned by a IDataProvider registered with a well-known key, specific for the routing algorithm: One of affectedEdgesDpKey, affectedEdgesDpKey, DEFAULT_AFFECTED_EDGES_DP_KEY, affectedEdgesDpKey, affectedEdgesDpKey, or affectedEdgesDpKey.
All other non-selected edges will be considered to have fixed routes.
See Also
Sample Graphs
A scope specifier which defines that all edges of the input graph will be routed.
A scope specifier which defines that only edges incident to selected nodes will be routed.
Remarks
The selection state of a node is determined by a boolean value returned by a IDataProvider registered with a well-known key, specific for the routing algorithm: One of affectedNodesDpKey, affectedNodesDpKey, affectedNodesDpKey, or affectedNodesDpKey.
All other edges that are incident to non-selected nodes will be considered to have fixed routes.
See Also
Sample Graphs
Static Methods
Converts the argument to EdgeRouterScope.
Parameters
A map of options to pass to the method.
- value - EdgeRouterScope
- The value to convert to EdgeRouterScope.
Returns
- ↪EdgeRouterScope
- Either
value
if it is already a EdgeRouterScope or an appropriate converted value.