Interface TextLayoutOptions

Options of TextLayout

interface TextLayoutOptions {
    horizontalAlign?: HorizontalAlign | VerticalAlign;
    maxHeight?: number;
    maxWidth?: number;
    verticalAlign?: HorizontalAlign | VerticalAlign;
    wrapHardBreaks?: boolean;
    wrapStyle?: WrapStyle;
}

Properties

horizontalAlign? maxHeight? maxWidth? verticalAlign? wrapHardBreaks? wrapStyle?

Properties

OptionalhorizontalAlign

horizontalAlign?: HorizontalAlign | VerticalAlign

Alignment of the lines relative to the widest line. Default: 'left' (before 3.0 this was called verticalAlign, values are accepted under either name)

OptionalmaxHeight

maxHeight?: number

Lines that don't fit are cut off. Default: Infinity

OptionalmaxWidth

maxWidth?: number

Longer lines are wrapped. Default: Infinity

OptionalverticalAlign

verticalAlign?: HorizontalAlign | VerticalAlign

Which lines to keep when cutting off at maxHeight. Default: 'top' (before 3.0 this was called horizontalAlign, values are accepted under either name)

OptionalwrapHardBreaks

wrapHardBreaks?: boolean

Whether to break lines at newline characters. Default: true

OptionalwrapStyle

wrapStyle?: WrapStyle

Whether to wrap between words or at any character. Default: 'word'

Settings

Member Visibility

On This Page

Properties