WorkSheet Class
File
wijmo.xlsx.js
Module
wijmo.xlsx
Implements
IWorkSheet

Represents the Workbook Object Model sheet definition that includes sheet properties and data.

The sheet cells are stored in row objects and are accessible using JavaScript expressions like sheet.rows[i].cells[j].

Constructor

constructor

constructor(): void

Initializes a new instance of the WorkSheet class.

Returns
void

Properties

columns

Gets or sets an array of sheet columns definitions.

Each WorkbookColumn object in the array describes a column at the corresponding position in xlsx sheet, i.e. the column with index 0 corresponds to xlsx sheet column with index A, object with index 1 defines sheet column with index B, and so on. If certain column has no description in xlsx file, then corresponding array element is undefined for both export and import operations.

If WorkbookColumn object in the array doesn't specify the width property value, then the default column width is applied.

Type
WorkbookColumn[]

frozenPane

Gets or sets the WorkbookFrozenPane settings.

Type
WorkbookFrozenPane

name

Gets or sets the sheet name.

Type
string

rightToLeft

Indicates whether the sheet is in "right to left" display mode, i.e. when Column A is placed on the far right. The default value is **undefined**, which means **false**.

Type
boolean

rows

Gets an array of sheet rows definition.

Each WorkbookRow object in the array describes a row at the corresponding position in xlsx sheet, i.e. the row with index 0 corresponds to excel sheet row with index 1, object with index 1 defines sheet row with index 2, and so on. If certain row has no properties and data in xlsx file, then corresponding array element is undefined for both export and import operations.

If WorkbookRow object in the array doesn't specify the height property value, then the default row height is applied.

Type
WorkbookRow[]

style

Gets or sets the row style.

The property defines the style for all cells in the worksheet, and can be overridden by the specific cell styles.

Type
WorkbookStyle

summaryBelow

Gets or sets a value indicating whether summary rows appear below or above detail rows.

Type
boolean

tables

Gets the name of tables refered in this worksheet.

Type
WorkbookTable[]

visible

Gets or sets the worksheet visibility.

Type
boolean