docx
    Preparing search index...

    Type Alias VmlShapeStyle

    Styling options for VML shapes.

    This type defines all available CSS-like styling properties for positioning, sizing, and configuring VML shapes in WordprocessingML documents. These properties control the shape's appearance, layout, and interaction with surrounding text.

    Properties are emitted in the order they are declared on the object.

    type VmlShapeStyle = {
        flip?: "x" | "y" | "xy" | "yx";
        height?: LengthUnit;
        left?: LengthUnit;
        marginBottom?: LengthUnit;
        marginLeft?: LengthUnit;
        marginRight?: LengthUnit;
        marginTop?: LengthUnit;
        position?: "static" | "absolute" | "relative";
        positionHorizontal?:
            | "absolute"
            | "left"
            | "center"
            | "right"
            | "inside"
            | "outside";
        positionHorizontalRelative?: "margin"
        | "page"
        | "text"
        | "char";
        positionVertical?:
            | "absolute"
            | "left"
            | "center"
            | "right"
            | "inside"
            | "outside";
        positionVerticalRelative?: "margin"
        | "page"
        | "text"
        | "char";
        rotation?: number;
        top?: LengthUnit;
        visibility?: "hidden" | "inherit";
        width: LengthUnit;
        wrapDistanceBottom?: number;
        wrapDistanceLeft?: number;
        wrapDistanceRight?: number;
        wrapDistanceTop?: number;
        wrapEdited?: boolean;
        wrapStyle?: "square" | "none";
        zIndex?: "auto" | number;
    }
    Index
    flip? height? left? marginBottom? marginLeft? marginRight? marginTop? position? positionHorizontal? positionHorizontalRelative? positionVertical? positionVerticalRelative? rotation? top? visibility? width wrapDistanceBottom? wrapDistanceLeft? wrapDistanceRight? wrapDistanceTop? wrapEdited? wrapStyle? zIndex?
    flip?: "x" | "y" | "xy" | "yx"

    Specifies that the orientation of a shape is flipped. Default is no value.

    height?: LengthUnit

    Specifies the height of the containing block of the shape. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element.

    left?: LengthUnit

    Specifies the position of the left of the containing block of the shape relative to the element left of it in the flow of the page. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. This property shall not be used for shapes anchored inline.

    marginBottom?: LengthUnit

    Specifies the position of the bottom of the containing block of the shape relative to the shape anchor. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element.

    marginLeft?: LengthUnit

    Specifies the position of the left of the containing block of the shape relative to the shape anchor. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element.

    marginRight?: LengthUnit

    Specifies the position of the right of the containing block of the shape relative to the shape anchor. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element.

    marginTop?: LengthUnit

    Specifies the position of the top of the containing block of the shape relative to the shape anchor. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element.

    position?: "static" | "absolute" | "relative"

    Specifies the type of positioning used to place an element. Default is static. When the element is contained inside a group, this property must be absolute.

    positionHorizontal?:
        | "absolute"
        | "left"
        | "center"
        | "right"
        | "inside"
        | "outside"

    Specifies the horizontal positioning data for objects in WordprocessingML documents. Default is absolute.

    positionHorizontalRelative?: "margin" | "page" | "text" | "char"

    Specifies relative horizontal position data for objects in WordprocessingML documents. This modifies the mso-position-horizontal property. Default is text.

    positionVertical?:
        | "absolute"
        | "left"
        | "center"
        | "right"
        | "inside"
        | "outside"

    Specifies the vertical positioning data for objects in WordprocessingML documents. Default is absolute.

    positionVerticalRelative?: "margin" | "page" | "text" | "char"

    Specifies relative vertical position data for objects in WordprocessingML documents. This modifies the mso-position-vertical property. Default is text.

    rotation?: number

    Specifies the angle that a shape is rotated, in degrees. Default is 0. Positive angles are clockwise.

    top?: LengthUnit

    Specifies the position of the top of the containing block of the shape relative to the element above it in the flow of the page. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. This property shall not be used for shapes anchored inline.

    visibility?: "hidden" | "inherit"

    Specifies whether a shape is displayed. Only inherit and hidden are used; any other values are mapped to inherit. Default is inherit.

    width: LengthUnit

    Specifies the width of the containing block of the shape. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element.

    wrapDistanceBottom?: number

    Specifies the distance from the bottom of the shape to the text that wraps around it. Default is 0 pt. Note that this property is different from the CSS margin property, which changes the origin of the shape to include the margin areas. This property does not change the origin.

    wrapDistanceLeft?: number

    Specifies the distance from the left side of the shape to the text that wraps around it. Default is 0 pt. Note that this property is different from the CSS margin property, which changes the origin of the shape to include the margin areas. This property does not change the origin.

    wrapDistanceRight?: number

    Specifies the distance from the right side of the shape to the text that wraps around it. Default is 0 pt. Note that this property is different from the CSS margin property, which changes the origin of the shape to include the margin areas. This property does not change the origin.

    wrapDistanceTop?: number

    Specifies the distance from the top of the shape to the text that wraps around it. Default is 0 pt. Note that this property is different from the CSS margin property, which changes the origin of the shape to include the margin areas. This property does not change the origin.

    wrapEdited?: boolean

    Specifies whether the wrap coordinates were customized by the user. If the wrap coordinates are generated by an editor, this property is true; otherwise they were customized by a user. Default is false.

    wrapStyle?: "square" | "none"

    Specifies the wrapping mode for text in shapes in WordprocessingML documents. Default is square.

    zIndex?: "auto" | number

    Specifies the display order of overlapping shapes. Default is 0. This property shall not be used for shapes anchored inline.

    Settings
    Member Visibility

    On This Page
    Properties