JSON API - addTableFigures

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addTableFigures

PREMIUM

TRIAL / ADVANCED

Inserts a Table of Figures.

Note

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

JSON data

{
    "options": {
        "autoUpdate": boolean,
        "scope": "string"
    },
    "legend": {
        /* check addText styles */
    }
}

Styles from addText can be used.

Key	Description
autoUpdate	If true it will try to update the TOC when first opened.
scope	Contents to display: table (default), figure and other custom values based on the content style ID.
legend	Defines the legend text and its style.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": "Table of Figures",
                "optionsParagraph": {
                    "bold": true,
                    "fontSize": 14
                }
            }
        },
        {
            "action": "addTableFigures",
            "data": {
                "options": {
                    "autoUpdate": true,
                    "scope": "Figure"
                },
                "legend": {
                    "text": "Click here to update the table of figures",
                    "color": "B70000",
                    "bold": true,
                    "fontSize": 12
                }
            }
        },
        {
            "action": "addImage",
            "data": {
                "src": "image.png",
                "imageAlign": "center",
                "scaling": 50,
                "spacingTop": 10,
                "spacingBottom": 0,
                "spacingLeft": 0,
                "spacingRight": 20,
                "textWrap": 0,
                "borderStyle": "lgDash",
                "borderWidth": 6,
                "borderColor": "FF0000",
                "caption": {
                    "showLabel": true,
                    "text": " Sample Image 1",
                    "styleName": "Figure",
                    "keepNext": true,
                    "position": "above"
                }
            }
        },
        {
            "action": "addImage",
            "data": {
                "src": "image.png",
                "imageAlign": "center",
                "scaling": 50,
                "spacingTop": 10,
                "spacingBottom": 0,
                "spacingLeft": 0,
                "spacingRight": 20,
                "textWrap": 0,
                "borderStyle": "lgDash",
                "borderWidth": 6,
                "borderColor": "FF0000",
                "caption": {
                    "showLabel": true,
                    "text": " Sample Image 2",
                    "styleName": "Figure"
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.