JavaScript API: addBackgroundImage

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addBackgroundImage

PREMIUM

TRIAL / ADVANCED

Adds background image.

Note

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

Description

addBackgroundImage (image: ArrayBuffer): this

Code samples

Example #1

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

const docx = new CreateDocx();

const filePng = fs.readFileSync("image.png");

docx.addBackgroundImage(filePng);

docx.addText("This document has a background image.");

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

The resulting Word document looks like:

Release notes

phpdocx 15.5:
- new method.