JSON API - addTable

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

addTable

PREMIUM

TRIAL / ADVANCED

Adds tables into the PowerPoint presentation.

Note

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

JSON data

{
    "contents": [
        [
            "string" | object | {
                "text": "string" | object,
                "align": "string",
                "backgroundColor": "string",
                "border": [
                    {
                        "dash": "string",
                        "color": "string",
                        "width": number
                    },
                    "top": {
                        "dash": "string",
                        "color": "string",
                        "width": number
                    },
                    "right": {
                        "dash": "string",
                        "color": "string",
                        "width": number
                    },
                    "bottom": {
                        "dash": "string",
                        "color": "string",
                        "width": number
                    },
                    "left": {
                        "dash": "string",
                        "color": "string",
                        "width": number
                    }
                ],
                "cellMargin": {
                    "top": number,
                    "right": number,
                    "bottom": number,
                    "left": number
                },
                "colspan": number,
                "image": "string",
                "rowspan": number,
                "textDirection": "string",
                "verticalAlign": "string",
                "wrap": "string"
            },
        ]
    ]
    "position": {
        "coordinateX": number,
        "coordinateY": number,
        "sizeX": number,
        "sizeY": number,
        "name": "string",
        "order": number
    },
    "tableStyles": {
        "backgroundColor": "string",
        "bandedColumns": boolean,
        "bandedRows": boolean,
        "border": {
            "dash": "string",
            "color": "string",
            "width": number
        },
        "cellMargin": {
            "top": number,
            "right": number,
            "bottom": number,
            "left": number
        },
        "columnWidths": number | array,
        "descr": "string",
        "firstColumn": boolean,
        "headerRow": boolean,
        "lastColumn": boolean,
        "rtl": boolean,
        "style": "string",
        "totalRow": boolean
    },
    "rowStyles": [
        {
            "height": number
        }
    ],
    "options": {}
}

Key	Description
contents	Array of cell contents and styles. PptxFragments can be used to add contents
text	See addText for text styles.
align	left, center, right, justify
backgroundColor	HEX color
border	"dash" solid, dot, dash, lgDash, dashDot, lgDashDot, lgDashDotDot, sysDash, sysDot, sysDashDot, sysDashDotDot. "color" default as 000000. none to avoid adding the color. "width" EMUs (English Metric Unit). Default as 12700 (1pt).
cellMargin	"top" "right" "bottom" "left"
colspan	HEX color.
image	Image path, Base64, or URL.
rowspan
textDirection	horz, vert, vert270, wordArtVert, eaVert, mongolianVert, wordArtVertRtl.
verticalAlign	top, middle, bottom, topCentered, middleCentered, bottomCentered.
wrap	square, none.
coordinateX	EMUs (English Metric Unit).
coordinateY	EMUs (English Metric Unit).
sizeX	EMUs (English Metric Unit).
sizeY	EMUs (English Metric Unit).
name	Internal name. If not set, a random name is generated.
order	Set the display order. Default after existing contents. 0 is the first order position. If the order position doesn't exist add after existing contents.
backgroundColor	HEX color.
bandedColumns	Banded columns. Default as false.
bandedRows	Banded rows. Default as false.
border	"dash" solid, dot, dash, lgDash, dashDot, lgDashDot, lgDashDotDot, sysDash, sysDot, sysDashDot, sysDashDotDot. "color" default as 000000. none to avoid adding the color. "width" EMUs (English Metric Unit). Default as 12700 (1pt).
cellMargin	"top" "right" "bottom" "left"
columnWidths	Column width fix (number) or column width variable (array). If not set, get from the shape size. EMUs (English Metric Unit).
descr	Placeholder alt text (descr) value.
firstColumn	First column. Default as false.
headerRow	Header row. Default as false.
lastColumn	Last column. Default as false.
rtl	RTL. Default as false.
style	Table style name. Using a template, if the table doesn't exist, try to import it from the default base template. Table styles available in the default base template: Dark Style 1 Dark Style 1 - Accent 1 Dark Style 1 - Accent 2 Dark Style 1 - Accent 3 Dark Style 1 - Accent 4 Dark Style 1 - Accent 5 Dark Style 1 - Accent 6 Dark Style 2 Dark Style 2 - Accent 1/Accent 2 Dark Style 2 - Accent 3/Accent 4 Dark Style 2 - Accent 5/Accent 6 Light Style 1 Light Style 1 - Accent 1 Light Style 1 - Accent 2 Light Style 1 - Accent 3 Light Style 1 - Accent 4 Light Style 1 - Accent 5 Light Style 1 - Accent 6 Light Style 2 Light Style 2 - Accent 1 Light Style 2 - Accent 2 Light Style 2 - Accent 3 Light Style 2 - Accent 4 Light Style 2 - Accent 5 Light Style 2 - Accent 6 Light Style 3 Light Style 3 - Accent 1 Light Style 3 - Accent 2 Light Style 3 - Accent 3 Light Style 3 - Accent 4 Light Style 3 - Accent 5 Light Style 3 - Accent 6 Medium Style 1 Medium Style 1 - Accent 1 Medium Style 1 - Accent 2 Medium Style 1 - Accent 3 Medium Style 1 - Accent 4 Medium Style 1 - Accent 5 Medium Style 1 - Accent 6 Medium Style 2 Medium Style 2 - Accent 1 Medium Style 2 - Accent 2 Medium Style 2 - Accent 3 Medium Style 2 - Accent 4 Medium Style 2 - Accent 5 Medium Style 2 - Accent 6 Medium Style 3 Medium Style 3 - Accent 1 Medium Style 3 - Accent 2 Medium Style 3 - Accent 3 Medium Style 3 - Accent 4 Medium Style 3 - Accent 5 Medium Style 3 - Accent 6 Medium Style 4 Medium Style 4 - Accent 1 Medium Style 4 - Accent 2 Medium Style 4 - Accent 3 Medium Style 4 - Accent 4 Medium Style 4 - Accent 5 Medium Style 4 - Accent 6 No Style, No Grid No Style, Table Grid Themed Style 1 - Accent 1 Themed Style 1 - Accent 2 Themed Style 1 - Accent 3 Themed Style 1 - Accent 4 Themed Style 1 - Accent 5 Themed Style 1 - Accent 6 Themed Style 2 - Accent 1 Themed Style 2 - Accent 2 Themed Style 2 - Accent 3 Themed Style 2 - Accent 4 Themed Style 2 - Accent 5 Themed Style 2 - Accent 6
totalRow	Total row. Default as false.
height	EMUs (English Metric Unit).

