JavaScript API: replaceVariableText

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

replaceVariableText

PREMIUM

TRIAL / ADVANCED

Replaces text variables.

Note

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

Description

replaceVariableText (variables: Map<string, string>, target: Element.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 variables = new Map<string, string>();
    variables.set("VAR_1", "New value 1");
    variables.set("VAR_2", "New value 2");
    variables.set("VAR_SHEET_2", "internal descr");
    variables.set("VAR_SHEET_2_B", "info content");
    variables.set("IMAGE_TITLE", "Title image");
    xlsx.replaceVariableText(variables, "sheets");

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

The resulting XLSX spreadsheet looks like:

Release notes

phpxlsx 5.0:
- new method.