E

DiscreteNodeLabelPositions
flags

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

Remarks

The DiscreteNodeLabelPositions enum provides several predefined constants that represent various label positions around and within a node. These positions can be combined to allow flexibility in label placement, depending on the specific requirements of your graph layout.

See Also

API

addDiscreteCandidates

Members

No filters for this type

Constants

BOTTOM

static
Position specifier that describes a label placement at the bottom outside the node.
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 bottom position

BOTTOM_INSIDE

static
Position specifier that describes a label placement at the bottom inside the node.
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 bottom position

BOTTOM_LEFT

static
Position specifier that describes a label placement at the bottom-left outside the node.
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 bottom-left position

BOTTOM_LEFT_INSIDE

static
Position specifier that describes a label placement at the bottom-left inside the node.
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 bottom-left position

BOTTOM_RIGHT

static
Position specifier that describes a label placement at the bottom-right outside the node.
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 bottom-right position

BOTTOM_RIGHT_INSIDE

static
Position specifier that describes a label placement at the bottom-right inside the node.
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 bottom-right position

CENTER

static
Position specifier that describes a label placement at the center of the node.
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

CORNERS

static
Combined position that describes the positions outside the node at each of its corners.
static

Sample Graphs

ShownSetting: Label positions at the corners of the node are valid

See Also

API
TOP_RIGHT, TOP_LEFT, BOTTOM_RIGHT, BOTTOM_LEFT

INSIDE

static
Combined position that describes the nine node-internal positions.
static

Sample Graphs

ShownSetting: All positions inside the node are valid

See Also

API
CENTER, TOP_INSIDE, BOTTOM_INSIDE, LEFT_INSIDE, RIGHT_INSIDE, TOP_LEFT_INSIDE, TOP_RIGHT_INSIDE, BOTTOM_LEFT_INSIDE, BOTTOM_RIGHT_INSIDE

LEFT

static
Position specifier that describes a label placement left outside the node.
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 left position

LEFT_INSIDE

static
Position specifier that describes a label placement at the left inside the node.
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 left position

OUTSIDE

static
Combined position that describes the positions outside the node.
static

Sample Graphs

ShownSetting: Positions outside the node are valid

See Also

API
TOP, RIGHT, BOTTOM, LEFT, TOP_RIGHT, TOP_LEFT, BOTTOM_RIGHT, BOTTOM_LEFT

RIGHT

static
Position specifier that describes a label placement right outside the node.
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 right position

RIGHT_INSIDE

static
Position specifier that describes a label placement at the right inside the node.
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 right position

SIDES

static
Combined position that describes the positions outside the node at each of its sides.
static

Sample Graphs

ShownSetting: Only positions on the sides are valid

See Also

API
RIGHT, LEFT, TOP, BOTTOM

TOP

static
Position specifier that describes a label placement at the top outside the node.
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 top position

TOP_INSIDE

static
Position specifier that describes a label placement at the top inside the node.
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 top position

TOP_LEFT

static
Position specifier that describes a label placement at the top-left outside the node.
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 top-left position

TOP_LEFT_INSIDE

static
Position specifier that describes a label placement at the top-left inside the node.
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 top-left position

TOP_RIGHT

static
Position specifier that describes a label placement at the top-right outside the node.
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 top-right position

TOP_RIGHT_INSIDE

static
Position specifier that describes a label placement at the top-right inside the node.
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 top-right position

Static Methods

from

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

Return Value

DiscreteNodeLabelPositions
The enum constant that corresponds to the given argument.

getName

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

Parameters

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