This algorithm recursively removes node overlaps from a graph with a hierarchic group structure.
Remarks
Basically, this algorithm combines a RecursiveGroupLayout with a specific customizable shuffle algorithm as its core layout algorithm. The shuffle algorithm will be recursively applied to all groups of the input graph to remove node overlaps.
Since this algorithm is a ILayoutStage, a core layout algorithm can be specified. In consequence, this algorithm will perform its work after the core algorithm was executed.
Default Values of Properties
groupBoundsCalculator | MinimumSizeGroupBoundsCalculator
| |
shuffleLayout | ShuffleLayout
|
Type Details
- yfiles module
- layout-organic
- yfiles-umd modules
- layout-multipage, layout-organic, layout
- Legacy UMD name
- yfiles.organic.RecursiveShuffleLayout
See Also
Constructors
Creates a new RecursiveShuffleLayout instance with an optional core layout algorithm.
Parameters
A map of options to pass to the method.
- coreLayout - ILayoutAlgorithm
- The core layout algorithm.
- groupBoundsCalculator - ILayoutGroupBoundsCalculator
The ILayoutGroupBoundsCalculator instance that computes the sizes of all group nodes. This option sets the groupBoundsCalculator property on the created object.
- shuffleLayout - ILayoutAlgorithm
The ILayoutAlgorithm instance that is used for removing node overlaps. This option sets the shuffleLayout property on the created object.
Properties
Gets or sets the core layout algorithm that is wrapped by this stage.
Gets or sets the ILayoutGroupBoundsCalculator instance that computes the sizes of all group nodes.
Default Value
MinimumSizeGroupBoundsCalculator.Gets or sets the ILayoutAlgorithm instance that is used for removing node overlaps.
Remarks
Default Value
ShuffleLayout.Methods
Removes all node overlaps in the given graph, after executing the specified core layout algorithm.
Parameters
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph
See Also
Implements
Invokes the layout process of the core layout algorithm.
Remarks
Parameters
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph