JavaScript API: setWorkbookSettings

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

setWorkbookSettings

PREMIUM

TRIAL / ADVANCED

Sets workbook settings.

Note

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

Description

setWorkbookSettings (settings: OptionsWorkbookSettings): this

interface OptionsWorkbookSettings {
    /** Active tab */
    activeTab?: number;
    /** Set the active sheet number as the active tab. Default as false */
    activeSheetAsActiveTab?: boolean;
    /** Force Full Calculation */
    forceFullCalc?: boolean;
    /** Full Calculation On Load */
    fullCalcOnLoad?: boolean;
    /** Read only */
    readOnly?: boolean;
}

Code samples

Example #1

import { CreateXlsx, OptionsSheet, OptionsSheetSettings, OptionsWorkbookSettings } from "build";
import * as fs from "fs";

const xlsx = new CreateXlsx();

// add new sheets
let sheetOptions: OptionsSheet = {
    name: "My 1",
};
xlsx.addSheet(sheetOptions);
sheetOptions = {
    name: "Other",
    removeSelected: true,
    selected: true,
    active: true,
};
xlsx.addSheet(sheetOptions);

// change sheet settings
let sheetSettingsOptions: OptionsSheetSettings = {
    tabSelected: false,
};
xlsx.setSheetSettings(sheetSettingsOptions);

xlsx.setActiveSheet(1);
sheetSettingsOptions = {
    tabSelected: true,
};
xlsx.setSheetSettings(sheetSettingsOptions);

// set the second sheet as the active tab in the workbook
const optionsWorkbookSettings: OptionsWorkbookSettings = {
    activeTab: 1,
};
xlsx.setWorkbookSettings(optionsWorkbookSettings);

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

Release notes

phpxlsx 5.0:
- new method.