This class implements a layout stage that handles a given partition grid structure.
Remarks
Information about the partition grid structure are held by a IDataProvider registered with the graph with key PARTITION_GRID_DP_KEY.
Type Details
- yfiles module
- layout-hierarchic
- yfiles-umd modules
- layout-familytree, layout-hierarchic, layout-radial, layout
- Legacy UMD name
- yfiles.hierarchic.PartitionGridLayoutStage
See Also
This stage is automatically added by the HierarchicLayout, if required.
Constructors
Creates a new instance of PartitionGridLayoutStage.
Properties
Gets or sets the core layout algorithm that is wrapped by this stage.
Methods
Calculates the layout based on a PartitionGrid structure.
Remarks
If no PartitionGrid structure exists, the core layouter will be called immediately.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph
See Also
Migrating from Synchronous to Asynchronous Layout Calculation,
Using Buffered Layout,
Writing a Custom Layout Stage
The given graph will not be copied during the layout process and the layout will be immediately applied to the given graph.
Implements
Invokes the layout process of the core layout algorithm.
Remarks
Overriding classes may call this method during applyLayout to delegate arranging the graph to the core layout algorithm. They can add pre- and post-processing code before and after this call.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph