JSON API - replaceVariableText

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

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": {
        "activeSlide": boolean,
        "target": "string",
        "type": "string"
    }
}

Key	Description
variables	The names of the placeholder template variables as keys and the plain texts that should replace them as values.
activeSlide	If true, get only the active slide. Default as false.
target	slides (default) notesSlides slideLayouts slideMasters
type	inline: (default) replace only the variable. block: replace the variable and its containing paragraph.

Code samples

Example #1

{
    "template": "template.pptx",
    "actions": [
        {
            "action": "replaceVariableText",
            "data": {
                "variables": {
                    "VAR_TITLE": "phppptx"
                }
            }
        }
    ]
}

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

Release notes

phppptx 5.0:
- new action.