com.yworks.yfiles.layout.hierarchic

Class AsIsLayerer

java.lang.Object

com.yworks.yfiles.layout.hierarchic.AsIsLayerer

All Implemented Interfaces:

ILayerer

public class AsIsLayerer
extends Object
implements ILayerer

AsIsLayerer assigns nodes to layers by analyzing already existing node coordinates.

Nodes whose bounding boxes overlap in the main layout direction are assigned to the same layer. To influence to which amount the boxes need to overlap, the nodes can temporarily be scaled. Alternatively, a minimum and maximum size or a halo can be specified for the nodes.

Initial graph

Hierarchic layout when the initial drawing is used as sketch

Hierarchic layout when the initial drawing is not used as sketch

Constructor Summary

Constructors

Constructor and Description
AsIsLayerer() Creates an instance of AsIsLayerer with default settings.

Method Summary

Modifier and Type	Method and Description
void	assignLayers(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp) Assigns all nodes of the graph to layers by analyzing already existing node coordinates and adds them to the ILayers instance.
int	assignNodeLayer(LayoutGraph graph, INodeMap layerID, EdgeList reversedEdges) Assigns all nodes of the graph to layers.
protected double	getMax(LayoutGraph graph, Node node) Callback used for calculating the lower (max) value of a given node.
double	getMaximumNodeSize() Gets the maximum size of a node used for calculating layer overlaps.
protected double	getMin(LayoutGraph graph, Node node) Callback used for calculating the upper (min) value of a given node.
double	getMinimumNodeSize() Gets the minimum size of a node used for calculating layer overlaps.
double	getNodeHalo() Gets the size of the halo around a node, that means the insets that are used for calculating layer overlaps.
double	getNodeScalingFactor() Gets the scaling factor used for scaling the size of the nodes.
void	setMaximumNodeSize(double value) Sets the maximum size of a node used for calculating layer overlaps.
void	setMinimumNodeSize(double value) Sets the minimum size of a node used for calculating layer overlaps.
void	setNodeHalo(double value) Sets the size of the halo around a node, that means the insets that are used for calculating layer overlaps.
void	setNodeScalingFactor(double value) Sets the scaling factor used for scaling the size of the nodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsIsLayerer

public AsIsLayerer()

Creates an instance of AsIsLayerer with default settings.

Method Detail

assignLayers

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

Assigns all nodes of the graph to layers by analyzing already existing node coordinates and adds them to the ILayers instance.

Nodes whose bounding boxes overlap in the main layout direction are assigned to the same layer. To influence to which amount the boxes need to overlap, the nodes can temporarily be scaled.

Specified by:

assignLayers in interface ILayerer

Parameters:

graph - the input graph

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

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

See Also:

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

assignNodeLayer

public int assignNodeLayer(LayoutGraph graph,
                           INodeMap layerID,
                           EdgeList reversedEdges)

Assigns all nodes of the graph to layers.

Parameters:

graph - the given graph

layerID - the INodeMap that will be filled by the layout algorithm and returns the zero-based index of the layer to which each node belongs

reversedEdges - an EdgeList containing the edges which had been reversed

Returns:

the number of layers

getMax

protected double getMax(LayoutGraph graph,
                        Node node)

Callback used for calculating the lower (max) value of a given node.

It is called by method assignNodeLayer(LayoutGraph, INodeMap, EdgeList).

Parameters:

graph - the graph

node - the node

Returns:

the lower (max) of a given node

getMaximumNodeSize

public double getMaximumNodeSize()

Gets the maximum size of a node used for calculating layer overlaps.

This can be used for more fuzzy layering.

The maximum size can take positive values.

Throws:

IllegalArgumentException - if the specified value is less than 0

Default Value:

The default value is Double.MAX_VALUE

Returns:

a positive double value

See Also:

setNodeScalingFactor(double), setNodeHalo(double), setMaximumNodeSize(double)

getMin

