EdgeRouterEdgeLabelPlacement

Edge labeling policies defining how edge labels are handled by EdgeRouter.

Members

No filters for this type

Constants

CONSIDER_UNAFFECTED_EDGE_LABELS

static

The original placement of the edge labels that are marked as unaffected are considered, but relative positions to their owners are not changed.

static

Sample Graphs

ShownSetting: true

GENERIC

static

The GenericLabeling algorithm is applied as a post-processing step of the main layout algorithm to the edge labels.

IGNORE

static

The edge labels are not considered for the positioning of other graph elements.

This may improve compactness but could lead to overlaps. Under this policy, the original placement of edge labels relative to their owner is maintained.

static

Sample Graphs

ShownSetting: false

INTEGRATED

static

The layout algorithm's inbuilt edge labeling strategy is applied, which chooses label positions fitting the algorithm's layout style.

If chosen, the routes of edges with labels can change significantly. The algorithm finds a position for labels and routes the edge near the label trying to consider the PreferredPlacementDescriptor. To do so, the route itself may need to take a detour that might otherwise not have been necessary. This especially holds true in cases where there is very little space for the labels and/or the labels are rather large.

static

Static Methods

from

(value: EdgeRouterEdgeLabelPlacement): EdgeRouterEdgeLabelPlacement

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

Return Value

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

getName

(value: EdgeRouterEdgeLabelPlacement): string

static

Returns the name of the given enum constant.

static

Parameters

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