JavaScript API: setSheetSettings

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

setSheetSettings

PREMIUM

TRIAL / ADVANCED

Sets sheet settings.

Note

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

Description

setSheetSettings (settings: OptionsSheetSettings): this

interface OptionsSheetSettings {
    /** Active cell */
    activeCell?: string;
    /** Color: HEX value */
    color?: string;
    /** Default col width */
    defaultColWidth?: number;
    /** Default row height */
    defaultRowHeight?: number;
    /** Margins: inch value */
    margin?: {
        top?: number;
        right?: number;
        bottom?: number;
        left?: number;
        header?: number;
        footer?: number;
    };
    /** Paper settings */
    paper?: {
        /** Height: mm, cm, in, pt, pc, pi */
        height?: string;
        /** Size code: SpreadsheetML values */
        size?: number;
        /** Type */
        type?:
            | "A4"
            | "A3"
            | "letter"
            | "legal"
            | "A4-landscape"
            | "A3-landscape"
            | "letter-landscape"
            | "legal-landscape";
        /** Orientation */
        orientation?: "portrait" | "landscape";
        /** Width: mm, cm, in, pt, pc, pi */
        width?: string;
    };
    /** RTL */
    rtl?: boolean;
    /** State */
    state?: "hidden" | "visible";
    /** Tab selected */
    tabSelected?: boolean;
    /** View */
    view?: "normal" | "pageBreakPreview" | "pageLayout";
}

Code samples

Example #1

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

const xlsx = new CreateXlsx();

const sheetSettingsOptions: OptionsSheetSettings = {
    paper: { type: "A4" },
    margin: { top: 0.1, bottom: 0.1 },
};
xlsx.setSheetSettings(sheetSettingsOptions);

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

Release notes

phpxlsx 5.0:
- new method.