E

HorizontalOverlapCriterion

Enum constants that specify the Horizontal overlap criterion for the RemoveOverlapsStage which takes effect when policy SHUFFLE is used.

Members

No filters for this type

Constants

Horizontal overlap criterion defining an overlap as horizontal if the overlapping area is greater in height than in width.

Otherwise, if the overlap area's width is greater than or equal to its height, an overlap will be categorized as vertical.

The area of an overlap is defined as the rectangle where two nodes intersect with each other.

If there are no overlaps where a node contains a whole other node then this criterion is equal to LESS_MOVEMENT.
static

Sample Graphs

ShownSetting: The two highlighted overlaps are detected as being horizontal, the others are vertical

See Also

API
horizontalOverlapCriterion
Horizontal overlap criterion categorizing an overlap as horizontal if the required movement for solving the overlap is shorter in horizontal direction than in vertical direction.

Otherwise, an overlap will be categorized as vertical.

This criterion tries to avoid moving nodes too much because the direction for resolving overlaps will be chosen such that the shorter movement is preferred.

If there are no overlaps where a node contains a whole other node then this criterion is equal to INTERSECTION_BOX.
static

Sample Graphs

ShownSetting: The highlighted overlaps are detected as being horizontal, the others are vertical

See Also

API
horizontalOverlapCriterion
Horizontal overlap criterion categorizing an overlap as horizontal if the center-to-center difference between the overlapping nodes is greater in horizontal direction (x-coordinates) than in vertical direction (y-coordinates).
Otherwise, if the center-to-center difference between two overlapping nodes is greater in vertical direction (y-coordinates), the corresponding overlap is categorized as vertical. The same applies if the differences in vertical and horizontal direction are equal.
static

Sample Graphs

ShownSetting: The three highlighted overlaps are detected as being horizontal, the other one is vertical

See Also

API
horizontalOverlapCriterion

Static Methods

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: HorizontalOverlapCriterion
The value to convert to an enum constant.

Return Value

HorizontalOverlapCriterion
The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
static

Parameters

value: HorizontalOverlapCriterion
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.