com.yworks.yfiles.layout.hierarchic

Interface INodePlacer

All Known Implementing Classes:

SimplexNodePlacer

public interface INodePlacer

This interface is responsible for the assignment of the x-(sequence) and preliminary y-coordinates of the nodes in a hierarchic layout.

Implementations of this interface are used during the drawing phase of HierarchicLayoutCore. They determine preliminary y-coordinates (which may be adjusted during the final edge routing) and the resulting x-coordinates of all elements that are part of the graph during the node placement phase.

The minimum distance between each pair of nodes of the graph is determined by a IDrawingDistanceCalculator instance.

The default implementation used by the HierarchicLayoutCore is SimplexNodePlacer. Custom implementations of INodePlacer interface can be used for hierarchic layout algorithms using methods NodePlacer or NodePlacer.

See Also:

SimplexNodePlacer, IDrawingDistanceCalculator, HierarchicLayoutCore, HierarchicLayoutCore.setNodePlacer(INodePlacer), HierarchicLayout.setNodePlacer(INodePlacer)

Method Summary

Modifier and Type	Method and Description
void	assignLayerCoordinates(LayoutGraph graph, ILayoutDataProvider layoutDataProvider, ILayers layers) Assigns preliminary y-coordinates for each layer of a hierarchic layout.
void	assignSequenceCoordinates(LayoutGraph graph, ILayoutDataProvider layoutDataProvider, ILayers layers, IDrawingDistanceCalculator drawingDistanceCalculator) Determines the resulting x-coordinates of a hierarchic layout.

Method Detail

assignLayerCoordinates

void assignLayerCoordinates(LayoutGraph graph,
                            ILayoutDataProvider layoutDataProvider,
                            ILayers layers)

Assigns preliminary y-coordinates for each layer of a hierarchic layout.

The distance between two layers will be adjusted later by the edge routing algorithm. This method is responsible for assigning the relative positions of the nodes within each layer.

Parameters:

graph - the input graph

layoutDataProvider - the ILayoutDataProvider containing information about the elements

layers - the ILayers instance that will be calculated by this method

assignSequenceCoordinates

void assignSequenceCoordinates(LayoutGraph graph,
                               ILayoutDataProvider layoutDataProvider,
                               ILayers layers,
                               IDrawingDistanceCalculator drawingDistanceCalculator)

Determines the resulting x-coordinates of a hierarchic layout.

The minimum distance between each pair of nodes of the graph is determined by a IDrawingDistanceCalculator instance.

Parameters:

graph - the input graph

layoutDataProvider - the ILayoutDataProvider containing information about the elements

layers - the ILayers instance that will be calculated by this method

drawingDistanceCalculator - the given IDrawingDistanceCalculator instance