Interface IFilterableDatasource<T>

Public ui-kit datasource contract for serializable filtering.

Unlike the lower-level foundation datasource contract, this surface accepts the serializable FilterExpression emitted by ui-filter.

interface IFilterableDatasource<T = unknown> {
    filterBy(expression: FilterExpression<T> | null | undefined): void;
    getNumberOfItems(): number | Promise<number>;
    getObjectAtRowIndex(rowIndex: number): RowResult<T>;
}

Type Parameters

T = unknown

Hierarchy (View Summary)

IDatasource<T>
- IFilterableDatasource

Implemented by

FilterableArrayDatasource

Index

Methods

filterBy getNumberOfItems getObjectAtRowIndex

Methods

filterBy

filterBy(expression: FilterExpression<T> | null | undefined): void
Applies the given serializable filter descriptor.

Pass null, undefined, or an empty rule list to clear the filter.
Parameters
- expression: FilterExpression<T> | null | undefined
Returns void
- Defined in packages/ui-kit/src/lib/table-view/datasources/datasource.ts:38

getNumberOfItems

getNumberOfItems(): number | Promise<number>
Returns the total number of items, synchronously or asynchronously.

Returns number | Promise<number>
Inherited from IDatasource.getNumberOfItems
- Defined in packages/foundation/src/lib/datasources/datasource.ts:26

getObjectAtRowIndex

getObjectAtRowIndex(rowIndex: number): RowResult<T>
Returns the row object at the given index.
Parameters
- rowIndex: number
  Zero-based index of the row to retrieve.
Returns RowResult<T>
The row value, or a Promise that resolves to it.
Inherited from IDatasource.getObjectAtRowIndex
- Defined in packages/foundation/src/lib/datasources/datasource.ts:34