JSON API - addFooterSlide

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

addFooterSlide

PREMIUM

TRIAL / ADVANCED

Inserts footers into the PowerPoint presentation.

Note

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

JSON data

{
    "type": "string",
    "options": {
        "applyToAll": boolean,
        "contentStyles": object,
        "dateAndTime": "string",
        "dateAndTimeLanguage": "string",
        "dateAndTimeType": "string",
        "hideOn": "string",
        "textContents": "string"
    }
}

Key	Description
type	Valid footer types: dateAndTime slideNumber textContents
applyToAll	If true apply to all slides. Default as false.
contentStyles	Use with dateAndTime and slideNumber types. Using the textContents type, the PptxFragment must include the styles to be applied.
dateAndTime	Set a fixed date and time. If not set, update automatically.
dateAndTimeLanguage	en-US, es-ES...
dateAndTimeType	datetime datetimeFigureOut datetime1 datetime2 datetime3 datetime4 datetime5 datetime6 datetime7 datetime8 datetime9 datetime10 datetime11 datetime12 datetime13 Available when not using a fixed date and time.
hideOn	If set, hide the footer on the slides that use the layout. Example: Title Slide.
textContents	Add a text content. Default as empty pararagraph.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addText",
            "data": {
                "contents": {
                    "text": "My title"
                },
                "position": {
                    "placeholder": {
                        "name": "Title 1"
                    }
                }
            }
        },
        {
            "action": "addFooterSlide",
            "data": {
                "type": "dateAndTime"
            }
        },
        {
            "action": "addSlide",
            "data": {
                "active": true
            }
        },
        {
            "action": "addFooterSlide",
            "data": {
                "type": "dateAndTime",
                "options": {
                    "dateAndTimeType": "datetime8"
                }
            }
        },
        {
            "action": "addSlide",
            "data": {
                "active": true
            }
        },
        {
            "action": "addFooterSlide",
            "data": {
                "type": "dateAndTime",
                "options": {
                    "dateAndTime": "2023/12/02"
                }
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.