JavaScript API: addFunction

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

addFunction

PREMIUM

TRIAL / ADVANCED

Adds function.

Note

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

Description

addFunction (func: string, position: string, contentStyles: OptionsCellContents = {}, cellStyles: OptionsCellStyles = {}, options: OptionsCell = {}): this

interface OptionsCellContents {
    /** Bold */
    bold?: boolean;
    /** Color: HEX value */
    color?: string;
    /** Font family */
    font?: string;
    /** Font size: point values */
    fontSize?: number;
    /** Italic */
    italic?: boolean;
    /** Strikethrough */
    strikethrough?: boolean;
    /** Subscript */
    subscript?: boolean;
    /** Superscript */
    superscript?: boolean;
    /** Text content */
    text?: boolean | number | string | Date;
    /** Underline */
    underline?: "single" | "double" | "none";
}

interface OptionsCellStyles {
    /** Background color: HEX value */
    backgroundColor?: string;
    /** Border: thin, thick, dashed, double, mediumDashDotDot, hair...*/
    border?: {
        bottom?: string;
        left?: string;
        right?: string;
        top?: string;
        diagonal?: string;
    };
    /** Border color: HEX value */
    borderColor?: {
        bottom?: string;
        left?: string;
        right?: string;
        top?: string;
        diagonal?: string;
    };
    /** Date format: 1900 or 1904. Default as 1900 */
    dateFormat?: "1900" | "1904";
    /** Horizontal alignment */
    horizontalAlign?: "left" | "center" | "right";
    /** Indent */
    indent?: number;
    /** Is function. Default as false. Set as function. If not set, if the content starts with = , isFunction is set as true (set isFunction as false to avoid this) */
    isFunction?: boolean;
    /** Locked */
    locked?: boolean;
    /** Orientation degrees */
    rotation?: number;
    /** Shrink to fit */
    shrinkToFit?: boolean;
    /** Text direction */
    textDirection?: "context" | "ltr" | "rtl";
    /** Type. Default as "general" */
    type?:
        | "accounting"
        | "boolean"
        | "currency"
        | "empty"
        | "date"
        | "fraction"
        | "function"
        | "general"
        | "number"
        | "percentage"
        | "scientific"
        | "special"
        | "text"
        | "time";
    /** Type options */
    typeOptions?: {
        /** Format code */
        formatCode?: string;
    };
    /** Vertical alignment */
    verticalAlign?: "top" | "center" | "bottom";
    /** Wrap text */
    wrapText?: boolean;
}

interface OptionsCell {
    /** Insert mode. Default as replace */
    insertMode?: "replace" | "ignore";
    /** Raw value. Default as false */
    raw?: boolean;
    /** Use existing cell styles. Default as false */
    useCellStyles?: boolean;
}

Code samples

Example #1

import { CreateXlsx, OptionsCellContents, OptionsCellStyles } from "build";
import * as fs from "fs";

const xlsx = new CreateXlsx();

let content: OptionsCellContents = {
    text: 100,
};
xlsx.addCell(content, "A2");
content = {
    text: 10.5,
};
xlsx.addCell(content, "A3");

const contentStyles: OptionsCellContents = {
    bold: true,
    font: "Arial",
};
const cellStyles: OptionsCellStyles = {
    backgroundColor: "FFFF00",
    verticalAlign: "top",
};

xlsx.addFunction("=SUM(A2:A3)", "D3", contentStyles, cellStyles);

xlsx.save().then(contents => {
    fs.writeFileSync("addFunction_1.xlsx", Buffer.from(contents));
});

The resulting XLSX spreadsheet looks like:

Release notes

phpxlsx 5.0:
- new method.