Table Class

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

Represents a Table within the FlexSheet control.

Constructor

Properties

Methods

Constructor

constructor

constructor(name: string, range: CellRange, style?: TableStyle, columns?: TableColumn[], options?: ITableOptions): Table

Initializes a new instance of the Table class.

Parameters
Returns
Table

Properties

alterFirstColumn

Gets or sets a value that determines whether the first table column should have the style applied.

Type
boolean

alterLastColumn

Gets or sets a value that determines whether the last table column should have the style applied.

Type
boolean

name

Gets or sets the table name.

The table name is used to reference the table programmatically.

Type
string

sheet

Gets the Sheet this table belongs to.

Type
Sheet

showBandedColumns

Indicating whether banded column formatting is applied.

Type
boolean

showBandedRows

Gets or sets a value that determines whether banded row formatting is applied.

Type
boolean

showHeaderRow

Indicates whether the table should include a header row.

Type
boolean

showTotalRow

Indicates whether the table should include a total row.

Type
boolean

style

Gets or sets the TableStyle associated with this table.

Type
TableStyle

Methods

deleteRows

deleteRows(index: number, count?: number, shift?: boolean): void

Delete rows of Table.

Parameters
Returns
void

getColumns

getColumns(): TableColumn[]

Gets the table's columns.

Returns
TableColumn[]

getRange

getRange(section?: TableSection, column?: any): CellRange

Gets the range of the specific section and column on the relevant sheet that the table occupies.

Parameters
Returns
CellRange

insertRows

insertRows(index: number, count?: number, shift?: boolean): boolean

Insert rows into Table.

Parameters
Returns
boolean