MutableTableDataProvider Interface
Deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.
MutableTableDataProvider provides mutation methods for data in the Table. Useful for Drag & Drop processing.
Extends
Implemented by
Methods
| Name | Description | |
|---|---|---|
| addRow(rowItem: RowItem): number | Adds a row to the end | |
| deleteRow(rowItem: RowItem): void | Deletes a row | |
| insertRow(rowItem: RowItem, index: number): number | Inserts a row at a given row index | |
| moveRow(rowItem: RowItem, newIndex: number): number | Moves a row to a new row index |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| applyFilterDescriptors(filterDescriptors: CompositeFilterDescriptorCollection): Promise<void> Optional | TableDataProvider | Apply a filter descriptor collection |
| getColumns(): Promise<ColumnDescription[]> | TableDataProvider | Retrieves the column descriptions |
| getDistinctValues(columnKey: string, maximumValueCount?: number): Promise<DistinctValueCollection> Optional | TableDataProvider | Gets distinct values in a column |
| getPropertyDisplayValueExpression(property: string): string Optional | TableDataProvider | Gets property display value expression |
| getRow(rowIndex: number, unfiltered?: boolean): Promise<RowItem> | TableDataProvider | Retrieves a specific row by index |
| getRowsCount(): Promise<number> | TableDataProvider | Retrieves the row count |
| sort(columnIndex: number, sortDirection: SortDirection): Promise<void> | TableDataProvider | Sorts the rows based on the value in a specific column |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| onColumnsChanged | TableDataChangeEvent | TableDataProvider | Event emitted by the data provider when column data changes |
| onRowsChanged | TableDataChangeEvent | TableDataProvider | Event emitted by the data provider when row data changes |
Defined in
Last Updated: 30 November, 2023