JSON API - removeVariableText

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

removeVariableText

PREMIUM

TRIAL / ADVANCED

Removes text placeholder variables from the Excel spreadsheet.

Note

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

JSON data

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

Key	Description
variables	Array of variables to remove.
target	sheets (default) [sharedStrings XML content], headers, footers, comments.

Code samples

Example #1

{
    "template": "template.xlsx",
    "actions": [
        {
            "action": "removeVariableText",
            "data": {
                "variables": ["VAR_1", "VAR_2"],
                "options": {
                    "target": "sheets"
                }
            }
        },
        {
            "action": "removeVariableText",
            "data": {
                "variables": ["VAR_HEADER_2", "HEADERS_1_1", "HEADERS_1_2"],
                "options": {
                    "target": "headers"
                }
            }
        },
        {
            "action": "removeVariableText",
            "data": {
                "variables": ["VAR_FOOTER_2", "FOOTER_1_3", "FOOTER_3_3"],
                "options": {
                    "target": "footers"
                }
            }
        },
        {
            "action": "removeVariableText",
            "data": {
                "variables": ["VAR_COMMENT"],
                "options": {
                    "target": "comments"
                }
            }
        }
    ]
}

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

Release notes

phpxlsx 6.0:
- new action.