JSON API - addTable

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

addTable

PREMIUM

TRIAL / ADVANCED

Adds tables into the Excel spreadsheet.

Note

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

JSON data

{
    "contents": array, /* check addCell contents and cellStyles */
    "position": "string",
    "tableStyles": {
        "bandedColumn": boolean,
        "bandedRow": boolean,
        "firstColumn": boolean,
        "headerRow": boolean,
        "lastColumn": boolean,
        "tableStyle": "string",
        "totalRow": boolean
    },
    "options": {
        "columnNames": array,
        "columnTotals": {
            "cellStyles": array, /* check addCell contents and cellStyles */
            "contentStyles": array, /* check addCell contents and cellStyles */
            "type": "string",
            "value": "string"
        },
        "description": "string",
        "filters": {
            "custom": {
                "andMode": boolean,
                "operator": "string",
                "value": "string"
            },
            "values": array
        },
        "tableName": "string",
        "title": "string"
    }
}

Contents, and cellStyles from addCell can be used.

Key	Description
contents	An array with the contents and styles to be added. Check addCell to see all available options.
position	Cell position in the active sheet: "A1", "C3", "AB7"...
bandedColumn	Banded column option. Default as false.
bandedRow	Banded row option. Default as true.
firstColumn	First column option. Default as false.
headerRow	Header row option. Default as false.
lastColumn	Last column option. Default as false.
tableStyle	Table style name. MS Excel includes built-in table style names: TableStyleMedium2, TableStyleLight3...
totalRow	Total row option. Default as false.
columnNames	Custom column names. If not set, "Column " is used to generate names.
columnTotals	"cellStyles": check addCell to see all available options. "contentStyles": check addCell to see all available options. "type": "formula", "function", "label". "value": "formula", "function" (average, count, countNums, max, min, stdDev, sum, var), "label". To be used with the previous "type" option.
description	Alternative text description.
filters	custom: "andMode": if true, enable 'and' option. Default as false. "operator": equal, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, notEqual. "value": ? (any single character), * (any series of characters). values
tableName	Custom table name. If not set a new table name is generated automatically.
title	Alternative text title.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addTable",
            "data": {
                "contents": [
                    [10],
                    [20],
                    [55],
                    [32]
                ],
                "position": "B3",
                "options": {
                    "columnNames": [
                        {
                            "text": "Values",
                            "bold": true
                        }
                    ]
                }
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "addTable",
            "data": {
                "contents": [
                    [
                        {
                            "text": "10",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        },
                        {
                            "text": "50",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        },
                        {
                            "text": "20",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        }
                    ],
                    [
                        {
                            "text": "20",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        },
                        {
                            "text": "25.5",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        },
                        {
                            "text": "31",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        }
                    ],
                    [
                        {
                            "text": "55",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        },
                        {
                            "text": "12",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        },
                        {
                            "text": "22",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        }
                    ],
                    [
                        {
                            "text": "32",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        },
                        {
                            "text": "36",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        },
                        {
                            "text": "10",
                            "cellStyles": {
                                "type": "general",
                                "backgroundColor": "D9E1F2"
                            }
                        }
                    ]
                ],
                "position": "B3",
                "options": {
                    "columnNames": [
                        {
                            "text": "Values 1",
                            "bold": true,
                            "color": "FFFFFF",
                            "cellStyles": {
                                "backgroundColor": "4472C4"
                            }
                        },
                        {
                            "text": "Values 2",
                            "bold": true,
                            "color": "FFFFFF",
                            "cellStyles": {
                                "backgroundColor": "4472C4"
                            }
                        },
                        {
                            "text": "Values 3",
                            "bold": true,
                            "color": "FFFFFF",
                            "cellStyles": {
                                "backgroundColor": "4472C4"
                            }
                        }
                    ]
                }
            }
        },
        {
            "action": "addTable",
            "data": {
                "contents": [
                    [10, 50],
                    [20, 25.5],
                    [55, 12],
                    [32, 36]
                ],
                "position": "G3",
                "tableStyles": {
                    "tableStyle": "TableStyleMedium2"
                },
                "options": {
                    "columnNames": [
                        {
                            "text": "Values"
                        },
                        {
                            "text": "Values"
                        }
                    ]
                }
            }
        }
    ]
}

Example #3

{
    "actions": [
        {
            "action": "addTable",
            "data": {
                "contents": [
                    [10],
                    [20],
                    [55],
                    [32]
                ],
                "position": "B3",
                "tableStyles": {
                    "totalRow": true
                },
                "options": {
                    "columnNames": [
                        {
                            "text": "Values",
                            "bold": false
                        }
                    ],
                    "columnTotals": [
                        {
                            "type": "function",
                            "value": "sum",
                            "contentStyles": {
                                "bold": true
                            },
                            "cellStyles": {
                                "backgroundColor": "FFFF00"
                            }
                        }
                    ]
                }
            }
        },
        {
            "action": "addTable",
            "data": {
                "contents": [
                    [10],
                    [20],
                    [55],
                    [32]
                ],
                "position": "E3",
                "tableStyles": {
                    "totalRow": true
                },
                "options": {
                    "columnNames": [
                        {
                            "text": "Values",
                            "bold": false
                        }
                    ],
                    "columnTotals": [
                        {
                            "type": "function",
                            "value": "count",
                            "contentStyles": {
                                "bold": true
                            },
                            "cellStyles": {
                                "backgroundColor": "FFFF00"
                            }
                        }
                    ]
                }
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.