A SubgraphLayoutStage is an ILayoutStage that filters out all graph elements that are not part of a specific subgraph.
Implements
- I
- I
Remarks
The nodes that induce this subgraph can be defined via property subgraphNodes. They will be arranged by the coreLayout.
Optionally, the edges that are included in the subgraph can explicitly be defined via property subgraphEdges. This feature is useful to exclude specific edges from being handled by the coreLayout. If no provider is registered, all edges are included.
In the same way it is also possible to include/exclude node labels or edge labels via properties subgraphNodeLabels and subgraphEdgeLabels.
Default Values of Properties
| Name | Default |
|---|---|
| coreLayout | null |
See Also
Developer's Guide
Members
Show:
Constructors
Creates a new SubgraphLayoutStage instance with an optional coreLayout.
Creates a new SubgraphLayoutStage instance with an optional 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.applyLayoutDelegates the arrangement of the specified subgraph of the given graph to the coreLayout.
Delegates the arrangement of the specified subgraph of the given graph to the coreLayout.
createLayoutData
(graph: LayoutGraph): SubgraphLayoutStageData<LayoutNode, LayoutEdge, LayoutNodeLabel, LayoutEdgeLabel>Returns an instance of LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> that can be used to perform item-specific configurations for the SubgraphLayoutStage.
createLayoutData
(graph: LayoutGraph): SubgraphLayoutStageData<LayoutNode, LayoutEdge, LayoutNodeLabel, LayoutEdgeLabel>Returns an instance of LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> that can be used to perform item-specific configurations for the SubgraphLayoutStage.
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
- SubgraphLayoutStageData<LayoutNode, LayoutEdge, LayoutNodeLabel, LayoutEdgeLabel>
- an instance of layout data that can be used to perform item-specific configurations for the given SubgraphLayoutStage.
Returns an instance of LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> that can be used to perform item-specific configurations for the SubgraphLayoutStage.
Returns an instance of LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> that can be used to perform item-specific configurations for the SubgraphLayoutStage.
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
- SubgraphLayoutStageData<INode, IEdge, ILabel, ILabel>
- an instance of layout data that can be used to perform item-specific configurations for the given SubgraphLayoutStage.
Constants
All constants are filtered. Go to Filters.