NodeLabelPlacement

Node labeling policies defining how node labels are handled by layout algorithms with generic node labeling support.

Type Details

yFiles module: algorithms

Constants

CONSIDER

: number

The node labels are considered for the positioning of other graph elements, for example to avoid overlaps with nodes, but the relative positions to their owners are kept.

GENERIC

: number

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

IGNORE

: number

The node label placements are not considered for the positioning of other graph elements.

Remarks

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

Static Methods

from

(value: NodeLabelPlacement) : NodeLabelPlacement

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

Returns

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

getName

(value: NodeLabelPlacement) : string

Returns the name of the given enum constant.

Parameters

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

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