JavaScript API: addTableOfFigures

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addTableOfFigures

PREMIUM

TRIAL / ADVANCED

Adds table of figures.

Note

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

Description

addTableOfFigures (options: OptionsTableOfFigures = {}): this

interface OptionsTableOfFigures {
    /** Try to update the TOF when first opened */
    autoUpdate?: boolean;
    /** Legend. Default as "No table of figures entries found." */
    legend?: OptionsText;
    /** Paragraph style */
    pStyle?: string;
    /** Scope. Default as Table */
    scope?: string;
}

Code samples

Example #1

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

const docx = new CreateDocx();

const tof: OptionsTableOfFigures = {
    autoUpdate: true,
    pStyle: "Heading2",
};
docx.addTableOfFigures(tof);

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

Release notes

phpdocx 15.5:
- new method.