JSON API - addTextBox

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

addTextBox

PREMIUM

TRIAL / ADVANCED

Inserts a text box into the Excel spreadsheet.

Note

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

JSON data

{
    "contents": {
        "text": "string",
        "bold": boolean,
        "color": "string",
        "font": "string",
        "fontSize": number,
        "highlight": "string",
        "italic": boolean,
        "strikethrough": boolean,
        "transparency": number,
        "underline": "string"
    } | array,
    "position": "string",
    "textBoxStyles": {
        "align": "string",
        "backgroundColor": "string",
        "backgroundTransparency": number,
        "border": {
            "color": "string",
            "dashType": "string",
            "transparency": number,
            "width": number
        },
        "rotation": number,
        "verticalAlign": "string"
    },
    "options": {
        "colOffset": {
            "from": number,
            "to": number
        },
        "colSize": number,
        "editAs": "string",
        "name": "string",
        "rowOffset": {
            "from": number,
            "to": number
        },
        "rowSize": number
    }
}

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.
highlight	Hexadecimal color value: "FF0000", "000000"...
italic	If true displays the content in italics.
strikethrough	If true displays text in strikethrough.
transparency	0 to 100.
underline	Underlines text: "single", "double".
position	Cell position in the active sheet: "A1", "C3", "AB7"...
align	left, center, right.
backgroundColor	Hexadecimal color value: "FF0000", "000000"...
backgroundTransparency	0 to 100.
border	"color" FFFFFF, FF0000... "dashType" solid, roundDot, squareDot, dash... "transparency" 0 to 100. "width" EMUs.
rotation	60.000ths of a degree.
verticalAlign	top, middle, bottom.
colOffset	"from" column size offset from. "to" column size offset to.
colSize	Number of columns used by the text box.
editAs	Possible values are: "oneCell" (default): move but don't size with cells. "twoCell": move and size with cells. "absolute": don't move or size with cells.
name	Sets a name value.
rowOffset	"from" row size offset from. "to" row size offset to.
rowSize	Number of rows used by the text box.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addTextBox",
            "data": {
                "contents": {
                    "text": "Text box content"
                },
                "position": "B2",
                "options": {
                    "colSize": 2,
                    "rowSize": 2
                }
            }
        },
        {
            "action": "addTextBox",
            "data": {
                "contents": {
                    "text": "Text box content"
                },
                "position": "H5",
                "textBoxStyles": {
                    "align": "right",
                    "backgroundColor": "FF0000",
                    "verticalAlign": "middle"
                },
                "options": {
                    "colSize": 6,
                    "rowSize": 8
                }
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.