This interface provides factory methods for creating incremental hints for the hierarchic layout.
Remarks
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 freely 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. A node without any hint is called a fixed node.
Sequence hints can also be specified for edges. These incremental edges are inserted in a suitable position within the layers crossed by the edges. For fixed edges the given input route is considered to calculate the position with the layers.
Information about incremental hints is provided by a IDataProvider registered with the graph with key INCREMENTAL_HINTS_DP_KEY.
An instance of a class implementing this interface can be obtained through method createIncrementalHintsFactory.
Type Details
- yfiles module
- layout-hierarchic
- yfiles-umd modules
- layout-familytree, layout-hierarchic, layout-radial, layout
- Legacy UMD name
- yfiles.hierarchic.IIncrementalHintsFactory
See Also
Methods
Creates a hint Object for a group YNode that should be inserted incrementally during the layering phase.
Remarks
The group will be placed on a suitable position. The descendants of the group may be associated with hints created by methods createLayerIncrementallyHint, createSequenceIncrementallyHint 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).
Parameters
A map of options to pass to the method.
- forItemId - Object
- the group node to be inserted incrementally
Returns
- ↪Object
- an Object that can be interpreted as a hint by HierarchicLayoutCore
See Also
Creates a hint Object for a YNode that should be inserted incrementally during the layering phase.
Remarks
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
A map of options to pass to the method.
- forNodeId - Object
- the node to be layered and sequenced incrementally
Returns
- ↪Object
- an Object that can be interpreted as a hint by HierarchicLayoutCore
Creates a hint Object for a YNode or Edge that should be inserted incrementally during the sequencing phase.
Remarks
All nodes that are not incrementally inserted during the layering phase (see createLayerIncrementallyHint) stay in their current layer. More precisely, the default fixedElementsLayerer implementation is an instance of AsIsLayerer that determines the layer of the "fixed" nodes by analyzing the current node coordinates. Note that for the other nodes, the layout algorithm may insert new layers in between the existing layers.
For edges associated with this hint (or which are incident to an incremental node), the algorithm automatically calculates a suitable sequencing (position within the layer). For edges between two non-incremental nodes that do not have a hint, the sequencing phase considers the current route.
Parameters
A map of options to pass to the method.
- forItemId - Object
- the node or edge to be sequenced/inserted incrementally
Returns
- ↪Object
- an Object that can be interpreted as a hint by HierarchicLayoutCore
Creates a hint Object for a YNode that should be inserted incrementally into the graph on its exact current position.
Remarks
Parameters
A map of options to pass to the method.
- forNodeId - Object
- the node to be placed on its exact current position
Returns
- ↪Object
- an Object that can be interpreted as a hint by HierarchicLayoutCore
See Also
Creates a hint Object for a YNode that should be inserted incrementally into the graph on its exact current layer position.
Remarks
Parameters
A map of options to pass to the method.
- forNodeId - Object
- the node to be placed on its exact current layer position
Returns
- ↪Object
- an Object that can be interpreted as a hint by HierarchicLayoutCore
See Also
Creates a hint Object for a YNode that should be inserted incrementally into the graph on its exact current sequence position.
Remarks
Parameters
A map of options to pass to the method.
- forNodeId - Object
- the node to be placed on its exact current sequence position
Returns
- ↪Object
- an Object that can be interpreted as a hint by HierarchicLayoutCore