JavaScript API: setRowSettings

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

setRowSettings

PREMIUM

TRIAL / ADVANCED

Sets row settings.

Note

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

Description

setRowSettings (position: string, settings: OptionsRowSettings): this

interface OptionsRowSettings {
    /** Custom height */
    height?: number;
    /** Hidden row */
    hidden?: boolean;
}

Code samples

Example #1

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

const xlsx = new CreateXlsx();

let content: OptionsCellContents = {
    text: "Lorem ipsum dolor sit amet",
};
xlsx.addCell(content, "A2");

// set row settings. The position is set using row numbers
let rowSettings: OptionsRowSettings = {
    height: 90.25,
};
xlsx.setRowSettings("4", rowSettings);
rowSettings = {
    height: 60,
};
xlsx.setRowSettings("2", rowSettings);
rowSettings = {
    height: 50.25,
};
xlsx.setRowSettings("3", rowSettings);

const sheetOptions: OptionsSheet = {
    name: "Other",
    removeSelected: true,
    selected: true,
    active: true,
};
xlsx.addSheet(sheetOptions);

content = {
    text: "Sed ut perspiciatis unde omnis",
};
xlsx.addCell(content, "A1");

// set row settings. The position is set using cell positions
rowSettings = {
    height: 40,
};
xlsx.setRowSettings("A1", rowSettings);
rowSettings = {
    height: 50,
};
xlsx.setRowSettings("A2", rowSettings);
rowSettings = {
    height: 40,
};
xlsx.setRowSettings("A3", rowSettings);

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

The resulting XLSX spreadsheet looks like:

Release notes

phpxlsx 5.0:
- new method.