replaceVariableImage

Replaces image variables.

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...) with an image of our choice.

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

type MimeImage =
    | "image/gif"
    | "image/jpg"
    | "image/png"
    | "image/svg+xml"
    | "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").buffer;

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

    // variables to be replaced in the document target
    const variablesDocument = new Map();
    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();
    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:

Download example document

Release notes

  • jsdocuments 1.0:
    • New method