JSON API - removeElement

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

removeElement

PREMIUM

TRIAL / ADVANCED

Removes elements in the PowerPoint presentation.

Note

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

JSON data

{
    "referenceNode": {
        "target": "string",
        "type": "string",
        "contains": "string",
        "occurrence": number|array|string,
        "attributes": object,
        "parent": "string",
        "rootParent": "string",
        "customQuery": "string"
    }
}

Key	Description
target	slide (default value)
type	audio chart diagram image paragraph run section shape (text box) (default value) slide table table-row table-cell table-cell-paragraph video
contains	Contains a text string. For paragraph, run, shape, table, table-row, table-cell, table-cell-paragraph types.
occurrence	(number) exact occurrence from 1 (array) occurrences (string) range of contents (e.g.: "2..9", "2..", "..9"), "first()", "last()"
attributes	Contains a specific attribute key and value. Node or descendant attributes.
parent	Immediate children (default as '/', any parent) or any other parent (a:tbl/, p:sp/...).
rootParent	Root parent. Default as p:spTree for slide elements and p:presentation for presentation elements.
customQuery	Custom XPath query, overwrites any other reference.

Code samples

Example #1

{
    "template": "template.pptx",
    "actions": [
        {
            "action": "removeElement",
            "data": {
                "referenceNode": {
                    "type": "slide",
                    "occurrence": 2
                }
            }
        }
    ]
}

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

Example #2

{
    "template": "template.pptx",
    "actions": [
        {
            "action": "setActiveSlide",
            "data": {
                "position": 1
            }
        },
        {
            "action": "removeElement",
            "data": {
                "referenceNode": {
                    "type": "paragraph"
                }
            }
        }
    ]
}

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

Release notes

phppptx 5.0:
- new action.