docx
    Preparing search index...

    Type Alias ShapeTextOptions

    How text is laid out inside a shape.

    type ShapeTextOptions = {
        columns?: { count: number; spacing?: number };
        direction?: ShapeTextDirection;
        margins?: { bottom?: number; left?: number; right?: number; top?: number };
        resizeShapeToFitText?: boolean;
        shrinkTextOnOverflow?: boolean;
        verticalAlignment?: ShapeTextVerticalAlignment;
        warp?: ShapeTextWarp;
        wrap?: boolean;
    }
    Index
    columns?: { count: number; spacing?: number }

    Lays the text out in columns

    Type Declaration

    • Readonlycount: number

      The number of columns, from 1 to 16

    • Optional Readonlyspacing?: number

      Space between the columns, in points. Default is 0

    direction?: ShapeTextDirection

    The direction the text runs in. Default is "horizontal"

    margins?: { bottom?: number; left?: number; right?: number; top?: number }

    Space between the shape's edges and its text, in points. Word's defaults are 7.2 (0.1") on the left and right and 3.6 (0.05") on the top and bottom

    resizeShapeToFitText?: boolean

    Grows or shrinks the shape to fit its text. Can't be used with shrinkTextOnOverflow

    shrinkTextOnOverflow?: boolean

    Makes the text smaller when there is too much of it for the shape. Can't be used with resizeShapeToFitText

    verticalAlignment?: ShapeTextVerticalAlignment

    Where the text sits between the top and bottom of the shape. Default is "center"

    Bends or stretches the text to a shape, like WordArt

    wrap?: boolean

    Whether lines of text wrap at the shape's edges. Default is true