docx
    Preparing search index...

    Class ShapeRun

    Represents a shape in a WordprocessingML document.

    A shape is one of the 187 DrawingML presets, such as a rectangle, ellipse, line, arrow, star, callout or flowchart symbol. It can have a fill, a line with dashes and arrowheads, and text inside it. It sits inline with text unless floating is set.

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

    // A black bar inline with text
    new Paragraph({
      children: [
        new TextRun("Name: "),
        new ShapeRun({ type: "rectangle", transformation: { width: 200, height: 4 }, fill: "000000", line: "none" }),
      ],
    });

    // An arrow
    new ShapeRun({
      type: "line",
      transformation: { width: 300, height: 0 },
      line: { color: "C00000", width: 2, endArrow: "triangle" },
    });

    Hierarchy (View Summary)

    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