Interface ITextFrame

Represents a frame of wrappable rich text.

interface ITextFrame {
    autoFit: TextAutofit;
    bounds: Readonly<Bounds>;
    columSpacing: number;
    columnCount: number;
    fontScale: number;
    horizontalCentered: boolean;
    insets: Rectangle;
    isSpaceFirstLastPara: boolean;
    lineReduction: number;
    lines: ITextLine[];
    paragraphs: ITextParagraph[];
    presetTextWarp: string;
    textBounds: Readonly<Bounds>;
    textDirection: TextDirection;
    vertical: boolean;
    verticalAlignment: VerticalAlignment;
    wrapped: boolean;
    layout(bounds?): ITextFrame;
    visitLines(visitor): void;
    visitParas(visitor): void;
}

Hierarchy (view full)

Properties

autoFit bounds columSpacing columnCount fontScale horizontalCentered insets isSpaceFirstLastPara lineReduction lines paragraphs presetTextWarp textBounds textDirection vertical verticalAlignment wrapped

Methods

layout visitLines visitParas

Properties

Readonly autoFit

autoFit: TextAutofit

Readonly bounds

bounds: Readonly<Bounds>

This is the bound of a textfield include any whitespace

Readonly columSpacing

columSpacing: number

Readonly columnCount

columnCount: number

Readonly fontScale

fontScale: number

Readonly horizontalCentered

horizontalCentered: boolean

This is different than center aligned text.

Readonly insets

insets: Rectangle

Readonly isSpaceFirstLastPara

isSpaceFirstLastPara: boolean

Readonly lineReduction

lineReduction: number

Readonly lines

lines: ITextLine[]

Readonly paragraphs

paragraphs: ITextParagraph[]

Readonly presetTextWarp

presetTextWarp: string

Returns the presetTextWarp. TODO - implement this.

Readonly textBounds

textBounds: Readonly<Bounds>

This is the bound of a text not include whitespace

Readonly textDirection

textDirection: TextDirection

Readonly vertical

vertical: boolean

Readonly verticalAlignment

verticalAlignment: VerticalAlignment

Readonly wrapped

wrapped: boolean

Methods

layout

  • layout(bounds?): ITextFrame

  • Before using the bounds of a textFrame the layout must be called. This will then return a a clone of this ITextFrame that can be placed and rendered.

    Parameters

    • Optional bounds: Partial<Size>

      will cause the text to wrap. If bounds are not specified or only a dimension then it will not wrap.

    Returns ITextFrame

visitLines

  • visitLines(visitor): void

  • Parameters

    • visitor: ITextVisitor

    Returns void

visitParas

  • visitParas(visitor): void

  • Parameters

    • visitor: ITextVisitor

    Returns void

Settings

Member Visibility

Theme

On This Page

autoFitboundscolumSpacingcolumnCountfontScalehorizontalCenteredinsetsisSpaceFirstLastParalineReductionlinesparagraphspresetTextWarptextBoundstextDirectionverticalverticalAlignmentwrappedlayoutvisitLinesvisitParas