JSON API - addBackgroundImage

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

addBackgroundImage

PREMIUM

TRIAL / ADVANCED

Inserts a background image into the PowerPoint presentation.

Note

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

JSON data

{
    "image": "string",
    "options": {
        "overwrite": boolean,
        "tilePictureAsTexture": boolean,
        "transparency": number
    }
}

Key	Description
image	Image path, Base64 string, or URL.
overwrite	If true overwrites existing background images. Default as true.
tilePictureAsTexture	Default as false.
transparency	From 0 to 100.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addBackgroundImage",
            "data": {
                "image": "image.png"
            }
        },
        {
            "action": "addSlide",
            "data": {
                "active": true
            }
        },
        {
            "action": "addBackgroundImage",
            "data": {
                "image": "image.png",
                "options": {
                    "transparency": 60
                }
            }
        },
        {
            "action": "addSlide",
            "data": {
                "active": true
            }
        },
        {
            "action": "addBackgroundImage",
            "data": {
                "image": "image.png",
                "options": {
                    "tilePictureAsTexture": true,
                    "transparency": 80
                }
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.