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

    Interface ITextBoxAlignment

    Provided options for aligned text within a bounding box.

    interface ITextBoxAlignment {
        isITextBoxAlignment: true;
        getHorizontal(): ITextFrame.HorizontalAlignment;
        getIndent(): number;
        getJustifyLastLine(): boolean;
        getOverflow(): ITextFrame.Overflow;
        getReadingDirection(): ITextFrame.ReadingDirection;
        getRelativeIndent(): number;
        getRotation(): number;
        getStacked(): boolean;
        getVertical(): ITextFrame.VerticalAlignment;
        setHorizontal(
            horizontal: ITextFrame.HorizontalAlignment | null,
            options?: UpdateOptions,
        ): ITextBoxAlignment;
        setIndent(
            indent: number | null,
            options?: UpdateOptions,
        ): ITextBoxAlignment;
        setJustifyLastLine(
            justifyLastLine: boolean | null,
            options?: UpdateOptions,
        ): ITextBoxAlignment;
        setOverflow(
            overflow: ITextFrame.Overflow | null,
            options?: UpdateOptions,
        ): ITextBoxAlignment;
        setReadingDirection(
            readingDirection: ITextFrame.ReadingDirection | null,
            options?: UpdateOptions,
        ): ITextBoxAlignment;
        setRelativeIndent(
            relativeIndent: number | null,
            options?: UpdateOptions,
        ): ITextBoxAlignment;
        setRotation(
            rotation: number | null,
            options?: UpdateOptions,
        ): ITextBoxAlignment;
        setStacked(
            stacked: boolean | null,
            options?: UpdateOptions,
        ): ITextBoxAlignment;
        setVertical(
            vertical: ITextFrame.VerticalAlignment | null,
            options?: UpdateOptions,
        ): ITextBoxAlignment;
        toJSON(): ITextBoxAlignment.JSON;
    }
    Index
    isITextBoxAlignment
    getHorizontal getIndent getJustifyLastLine getOverflow getReadingDirection getRelativeIndent getRotation getStacked getVertical setHorizontal setIndent setJustifyLastLine setOverflow setReadingDirection setRelativeIndent setRotation setStacked setVertical toJSON
    isITextBoxAlignment: true

    For runtime type checking.

    • An integer value, where an increment of 1 represents 3 spaces. Indicates the number of spaces (of the normal style font) of indentation for text in a cell.

      Returns number

      This is only applied for alignments: left, right, and distributed.

    • If the cells justified or distributed alignment should be used on the last line of text. (This is typical for East Asian alignments but not typical in other contexts.)

      Returns boolean

    • Indicates additional number of spaces of indentation to adjust for text in a cell.

      Returns number

    • Rotation of the text, in degrees 0…360 (counter-clockwise, as OOXML stores it).

      Returns number

      0

    • If the text is stacked — every glyph upright, one below the other (Excel's "Vertical Text").

      Returns boolean

      false

    • Sets the rotation.

      Parameters

      • rotation: number | null

        The rotation in degrees; negative values are normalized (-45 is 315).

      • Optionaloptions: UpdateOptions

      Returns ITextBoxAlignment

      Rotation and stacked are one orientation setting: setting a rotation turns stacking off.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods