TextWrapping

Show usages

Specifies how text is wrapped and trimmed when it overflows its desired box.

Type Details

yFiles module: view

Constants

CLIP

: number

The text should neither be wrapped nor trimmed when it overflows its container, but is clipped at the container bounds.

NONE

: number

The text should neither be wrapped nor trimmed when it overflows its container.

TRIM_CHARACTER

: number

The text is not wrapped, but trimmed character-wise when it overflows its container.

TRIM_CHARACTER_ELLIPSIS

: number

The text is not wrapped, but trimmed character-wise when it overflows its container, with an ellipsis character added to indicate trimmed text.

TRIM_WORD

: number

The text is not wrapped, but trimmed at word boundaries when it overflows its container.

TRIM_WORD_ELLIPSIS

: number

The text is not wrapped, but trimmed at word boundaries when it overflows its container, with an ellipsis character added to indicate trimmed text.

WRAP_CHARACTER

: number

The text is wrapped character-wise when it overflows its container and if the wrapped text is bigger than the available container, then it is trimmed character by character to fit the container.

WRAP_CHARACTER_ELLIPSIS

: number

The text is wrapped character-wise when it overflows its container and if the wrapped text is bigger than the available container, then it is trimmed character by character to fit the container and an ellipsis is added to indicate trimmed text.

WRAP_WORD

: number

The text is wrapped at word boundaries when it overflows its container and if the wrapped text is bigger than the available container, then it is trimmed at word boundaries to fit the container.

WRAP_WORD_ELLIPSIS

: number

The text is wrapped at word boundaries when it overflows its container and if the wrapped text is bigger than the available container, then it is trimmed character by character to fit the container and an ellipsis is added to indicate trimmed text.

Static Methods

from

(value: TextWrapping) : TextWrapping

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

Returns

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

getName

(value: TextWrapping) : string

Returns the name of the given enum constant.

Parameters

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

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