JSON API - addNotes

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

addNotes

PREMIUM

TRIAL / ADVANCED

Inserts notes into the PowerPoint presentation.

Note

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

JSON data

{
    "content": "string" | object | array,
    "paragraphStyles": object,
    "options": {
        "insertMode": "string"
    }
}

Key	Description
content	See addText.
paragraphStyles	See addText for paragraph styles.
insertMode	Insert mode if the position contains existing notes: append replace Default as append.

Key

Description

content

See addText.

paragraphStyles

See addText for paragraph styles.

insertMode

Insert mode if the position contains existing notes:

append
replace

Default as append.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addNotes",
            "data": {
                "content": "A new note."
            }
        },
        {
            "action": "addNotes",
            "data": {
                "content": "A new note 2."
            }
        },
        {
            "action": "addSlide"
        },
        {
            "action": "addSlide"
        },
        {
            "action": "setActiveSlide",
            "data": {
                "position": 2
            }
        },
        {
            "action": "addNotes",
            "data": {
                "content": [
                    {
                        "text": "A note",
                        "italic": true
                    },
                    {
                        "text": " with ",
                        "bold": true,
                        "font": "Times New Roman"
                    },
                    {
                        "text": "styles.",
                        "italic": true,
                        "underline": true
                    }
                ],
                "paragraphStyles": {
                    "align": "center"
                }
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.