v5.20192.624
|

WorkSheet Class

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].

Hierarchy

  • WorkSheet

Constructors

constructor

Properties

columns

columns: WorkbookColumn[]

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.

frozenPane

frozenPane: WorkbookFrozenPane

Gets or sets the WorkbookFrozenPane settings.

name

name: string

Gets or sets the sheet name.

rows

rows: WorkbookRow[]

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.

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.

summaryBelow

summaryBelow: boolean

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

tables

tables: WorkbookTable[]

Gets the name of tables refered in this worksheet.

visible

visible: boolean

Gets or sets the worksheet visibility.