Hints how the HierarchicalLayout should treat nodes in incremental mode.
Remarks
Incremental hints can be used for specifying how 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 hint (i.e. NONE) is called a fixed node and maintains its position relative to other fixed nodes.
Information about incremental hints for nodes is provided by incrementalNodes.
Type Details
- yFiles module
- algorithms
See Also
Constants
A hint for a group LayoutNode 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 LAYER_INCREMENTALLY, SEQUENCE_INCREMENTALLY or this hint (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).
A hint that a node 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 also be marked such that they are laid out incrementally. This makes it possible to incrementally add whole subgraphs to the current layout.
A hint for a LayoutNode that should be inserted incrementally during the sequencing phase.
Remarks
A hint for a LayoutNode that should be inserted incrementally into the graph on its exact current position.
Remarks
See Also
Creates a hint for a LayoutNode that should be inserted incrementally into the graph on its exact current layer position.
Remarks
See Also
A hint for a LayoutNode that should be inserted incrementally into the graph on its exact current sequence position.
Remarks
See Also
Static Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Parameters
A map of options to pass to the method.
- value - IncrementalNodeHint
- The value to convert to an enum constant.
Returns
- ↪IncrementalNodeHint
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
A map of options to pass to the method.
- value - IncrementalNodeHint
- The numeric value of an enum constant.
Returns
- ↪string
- The name of the enum constant.
Throws
- Exception({ name: 'Error' })
- If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.