JavaScript API: removeVariableImage

CONTENTS

addBreak
addCell
addFunction
addImage
addLink
addSheet
getCell
removeCell
setCellValue

LAYOUTS

getActiveSheet
getCellPositions
setActiveSheet
setRtl

SETTINGS

addProperties
setColumnSettings
setRowSettings
setSheetSettings
setWorkbookSettings

TEMPLATES

getTemplateVariables
openTemplate
removeVariableImage
removeVariableText
replaceVariableImage
replaceVariableText
setTemplateSymbols

OTHERS

convertMeasuringUnit
save

removeVariableImage

PREMIUM

TRIAL / ADVANCED

Removes image variables.

Note

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

Description

removeVariableImage (variables: string[], 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 variables = ["IMAGE_1"];
    xlsx.removeVariableImage(variables, "sheets");

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

Release notes

phpxlsx 5.0:
- new method.