com.yworks.yfiles.layout.hierarchic

Class AspectRatioComponentLayerer

java.lang.Object

com.yworks.yfiles.layout.hierarchic.AspectRatioComponentLayerer

All Implemented Interfaces:

ILayerer

public class AspectRatioComponentLayerer
extends Object
implements ILayerer

This class is a wrapper ILayerer implementation that delegates the actual layering to a delegate ILayerer object.

If the graph consists of multiple components, they will be identified and each of the components will be layered separately using the delegate ILayerer instance. After that they will all be merged such that the desired aspect ratio is fulfilled best.

Sample output of AspectRatioComponentLayerer with default settings on a graph with two connected components.

For grouped graphs, the desired aspect ratio is also considered for each group node separately.

See Also:

setDesiredAspectRatio(double), MultiComponentLayerer

Constructor Summary

Constructors

Constructor and Description
AspectRatioComponentLayerer(ILayerer singleComponentLayerer) Creates a new instance of AspectRatioComponentLayerer using the given delegate ILayerer instance.

Method Summary

Modifier and Type	Method and Description
void	assignLayers(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp) Assigns all nodes of the graph to layers and registers them to the ILayers instance based on the given aspect ratio.
double	getDesiredAspectRatio() Gets the desired aspect ratio.
ILayerer	getSingleComponentLayerer() Gets the delegate ILayerer instance.
boolean	isNodeSizeConsiderationEnabled() Gets whether or not the size of the nodes should be considered.
void	setDesiredAspectRatio(double value) Sets the desired aspect ratio.
void	setNodeSizeConsiderationEnabled(boolean value) Sets whether or not the size of the nodes should be considered.
void	setSingleComponentLayerer(ILayerer value) Sets the delegate ILayerer instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AspectRatioComponentLayerer

public AspectRatioComponentLayerer(ILayerer singleComponentLayerer)

Creates a new instance of AspectRatioComponentLayerer using the given delegate ILayerer instance.

Throws:

IllegalArgumentException - if the specified ILayerer is null

Method Detail

assignLayers

public void assignLayers(LayoutGraph graph,
                         ILayers layers,
                         ILayoutDataProvider ldp)

Assigns all nodes of the graph to layers and registers them to the ILayers instance based on the given aspect ratio.

If the graph consists of multiple components, they will be identified and each of the components will be layered separately using the delegate ILayerer instance. After that, they will all be merged such that the desired aspect ratio is best fulfilled.

Specified by:

assignLayers in interface ILayerer

For grouped graphs, the desired aspect ratio is also considered for each group node separately.

Parameters:

graph - the input graph

layers - the ILayers instance that will be filled with the results of the calculation

ldp - the ILayoutDataProvider used for query information about the nodes and edges

See Also:

ILayers.insert(com.yworks.yfiles.layout.hierarchic.LayerType, int), ILayer.add(com.yworks.yfiles.algorithms.Node)

getDesiredAspectRatio

public double getDesiredAspectRatio()

Gets the desired aspect ratio.

If the graph consists of multiple components, they will be identified and each of the components will be layered separately using the delegate ILayerer instance. After that, they will all be merged such that the desired aspect ratio is best fulfilled.

The given aspect ratio should be greater or equal to 0.

Throws:

IllegalArgumentException - if the aspect ratio is negative

For grouped graphs, the desired aspect ratio is also considered for each group node separately.

Default Value:

The default value is 1.

Returns:

the desired aspect ratio

See Also:

setDesiredAspectRatio(double)

getSingleComponentLayerer

public ILayerer getSingleComponentLayerer()

Gets the delegate ILayerer instance.

Throws:

IllegalArgumentException - if the specified ILayerer is null

Returns:

a ILayerer instance

See Also:

setSingleComponentLayerer(ILayerer)

isNodeSizeConsiderationEnabled

public boolean isNodeSizeConsiderationEnabled()

Gets whether or not the size of the nodes should be considered.

If this option is disabled, all nodes are considered to be of equal size. Hence, the given aspect ratio specifies the ratio between the number of nodes within a layer and the overall number of layers.

Default Value:

The default value is true.

Returns:

true if the size of the node is considered, false otherwise

See Also:

setNodeSizeConsiderationEnabled(boolean)

setDesiredAspectRatio

public void setDesiredAspectRatio(double value)

Sets the desired aspect ratio.

If the graph consists of multiple components, they will be identified and each of the components will be layered separately using the delegate ILayerer instance. After that, they will all be merged such that the desired aspect ratio is best fulfilled.

The given aspect ratio should be greater or equal to 0.

Throws:

IllegalArgumentException - if the aspect ratio is negative

For grouped graphs, the desired aspect ratio is also considered for each group node separately.

Default Value:

The default value is 1.

Parameters:

value - the desired aspect ratio

See Also:

getDesiredAspectRatio()

setNodeSizeConsiderationEnabled

public void setNodeSizeConsiderationEnabled(boolean value)

Sets whether or not the size of the nodes should be considered.

If this option is disabled, all nodes are considered to be of equal size. Hence, the given aspect ratio specifies the ratio between the number of nodes within a layer and the overall number of layers.

Default Value:

The default value is true.

Parameters:

value - true if the size of the node is considered, false otherwise

See Also:

isNodeSizeConsiderationEnabled()

setSingleComponentLayerer

public void setSingleComponentLayerer(ILayerer value)

Sets the delegate ILayerer instance.

Throws:

IllegalArgumentException - if the specified ILayerer is null

Parameters:

value - a ILayerer instance

See Also:

getSingleComponentLayerer()