JSON API - addHtml

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

addHtml

PREMIUM

TRIAL / ADVANCED

Inserts HTML and CSS into the Excel spreadsheet.

Note

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

JSON data

{
    "html": "string",
    "position": "string",
    "options": {
        "disableWrapValue": boolean,
        "forceNotTidy": boolean,
        "insertMode": "string",
        "parseCSSVars": boolean
    }
}

Key	Description
html	HTML and CSS content to be transformed.
position	Cell position in the active sheet: "A1", "C3", "AB7"...
disableWrapValue	If true disable using a wrap value with Tidy to prevent extra blank spaces. Default as false.
forceNotTidy	False as default. If true, avoid using Tidy. Only recommended if Tidy can't be installed.
insertMode	Insert mode if the position contains an existing content: "replace", "ignore". Default as "replace".
parseCSSVars	If true parses CSS variables.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addHtml",
            "data": {
                "html": "<p>Lorem ipsum</p>",
                "position": "A1"
            }
        },
        {
            "action": "addHtml",
            "data": {
                "html": "<style>p {font-family: Arial;font-style: italic;text-decoration: underline;color: #2CA87A;vertical-align: bottom;}</style><p>Lorem ipsum with Arial font</p>",
                "position": "A3"
            }
        },
        {
            "action": "addHtml",
            "data": {
                "html": "<a href=\"https://www.phpxlsx.com\">Link to phpxlsx</a>",
                "position": "B5"
            }
        },
        {
            "action": "addHtml",
            "data": {
                "html": "<style>p {background-color: #AEBF7A;}.c1 {text-decoration: underline;font-size: 16pt;}</style><p><b>phpxlsx</b> can transform <span class=\"c1\">HTML to XLSX</span>.</p>",
                "position": "A10"
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "addHtml",
            "data": {
                "html": "<style>#i1 {font-size: 18px;}.c1 {text-decoration: underline;}.c2 {color: #2CA87A;}</style><p><p><b>phpxlsx</b> can transform <span class=\"c1\">HTML to XLSX</span>.</p><p id=\"i1\" class=\"c2\"><span class=\"c1\">CSS styles</span> using ids and classes are supported.</p><p class=\"c2\">CSS styles classes are supported.</p></p><p>Links can be added:</p><a href=\"https://www.phpxlsx.com\">Link</a><p>Heading tags are added as block elements:</p><h1>Heading 1</h1><h2>Heading 2</h2><h3>Heading 3</h3><h4>Heading 4</h4><h5>Heading 5</h5><h6>Heading 6</h6>",
                "position": "A1"
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.