JavaScript API: addSheet

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

addSheet

PREMIUM

TRIAL / ADVANCED

Adds sheet.

Note

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

Description

addSheet (options: OptionsSheet = {}): this

interface OptionsSheet {
    /** Set as active sheet */
    active?: boolean;
    /** Color: HEX value */
    color?: string;
    /** Default column width */
    defaultColWidth?: number;
    /** Default row height */
    defaultRowHeight?: number;
    /** Sheet name */
    name?: string;
    /** Margins: inch value */
    margin?: {
        top?: number;
        right?: number;
        bottom?: number;
        left?: number;
        header?: number;
        footer?: number;
    };
    /** Sheet position. As default use the last position. 0 is the first sheet */
    position?: number;
    /** Remove selected property in all sheets */
    removeSelected?: boolean;
    /** RTL */
    rtl?: boolean;
    /** Selected */
    selected?: boolean;
    /** State */
    state?: "hidden";
}

Code samples

Example #1

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

const xlsx = new CreateXlsx();

xlsx.addSheet();

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

The resulting XLSX spreadsheet looks like:

Release notes

phpxlsx 5.0:
- new method.