JSON API - replaceVariableText

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

replaceVariableText

PREMIUM

TRIAL / ADVANCED

Replaces placeholder variables with text.

Note

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

JSON data

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

Key	Description
variables	Array with the names of the placeholder template variables as keys and the plain text that should replace them as values.
target	sheets (default) [sharedStrings XML content], headers, footers, comments.

Code samples

Example #1

{
    "template": "templates.xlsx",
    "actions": [
        {
            "action": "replaceVariableText",
            "data": {
                "variables": {
                    "VAR_1": "New value 1",
                    "VAR_2": "New value 2",
                    "VAR_SHEET_2": "internal descr",
                    "VAR_SHEET_2_B": "info content",
                    "IMAGE_TITLE": "Title image"
                },
                "options": {
                    "target": "sheets"
                }
            }
        },
        {
            "action": "replaceVariableText",
            "data": {
                "variables": {
                    "VAR_HEADER_2": "Header content",
                    "HEADERS_1_1": "Header A",
                    "HEADERS_1_2": "Header B"
                },
                "options": {
                    "target": "headers"
                }
            }
        },
        {
            "action": "replaceVariableText",
            "data": {
                "variables": {
                    "VAR_FOOTER_2": "Footer content",
                    "FOOTER_1_3": "Footer A",
                    "FOOTER_3_3": "Footer C"
                },
                "options": {
                    "target": "footers"
                }
            }
        },
        {
            "action": "replaceVariableText",
            "data": {
                "variables": {
                    "VAR_COMMENT": "More content in the 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.