OverlapRemovalPolicy

Policies that describe how RemoveOverlapsStage removes node overlaps.

Members

No filters for this type

Constants

PRESERVE_RELATIVE_LOCATIONS

static

A high-quality overlap removal policy where changes to the original layout structure are avoided with the goal to keep the relative locations and geometric distances between the nodes.

This policy for removing overlaps is similar to the layout strategy used by organic (force-directed) layout algorithms (e.g. OrganicLayout). Therefore, this stage is especially well suited to remove node overlaps in undirected graph drawings with straight-line edges, as produced by organic layout approaches.

When defining fixedNodes , the overall runtime may significantly increase. Hence, the policy SHUFFLE may be the better choice for such inputs.

When using this policy, property horizontalOverlapCriterion is ignored.

static

Sample Graphs

ShownSetting: A graph containing overlaps (left) and the result after removal (right)

SHUFFLE

static

A simple overlap removal policy leading to results that often resemble the look of tiles which have been dropped onto each other, where tiles correspond to nodes of the graph.

Overlapping nodes are moved in order to resolve the overlap. During this process, several nodes moving in the same direction may be stacked next to or above each other.

static

Sample Graphs

ShownSetting: Example with overlaps (left) and after removal (right)

Static Methods

from

(value: OverlapRemovalPolicy): OverlapRemovalPolicy

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

Return Value

OverlapRemovalPolicy: The enum constant that corresponds to the given argument.

getName

(value: OverlapRemovalPolicy): string

static

Returns the name of the given enum constant.

static

Parameters

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