JavaScript API: addFooter

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addFooter

PREMIUM

TRIAL / ADVANCED

Adds footer.

Note

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

Description

addFooter (footers: OptionsFooter[]): this

interface OptionsFooter extends OptionsReference {}

interface OptionsReference {
    /** Replace existing reference in the section. Default as true */
    replaceOthers?: boolean;
    /** Section to add the content. Default as -1 (last section) */
    section?: number | "all";
    /** Content */
    text: WordFragment;
    /** Type. Default as default */
    type?: "default" | "even" | "first";
}

Code samples

Example #1

import {
    CreateDocx,
    OptionsFooter,
    OptionsText,
    WordFragment,
} from "build";
import * as fs from "fs";

const docx = new CreateDocx();

// generate footer content
const footers: OptionsFooter[] = [];

const textDefaultFooterA: OptionsText = {
    bold: true,
    italic: true,
    fontSize: 14,
    text: "Text ",
};
const textDefaultFooterB: OptionsText = {
    color: "0000FF",
    font: "Times New Roman",
    text: "default footer.",
};
const footerFragmentDefault = new WordFragment();
footerFragmentDefault.addText([textDefaultFooterA, textDefaultFooterB]);
const footerContentDefault: OptionsFooter = {
    text: footerFragmentDefault,
};

const textFirstFooter: OptionsText = {
    bold: true,
    text: "Text first footer.",
};
const footerFragmentFirst = new WordFragment();
footerFragmentFirst.addText([textFirstFooter]);
const footerContentFirst: OptionsFooter = {
    text: footerFragmentFirst,
    type: "first",
};

const footerFragmentEven = new WordFragment();
footerFragmentEven.addText("Text even footer.");
const footerContentEven: OptionsFooter = {
    text: footerFragmentEven,
    type: "even",
};

footers.push(footerContentDefault);
footers.push(footerContentFirst);
footers.push(footerContentEven);

// add footers
docx.addFooter(footers);

docx.addText("First page.");
docx.addBreak("page");
docx.addText("Even page.");
docx.addBreak("page");
docx.addText("Other page.");

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.