JavaScript API: modifySectionLayout

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

modifySectionLayout

PREMIUM

TRIAL / ADVANCED

Modifies section layout.

Note

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

Description

modifySectionLayout (options: OptionsSectionLayout): this

interface OptionsSectionLayout extends OptionsSection {
    /** If true only modifies the last section. Default as false */
    onlyLastSection?: boolean;
}

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, OptionsSectionLayout } from "build";
import * as fs from "fs";

const docx = new CreateDocx();

const sectionLayout: OptionsSectionLayout = {
    size: "A3-landscape",
    numberColumns: 3,
};
docx.modifySectionLayout(sectionLayout);

const text =
    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.";
for (let i = 0; i < 25; i++) {
    docx.addText(text);
}

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

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.