JavaScript API: setColumnSettings

CONTENTS

LAYOUTS

SETTINGS

TEMPLATES

OTHERS

setColumnSettings

PREMIUM

TRIAL / ADVANCED

Sets column settings.

Note

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

Description

setColumnSettings (position: string, settings: OptionsColumnSettings): this

interface OptionsColumnSettings {
    /** Hidden column */
    hidden?: boolean;
    /** Custom width */
    width?: number;
}

Code samples

Example #1

import { CreateXlsx, OptionsCellContents, OptionsColumnSettings, 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 column settings. The position is set using column letters
let columnSettings: OptionsColumnSettings = {
    width: 40,
};
xlsx.setColumnSettings("B", columnSettings);
columnSettings = {
    width: 30.25,
};
xlsx.setColumnSettings("C", columnSettings);

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 column settings. The position is set using cell positions
columnSettings = {
    width: 20,
};
xlsx.setColumnSettings("A1", columnSettings);
columnSettings = {
    width: 30,
};
xlsx.setColumnSettings("B2", columnSettings);
columnSettings = {
    width: 25,
};
xlsx.setColumnSettings("C1", columnSettings);

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

The resulting XLSX spreadsheet looks like:

Release notes

phpxlsx 5.0:
- new method.