JSON API - replacePlaceholderImage

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

replacePlaceholderImage

PREMIUM

TRIAL / ADVANCED

Replaces a placeholder within an image by a new image.

Note

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

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

JSON data

{
    "variable": "string",
    "options": {
        "src": "string",
        "firstMatch": boolean,
        "hyperlink": "string",
        "replaceShapes": boolean,
        "target": "string",
        "width": number | "string",
        "height": number | "string",
        "dpi": number,
        "mime": "string"
    }
}

Key	Description
variable	The name of the variable that identifies the placeholder image.
src	Path to the local image, Base64 string, or URL.
firstMatch	If the variable appears more than once within the Word document and firstMatch is set to true, phpdocx will only replace the first occurrence of the variable within the Word document.
hyperlink	If set, adds the image hyperlink (hyperlink or bookmark).
replaceShapes	If true, replace images in shapes too. Default as false.
target	Possible values are: document, header, footer, footnote, endnote or comment.
width	The value in: cm (number) "auto" (string) (use image size) 0 (number) to not change the previous size "fit" (string) fit the image in the placeholder image size
height	The value in: cm (number) "auto" (string) (use image size) 0 (number) to not change the previous size "fit" (string) fit the image in the placeholder image size
dpi	Dots per inch. This parameter is only taken into account if width or height are set to auto.
mime	Forces a mime (image/jpg, image/jpeg, image/png, image/gif, image/bmp, image/webp).

Code samples

Example #1

{
    "template": "template.docx",
    "actions": [
        {
            "action": "replacePlaceholderImage",
            "data": {
                "variable": "HEADERIMG",
                "src": "image.jpg",
                "options": {
                    "height": 3,
                    "width": 3,
                    "target": "header"
                }
            }
        },
        {
            "action": "replacePlaceholderImage",
            "data": {
                "variable": "LOGO",
                "src": "image.png"
            }
        }
    ]
}

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

Release notes

phpdocx 18.0:
- new action.