JSON API - setSheetSettings

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

setSheetSettings

PREMIUM

TRIAL / ADVANCED

Sets sheet settings.

Note

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

JSON data

{
    "activeCell": "string",
    "color": "string",
    "defaultColWidth": number,
    "defaultRowHeight": number,
    "marginTop": number,
    "marginRight": number,
    "marginBottom": number,
    "marginLeft": number,
    "marginHeader": number,
    "marginFooter": number,
    "orient": "string",
    "paperType": "string",
    "rtl": boolean,
    "state": "string",
    "tabSelected": boolean,
    "view": "string"
}

Key	Description
activeCell	Active cell.
color	HEX value.
defaultColWidth	Default column width.
defaultRowHeight	Default row height.
marginTop	Measurement in inches.
marginRight	Measurement in inches.
marginBottom	Measurement in inches.
marginLeft	Measurement in inches.
marginHeader	Measurement in inches.
marginFooter	Measurement in inches.
orient	portrait, landscape.
paperType	A4, A3, letter, legal, A4-landscape, A3-landscape, letter-landscape, legal-landscape.
rtl	Set to true for right to left.
state	hidden, visible.
tabSelected	Tab selected.
view	View mode: normal, pageBreakPreview, pageLayout.

Code samples

Example #1

{
    "actions": [
        {
            "action": "setSheetSettings",
            "data": {
                "paperType": "A4",
                "marginTop": 0.1,
                "marginBottom": 0.1
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.