JSON API - addHeading

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addHeading

PREMIUM

TRIAL / ADVANCED

Inserts a heading.

Note

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

JSON data

{
    "text": "string",
    "level": number,
    "options": {
        /* check addText styles */
    }
}

Styles from addText can be used.

Key	Description
text	Text content.
level	Heading level. If not set up explicitely it takes the default value of 1.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addHeading",
            "data": {
                "text": "First level title",
                "level": 0
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
            }
        },
        {
            "action": "addHeading",
            "data": {
                "text": "Second level title",
                "level": 1
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
            }
        },
        {
            "action": "addHeading",
            "data": {
                "text": "Third level title with additional custom formatting",
                "level": 2,
                "options": {
                    "fontSize": 13,
                    "color": "FF0000",
                    "textAlign": "center"
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.