C

SubgraphLayoutStage

Show Usages
A SubgraphLayoutStage is an ILayoutStage that filters out all graph elements that are not part of a specific subgraph.

Remarks

The nodes that induce this subgraph can be defined via property SubgraphLayoutStageData<TNode, TEdge, TNodeLabel, TEdgeLabel>.subgraphNodes. They will be arranged by the LayoutStageBase.coreLayout.

Optionally, the edges that are included in the subgraph can explicitly be defined via property SubgraphLayoutStageData<TNode, TEdge, TNodeLabel, TEdgeLabel>.subgraphEdges. This feature is useful to exclude specific edges from being handled by the LayoutStageBase.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 SubgraphLayoutStageData<TNode, TEdge, TNodeLabel, TEdgeLabel>.subgraphNodeLabels and SubgraphLayoutStageData<TNode, TEdge, TNodeLabel, TEdgeLabel>.subgraphEdgeLabels.

Default Values of Properties

NameDefault
coreLayoutnull

See Also

Developer's Guide

Members

Show:

Constructors

SubgraphLayoutStage

(coreLayout?: ILayoutAlgorithm)
Creates a new SubgraphLayoutStage instance with an optional LayoutStageBase.coreLayout.

Parameters

coreLayout?: ILayoutAlgorithm
The core layout algorithm.

Properties

coreLayout

: ILayoutAlgorithm
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

enabled

: boolean
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

Methods

applyLayout

(graph: LayoutGraph)
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.

applyLayoutImpl

(graph: LayoutGraph)
protected
Delegates the arrangement of the specified subgraph of the given graph to the LayoutStageBase.coreLayout.
protected

Parameters

graph: LayoutGraph
The input graph

createLayoutData

<T> (): TextendsIGraph?SubgraphLayoutStageData<INode, IEdge, ILabel, ILabel>: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 depend on the provided type parameter for this method.
final

Return Value

TextendsIGraph?SubgraphLayoutStageData<INode, IEdge, ILabel, ILabel>:SubgraphLayoutStageData<LayoutNode, LayoutEdge, LayoutNodeLabel, LayoutEdgeLabel>
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.