JSON API - replaceVariableImage

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

replaceVariableImage

PREMIUM

TRIAL / ADVANCED

Replaces image placeholders with new images.

Note

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

JSON data

{
    "variables": object,
    "options": {
        "activeSlide": boolean,
        "descr": "string",
        "hyperlink": "string",
        "mime": "string",
        "sizeX": number,
        "sizeY": number,
        "target": "string"
    }
}

Key	Description
variables	The names of the placeholder template variables as keys and the images that should replace them as values. Image path, Base64 string, or URL.
activeSlide	If true, get only the active slide. Default as false.
descr	Descr value.
hyperlink	If set, adds the image hyperlink (hyperlink or bookmark).
mime	Forces a mime: image/jpg, image/jpeg, image/png, image/gif, image/bmp, image/webp.
sizeX	EMUs (English Metric Unit).
sizeY	EMUs (English Metric Unit).
target	slides (default) slideLayouts slideMasters

Code samples

Example #1

{
    "template": "template.pptx",
    "actions": [
        {
            "action": "replaceVariableImage",
            "data": {
                "variables": {
                    "VAR_IMAGE_PHPDOCX": "imageA.png",
                    "VAR_IMAGE_PHPXLSX": "imageB.png"
                }
            }
        }
    ]
}

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

Release notes

phppptx 5.0:
- new action.