JSON API - addLink

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

addLink

PREMIUM

TRIAL / ADVANCED

Adds links into the Excel spreadsheet.

Note

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

JSON data

{
    "link": "string",
    "position": "string",
    "contents": {
        /* check addCell contents */
    },
    "cellStyles": {
        /* check addCell cellStyles */
    },
    "options": {
        /* check addCell options */
    }
}

Contents, cellStyles, and options from addCell can be used.

Key	Description
link	URL or #location.
position	Cell position in the active sheet: "A1", "C3", "AB7"...

Code samples

Example #1

{
    "actions": [
        {
            "action": "addLink",
            "data": {
                "link": "https://www.phpxlsx.com",
                "position": "B2",
                "contents": {
                    "text": "Link to phpxlsx"
                }
            }
        },
        {
            "action": "addLink",
            "data": {
                "link": "https://www.phpdocx.com",
                "position": "D5",
                "contents": {
                    "text": "Link to phpdocx",
                    "bold": true,
                    "color": "000000",
                    "underline": "none"
                }
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "addSheet",
            "data": {
                "name": "Sheet2"
            }
        },
        {
            "action": "addLink",
            "data": {
                "link": "#Sheet2!A1",
                "position": "A1",
                "contents": {
                    "text": "Link to Sheet2"
                }
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.