JavaScript API: setTemplateSymbols

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

setTemplateSymbols

PREMIUM

TRIAL / ADVANCED

Sets template symbols.

Note

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

Description

setTemplateSymbols (templateSymbolStart: string, templateSymbolEnd?: string): this

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 => {
    // replace variables with #
    let variables = new Map<string, string>();
    variables.set("VAR_1", "New value 1");
    xlsx.setTemplateSymbols("#");
    xlsx.replaceVariableText(variables, "sheets");

    // replace variables with ${}
    variables = new Map<string, string>();
    variables.set("VAR_1", "New value 2");
    xlsx.setTemplateSymbols("${", "}");
    xlsx.replaceVariableText(variables, "sheets");

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

Release notes

phpxlsx 5.0:
- new method.