E

DiscreteEdgeLabelPositions
flags

Show Usages
Specifies discrete positions for placing edge labels with the GenericLabeling algorithm.

Remarks

This enumeration defines various label positions along an edge in a graph, allowing for precise control over the placement of labels relative to the edge's path. The positions can be combined using a bitwise OR operation to specify multiple valid locations for label placement.

See Also

API

addDiscreteCandidates

Members

No filters for this type

Constants

CENTER

static
Position specifier that describes a label placement near the middle of the edge, directly on the edge's path.
To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.
static

Sample Graphs

ShownSetting: Label at the center position

CENTERED

static
Position mask that constrains the allowed positions to the CENTER of the edge's path.
static

Sample Graphs

ShownSetting: Only the center position is valid

See Also

API
CENTER

HEAD

static
Position specifier that describes a label placement near the middle of the edge, left/above the edge's path.
To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.
static

Sample Graphs

ShownSetting: Label at the head position

SIX_POS

static
Position mask that constrains the allowed positions to a set of six positions beside the edge path.
Two of the positions are near the source and two others are near the target. The remaining positions are in the middle of the edge.
static

Sample Graphs

ShownSetting: The six positions beside the edge are valid

See Also

API
SOURCE_HEAD, SOURCE_TAIL, HEAD, TAIL, TARGET_HEAD, TARGET_TAIL

SOURCE_CENTER

static
Position specifier that describes a label placement near the source, directly on the edge's path.
To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.
static

Sample Graphs

ShownSetting: Label at the source center position

SOURCE_HEAD

static
Position specifier that describes a label placement near the source, left/above the edge's path.
To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.
static

Sample Graphs

ShownSetting: Label at the source head position

SOURCE_TAIL

static
Position specifier that describes a label placement near the source, right/below the edge's path.
To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.
static

Sample Graphs

ShownSetting: Label at the source tail position

TAIL

static
Position specifier that describes a label placement near the middle of the edge, right/below the edge's path.
To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.
static

Sample Graphs

ShownSetting: Label at the tail position

TARGET_CENTER

static
Position specifier that describes a label placement near the target, directly on the edge's path.
To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.
static

Sample Graphs

ShownSetting: Label at tail center position

TARGET_HEAD

static
Position specifier that describes a label placement near the target, left/above the edge's path.
To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.
static

Sample Graphs

ShownSetting: Label at the target head position

TARGET_TAIL

static
Position specifier that describes a label placement near the target, right/below the edge's path.
To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.
static

Sample Graphs

ShownSetting: Label at the target tail position

THREE_CENTER

static
Position mask that constrains the allowed positions to a set of three positions directly on the edge's path.
static

Sample Graphs

ShownSetting: The three positions on the edge are valid

See Also

API
SOURCE_CENTER, CENTER, TARGET_CENTER

TWO_POS

static
Position mask that constrains the allowed positions to the two locations near the middle of the edge beside the edge's path.
static

Sample Graphs

ShownSetting: The two center positions are valid

See Also

API
HEAD, TAIL

Static Methods

from

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

Return Value

DiscreteEdgeLabelPositions
The enum constant that corresponds to the given argument.

getName

(value: DiscreteEdgeLabelPositions): string
static
Returns the name of the given enum constant.
static

Parameters

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