JSON API - setTemplateSymbol

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

setTemplateSymbol

PREMIUM

TRIAL / ADVANCED

Sets the character or characters used to identify placeholder variables within a given template.

Note

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

JSON data

{
    "start": "string",
    "end": "string",
    "options": {
        "preprocessed": boolean
    }
}

Key	Description
start	The character or symbol to be used for identifying placeholder variables within templates. If "end" is null, it uses "start" at the beginning and the end of the variable.
end	The character or symbol to be used at the end for identifying placeholder variables within templates. If "end" is null, it uses "start" at the beginning and the end of the variable. If it has a value, it uses "start" at the beginning and "end" at the end.
preprocessed	Set the template as preprocessed. Default as false.

Code samples

Example #1

{
    "template": "template.xlsx",
    "actions": [
        {
            "action": "setTemplateSymbol",
            "data": {
                "start": "#"
            }
        },
        {
            "action": "replaceVariableText",
            "data": {
                "variables": {
                    "VAR_1": "New value 1"
                },
                "options": {
                    "target": "sheets"
                }
            }
        },
        {
            "action": "setTemplateSymbol",
            "data": {
                "start": "${",
                "end": "}"
            }
        },
        {
            "action": "replaceVariableText",
            "data": {
                "variables": {
                    "VAR_1": "New value 2"
                },
                "options": {
                    "target": "sheets"
                }
            }
        }
    ]
}

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

Release notes

phpxlsx 6.0:
- new action.