Table Class

File
wijmo.grid.sheet.js
Module
wijmo.grid.sheet

Represents a Table within the FlexSheet control.

Constructor

Properties

Methods

Constructor

constructor

constructor(owner: FlexSheet, name: string, range: CellRange, style?: TableStyle, columns?: TableColumn[], showHeaderRow?: boolean, showTotalRow?: boolean, showBandedColumns?: boolean, showBandedRows?: boolean, showFirstColumn?: boolean, showLastColumn?: boolean): Table

Initializes a new instance of the Table class.

Parameters
Returns
Table

Properties

columns

Gets the table columns of the table.

Type
TableColumn[]

name

Gets or sets the name of the table. It is used to reference the table programmatically.

Type
string

range

Gets the range on the relevant sheet that the table occupies. The reference shall include the totals row if it is shown.

Type
CellRange

showBandedColumns

Indicating whether banded column formatting is applied.

Type
boolean

showBandedRows

Indicating whether banded row formatting is applied.

Type
boolean

showFirstColumn

Indicating whether the first column in the table should have the style applied.

Type
boolean

showHeaderRow

Indicates whether show the header row for the table.

Type
boolean

showLastColumn

Indicating whether the last column in the table should have the style applied.

Type
boolean

showTotalRow

Indicates whether show the total row for the table.

Type
boolean

style

Gets or sets the table style to use with the table.

Type
TableStyle

Methods

getColumnRange

getColumnRange(columnName: string): CellRange

Gets the range of the specific column in the table.

Parameters
Returns
CellRange

getDataRange

getDataRange(): CellRange

Gets data range of the table.

Returns
CellRange

getHeaderRange

getHeaderRange(): CellRange

Gets header row range of the table.

Returns
CellRange

getTotalRange

getTotalRange(): CellRange

Gets total row range of the table.

Returns
CellRange