docx
    Preparing search index...

    Class ShapeGroupRun

    Represents a group of shapes in a WordprocessingML document.

    The shapes are positioned with transformation.offset, in pixels, and the group is as big as the box around them. Give the group its own transformation to scale, rotate or flip all of them together.

    Connectors are drawn between the shapes they name. Word only keeps connectors attached when shapes are moved on a ShapeCanvasRun; in a group they stay where they are drawn.

    Reference: http://officeopenxml.com/drwSp-group.php

    new ShapeGroupRun({
      children: [
        { id: "start", type: "rectangle", transformation: { width: 120, height: 48 }, fill: "4472C4" },
        { id: "end", type: "ellipse", transformation: { offset: { left: 160 }, width: 120, height: 48 }, fill: "ED7D31" },
        { type: "connector", from: "start", to: "end", line: { endArrow: "triangle" } },
      ],
    });

    Hierarchy (View Summary)

    • Run
      • ShapeGroupRun
    Index
    constructor
    writtenAs
    addChildElement prepForXml
    • get writtenAs(): readonly BaseXmlComponent[] | undefined
      Internal

      The components written in this one's place, one after another, when it can't be written as a single element, such as a run with another run in its children. Undefined when it is written as itself.

      Returns readonly BaseXmlComponent[] | undefined

    • Prepares this component and its children for XML serialization.

      This method is called by the Formatter to convert the component tree into an object structure compatible with the xml library (https://www.npmjs.com/package/xml). It recursively processes all children and handles special cases like attribute-only elements and empty elements.

      The method can be overridden by subclasses to customize XML representation or execute side effects during serialization (e.g., creating relationships).

      Parameters

      • context: IContext

        The serialization context containing document state

      Returns IXmlableObject | undefined

      The XML-serializable object, or undefined to exclude from output

      // Override to add custom serialization logic
      prepForXml(context: IContext): IXmlableObject | undefined {
        // Custom logic here
        return super.prepForXml(context);
      }

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods