docx
    Preparing search index...

    Type Alias IShapeNestedGroupOptions

    IShapeNestedGroupOptions: DrawingLinkOptions & {
        altText?: DocPropertiesOptions;
        children: readonly IShapeGroupChildOptions[];
        lane?: string;
        layout?: ShapeLayout;
        transformation?: Omit<IMediaTransformation, "width" | "height"> & {
            height?: number;
            width?: number;
        };
        type: "group";
    }

    A group of shapes inside a ShapeGroupRun or ShapeCanvasRun, which moves, scales and rotates as one.

    Its children are positioned relative to each other, like the children of a ShapeGroupRun, and transformation.offset places the group's top-left corner. Connectors in the group can only join shapes in the group, but connectors outside it can attach to the shapes in it.

    Type Declaration

    • Optional ReadonlyaltText?: DocPropertiesOptions

      Name, description and title used by screen readers

    • Readonlychildren: readonly IShapeGroupChildOptions[]

      The shapes, pictures, groups and connectors in the group

    • Optional Readonlylane?: string

      The lane of the flow the group goes in, by its name. See ShapeFlowLayout.lanes

    • Optional Readonlylayout?: ShapeLayout

      Places the children that have no offset, such as in a flowchart, tree or grid

    • Optional Readonlytransformation?: Omit<IMediaTransformation, "width" | "height"> & {
          height?: number;
          width?: number;
      }

      Position and size of the group in pixels, with optional rotation (degrees) and flip. The size defaults to the box around the children, and a different size scales every child

    • Readonlytype: "group"