DiscreteNodeLabelPositions

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.

Type Details

yFiles module: algorithms

Constants

BOTTOM

: number

Position specifier that describes a label placement at the bottom outside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

BOTTOM_INSIDE

: number

Position specifier that describes a label placement at the bottom inside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

BOTTOM_LEFT

: number

Position specifier that describes a label placement at the bottom-left outside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

BOTTOM_LEFT_INSIDE

: number

Position specifier that describes a label placement at the bottom-left inside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

BOTTOM_RIGHT

: number

Position specifier that describes a label placement at the bottom-right outside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

BOTTOM_RIGHT_INSIDE

: number

Position specifier that describes a label placement at the bottom-right inside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

CENTER

: number

Position specifier that describes a label placement at the center of the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

CORNERS

: number

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

Sample Graphs

INSIDE

: number

Combined position that describes the nine node-internal positions.

Sample Graphs

LEFT

: number

Position specifier that describes a label placement left outside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

LEFT_INSIDE

: number

Position specifier that describes a label placement at the left inside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

OUTSIDE

: number

Combined position that describes the positions outside the node.

Sample Graphs

RIGHT

: number

Position specifier that describes a label placement right outside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

RIGHT_INSIDE

: number

Position specifier that describes a label placement at the right inside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

SIDES

: number

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

Sample Graphs

TOP

: number

Position specifier that describes a label placement at the top outside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

TOP_INSIDE

: number

Position specifier that describes a label placement at the top inside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

TOP_LEFT

: number

Position specifier that describes a label placement at the top-left outside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

TOP_LEFT_INSIDE

: number

Position specifier that describes a label placement at the top-left inside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

TOP_RIGHT

: number

Position specifier that describes a label placement at the top-right outside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

TOP_RIGHT_INSIDE

: number

Position specifier that describes a label placement at the top-right inside the node.

Sample Graphs

To define multiple valid placements for a label, all position specifiers can be combined with a logical or-operation.

Static Methods

from

(value: DiscreteNodeLabelPositions) : DiscreteNodeLabelPositions

Converts the given argument to an enum constant of this enum type.

Remarks

Most notably, this method can convert an enum constant's name into the enum constant itself.

Parameters

options - Object
A map of options to pass to the method.

value - DiscreteNodeLabelPositions: The value to convert to an enum constant.

Returns

↪DiscreteNodeLabelPositions: The enum constant that corresponds to the given argument.

getName

(value: DiscreteNodeLabelPositions) : string

Returns the name of the given enum constant.

Parameters

options - Object
A map of options to pass to the method.

value - DiscreteNodeLabelPositions: The numeric value of an enum constant.

Returns

↪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.

DiscreteNodeLabelPositions

Remarks

Type Details

See Also

Constants

BOTTOM

Sample Graphs

BOTTOM_INSIDE

Sample Graphs

BOTTOM_LEFT

Sample Graphs

BOTTOM_LEFT_INSIDE

Sample Graphs

BOTTOM_RIGHT

Sample Graphs

BOTTOM_RIGHT_INSIDE

Sample Graphs

CENTER

Sample Graphs

CORNERS

See Also

Sample Graphs

INSIDE

See Also

Sample Graphs

LEFT

Sample Graphs

LEFT_INSIDE

Sample Graphs

OUTSIDE

See Also

Sample Graphs

RIGHT

Sample Graphs

RIGHT_INSIDE

Sample Graphs

SIDES

See Also

Sample Graphs

TOP

Sample Graphs

TOP_INSIDE

Sample Graphs

TOP_LEFT

Sample Graphs

TOP_LEFT_INSIDE

Sample Graphs

TOP_RIGHT

Sample Graphs

TOP_RIGHT_INSIDE

Sample Graphs

Static Methods

from

Remarks

Parameters

Returns

getName

Parameters

Returns

Throws