protected double getMin(LayoutGraph graph,
                        Node node)

Callback used for calculating the upper (min) value of a given node.

It is called by method assignNodeLayer(LayoutGraph, INodeMap, EdgeList).

Parameters:

graph - the graph

node - the node

Returns:

the upper (min) value of a given node

getMinimumNodeSize

public double getMinimumNodeSize()

Gets the minimum size of a node used for calculating layer overlaps.

This can be used for more fuzzy layering.

The minimum size can take positive values.

Throws:

IllegalArgumentException - if the specified value is less than 0

Default Value:

The default value is 0.0.

Returns:

a positive double value

See Also:

setNodeScalingFactor(double), setNodeHalo(double), setMinimumNodeSize(double)

getNodeHalo

public double getNodeHalo()

Gets the size of the halo around a node, that means the insets that are used for calculating layer overlaps.

If the value of the halo is positive, it specifies a border around a node. In case it is negative, it is considered as an inset that defines a smaller area inside the node.

This can be used for more fuzzy layering.

Default Value:

The default value is 0.0d.

Returns:

the size of a node's halo

See Also:

setNodeScalingFactor(double), setMinimumNodeSize(double), setMaximumNodeSize(double), setNodeHalo(double)

getNodeScalingFactor

public double getNodeScalingFactor()

Gets the scaling factor used for scaling the size of the nodes.

Nodes are being scaled from their center. This can be used for more fuzzy layering.

The scaling factor can take positive values. Factors smaller than 1 only consider large overlaps of the nodes' bounding boxes in the main layout direction. Factors larger than 1 also combine nodes with some distance between them.

Throws:

IllegalArgumentException - if the specified value is less than 0

Default Value:

The default value is 1.0.

Returns:

a positive double value

See Also:

getMinimumNodeSize(), getMaximumNodeSize(), getNodeHalo(), setNodeScalingFactor(double)

setMaximumNodeSize

public void setMaximumNodeSize(double value)

Sets the maximum size of a node used for calculating layer overlaps.

This can be used for more fuzzy layering.

The maximum size can take positive values.

Throws:

IllegalArgumentException - if the specified value is less than 0

Default Value:

The default value is Double.MAX_VALUE

Parameters:

value - a positive double value

See Also:

setNodeScalingFactor(double), setNodeHalo(double), getMaximumNodeSize()

setMinimumNodeSize

public void setMinimumNodeSize(double value)

Sets the minimum size of a node used for calculating layer overlaps.

This can be used for more fuzzy layering.

The minimum size can take positive values.

Throws:

IllegalArgumentException - if the specified value is less than 0

Default Value:

The default value is 0.0.

Parameters:

value - a positive double value

See Also:

setNodeScalingFactor(double), setNodeHalo(double), getMinimumNodeSize()

setNodeHalo

public void setNodeHalo(double value)

Sets the size of the halo around a node, that means the insets that are used for calculating layer overlaps.

If the value of the halo is positive, it specifies a border around a node. In case it is negative, it is considered as an inset that defines a smaller area inside the node.

This can be used for more fuzzy layering.

Default Value:

The default value is 0.0d.

Parameters:

value - the size of a node's halo

See Also:

setNodeScalingFactor(double), setMinimumNodeSize(double), setMaximumNodeSize(double), getNodeHalo()

setNodeScalingFactor

public void setNodeScalingFactor(double value)

Sets the scaling factor used for scaling the size of the nodes.

Nodes are being scaled from their center. This can be used for more fuzzy layering.

The scaling factor can take positive values. Factors smaller than 1 only consider large overlaps of the nodes' bounding boxes in the main layout direction. Factors larger than 1 also combine nodes with some distance between them.

Throws:

IllegalArgumentException - if the specified value is less than 0

Default Value:

The default value is 1.0.

Parameters:

value - a positive double value

See Also:

getMinimumNodeSize(), getMaximumNodeSize(), getNodeHalo(), getNodeScalingFactor()