JavaScript API: replaceVariableImage

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

replaceVariableImage

PREMIUM

TRIAL / ADVANCED

Replaces image variables.

Note

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

Description

replaceVariableImage (variables: Map<string, ArrayBuffer>, target: Target = "document", options: OptionsReplaceVariableImage = {}): this

This method allows to replace a placeholder image that may be fully formatted in Word (border, shadows, effects...) by an image of our choice.

The placeholder image should be tagged using the alternate text option of the Word interface (this may depend on the Word version).

type Target =
    | "document"
    | "header"
    | "footer"
    | "comment"
    | "endnote"
    | "footnote";

type MimeImage = "image/gif" | "image/jpg" | "image/png" | "image/webp";

interface OptionsReplaceVariableImage extends OptionsFirstMatch {
    /** Height: EMUs value. If -1 do not change the placeholder image height. If not set, use new image height */
    height?: number;
    /** Mime type */
    mime?: MimeImage;
    /** Width: EMUs value. If -1 do not change the placeholder image width. If not set, use new image width */
    width?: number;
}

Code samples

Example #1

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

const docxTemplate = fs.readFileSync("template.docx");

const docx = new CreateDocx();
// load the template
docx.openTemplate(docxTemplate).then(docx => {
    const fileJpgA = fs.readFileSync("imageA.jpg");
    const fileJpgB = fs.readFileSync("imageB.jpg");
    const fileJpgC = fs.readFileSync("imageC.jpg");

    // variables to be replaced in the document target
    const variablesDocument = new Map<string, ArrayBuffer>();
    variablesDocument.set("IMAGE_1", fileJpgA);
    variablesDocument.set("IMAGE_2", fileJpgB);

    // replace template image variables in the document target
    docx.replaceVariableImage(variablesDocument, "document");

    // variables to be replaced in the header target
    const variablesHeader = new Map<string, ArrayBuffer>();
    variablesHeader.set("HEADERIMG", fileJpgC);

    // replace template image variables in the header target
    docx.replaceVariableImage(variablesHeader, "header");

    // save the DOCX
    docx.save().then(contents => {
        fs.writeFileSync("replaceVariableImage_1.docx", Buffer.from(contents));
    });
});

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.