JSON API - addComment

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

addComment

PREMIUM

TRIAL / ADVANCED

Adds comments into the Excel spreadsheet.

Note

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

JSON data

{
    "contents": {
        "text": "string",
        "bold": boolean,
        "color": "string",
        "font": "string",
        "fontSize": number,
        "italic": boolean,
        "strikethrough": boolean,
        "subscript": boolean,
        "superscript": boolean,
        "underline": "string"
    } | array,
    "position": "string",
    "options": {
        "author": "string"
        "replace": boolean
    }
}

Key	Description
text	The content to be inserted.
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".
position	Cell position in the active sheet: "A1", "C3", "AB7"...
author	Author name.
replace	If true replaces existing comment in the same position. Default as true.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "Cell B2"
                },
                "position": "B2"
            }
        },
        {
            "action": "addComment",
            "data": {
                "contents": {
                    "text": "New comment"
                },
                "position": "B2"
            }
        },
        {
            "action": "addCommentAuthor",
            "data": {
                "author": "myauthor"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "Cell D2"
                },
                "position": "D2"
            }
        },
        {
            "action": "addComment",
            "data": {
                "contents": {
                    "text": "My comment"
                },
                "position": "D2",
                "options": {
                    "author": "myauthor"
                }
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "Cell E6"
                },
                "position": "E6"
            }
        },
        {
            "action": "addComment",
            "data": {
                "contents": {
                    "text": "Comment with styles",
                    "bold": true,
                    "italic": true,
                    "underline": "single"
                },
                "position": "E6",
                "options": {
                    "author": "phpxlsx"
                }
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "Cell G3"
                },
                "position": "G3"
            }
        },
        {
            "action": "addComment",
            "data": {
                "contents": [
                    {
                         "text": "Another comment",
                         "bold": true,
                         "font": "Arial",
                         "fontSize": 16
                    },
                    {
                        "text": " with",
                        "italic": true
                    },
                    {
                        "text": " multiple styles",
                        "underline": "single"
                    }
                ],
                "position": "G3",
                "options": {
                    "author": "phpxlsx"
                }
            }
        },
        {
            "action": "addSheet",
            "data": {
                "removeSelected": true,
                "selected": true,
                "active": true
            }
        },
        {
            "action": "addComment",
            "data": {
                "contents": {
                    "text": "Comment in Sheet2."
                },
                "position": "B2"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "Lorem ipsum dolor sit amet"
                },
                "position": "A1"
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.