JSON API - addImage

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

addImage

PREMIUM

TRIAL / ADVANCED

Inserts an image into the Excel spreadsheet.

Note

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

JSON data

{
    "image": "string",
    "position": "string",
    "options": {
        "colOffset": {
            "from": number,
            "to": number
        },
        "colSize": number,
        "descr": "string",
        "editAs": "string",
        "dpi": number,
        "hyperlink": "string",
        "mime": "string",
        "name": "string",
        "rotation": number,
        "rowOffset": {
            "from": number,
            "to": number
        },
        "rowSize": number,
        "transparency": number
    }
}

Key	Description
image	Image path, Base64 string, or URL.
position	Cell position in the active sheet: "A1", "C3", "AB7"...
colOffset	"from" column size offset from. "to" column size offset to.
colSize	Number of columns used by the image.
descr	Descr value.
dpi	Dots per inch. Autodetect if not set.
editAs	Possible values are: "oneCell" (default): move but don't size with cells. "twoCell": move and size with cells. "absolute": don't move or size with cells.
hyperlink	Hyperlink.
mime	Forces a mime (image/jpg, image/jpeg, image/png, image/gif, image/bmp, image/webp).
name	Sets a name value.
rotation	60.000ths of a degree.
rowOffset	"from" row size offset from. "to" row size offset to.
rowSize	Number of rows used by the image.
transparency	0 to 100.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addImage",
            "data": {
                "image": "image.png",
                "position": "A1",
                "options": {
                    "colSize": 3,
                    "rowSize": 7
                }
            }
        },
        {
            "action": "addImage",
            "data": {
                "image": "image.webp",
                "position": "AB4",
                "options": {
                    "colOffset": {
                        "from": 129600,
                        "to": 137160
                    },
                    "colSize": 6,
                    "rowOffset": {
                        "from": 152280,
                        "to": 159840
                    },
                    "rowSize": 11,
                    "rotation": 315,
                    "transparency": 60
                }
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.