CompositeLayoutStage allows for combining multiple ILayoutStages.
Remarks
The ILayoutStages are organized in a pipeline where additional ILayoutStages can be prepended or appended.
Each ILayoutStage in the pipeline executes its pre-processing code before calling its successor ILayoutStage. Then, after all subsequent ILayoutStages have finished, it will execute its post-processing code.
Note that the pipeline only works when all ILayoutStages call their core layout algorithm which is the next ILayoutStage in the pipeline.
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.CompositeLayoutStage
See Also
Constructors
Creates a new CompositeLayoutStage instance with an empty pipeline.
Creates a new CompositeLayoutStage instance with two ILayoutStages in the pipeline.
Remarks
Parameters
A map of options to pass to the method.
- outerStage - ILayoutStage
- the wrapping ILayoutStage
- innerStage - ILayoutStage
- the wrapped ILayoutStage
Properties
Gets or sets the core layout algorithm that is wrapped by this stage.
Gets the complete pipeline of ILayoutStages that were added to this CompositeLayoutStage.
Methods
Appends a ILayoutStage to the previously added ILayoutStages.
Remarks
Parameters
A map of options to pass to the method.
- stage - ILayoutStage
- the stage to append
Executes the pipeline of ILayoutStage and the core layout algorithm which apply the layout to the graph.
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
Prepends a ILayoutStage to the previously added ILayoutStages.
Remarks
Parameters
A map of options to pass to the method.
- stage - ILayoutStage
- the stage to prepend