JSON API - transform

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

transform

PREMIUM

TRIAL / ADVANCED

Transforms presentations into other formats (PPTX, PDF, PPT, ODP).

Note

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

JSON data

{
    "document": "string",
    "targetFormat": "string",
    "method": "string",
    "options": {
        "debug": boolean,
        "escapeshellarg": boolean,
        "extraOptions": "string",
        "homeFolder": "string",
        "path": "string",
        "outdir": "string"
    }
}

Key	Description
document	Document to transform. Path to the local document, Base64 string, or URL.
targetFormat	The target format for the transformation. Available formats: "pdf", "pptx", "ppt", "odp".
method	Method used to transform the document: "libreoffice".

"libreoffice" method options:

Key	Description
debug	Returns debug information about the conversion plugin. Default as false
escapeshellarg	Applies escapeshellarg to escape source and LibreOffice path strings. Default as false
extraOptions	Extra parameters to be used when doing the conversion.
homeFolder	Set a custom home folder to be used for the conversions.
path	Sets the LibreOffice path. This option can be used instead of the path option in config/phppptxconfig.ini.
outdir	Set the outdir path. Useful when the output path is not the same than the running script.

Code samples

Example #1

{
    "actions": [
        {
            "action": "transform",
            "data": {
                "document": "file.pptx",
                "targetFormat": "pdf"
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.