JSON API - addTextBox

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

addTextBox

PREMIUM

TRIAL / ADVANCED

Inserts a text box into the PowerPoint presentation.

Note

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

JSON data

{
    "position": {
        "coordinateX": number,
        "coordinateY": number,
        "sizeX": number,
        "sizeY": number,
        "name": "string",
        "order": number
    },
    "textBoxStyles": {
        "autofit": "string",
        "border": {
            "cap": "string",
            "dash": "string",
            "color": "string",
            "transparency": number,
            "width": number
        },
        "columns": {
            "number": number,
            "spacing": number
        },
        "descr": "string",
        "fill": {
            "color": "string",
            "image": "string",
            "imageAsTexture": boolean,
            "transparency": number
        },
        "margin": {
            "bottom": number,
            "left": number,
            "right": number,
            "top": number
        },
        "rotation": number,
        "textDirection": "string",
        "verticalAlign": "string",
        "wrap": "string"
    },
    "options": {}
}

Key	Description
coordinateX	EMUs (English Metric Unit).
coordinateY	EMUs (English Metric Unit).
sizeX	EMUs (English Metric Unit).
sizeY	EMUs (English Metric Unit).
name	Internal name. If not set, a random name is generated.
order	Set the display order. Default after existing contents. 0 is the first order position. If the order position doesn't exist add after existing contents.
autofit	autofit (default), noautofit, shrink.
border	"cap" rnd, sq, flat. "dash" solid, dot, dash, lgDash, dashDot, lgDashDot, lgDashDotDot, sysDash, sysDot, sysDashDot, sysDashDotDot. "color" default as 000000. "transparency" 0 to 100. "width" EMUs (English Metric Unit). Default as 12700 (1pt).
columns	"number" "spacing" EMUs (English Metric Unit).
descr	Descr value.
fill	"color" FFFF00, CCCCCC... "image" Image path, Base64 string, or URL. "imageAsTexture" default as false "transparency" 0 to 100.
margin	"bottom" EMUs (English Metric Unit) "left" EMUs (English Metric Unit) "right" EMUs (English Metric Unit) "top" EMUs (English Metric Unit)
rotation	60.000ths of a degree.
textDirection	horz, vert, vert270, wordArtVert, eaVert, mongolianVert, wordArtVertRtl.
verticalAlign	top, middle, bottom, topCentered, middleCentered, bottomCentered.
wrap	square, none.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addTextBox",
            "data": {
                "position": {
                    "coordinateX": 1470000,
                    "coordinateY": 600000,
                    "sizeX": 5000000,
                    "sizeY": 450000
                },
                "textBoxStyles": {
                    "border": {
                        "color": "000000"
                    }
                }
            }
        },
        {
            "action": "addTextBox",
            "data": {
                "position": {
                    "coordinateX": 3770000,
                    "coordinateY": 4507000,
                    "sizeX": 7000000,
                    "sizeY": 1450000
                },
                "textBoxStyles": {
                    "autofit": "noautofit",
                    "border": {
                        "color": "000000"
                    },
                    "fill": {
                        "color": "99B369"
                    }
                }
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.