This layout stage enables support for handling a graph with a PartitionGrid structure.
Remarks
Concept
Before executing the core layout algorithm, this stage prepares the grid structure of the graph accordingly, e.g., by hiding top-level grid nodes. Then, the core layout algorithm is applied to the graph. Finally, the grid is restored, configured and positioned such that it is consistent with the layout computed by the core algorithm.
Information about the PartitionGrid structure is retrieved from a IDataProvider registered with the graph using key PARTITION_GRID_DP_KEY.
Usage
When using OrganicLayout, this stage will automatically be used, if required. It is not necessary to append this stage manually to OrganicLayout.
Appending this stage can be useful to add support for partition grid structures to other ILayoutAlgorithms.
The stage can be appended to all algorithms of type MultiStageLayout by using method appendStage.
Default Values of Properties
| coreLayout | null |
Type Details
- yfiles module
- layout-organic
- yfiles-umd modules
- layout-multipage, layout-organic, layout
- Legacy UMD name
- yfiles.organic.OrganicPartitionGridLayoutStage
See Also
Constructors
Creates a new instance of OrganicPartitionGridLayoutStage with the given layout algorithm as core algorithm.
Parameters
A map of options to pass to the method.
- coreLayout - ILayoutAlgorithm
- the core layout algorithm
Properties
Gets or sets the core layout algorithm that is wrapped by this stage.
Methods
Calculates the layout according to the core layout algorithm, while considering an existing partition grid structure defined for the graph.
Remarks
Parameters
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph
Throws
- Exception({ name: 'InvalidGraphStructureError' })
- if the graph has group nodes whose content spans multiple grid cells or if the associated group node mode data is equal to FIX_CONTENTS or FIX_BOUNDS.
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