JSON API - createTableStyle

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

createTableStyle

PREMIUM

TRIAL / ADVANCED

Creates a table style.

Note

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

JSON data

{
    "name": "string",
    "styles": {
        "wholeTable": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "headerRow": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "totalRow": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "firstColumn": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "lastColumn": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "firstRowStripe": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "secondRowStripe": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "firstColumnStripe": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "secondColumnStripe": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "firstHeaderCell": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "lastHeaderCell": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "firstTotalCell": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        },
        "lastTotalCell": {
            "backgroundColor": "string",
            "bold": boolean,
            "border": "string",
            "borderColor": "string",
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string"
        }
    }
    "options": {}
}

Key	Description
name	Style name.
backgroundColor	Hexadecimal color value: "FFFF00", "CCCCCC"...
bold	If true the content will be shown in bold characters.
border	Border type: thin, thick, dashed, double, mediumDashDotDot, hair... This value can be overridden for each side with "borderTop", "borderRight", "borderBottom", "borderLeft" and "borderDiagonal" properties.
borderColor	Hexadecimal color value: "FFFF00", "CCCCCC"... This value can be overridden for each side with "borderColorTop", "borderColorRight", "borderColorBottom", "borderColorLeft" and "borderColorDiagonal" properties.
color	Hexadecimal color value: "FF0000", "000000"...
font	Font family: "Arial", "Calibri"...
fontSize	Font size in points.
italic	If true displays the content in italics.
strikethrough	If true displays text in strikethrough.
underline	Underlines text: single, double.

Code samples

Example #1

{
    "actions": [
        {
            "action": "createTableStyle",
            "data": {
                "name": "MyTableStyle1",
                "styles": {
                    "wholeTable": {
                        "bold": true,
                        "fontSize": 14,
                        "italic": true,
                        "backgroundColor": "FFFF00"
                    }
                }
            }
        },
        {
            "action": "addTable",
            "data": {
                "contents": [
                    [10],
                    [20],
                    [55],
                    [32]
                ],
                "position": "B3",
                "tableStyles": {
                    "tableStyle": "MyTableStyle1"
                },
                "options": {
                    "columnNames": [
                        {
                            "text": "Values",
                            "bold": true
                        }
                    ]
                }
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.