JSON API - addLink

CONTENTS

LAYOUTS

TEMPLATES

PPTXPATH

FORMAT CONVERSION

PPTXUTILITIES

PPTXCUSTOMIZER

customizeElementStyles

PERFORMANCE

zipStream

addLink

PREMIUM

TRIAL / ADVANCED

Inserts a link into the PowerPoint presentation.

Note

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

JSON data

{
    "link": "string",
    "linkText": "string",
    "position": {
        "placeholder": {
            "name": "string",
            "descr": "string",
            "position": number,
            "type": "string"
        },
        "new": {
            "coordinateX": number,
            "coordinateY": number,
            "sizeX": number,
            "sizeY": number,
            "name": "string",
            "order": number,
            "textBoxStyles": {
                /* check addTextBox styles */
            }
        }
    },
    "linkStyles": {
        "bold": boolean,
        "characterSpacing": number,
        "color": "string",
        "font": "string",
        "fontSize": number,
        "highlight": "string",
        "italic": boolean,
        "lang": "string",
        "strikethrough": boolean,
        "underline": "string"
    },
    "paragraphStyles": {
        "align": "string",
        "lineSpacing": number,
        "noBullet": boolean,
        "parseLineBreaks": boolean
    },
    "options": {
        "insertMode": "string"
    }
}

Key	Description
link	External link, bookmark (#firstslide, #lastslide, #nextslide, #previousslide) or slide (#slide with position)
linkText	Text Content.
placeholder	The content is added in a placeholder of the layout. One of the following options can be used to get the text box. "name" name. "descr" alt text (descr) value. "position" position by order. 0 is the first order position. "type" title (Title), body (Body), ctrTitle (Centered Title), subTitle (Subtitle).
new	A new position is generated. "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. "textBoxStyles" See addTextBox for text box styles.
bold
characterSpacing
color	HEX color.
font	Font family.
fontSize	8, 9, 10, 11...
highlight	HEX color.
italic
lang	Language.
strikethrough
underline	Underline: single.
align	left, center, right, justify.
lineSpacing	1, 1.5, 2...
noBullet	No bullet added. Default as true
parseLineBreaks	If true parses the line breaks. Default as false
insertMode	Insert mode if the position contains an existing content: append replace Default as append.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addLink",
            "data": {
                "link": "https://www.phppptx.com",
                "linkText": "My link",
                "position": {
                    "placeholder": {
                        "name": "Title 1"
                    }
                }
            }
        },
        {
            "action": "addSlide",
            "data": {
                "layout": "Title and Content"
            }
        },
        {
            "action": "addLink",
            "data": {
                "link": "#slide1",
                "linkText": "link",
                "position": {
                    "placeholder": {
                        "name": "Subtitle 2"
                    }
                },
                "linkStyles": {
                    "bold": true
                }
            }
        },
        {
            "action": "addSlide",
            "data": {
                "layout": "Blank",
                "active": true
            }
        },
        {
            "action": "addLink",
            "data": {
                "link": "#firstslide",
                "linkText": "Link to the first slide.",
                "position": {
                    "new": {
                        "coordinateX": 770000,
                        "coordinateY": 507000,
                        "sizeX": 7000000,
                        "sizeY": 450000,
                        "textBoxStyles": {
                            "border": {
                                "color": "FF0000",
                                "dash": "dash",
                                "width": 48575
                            }
                        }
                    }
                },
                "paragraphStyles": {
                    "align": "center"
                }
            }
        }
    ]
}

Release notes

phppptx 5.0:
- new action.