E

IncrementalEdgeHint

Show Usages
Hints how the HierarchicalLayout should treat edges when the HierarchicalLayout.fromSketchMode is enabled.

Remarks

When HierarchicalLayout.fromSketchMode is active, edges can be either incremental or sketch-based. Incremental edges are freely routed, while sketch-based edges maintain their relative routing from the input sketch.

Incremental hints can be used for specifying a subset of 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 edges with hint KEEP_RELATIVE_ORDER, the given input route is considered to calculate the position within the layers.

Information about incremental hints for edges is provided by layout data property HierarchicalLayoutData<TNode, TEdge, TNodeEdge, TNodeLabel, TEdgeLabel>.incrementalEdges.

See Also

Developer's Guide

API

IncrementalNodeHint

Members

No filters for this type

Constants

INCREMENTAL

static
A hint for an edge that should be inserted incrementally during the sequencing phase (fully rerouted).

The hierarchical layout calculates a suitable position within the layer (sequence), ignoring the given edge route.

This behavior is also automatically applied to edges which are incident to incremental nodes.

static

See Also

Developer's Guide

KEEP_RELATIVE_ORDER

static
A hint that an edge should maintain its relative order within layers, meaning that the given input route is considered to calculate the position of the edge within the layers.

This is the default hint applied when running the algorithm with HierarchicalLayout.fromSketchMode enabled, but not defining another hint for an edge.

For example, when an edge currently passes through a layer on the right side of a non-incremental node, it will stay right (even in the case that a simpler route would be possible).

Both the source node and the target node must be non-incremental for this hint to have an effect.

static

See Also

Developer's Guide

Static Methods

from

(value: IncrementalEdgeHint): IncrementalEdgeHint
static
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
conversion
The value to convert to an enum constant.

Return Value

IncrementalEdgeHint
The enum constant that corresponds to the given argument.

getName

(value: IncrementalEdgeHint): string
static
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.