Swimlanes provides helper classes and methods to handle swimlanes.
Inheritance Hierarchy
Swimlanes
Remarks
It is used by HierarchicLayout to arrange the nodes in lanes.
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.Swimlanes
Static Methods
Calculates an ordering of the swimlanes.
Remarks
The ordering will try to reduce:
- the number of swimlanes traversed by edges
- the number of swimlanes spanned by group nodes
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - Graph
- the input graph
- node2Swimlane - IDataProvider
- the assignment of nodes to swimlanes
Domain YNode Values SwimlaneRepresentative the representative swimlane to which the node is assigned
See Also
A group node can span a swimlane without having a descendant in it.
After calling this method, swimlanePos returns an integer value
(>= 0) for each swimlane representative denoting the optimized position of the associated swimlane.arrangeSwimlanes
(graph: Graph, node2Swimlane: IDataProvider, iterations: number, mode: SwimlanesMode)Calculates an ordering of the swimlanes considering the specified ordering mode.
Remarks
Depending on the swimlane mode, the ordering will try to reduce:
- the number of swimlanes traversed by edges
- the number of swimlanes spanned by group nodes
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - Graph
- the input graph
- node2Swimlane - IDataProvider
- the assignment of nodes to swimlanes
Domain YNode Values SwimlaneRepresentative the representative swimlane to which the node is assigned - iterations - number
- the number of iterations performed by the heuristic.
- mode - SwimlanesMode
- one of the valid swimlane ordering mode specifier
See Also
A group node can span a swimlane without having a descendant in it.
After calling this method, swimlanePos returns an integer value
(>= 0) for each swimlane representative denoting the optimized position of the associated swimlane.