JSON API - addList

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

addList

PREMIUM

TRIAL / ADVANCED

Inserts a list into the PowerPoint presentation.

Note

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

JSON data

{
    "contents": [
        "string" | {
            "bold": boolean,
            "characterSpacing": number,
            "color": "string",
            "font": "string",
            "fontSize": number,
            "highlight": "string",
            "italic": boolean,
            "lang": "string",
            "strikethrough": boolean,
            "text": "string",
            "underline": "string"
        }
    ],
    "position": {
        "placeholder": {
            "name": "string",
            "descr": "string",
            "position": number,
            "type": "string"
        },
        "new": {
            "coordinateX": number,
            "coordinateY": number,
            "sizeX": number,
            "sizeY": number,
            "name": "string",
            "order": number,
            "textBoxStyles": {
                /* check addTextBox styles */
            }
        }
    },
    "listStyles": {
        "color": "string",
        "indent": number,
        "marginLeft": number,
        "marginRight": number,
        "size": number,
        "startAt": number,
        "type": "string"
    }
    "options": {
        "insertMode": "string"
    }
}

Key	Description
contents	Array of text contents and styles. PptxFragments can be used to add contents.
bold
characterSpacing
color	HEX color.
font	Font family.
fontSize	8, 9, 10, 11...
highlight	HEX color.
italic
lang	Language.
strikethrough
text	Text content.
underline	Underline: single.
placeholder	The content is added in a placeholder of the layout. One of the following options can be used to get the text box. "name" name. "descr" alt text (descr) value. "position" position by order. 0 is the first order position. "type" title (Title), body (Body), ctrTitle (Centered Title), subTitle (Subtitle).
new	A new position is generated. "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. "textBoxStyles" See addTextBox for text box styles.
indent	EMUs (English Metric Unit) default as -250000.
marginLeft	EMUs (English Metric Unit) (0 >= and <= 51206400)
marginRight	EMUs (English Metric Unit) (0 >= and <= 51206400)
size	% of text.
startAt	Start at value.
type	"filledRoundBullet" "hollowRoundBullet" "filledSquareBullet" "hollowSquareBullet" "starBullet" "arrowBullet" "checkmarkBullet" "decimal" "romanUpperCase" "romanLowerCase" "alphaUpperCase" "alphaLowerCase" "alphaLcParenBoth" "alphaUcParenBoth" "alphaLcParenR" "alphaUcParenR" "alphaLcPeriod" "alphaUcPeriod" "arabicParenBoth" "arabicParenR" "arabicPeriod" "arabicPlain" "romanLcParenBoth" "romanUcParenBoth" "romanLcParenR" "romanUcParenR" "romanLcPeriod" "romanUcPeriod" "circleNumDbPlain" "circleNumWdBlackPlain" "circleNumWdWhitePlain" "arabicDbPeriod" "arabicDbPlain" "ea1ChsPeriod" "ea1ChsPlain" "ea1ChtPlain" "ea1JpnChsDbPeriod" "ea1JpnKorPlain" "ea1JpnKorPeriod" "arabic1Minus" "arabic2Minus" "hebrew2Minus" "thaiAlphaPeriod" "thaiAlphaParenR" "thaiAlphaParenBoth" "thaiNumPeriod" "thaiNumParenR" "thaiNumParenBoth" "hindiAlphaPeriod" "hindiNumPeriod" "hindiNumParenR" "hindiAlpha1Period"
insertMode	Insert mode if the position contains an existing content: append replace Default as append.

Code samples

Example #1

{
    "settings": {
        "layout": "Two Content"
    },
    "actions": [
        {
            "action": "addList",
            "data": {
                "contents": ["Item 1", "Item 2", "Item 3"],
                "position": {
                    "placeholder": {
                        "name": "Content Placeholder 2"
                    }
                }
            }
        },
        {
            "action": "addList",
            "data": {
                "contents": [
                    "Item A",
                    [
                        "Item A.1",
                        "Item A.2",
                        [
                            "Item A.2.sub1",
                            "Item A.2.sub2"
                        ],
                        "Item A.3"
                    ],
                    "Item B",
                    "Item C"
                ],
                "position": {
                    "placeholder": {
                        "name": "Content Placeholder 3"
                    }
                }
            }
        }
    ]
}

Example #2

{
    "settings": {
        "layout": "Two Content"
    },
    "actions": [
        {
            "action": "addList",
            "data": {
                "contents": [
                    {
                        "text": "Item 1",
                        "bold": true
                    },
                    {
                        "text": "Item 2",
                        "bold": true,
                        "italic": true,
                        "underline": "single"
                    },
                    {
                        "text": "Item 3",
                        "fontSize": 16
                    }
                ],
                "position": {
                    "placeholder": {
                        "name": "Content Placeholder 2"
                    }
                }
            }
        },
        {
            "action": "addList",
            "data": {
                "contents": [
                    "Item A",
                    [
                        "Item A.1",
                        "Item A.2",
                        [
                            "Item A.2.sub1",
                            "Item A.2.sub2"
                        ],
                        "Item A.3"
                    ],
                    "Item B",
                    "Item C"
                ],
                "position": {
                    "placeholder": {
                        "name": "Content Placeholder 3"
                    }
                },
                "listStyles": [
                    {
                        "type": "decimal"
                    },
                    {},
                    {
                        "type": "romanLowerCase",
                        "startAt": 3,
                        "color": "FF0000",
                        "marginLeft": 1800000,
                        "indent": -400000,
                        "size": 110
                    }
                ]
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.