JSON API - addFunction

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

transform

XLSXPATH

XLSXUTILITIES

watermark

PERFORMANCE

zipStream

addFunction

PREMIUM

TRIAL / ADVANCED

Adds functions into the Excel spreadsheet.

Note

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

JSON data

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

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

Key	Description
function	Function beginning with "=".
position	Cell position in the active sheet: "A1", "C3", "AB7"...

Code samples

Example #1

{
    "actions": [
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 100
                },
                "position": "A2"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 10.50
                },
                "position": "A3"
            }
        },
        {
            "action": "addFunction",
            "data": {
                "function": "=SUM(A2:A3)",
                "position": "D3",
                "contentStyles": {
                    "bold": true,
                    "font": "Arial"
                },
                "cellStyles": {
                    "backgroundColor": "FFFF00",
                    "verticalAlign": "top"
                }
            }
        }
    ]
}

Example #2

{
    "actions": [
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 100
                },
                "position": "A2"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 10.50
                },
                "position": "A3"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 12
                },
                "position": "A4"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 27.2
                },
                "position": "A5"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 17
                },
                "position": "B2"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 8.50
                },
                "position": "B3"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 2
                },
                "position": "B4"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": 37.2
                },
                "position": "B5"
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "SUM:",
                    "bold": true
                },
                "position": "D3"
            }
        },
        {
            "action": "addFunction",
            "data": {
                "function": "=SUM(A2:B5)",
                "position": "E3",
                "cellStyles": {
                    "backgroundColor": "F5FFF2",
                    "type": "number"
                }
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "MAX:",
                    "bold": true
                },
                "position": "D4"
            }
        },
        {
            "action": "addFunction",
            "data": {
                "function": "=MAX(A2:B5)",
                "position": "E4",
                "cellStyles": {
                    "backgroundColor": "F5FFF2",
                    "type": "number"
                }
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "MIN:",
                    "bold": true
                },
                "position": "D5"
            }
        },
        {
            "action": "addFunction",
            "data": {
                "function": "=MIN(A2:B5)",
                "position": "E5",
                "cellStyles": {
                    "backgroundColor": "F5FFF2",
                    "type": "number"
                }
            }
        },
        {
            "action": "addCell",
            "data": {
                "contents": {
                    "text": "PRODUCT:",
                    "bold": true
                },
                "position": "D6"
            }
        },
        {
            "action": "addFunction",
            "data": {
                "function": "=PRODUCT(E3,E5)",
                "position": "E6",
                "cellStyles": {
                    "backgroundColor": "F5FFF2",
                    "type": "number"
                }
            }
        }
    ]
}

Release notes

phpxlsx 6.0:
- new action.