JSON API - setActiveSheet

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

setActiveSheet

PREMIUM

TRIAL / ADVANCED

Sets the active sheet.

Note

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

JSON data

{
    "name": "string",
    "position": number
}

Key	Description
name	Sheet name.
position	Sheet position. 0 is the first sheet. -1 choose the last sheet.

An existing name or position must be chosen.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addSheet"
        },
        {
            "action": "addSheet",
            "data": {
                "name": "Other"
            }
        },
        {
            "action": "setActiveSheet",
            "data": {
                "position": 1
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "Lorem ipsum dolor sit amet"
                },
                "position": "A1"
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "addSheet"
        },
        {
            "action": "addSheet",
            "data": {
                "name": "Other"
            }
        },
        {
            "action": "setActiveSheet",
            "data": {
                "name": "Other"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "Lorem ipsum dolor sit amet"
                },
                "position": "A1"
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.