JavaScript API: addTableOfContents

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addTableOfContents

PREMIUM

TRIAL / ADVANCED

Adds table of contents.

Note

You are reading the JavaScript API documentation. For the PHP API method please go to addTableContents.

Description

addTableOfContents (options: OptionsTableOfContents = {}): this

interface OptionsTableOfContents {
    /** Try to update the TOC when first opened */
    autoUpdate?: boolean;
    /** Outline levels to be displayed. Default as "1-4" */
    showLevels?: string;
    /** Legend. Default as "Click here to update the Table of Contents" */
    legend?: OptionsText;
}

Code samples

Example #1

import {
    CreateDocx,
    OptionsParagraph,
    OptionsTableOfContents,
} from "build";
import * as fs from "fs";

const docx = new CreateDocx();

const toc: OptionsTableOfContents = {
    autoUpdate: true,
};
docx.addTableOfContents(toc);

const optionsParagraphA: OptionsParagraph = {
    pStyle: "Heading1",
};
docx.addText("Heading 1 content.", optionsParagraphA);

const optionsParagraphB: OptionsParagraph = {
    pStyle: "Heading2",
};
docx.addText("Heading 2 content.", optionsParagraphB);

const optionsParagraphC: OptionsParagraph = {
    outlineLvl: 2,
};
docx.addText("Text content with an outline level.", optionsParagraphC);

docx.addText("Text content without an outline level.");

docx.save().then(contents => {
    fs.writeFileSync("addTableOfContents_1.docx", Buffer.from(contents));
});

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.