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.
See Also
Developer's Guide
API
- IncrementalNodeHint
Members
No filters for this type
Constants
This means the corresponding edge should not be treated as an incrementally added element by the layout algorithm.
static
A hint for an LayoutEdge that should be inserted incrementally during the sequencing phase.
A hint for an LayoutEdge that should be inserted incrementally during the sequencing phase.
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
Static Methods
Converts the given argument to an enum constant of this enum type.
Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static
Parameters
- value: IncrementalEdgeHint
- The value to convert to an enum constant.
Return Value
- IncrementalEdgeHint
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Returns the name of the given enum constant.
static
Parameters
- value: IncrementalEdgeHint
- The numeric value of an enum constant.
Return Value
- 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.