Hints how the HierarchicalLayout should treat edges in incremental mode.
Remarks
Incremental hints can be used for specifying that a subset of edges (called incremental edges) that should be added to an existing graph layout. 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 within the layers.
Information about incremental hints for edges is provided by incrementalEdges.
Type Details
- yFiles module
- algorithms
See Also
Constants
A hint for an LayoutEdge that should be inserted incrementally during the sequencing phase.
Remarks
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.
Static Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Most notably, this method can convert an enum constant's name into the enum constant itself.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - IncrementalEdgeHint
- The value to convert to an enum constant.
Returns
- ↪IncrementalEdgeHint
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - IncrementalEdgeHint
- 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.