Abstract base class implementing ILayoutStage that handles the management of the coreLayout.
Implements
- I
- I
Remarks
Subclasses of this stage can use the provided methods, such that the management of the coreLayout and the enabled state do not need to be considered explicitly.
Default Values of Properties
| Name | Default |
|---|---|
| coreLayout | null |
See Also
Developer's Guide
API
- LayoutStageStack
Members
Show:
Constructors
Initializes a new LayoutStageBase instance.
Initializes a new LayoutStageBase instance.
This constructor will only be called by subclasses and optionally initializes the coreLayout field.
protected
Parameters
- coreLayout?: ILayoutAlgorithm
- The core layout algorithm. The default value is
null.
Properties
Gets or sets the core ILayoutAlgorithm that is wrapped by this stage.
Gets or sets the core ILayoutAlgorithm that is wrapped by this stage.
final
Property Value
the core layout routine
Default Value
The default value is: null
Implements
ILayoutStage.coreLayoutGets or sets a value that determines whether this stage should do anything but execute the coreLayout.
Gets or sets a value that determines whether this stage should do anything but execute the coreLayout.
By default, when constructed, stages should be enabled. Users may disable a stage's functionality by setting this property to false.
Stages that can guarantee that the graph will not change can choose to not even execute the coreLayout when disabled.
final
Implements
ILayoutStage.enabledMethods
Implementation of the ILayoutAlgorithm interface and main entry point for the layout calculation.
Implementation of the ILayoutAlgorithm interface and main entry point for the layout calculation.
This implementation checks the enabled state and when it's not enabled, will delegate to the coreLayout, directly. When the stage is enabled, all the work will be delegated to applyLayoutImpl, instead.
final
Parameters
- graph: LayoutGraph
- The graph to apply the layout to.
Implements
ILayoutAlgorithm.applyLayoutAbstract method that performs the actual implementation when the stage is enabled
Abstract method that performs the actual implementation when the stage is enabled
Subclasses don't need to check the enabled field, because applyLayout will only invoke this method on enabled instances. Implementations should call applyLayout of the coreLayout between pre- and postprocessing steps as appropriate for the stage. applyLayout only invokes the core algorithm when the stage is disabled.
protectedabstract
Parameters
- graph: LayoutGraph
See Also
Developer's Guide