JavaScript API: addSection

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addSection

PREMIUM

TRIAL / ADVANCED

Adds section.

Note

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

Description

addSection (options: OptionsSection = {}): this

type LayoutPreset =
    | "A4"
    | "A3"
    | "letter"
    | "legal"
    | "A4-landscape"
    | "A3-landscape"
    | "letter-landscape"
    | "legal-landscape"
    | "custom";

interface OptionsSection {
    /** Bidi */
    bidi?: boolean;
    /** Internal code number */
    code?: number;
    /** Exclude headers and footers reference tags. Default as false */
    excludeHeadersFooters?: boolean;
    /** Height: twips value */
    height?: number;
    /** Margins: twips value */
    margin?: {
        top?: number;
        right?: number;
        bottom?: number;
        left?: number;
        header?: number;
        footer?: number;
    };
    /** Number of columns */
    numberColumns?: number;
    /** Orientation */
    orient?: "portrait" | "landscape";
    /** RTL gutter */
    rtlGutter?: boolean;
    /** Sizes. If undefined use the previous section from the document */
    size?: LayoutPreset;
    /** Type. Default as nextPage */
    type?: "nextPage" | "nextColumn" | "continuous" | "evenPage" | "oddPage";
    /** Width: twips value */
    width?: number;
}

Code samples

Example #1

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

const docx = new CreateDocx();

docx.addText("New content in the first section.");

const section: OptionsSection = {
    size: "A3",
};
docx.addSection(section);

docx.addText("New content in the new section.");

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.