com.yworks.yfiles.layout

Class SubgraphLayout

java.lang.Object

com.yworks.yfiles.layout.AbstractLayoutStage

com.yworks.yfiles.layout.SubgraphLayout

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage

public class SubgraphLayout
extends AbstractLayoutStage

A SubgraphLayout is a ILayoutStage that filters out all graph elements that are not part of a specific subgraph.

The nodes that induce this subgraph are marked using a IDataProvider registered with a specific key. They will be arranged by the core layout algorithm.

All excluded nodes and their incident edges keep their locations. Hence, arranging only a subgraph may lead to overlaps.

Constructor Summary

Constructors

Constructor and Description
SubgraphLayout() Creates a new SubgraphLayout instance with an optional core layout algorithm.
SubgraphLayout(ILayoutAlgorithm coreLayouter) Creates a new SubgraphLayout instance with an optional core layout algorithm.

Method Summary

Modifier and Type	Method and Description
void	applyLayout(LayoutGraph graph) Delegates the arrangement of the specified subgraph of the given graph to the core layout algorithm.
Object	getAffectedNodesDpKey() Gets the key to register a IDataProvider which marks the nodes that induce the subgraph to be arranged.
void	setAffectedNodesDpKey(Object value) Sets the key to register a IDataProvider which marks the nodes that induce the subgraph to be arranged.

Methods inherited from class com.yworks.yfiles.layout.AbstractLayoutStage

applyLayoutCore, getCoreLayout, setCoreLayout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubgraphLayout

public SubgraphLayout()

Creates a new SubgraphLayout instance with an optional core layout algorithm.

SubgraphLayout

public SubgraphLayout(ILayoutAlgorithm coreLayouter)

Creates a new SubgraphLayout instance with an optional core layout algorithm.

Parameters:

coreLayouter - The core layout algorithm.

Method Detail

applyLayout

public void applyLayout(LayoutGraph graph)

Delegates the arrangement of the specified subgraph of the given graph to the core layout algorithm.

Specified by:

applyLayout in interface ILayoutAlgorithm

Specified by:

applyLayout in class AbstractLayoutStage

Parameters:

graph - the input graph

getAffectedNodesDpKey

public Object getAffectedNodesDpKey()

Gets the key to register a IDataProvider which marks the nodes that induce the subgraph to be arranged.

Throws:

IllegalArgumentException - if the specified key is null

Default Value:

The default value is LayoutKeys.AFFECTED_NODES_DPKEY

Returns:

the IDataProvider key

See Also:

setAffectedNodesDpKey(Object)

setAffectedNodesDpKey

public void setAffectedNodesDpKey(Object value)

Sets the key to register a IDataProvider which marks the nodes that induce the subgraph to be arranged.

Throws:

IllegalArgumentException - if the specified key is null

Default Value:

The default value is LayoutKeys.AFFECTED_NODES_DPKEY

Parameters:

value - the IDataProvider key

See Also:

getAffectedNodesDpKey()