A layout stage that hides the group nodes of hierarchically grouped graphs.
Remarks
This stage removes all group nodes and adjacent edges from the graph before passing it to the core layout algorithm. After the core layout algorithm has arranged the graph, the hidden elements will be reinserted.
This stage is used by layout algorithms that cannot handle grouped graphs.
Default Values of Properties
| hidingEmptyGroupNodes | true | All group nodes will be hidden. |
| resetEdgePaths | false | This stage does not reset the path of edges incident to group nodes. |
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.HideGroupsStage
See Also
Constructors
Creates an instance of HideGroupsStage with an optional core layout algorithm.
Parameters
A map of options to pass to the method.
- coreLayout - ILayoutAlgorithm
- The core layout algorithm.
- resetEdgePaths - boolean
Whether or not this stage resets the paths of edges incident to group nodes. This option sets the resetEdgePaths property on the created object.
- hidingEmptyGroupNodes - boolean
Whether or not empty group nodes, i.e., group nodes without children, will be hidden by this stage. This option sets the hidingEmptyGroupNodes property on the created object.
- groupBoundsCalculator - ILayoutGroupBoundsCalculator
The ILayoutGroupBoundsCalculator instance for calculating the sizes of group nodes. This option sets the groupBoundsCalculator 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 for calculating the sizes of group nodes.
Remarks
Default Value
Gets or sets whether or not this stage resets the paths of edges incident to group nodes.
Remarks
Default Value
false.This stage does not reset the path of edges incident to group nodes.
Methods
Calculates the layout based on the given core layout algorithm.
Remarks
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
See Also
Defined in
Hides the group nodes and their incident edges of the input graph.
Remarks
Parameters
A map of options to pass to the method.
- graph - LayoutGraph
- the input graph
See Also
Un-hides the group nodes and their incident edges of the input graph that were previously hidden using method hideGroupNodes.
Remarks
Parameters
A map of options to pass to the method.
- graph - LayoutGraph
- the given graph