JavaScript API: setCellValue

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

setCellValue

PREMIUM

TRIAL / ADVANCED

Sets a cell value keeping existing styles.

Note

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

Description

setCellValue (contents: OptionsCellContents, position: string): 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";
}

Code samples

Example #1

import { CreateXlsx } from "build";
import * as fs from "fs";

const xlsxTemplate = fs.readFileSync("template.xlsx").buffer;

const xlsx = new CreateXlsx();
xlsx.openTemplate(xlsxTemplate).then(xlsx => {
    // change the active sheet
    xlsx.setActiveSheet(1);

    // set the cell value in B5 position
    const content = {
        text: "New content",
    };
    xlsx.setCellValue(content, "B5");

    // the same can be done using addCell, that allows using more options
    /*
    const optionsCell: OptionsCell = {
        useCellStyles: true,
    };
    xlsx.addCell(content, "B5", {}, optionsCell);
    */

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

The resulting XLSX spreadsheet looks like:

Release notes

phpxlsx 5.0:
- new method.