JSON API - removeElement

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

removeElement

PREMIUM

TRIAL / ADVANCED

Removes elements in the spreadsheet.

Note

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

JSON data

{
    "referenceNode": {
        "type": "string",
        "contains": "string",
        "occurrence": number | "string" | array,
        "attributes": array,
        "customQuery": "string"
    }
}

Key	Description
type	cell (default value) drawing row sheet
contains	Contains a text string. Cell and sheet 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.
customQuery	Custom XPath query, overwrites any other reference.

Code samples

Example #1

{
    "template": "template.xlsx",
    "actions": [
        {
            "action": "removeElement",
            "data": {
                "referenceNode": {
                    "type": "cell",
                    "occurrence": 1
                }
            }
        },
        {
            "action": "removeElement",
            "data": {
                "referenceNode": {
                    "type": "cell",
                    "occurrence": "2.."
                }
            }
        },
        {
            "action": "setActiveSheet",
            "data": {
                "position": 2
            }
        },
        {
            "action": "removeElement",
            "data": {
                "referenceNode": {
                    "type": "cell",
                    "contains": "IMAGE"
                }
            }
        }
    ]
}

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

Release notes

phpxlsx 6.0:
- new action.