Code samples

Example #1

{
    "settings": {
        "layout": "Blank"
    },
    "actions": [
        {
            "action": "addTable",
            "data": {
                "contents": [
                    ["Cell 1.1", "Cell 1.2", "Cell 1.3", "Cell 1.4"],
                    ["Cell 2.1", "Cell 2.2", "Cell 2.3", "Cell 2.4"],
                    ["Cell 3.1", "Cell 3.2", "Cell 3.3", "Cell 3.4"]
                ],
                "position": {
                    "coordinateX": 850000,
                    "coordinateY": 1800000,
                    "sizeX": 10500000,
                    "sizeY": 750000
                }
            }
        },
        {
            "action": "addSlide",
            "data": {
                "active": true
            }
        },
        {
            "action": "addTable",
            "data": {
                "contents": [
                    ["Cell 1.1", "Cell 1.2", "Cell 1.3", "Cell 1.4"],
                    ["Cell 2.1", "Cell 2.2", "Cell 2.3", "Cell 2.4"],
                    ["Cell 3.1", "Cell 3.2", "Cell 3.3", "Cell 3.4"]
                ],
                "position": {
                    "coordinateX": 850000,
                    "coordinateY": 1800000,
                    "sizeX": 10500000,
                    "sizeY": 750000
                },
                "tableStyles": {
                    "columnWidths": 2625000
                },
                "rowStyles": [
                    {
                        "height": 650000
                    },
                    {},
                    {
                        "height": 450000
                    }
                ]
            }
        },
        {
            "action": "addSlide",
            "data": {
                "active": true
            }
        },
        {
            "action": "addTable",
            "data": {
                "contents": [
                    ["Cell 1.1 and more content", "Cell 1.2", "Cell 1.3", "Cell 1.4"],
                    ["Cell 2.1", "Cell 2.2", "Cell 2.3", "Cell 2.4"],
                    ["Cell 3.1", "Cell 3.2", "Cell 3.3", "Cell 3.4"]
                ],
                "position": {
                    "coordinateX": 850000,
                    "coordinateY": 1800000,
                    "sizeX": 10500000,
                    "sizeY": 750000
                },
                "tableStyles": {
                    "columnWidths": [1000000, 3000000, 3000000]
                }
            }
        }
    ]
}

