JSON API - setWorkbookSettings

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

setWorkbookSettings

PREMIUM

TRIAL / ADVANCED

Sets workbook settings.

Note

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

JSON data

{
    "activeSheetAsActiveTab": boolean,
    "activeTab": number,
    "forceFullCalc": boolean,
    "fullCalcOnLoad": boolean,
    "readOnly": boolean
}

Key	Description
activeSheetAsActiveTab	Active sheet number as the active tab. Default as false.
activeTab	Active tab number. The first tab is 0.
forceFullCalc	Enable Force Full Calculation.
fullCalcOnLoad	Enable Full Calculation On Load.
readOnly	Set as read only. Default as false.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addSheet",
            "data": {
                "name": "My 1"
            }
        },
        {
            "action": "addSheet",
            "data": {
                "name": "Other",
                "removeSelected": true,
                "selected": true,
                "active": true
            }
        },
        {
            "action": "setSheetSettings",
            "data": {
                "tabSelected": false
            }
        },
        {
            "action": "setActiveSheet",
            "data": {
                "position": 1
            }
        },
        {
            "action": "setSheetSettings",
            "data": {
                "tabSelected": true
            }
        },
        {
            "action": "setWorkbookSettings",
            "data": {
                "activeTab": 1
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.