JSON API - addText

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

addText

PREMIUM

TRIAL / ADVANCED

Inserts a text into the PowerPoint presentation.

Note

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

JSON data

{
    "contents": {
        "text": "string",
        "bold": boolean,
        "characterSpacing": number,
        "color": "string",
        "font": "string",
        "fontSize": number,
        "highlight": "string",
        "hyperlink": "string",
        "italic": boolean,
        "lang": "string",
        "strikethrough": boolean,
        "transparency": number,
        "underline": "string"
    } | array,
    "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 */
            }
        }
    },
    "paragraphStyles": {
        "align": "string",
        "indentation": number,
        "lineSpacing": number,
        "listLevel": number,
        "listStyles": array,
        "marginLeft": number,
        "marginRight": number,
        "noBullet": boolean,
        "parseLineBreaks": boolean,
        "spacingAfter": number,
        "spacingBefore": number
    },
    "options": {
        "insertMode": "string"
    }
}

Key	Description
text	Text content.
bold
characterSpacing
color	HEX color.
font	Font family.
fontSize	8, 9, 10, 11...
highlight	HEX color.
hyperlink	Hyperlink. External, bookmark (#firstslide, #lastslide, #nextslide, #previousslide) or slide (#slide with position).
italic
lang	Language.
strikethrough
transparency	0 to 100.
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.
align	left, center, right, justify, distributed.
indentation	EMUs (English Metric Unit)
lineSpacing	1, 1.5, 2...
listLevel	0, 1, 2...
listStyles	view addList
marginLeft	EMUs (English Metric Unit) (0 >= and <= 51206400)
marginRight	EMUs (English Metric Unit) (0 >= and <= 51206400)
noBullet	No bullet added. Default as true
parseLineBreaks	If true parses the line breaks. Default as false
spacingAfter	points (0 >= and <= 158400)
spacingBefore	points (0 >= and <= 158400)
insertMode	Insert mode if the position contains an existing content: append replace Default as append.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addText",
            "data": {
                "contents": {
                    "text": "My title"
                },
                "position": {
                    "placeholder": {
                        "name": "Title 1"
                    }
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "contents": {
                    "text": "My subtitle",
                    "bold": true,
                    "underline": "single"
                },
                "position": {
                    "placeholder": {
                        "name": "Subtitle 2"
                    }
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "contents": [
                    {
                        "text": "At vero",
                        "highlight": "628A54"
                    },
                    {
                        "text": " eos et ",
                        "bold": true,
                        "italic": true,
                        "font": "Times New Roman"
                    },
                    {
                        "text": "accusamus et iusto.",
                        "strikethrough": true,
                        "color": "628A54",
                        "italic": true
                    }
                ],
                "position": {
                    "placeholder": {
                        "name": "Subtitle 2"
                    }
                }
            }
        },
        {
            "action": "addSlide",
            "data": {
                "layout": "Title and Content",
                "active": true
            }
        },
        {
            "action": "addText",
            "data": {
                "contents": {
                    "text": "My custom title",
                    "bold": true,
                    "font": "Arial",
                    "fontSize": 60
                },
                "position": {
                    "placeholder": {
                        "name": "Title 1"
                    }
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "contents": {
                    "text": "My new \ntitle"
                },
                "position": {
                    "placeholder": {
                        "name": "Title 1"
                    }
                },
                "paragraphStyles": {
                    "align": "center",
                    "parseLineBreaks": true
                },
                "options": {
                    "insertMode": "replace"
                }
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.