GivenCoordinatesLayout changes node locations and sizes as well as edge paths to user-specified values before invoking the coreLayout.
Implements
- I
- I
Remarks
Use nodeLocations to specify the locations (top-left coordinates) of nodes, nodeSizes to specify the size of nodes, and edgePaths to specify the path of edges (i.e. the port locations and the bends of edges).
A possible application for this stage is animated incremental layouts where the position of non-incremental elements should be changed/restored without affecting the start position of these elements in the animation. Therefore, this stage could also be used together with PlaceNodesAtBarycenterStage.
Default Values of Properties
| Name | Default |
|---|---|
| coreLayout | null |
See Also
Developer's Guide
API
- PlaceNodesAtBarycenterStage
Members
Show:
Constructors
Creates a new GivenCoordinatesLayout instance using the given coreLayout.
Creates a new GivenCoordinatesLayout instance using the given coreLayout.
Parameters
- coreLayout?: ILayoutAlgorithm
- the core layout algorithm
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
Defined in
LayoutStageBase.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
Defined in
LayoutStageBase.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.
Defined in
LayoutStageBase.applyLayoutChanges node locations and edge paths to user-specified values and then invokes the core layout algorithm.
Changes node locations and edge paths to user-specified values and then invokes the core layout algorithm.
createLayoutData
(graph: LayoutGraph): GivenCoordinatesLayoutData<LayoutNode, LayoutEdge, LayoutNodeLabel, LayoutEdgeLabel>Returns an instance of LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> that can be used to perform item-specific configurations for the GivenCoordinatesLayout.
createLayoutData
(graph: LayoutGraph): GivenCoordinatesLayoutData<LayoutNode, LayoutEdge, LayoutNodeLabel, LayoutEdgeLabel>Returns an instance of LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> that can be used to perform item-specific configurations for the GivenCoordinatesLayout.
The generic type arguments of the created layout data are compatible with instances of LayoutGraph, but the layout data is not bound to a specific graph instance. Therefore, the created layout data still has to be passed as an argument of applyLayout in order to be applied.
Parameters
- graph: LayoutGraph
- the graph that determines the generic type arguments of the created layout data
Return Value
- GivenCoordinatesLayoutData<LayoutNode, LayoutEdge, LayoutNodeLabel, LayoutEdgeLabel>
- an instance of layout data that can be used to perform item-specific configurations for the given GivenCoordinatesLayout.
Returns an instance of LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> that can be used to perform item-specific configurations for the GivenCoordinatesLayout.
Returns an instance of LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> that can be used to perform item-specific configurations for the GivenCoordinatesLayout.
The generic type arguments of the created layout data are compatible with instances of IGraph, but the layout data is not bound to a specific graph instance. Therefore, the created layout data still has to be passed as an argument of applyLayout in order to be applied.
This method is not available unless the module view-layout-bridge is loaded. Either load the module 'view-layout-bridge' explicitly or ensure that the
LayoutExecutor type is available at runtime.Parameters
- graph?: IGraph
- the graph that determines the generic type arguments of the created layout data
Return Value
- GivenCoordinatesLayoutData<INode, IEdge, ILabel, ILabel>
- an instance of layout data that can be used to perform item-specific configurations for the given GivenCoordinatesLayout.
Constants
All constants are filtered. Go to Filters.