docx
    Preparing search index...

    Class Numbering

    Represents the numbering definitions in a WordprocessingML document.

    The numbering element contains abstract numbering definitions and their concrete instances, which are referenced by paragraphs to create lists. Each numbering configuration includes a default bullet list and any custom numbering schemes defined by the user.

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

    <xsd:element name="numbering" type="CT_Numbering"/>

    <xsd:complexType name="CT_Numbering">
      <xsd:sequence>
        <xsd:element name="numPicBullet" type="CT_NumPicBullet" minOccurs="0" maxOccurs="unbounded"/>
        <xsd:element name="abstractNum" type="CT_AbstractNum" minOccurs="0" maxOccurs="unbounded"/>
        <xsd:element name="num" type="CT_Num" minOccurs="0" maxOccurs="unbounded"/>
        <xsd:element name="numIdMacAtCleanup" type="CT_DecimalNumber" minOccurs="0"/>
      </xsd:sequence>
    </xsd:complexType>

    // Create numbering with custom decimal list
    const numbering = new Numbering({
      config: [
        {
          reference: "my-decimal-list",
          levels: [
            {
              level: 0,
              format: LevelFormat.DECIMAL,
              text: "%1.",
              alignment: AlignmentType.LEFT,
              start: 1,
              style: {
                paragraph: {
                  indent: { left: 720, hanging: 360 },
                },
              },
            },
            {
              level: 1,
              format: LevelFormat.LOWER_LETTER,
              text: "%2)",
              alignment: AlignmentType.LEFT,
              style: {
                paragraph: {
                  indent: { left: 1440, hanging: 360 },
                },
              },
            },
          ],
        },
      ],
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    ConcreteNumbering ReferenceConfig

    Methods

    addChildElement createConcreteNumberingInstance prepForXml

    Constructors

    Accessors

    • get ReferenceConfig(): readonly Record<string, any>[]

      Gets all reference configurations.

      Returns readonly Record<string, any>[]

      An array of all numbering reference configurations

    Methods

    • Creates a concrete numbering instance from an abstract numbering definition.

      This method creates a new concrete numbering instance that references an abstract numbering definition. It's used internally when paragraphs reference numbering configurations.

      Parameters

      • reference: string

        The reference name of the abstract numbering definition

      • instance: number

        The instance number for this concrete numbering

      Returns void

    Settings

    Member Visibility

    On This Page

    XSD Schema
    Constructors
    Accessors
    Methods