Sheet Class

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

Represents a sheet within the FlexSheet control.

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(owner?: FlexSheet, grid?: FlexGrid, sheetName?: string, rows?: number, cols?: number): Sheet

Initializes a new instance of the Sheet class.

Parameters
Returns
Sheet

Properties

columnCount

Gets or sets the number of columns in the sheet.

Type
number

filterSetting

Gets or sets the filter setting for this sheet.

Type
IFilterSetting

grid

Gets the associated FlexGrid control used to store the sheet data.

Type
FlexGrid

itemsSource

Gets or sets the array or ICollectionView for the FlexGrid instance of the sheet.

Type
any

name

Gets or sets the name of the sheet.

Type
string

rowCount

Gets or sets the number of rows in the sheet.

Type
number

selectionRanges

Gets the selection array.

Type
ObservableArray

tables

Gets the collection of the Table objects on this Sheet. It allows to insert/remove Table on this Sheet via the tables collection.

Type
ObservableArray

visible

Gets or sets the sheet visibility.

Type
boolean

Methods

addTableFromArray

addTableFromArray(row: number, column: number, array: any[], properties?: string[], tableName?: string, tableStyle?: TableStyle, options?: ITableOptions, shift?: boolean): Table

Add table from an object array.

Parameters
Returns
Table

dispose

dispose(): void

Dispose sheet instance.

Returns
void

findTable

findTable(rowIndex: number, columnIndex: number): Table

Finds the table via the cell location.

Parameters
Returns
Table

getCellStyle

getCellStyle(rowIndex: number, columnIndex: number): ICellStyle

Gets the style of specified cell.

Parameters
Returns
ICellStyle

onNameChanged

onNameChanged(e: PropertyChangedEventArgs): void

Raises the nameChanged event.

Parameters
Returns
void

onVisibleChanged

onVisibleChanged(e: EventArgs): void

Raises the visibleChanged event.

Parameters
Returns
void

Events

nameChanged

Occurs after the sheet name has changed.

Arguments
PropertyChangedEventArgs

visibleChanged

Occurs after the visible of sheet has changed.

Arguments
EventArgs