JSON API - replaceVariableImage

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

replaceVariableImage

PREMIUM

TRIAL / ADVANCED

Replaces a placeholder within an image with a new image.

Note

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

The placeholder image should be tagged using the alternate text option of the Excel interface (this may depend on the Excel version).

JSON data

{
    "variables": object,
    "options": {
        "alt": "string",
        "colOffset": {
            "from": number,
            "to": number
        },
        "colSize": number,
        "descr": "string",
        "hyperlink": "string",
        "mime": "string",
        "rowOffset": {
            "from": number,
            "to": number
        },
        "rowSize": number,
        "target": "string"
    }
}

Key	Description
variables	Object with the names of the placeholder template image variables as keys and the image paths, base64 contents or streams that should replace them.
alt	Alt value.
colOffset	"from" column size offset from. "to" column size offset to.
colSize	Number of columns used by the text box.
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).
rowOffset	"from" row size offset from. "to" row size offset to.
rowSize	Number of rows used by the text box.
target	sheets (default), headers, footers.

Code samples

Example #1

{
    "template": "template.xlsx",
    "actions": [
        {
            "action": "replaceVariableImage",
            "data": {
                "variables": {
                    "IMAGE_1": "image.png"
                }
            }
        },
        {
            "action": "replaceVariableImage",
            "data": {
                "variables": {
                    "IMAGE_HEADER": "image.jpg"
                },
                "options": {
                    "target": "headers"
                }
            }
        },
        {
            "action": "replaceVariableImage",
            "data": {
                "variables": {
                    "IMAGE_FOOTER": "image.jpg"
                },
                "options": {
                    "target": "footers"
                }
            }
        }
    ]
}

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

Release notes

phpxlsx 6.0:
- new action.