JSON API - removeVariableImage

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

removeVariableImage

PREMIUM

TRIAL / ADVANCED

Removes image placeholder variables from the Excel spreadsheet.

Note

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

JSON data

{
    "variables": array,
    "options": {
        "target": "string"
    }
}

Key	Description
variables	Array of variables to remove.
target	sheets (default), headers, footers.

Code samples

Example #1

{
    "template": "template.xlsx",
    "actions": [
        {
            "action": "removeVariableImage",
            "data": {
                "variables": ["IMAGE_1"]
            }
        },
        {
            "action": "removeVariableImage",
            "data": {
                "variables": ["IMAGE_HEADER"],
                "options": {
                    "target": "headers"
                }
            }
        },
        {
            "action": "removeVariableImage",
            "data": {
                "variables": ["IMAGE_FOOTER"],
                "options": {
                    "target": "footers"
                }
            }
        }
    ]
}

A template can be a local file, a Base64 string, or a remote file.

Release notes

phpxlsx 6.0:
- new action.