Abstract base class implementing ILayoutStage that handles the management of the core layout algorithm.
Inheritance Hierarchy
LayoutStageBase
Implemented Interfaces
Remarks
Subclasses of this stage can use the provided methods, such that the management of the core layout algorithm does not need to be considered anymore.
Default Values of Properties
| coreLayout | null |
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.LayoutStageBase
See Also
Constructors
Creates a new ILayoutStage instance with an optional core layout algorithm.
Parameters
options - Object
A map of options to pass to the method.
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
Main layout routine that assigns new layout information to the given graph.
Remarks
The call to this routine will only succeed if the layout algorithm can handle the input graph.
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
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