JavaScript API: replaceVariableImage

CONTENTS

LAYOUTS

SETTINGS

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 replaceVariableImage.

Description

replaceVariableImage (variables: Map<string, ArrayBuffer>, target: Target = "sheets"): this

type Target = "sharedStrings" | "sheets" | "workbook";

Code samples

Example #1

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

const xlsxTemplate = fs.readFileSync("template.xlsx").buffer;

const xlsx = new CreateXlsx();
xlsx.openTemplate(xlsxTemplate).then(xlsx => {
    const imageContent = fs.readFileSync("image.png").buffer;
    const variables = new Map<string, ArrayBuffer>();
    variables.set("IMAGE_1", imageContent);
    xlsx.replaceVariableImage(variables, "sheets");

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

The resulting XLSX spreadsheet looks like:

Release notes

phpxlsx 5.0:
- new method.