Interface IFilterableDatasource<T>

A datasource that supports server-side or in-memory filtering.

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

Type Parameters

T = unknown
The row object type.

Hierarchy (View Summary)

IDatasource<T>
- IFilterableDatasource

Implemented by

FilterableArrayDatasource

Index

Methods

filterBy getNumberOfItems getObjectAtRowIndex

Methods

filterBy

filterBy(expression: CompiledFilter<T> | null | undefined): void
Applies the given filter expression to the datasource.

The expression is a structured array of property-level or row-level predicates. Pass null or undefined to clear the filter and restore all rows.
Parameters
- expression: CompiledFilter<T> | null | undefined
  The filter criteria to apply, or null/undefined to clear.
Returns void
- Defined in packages/foundation/src/lib/datasources/datasource.ts:73

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