Wijmo
Grid
Sheet
5.20231.904
wijmo.grid.sheet Class Sheet Wijmo API Class

Sheet Class

Represents a sheet within the FlexSheet control.

Heirarchy

Constructors

Properties

Methods

Events

Constructors

constructor

  • Initializes a new instance of the Sheet class.

    Parameters

    • Optional owner: FlexSheet

      The owner FlexSheet control.

    • Optional grid: FlexGrid

      The associated FlexGrid control used to store the sheet data. If not specified then the new FlexGrid control will be created.

    • Optional sheetName: string

      The name of the sheet within the FlexSheet control.

    • Optional rows: number

      The row count for the sheet.

    • Optional cols: number

      The column count for the sheet.

    Returns Sheet

Properties

columnCount

columnCount: number

Gets or sets the number of columns in the sheet.

filterSetting

filterSetting: IFilterSetting

Gets or sets the filter setting for this sheet.

grid

grid: FlexGrid

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

itemsSource

itemsSource: any

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

name

name: string

Gets or sets the name of the sheet.

rowCount

rowCount: number

Gets or sets the number of rows in the sheet.

selectionRanges

selectionRanges: ObservableArray

Gets the selection array.

tables

tables: ObservableArray<Table>

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

visible

visible: boolean

Gets or sets the sheet visibility.

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

    • row: number

      The row position of the table.

    • column: number

      The column position of the table.

    • array: any[]

      The object array load to the table.

    • Optional properties: string[]

      It allows to retrieve only a subset of columns from the object of the array. If it is omitted, the table will load all the keys of the object of the array.

    • Optional tableName: string

      The name of the table.

    • Optional tableStyle: TableStyle

      The table style is applied to the table.

    • Optional options: ITableOptions

      The options ITableOptions of the table.

    • Optional shift: boolean

      Indicates whether cells beneath the table should be shifted or not. If not specified cells beneath will be shifted.

    Returns Table

    the table if the table was added successfully, otherwise retun null.

dispose

  • dispose(): void

  • Dispose sheet instance.

    Returns void

findTable

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

  • Finds the table via the cell location.

    Parameters

    • rowIndex: number

      the row index of the specified cell.

    • columnIndex: number

      the column index of the specified cell.

    Returns Table

getCellStyle

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

  • Gets the style of specified cell.

    Parameters

    • rowIndex: number

      the row index of the specified cell.

    • columnIndex: number

      the column index of the specified cell.

    Returns ICellStyle

onNameChanged

onVisibleChanged

Events

nameChanged

nameChanged: Event<Sheet, PropertyChangedEventArgs>

Occurs after the sheet name has changed.

visibleChanged

visibleChanged: Event<Sheet, EventArgs>

Occurs after the visible of sheet has changed.