com.yworks.yfiles.layout.hierarchic

Interface IIncrementalHintsFactory

public interface IIncrementalHintsFactory

This interface provides factory methods for creating incremental hints for the hierarchic layout.

Incremental hints can be used for specifying that a subset of nodes (called incremental nodes) should be added to an existing graph layout. A layer hint specifies that both, a node's layer and its position within the layer should be determined by the algorithm. A sequence hint specifies that the algorithm should consider the current layer of a node while its position within the layer should be freely determined by the algorithm.

Information about incremental hints is provided by a IDataProvider registered with the graph with key HierarchicLayout.INCREMENTAL_HINTS_DPKEY.

An instance of a class implementing this interface can be obtained through method HierarchicLayout.createIncrementalHintsFactory().

Method Summary

Modifier and Type	Method and Description
Object	createIncrementalGroupHint(Object forItemId) Creates a hint Object for a group Node that should be inserted incrementally during the layering phase.
Object	createLayerIncrementallyHint(Object forNodeId) Creates a hint Object for a Node that should be inserted incrementally during the layering phase.
Object	createSequenceIncrementallyHint(Object forItemId) Creates a hint Object for a Node or Edge that should be inserted incrementally during the sequencing phase.
Object	createUseExactCoordinatesHint(Object forNodeId) Creates a hint Object for a Node that should be inserted incrementally into the graph on its exact current position.
Object	createUseExactLayerCoordinatesHint(Object forNodeId) Creates a hint Object for a Node that should be inserted incrementally into the graph on its exact current layer position.
Object	createUseExactSequenceCoordinatesHint(Object forNodeId) Creates a hint Object for a Node that should be inserted incrementally into the graph on its exact current sequence position.

Method Detail

createIncrementalGroupHint

Object createIncrementalGroupHint(Object forItemId)

Creates a hint Object for a group Node that should be inserted incrementally during the layering phase.

The group will be placed on a suitable position. The descendants of the group may be associated with hints created by methods createLayerIncrementallyHint(Object), createSequenceIncrementallyHint(Object) or this method (if the descendant is an inner group).

All hints of the descendants of a group are interpreted relative to the group node. Descendants without hints maintain their relative order within the group node (but not with elements outside the group).

The positions of groups without incremental hints depend on the position of their descendants (i.e., the group is not interpreted as fixed - it is simply ignored).

Descendants of incremental groups must not be associated with exact coordinate hints (see method createUseExactCoordinatesHint(Object), createUseExactSequenceCoordinatesHint(Object) and createUseExactLayerCoordinatesHint(Object)).

Parameters:

forItemId - the group node to be inserted incrementally

Returns:

an Object that can be interpreted as a hint by HierarchicLayoutCore

createLayerIncrementallyHint

Object createLayerIncrementallyHint(Object forNodeId)

Creates a hint Object for a Node that should be inserted incrementally during the layering phase.

This will place the node in a suitable layer, possibly creating new layers.

Neighbors of this node may be also marked such that they are laid out incrementally. This makes it possible to incrementally add whole subgraphs to the current layout.

Parameters:

forNodeId - the node to be layered and sequenced incrementally

Returns:

an Object that can be interpreted as a hint by HierarchicLayoutCore

createSequenceIncrementallyHint

Object createSequenceIncrementallyHint(Object forItemId)

Creates a hint Object for a Node or Edge that should be inserted incrementally during the sequencing phase.

This will prevent the layering from being changed.

The Node will be placed on an already existing layer that is determined by the Layerer implementation, i.e. "from sketch". Adjacent edges will automatically be rerouted optimally.

Parameters:

forItemId - the node or edge to be sequenced/inserted incrementally

Returns:

an Object that can be interpreted as a hint by HierarchicLayoutCore

createUseExactCoordinatesHint

Object createUseExactCoordinatesHint(Object forNodeId)

Creates a hint Object for a Node that should be inserted incrementally into the graph on its exact current position.

The node will be placed in an already existing layer that is determined by the layerer implementation. The position within its layer will be determined by its current position.

Parameters:

forNodeId - the node to be placed on its exact current position

Returns:

an Object that can be interpreted as a hint by HierarchicLayoutCore

See Also:

createUseExactSequenceCoordinatesHint(Object), createUseExactLayerCoordinatesHint(Object), SimplexNodePlacer.setExactPlacement(boolean)

createUseExactLayerCoordinatesHint

Object createUseExactLayerCoordinatesHint(Object forNodeId)

Creates a hint Object for a Node that should be inserted incrementally into the graph on its exact current layer position.

The node will be placed in an already existing layer that is determined by the layerer on the position that it occupies initially. The position within its layer will be determined by a INodePlacer instance.

Parameters:

forNodeId - the node to be placed on its exact current layer position

Returns:

an Object that can be interpreted as a hint by HierarchicLayoutCore

See Also:

createUseExactCoordinatesHint(Object), createUseExactSequenceCoordinatesHint(Object), SimplexNodePlacer.setExactPlacement(boolean)

createUseExactSequenceCoordinatesHint

Object createUseExactSequenceCoordinatesHint(Object forNodeId)

Creates a hint Object for a Node that should be inserted incrementally into the graph on its exact current sequence position.

The node will be placed in an already existing layer that is determined by the layerer on the position that is considered best for its layer. The position within the sequence of its layer will be determined by its current coordinates.

Parameters:

forNodeId - the node to be placed on its exact current sequence position

Returns:

an Object that can be interpreted as a hint by HierarchicLayoutCore

See Also:

createUseExactCoordinatesHint(Object), createUseExactLayerCoordinatesHint(Object), SimplexNodePlacer.setExactPlacement(boolean)