SymmetryOptimizationStrategy

Show Usages

Predefined optimization strategies for the HierarchicalLayout.

Members

No filters for this type

Constants

NONE

static

A strategy where symmetry is not prioritized.

STRONG

static

A strategy where symmetry is prioritized over performance and other layout qualities like compactness.

In this strategy, substructures of the graph such as trees and chains are detected and arranged symmetrically if possible. Additionally, the final coordinate calculation is performed twice and average coordinates are used, leading to more balanced layouts overall.

static

WEAK

static

A strategy where symmetry is prioritized over performance but not over other layout qualities like compactness.

In this strategy, the final coordinate calculation is performed twice and average coordinates are used, leading to more balanced layouts overall.

static

Static Methods

from

(value: SymmetryOptimizationStrategy): SymmetryOptimizationStrategy

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

Return Value

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

getName

(value: SymmetryOptimizationStrategy): string

static

Returns the name of the given enum constant.

static

Parameters

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