Example #2

{
    "settings": {
        "layout": "Blank"
    },
    "actions": [
        {
            "action": "addTable",
            "data": {
                "contents": [
                    ["Header A", "Header B", "Header C", "Header D"],
                    ["Cell 2.1", "Cell 2.2", "Cell 2.3", "Cell 2.4"],
                    ["Cell 3.1", "Cell 3.2", "Cell 3.3", "Cell 3.4"],
                    ["Cell 4.1", "Cell 4.2", "Cell 4.3", "Cell 4.4"],
                    ["Total A", "Total B", "Total C", "Total D"]
                ],
                "position": {
                    "coordinateX": 850000,
                    "coordinateY": 1800000,
                    "sizeX": 10500000,
                    "sizeY": 750000
                },
                "tableStyles": {
                    "bandedRows": true,
                    "headerRow": true,
                    "style": "Medium Style 2 - Accent 1",
                    "totalRow": true
                }
            }
        },
        {
            "action": "addSlide",
            "data": {
                "active": true
            }
        },
        {
            "action": "addTable",
            "data": {
                "contents": [
                    ["Header A", "Header B", "Header C", "Header D"],
                    ["Cell 2.1", "Cell 2.2", "Cell 2.3", "Cell 2.4"],
                    ["Cell 3.1", "Cell 3.2", "Cell 3.3", "Cell 3.4"],
                    ["Cell 4.1", "Cell 4.2", "Cell 4.3", "Cell 4.4"],
                    ["Total A", "Total B", "Total C", "Total D"]
                ],
                "position": {
                    "coordinateX": 850000,
                    "coordinateY": 1800000,
                    "sizeX": 10500000,
                    "sizeY": 750000
                },
                "tableStyles": {
                    "bandedRows": true,
                    "headerRow": true,
                    "totalRow": true,
                    "style": "Dark Style 1 - Accent 6"
                }
            }
        },
        {
            "action": "addSlide",
            "data": {
                "active": true
            }
        },
        {
            "action": "addTable",
            "data": {
                "contents": [
                    [
                        {
                            "text": "Title A",
                            "backgroundColor": "000000",
                            "color": "FFFFFF",
                            "border": {
                                "color": "none"
                            },
                            "cellMargin": {
                                "top": 90000,
                                "left": 200000
                            }
                        },
                        {
                            "text": "Title B",
                            "backgroundColor": "000000",
                            "color": "FFFFFF",
                            "border": {
                                "color": "none"
                            },
                            "cellMargin": {
                                "top": 90000,
                                "left": 200000
                            }
                        },
                        {
                            "text": "Title C",
                            "backgroundColor": "000000",
                            "color": "FFFFFF",
                            "border": {
                                "color": "none"
                            },
                            "cellMargin": {
                                "top": 90000,
                                "left": 200000
                            }
                        },
                        {
                            "text": "Title D",
                            "backgroundColor": "000000",
                            "color": "FFFFFF",
                            "border": {
                                "color": "none"
                            },
                            "cellMargin": {
                                "top": 90000,
                                "left": 200000
                            }
                        }
                    ],
                    [
                        "Cell 2.1",
                        "Cell 2.2",
                        "Cell 2.3",
                        {
                            "text": "Cell 2.4",
                            "border": {
                                "bottom": {
                                    "dash": "sysDot",
                                    "color": "0000FF",
                                    "width": 50000
                                }
                            }
                        }
                    ],
                    [
                        "Cell 3.1",
                        "Cell 3.2",
                        {
                            "text": "Cell 3.3",
                            "border": {
                                "right": {
                                    "dash": "sysDot",
                                    "color": "0000FF",
                                    "width": 50000
                                },
                                "bottom": {
                                    "dash": "sysDot",
                                    "color": "0000FF",
                                    "width": 50000
                                }
                            }
                        },
                        {
                            "text": "Cell 3.4",
                            "bold": true,
                            "border": {
                                "dash": "sysDot",
                                "color": "0000FF",
                                "width": 50000
                            }
                        }
                    ]
                ],
                "position": {
                    "coordinateX": 850000,
                    "coordinateY": 1800000,
                    "sizeX": 10500000,
                    "sizeY": 750000
                },
                "tableStyles": {
                    "backgroundColor": "7FAAF0",
                    "border": {
                        "dash": "sysDash",
                        "color": "224887",
                        "width": 50000
                    }
                }
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.