SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface ITextFrame

    Represents a rectangular container for text and its formatting within a document.

    A TextFrame allows precise control over the positioning, size (width and height), layout, and appearance of text content.

    interface ITextFrame {
        autoFit: ITextFrame.Autofit;
        bounds: Readonly<Bounds>;
        columnCount: number;
        columnSpacing: number;
        fontScale: number;
        horizontalCentered: boolean;
        insets: Rectangle;
        isITextFrame: true;
        isSpaceFirstLastPara: boolean;
        lineReduction: number;
        lines: ITextLine[];
        orientation: ITextFrame.Orientation;
        paragraphs: ITextParagraph[];
        presetTextWarp: string | null;
        textBounds: Readonly<Bounds>;
        vertical: boolean;
        verticalAlignment: ITextFrame.VerticalAlignment;
        wrapped: boolean;
        createTextFrame(text: string, allowWrap?: boolean): ITextFrame;
        getText(): string;
        layout(dimensions?: Partial<Size>): ITextFrame;
        visitLines(visitor: TextVisitor): void;
        visitParas(visitor: TextVisitor): void;
    }

    Hierarchy (View Summary)

    Index
    autoFit bounds columnCount columnSpacing fontScale horizontalCentered insets isITextFrame isSpaceFirstLastPara lineReduction lines orientation paragraphs presetTextWarp textBounds vertical verticalAlignment wrapped
    createTextFrame getText layout visitLines visitParas
    autoFit: ITextFrame.Autofit
    bounds: Readonly<Bounds>

    This is the bound of a textfield include any whitespace

    columnCount: number
    columnSpacing: number
    fontScale: number
    horizontalCentered: boolean

    This is different then center aligned text.

    insets: Rectangle
    isITextFrame: true

    For runtime type checking.

    isSpaceFirstLastPara: boolean
    lineReduction: number
    lines: ITextLine[]
    orientation: ITextFrame.Orientation
    paragraphs: ITextParagraph[]
    presetTextWarp: string | null

    Returns the presetTextWarp. TODO - implement this.

    textBounds: Readonly<Bounds>

    This is the bound of a text not include whitespace

    vertical: boolean
    verticalAlignment: ITextFrame.VerticalAlignment
    wrapped: boolean

    • Creates a simple text frame that can be used for rendering and/or measuring.

      Parameters

      • text: string

        The text to use

      • OptionalallowWrap: boolean

        If true then will try to wrap on natural breaks. Defaults the the current settings.

      Returns ITextFrame

    • Returns the frame's text with its formatting stripped.

      Returns string

      • Paragraphs are separated by , and a line break inside a paragraph is also .
      • Runs and fields are concatenated in document order.
      • Blank paragraphs at the start and end are dropped; blank paragraphs between text are kept.
      • An equation reads as its linear text form.
      • A frame with nothing written in it answers ''.

    • 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

      • Optionaldimensions: Partial<Size>

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

      Returns ITextFrame

    • Parameters

      • visitor: TextVisitor

      Returns void

    • Parameters

      • visitor: TextVisitor

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods