JSON API - addFooter

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

addFooter

PREMIUM

TRIAL / ADVANCED

Adds a footer into the Excel spreadsheet.

Note

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

JSON data

{
    "contents": {
        "left": {
            "text": "string",
            "bold": boolean,
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string",
            "image": {
                "src": "string",
                "width": number,
                "height": number,
                "alt": "string",
                "brightness": "string,
                "color": "string",
                "contrast": "string",
                "title": "string"
            }
        } | array,
        "center": {
            "text": "string",
            "bold": boolean,
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string",
            "image": {
                "src": "string",
                "width": number,
                "height": number,
                "alt": "string",
                "brightness": "string,
                "color": "string",
                "contrast": "string",
                "title": "string"
            }
        } | array,
        "right": {
            "text": "string",
            "bold": boolean,
            "color": "string",
            "font": "string",
            "fontSize": number,
            "italic": boolean,
            "strikethrough": boolean,
            "underline": "string",
            "image": {
                "src": "string",
                "width": number,
                "height": number,
                "alt": "string",
                "brightness": "string,
                "color": "string",
                "contrast": "string",
                "title": "string"
            }
        } | array
    },
    "target": "string",
    "options: {
        "replace": boolean
    }
}

Key	Description
text	The content to be inserted. Available special elements: &[Page], &[Pages], &[Date], &[Time], &[Tab], &[File], &[Path].
bold	If true the content will be shown in bold characters.
color	Hexadecimal color value: "FF0000", "000000"...
font	Font family: "Arial", "Calibri"...
fontSize	Font size in points.
italic	If true displays the content in italics.
strikethrough	If true displays text in strikethrough.
subscript	If true displays text in subscript.
superscript	If true displays text in superscript.
underline	Underlines text: "single", "double".
image	"src": image path, Base64 string, or URL. "width": pt size. "height": pt size. "alt": alt text. "brightness" "color": automatic (default), grayscale, blackAndWhite, washout. "contrast" "title": "image" as default
target	first, default, even.
replace	If true replaces the existing footer if it exists. Default as true.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "Lorem ipsum dolor sit amet"
                },
                "position": "A1"
            }
        },
        {
            "action": "addFooter",
            "data": {
                "contents": {
                    "center": {
                        "text": "Footer content"
                    }
                }
            }
        },
        {
            "action": "setSheetSettings",
            "data": {
                "view": "pageLayout"
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "Lorem ipsum dolor sit amet"
                },
                "position": "A1"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "J1 content"
                },
                "position": "J1"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "S1 content"
                },
                "position": "S1"
            }
        },
        {
            "action": "addFooter",
            "data": {
                "contents": {
                    "center": {
                        "text": " "
                    }
                },
                "target": "first"
            }
        },
        {
            "action": "addFooter",
            "data": {
                "contents": {
                    "left": {
                        "text": "Date and time: &[Date] &[Time]"
                    },
                    "center": {
                        "text": "Default footer"
                    },
                    "right": {
                        "text": "&[Page] of &[Pages]"
                    }
                }
            }
        },
        {
            "action": "addFooter",
            "data": {
                "contents": {
                    "left": {
                        "text": "Date and time: &[Date] &[Time]"
                    },
                    "right": {
                        "text": "&[Page] of &[Pages]"
                    }
                },
                "target": "even"
            }
        },
        {
            "action": "setSheetSettings",
            "data": {
                "view": "pageLayout"
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.