Type alias FieldMeasureResult

FieldMeasureResult: {
    didWrap: boolean;
    didWrapWord: boolean;
    height: number;
    overflow: string[];
    overflowBrokenByAlgorithm: boolean;
    overflowCursor: number;
    overflowStyle: Record<string, RichTextEntry[]> | null;
    overflowText: string;
    width: number;
}

Result object when calling MeasureFieldText. This object contains all the information about the text measurement.

Type declaration

  • didWrap: boolean

    Flag to indicate if the text was wrapped or not at line level.

  • didWrapWord: boolean

    Flag to indicate if the text was wrapped or not at word level.

  • height: number

    The height of the text in points.

  • overflow: string[]

    Any overflowing text which didn't fit in the field as individual lines as broken by the algorithm.

  • overflowBrokenByAlgorithm: boolean

    Flag to control if the overflow has been created due to line wrapping.

  • overflowCursor: number

    The cursor position of the overflow if applicable (if there is an active UI cursor).

  • overflowStyle: Record<string, RichTextEntry[]> | null

    The style (rich text) of the overflowed text.

  • overflowText: string

    The overflowed text.

  • width: number

    The width of text in points.

Settings

Member Visibility

Theme

Generated using TypeDoc