ExteriorNodeLabelModelPosition

Show usages

Enumeration of the possible positions of the ExteriorNodeLabelModel.

Remarks

This field can be used as an argument for the createParameter factory method.

Type Details

yFiles module: view

Constants

BOTTOM

: number

Encodes a position outside the node at the bottom.

BOTTOM_LEFT

: number

Encodes a position outside the node at the lower-left corner.

BOTTOM_RIGHT

: number

Encodes a position outside the node at the lower right corner.

LEFT

: number

Encodes a position outside the node on the left side.

RIGHT

: number

Encodes a position outside the node on the right side.

TOP

: number

Encodes a position outside the node at the top.

TOP_LEFT

: number

Encodes a position outside the node at the upper left corner.

TOP_RIGHT

: number

Encodes a position outside the node at the upper right corner.

Static Methods

from

(value: ExteriorNodeLabelModelPosition) : ExteriorNodeLabelModelPosition

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

Returns

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

getName

(value: ExteriorNodeLabelModelPosition) : string

Returns the name of the given enum constant.

Parameters

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

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