JSON API - addCsv

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

addCsv

PREMIUM

TRIAL / ADVANCED

Adds CSV contents.

Note

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

JSON data

{
    "csv": "string",
    "position": "string",
    "options": {
        "delimiter": "string",
        "enclosure": "string",
        "escape": "string",
        "firstRowAsHeader": boolean,
        "headerCellStyles": array,
        "headerTextStyles": array
    }
}

Key	Description
csv	File path, Base64 string, or URL.
position	Cell position in the active sheet: "A1", "C3", "AB7"...
delimiter	Field separator. Default as ,
enclosure	Field enclosure character. Default as "
escape	Escape character. Default as \
firstRowAsHeader	If true, the first row is added as table header. Default as false
headerCellStyles	If firstRowAsHeader is true, apply the cell styles to the header. Default as empty. Check addCell to see all available options.
headerTextStyles	If firstRowAsHeader is true, apply the text styles to the header. Default as empty. Check addCell to see all available options.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addCsv",
            "data": {
                "csv": "file.csv",
                "position": "A1"
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.