Class RemoteDataProvider

Remote data provider for the Grid.

Fetches tabular data from a remote API in chunks and exposes it through the standard DataProvider interface used by the Grid viewport.

Caches fetched chunks (optionally with an LRU eviction policy).
Deduplicates concurrent requests for the same chunk.
Uses a query fingerprint to invalidate caches when the query changes.

Hierarchy (View Summary)

DataProvider
- RemoteDataProvider

Index

Constructors

Properties

options querying

Methods

applyQuery destroy getColumnDataType getColumnIds getPrePaginationRowCount getRowCount getRowId getRowIndex getRowObject getValue init setValue assumeColumnDataType

Constructors

constructor

new RemoteDataProvider(
queryingController: QueryingController,
options: DataProviderOptions,
): RemoteDataProvider
Parameters
- queryingController: QueryingController
- options: DataProviderOptions
Returns RemoteDataProvider
Inherited from DataProvider.constructor

Properties

`Readonly`options

options: RemoteDataProviderOptions

Provider options as passed via grid.options.data.

`Protected` `Readonly`querying

querying: QueryingController

Querying controller used to build and apply modifiers.

Methods

applyQuery

applyQuery(): Promise<void>
Applies the current query modifiers to update the provider's presentation state.

Returns Promise<void>
Overrides DataProvider.applyQuery

destroy

destroy(): void
Destroys the provider and releases resources.

Returns void
Overrides DataProvider.destroy

getColumnDataType

getColumnDataType(columnId: string): Promise<ColumnDataType>
Returns the assumed / configured data type for a column.
Parameters
- columnId: string
Returns Promise<ColumnDataType>
Overrides DataProvider.getColumnDataType

getColumnIds

getColumnIds(): Promise<string[]>
Returns all available column IDs.

Returns Promise<string[]>
Overrides DataProvider.getColumnIds

getPrePaginationRowCount

getPrePaginationRowCount(): Promise<number>
Returns the number of items before pagination has been applied.

Returns Promise<number>
Overrides DataProvider.getPrePaginationRowCount

getRowCount

getRowCount(): Promise<number>
Returns the current number of rows in the presentation dataset (after applying all query modifiers).

Returns Promise<number>
Overrides DataProvider.getRowCount

getRowId

getRowId(rowIndex: number): Promise<RowId | undefined>
Returns a stable row id for a given row index (as used by the viewport).
Parameters
- rowIndex: number
Returns Promise<RowId | undefined>
Overrides DataProvider.getRowId

getRowIndex

getRowIndex(rowId: RowId): Promise<number | undefined>
Returns the current row index for a given stable row id.
Parameters
- rowId: RowId
Returns Promise<number | undefined>
Overrides DataProvider.getRowIndex

getRowObject

getRowObject(rowIndex: number): Promise<RowObject | undefined>
Returns a row as an object keyed by column IDs.
Parameters
- rowIndex: number
Returns Promise<RowObject | undefined>
Overrides DataProvider.getRowObject

getValue

getValue(columnId: string, rowIndex: number): Promise<CellType>
Returns a cell value for a given column and row index.
Parameters
- columnId: string
- rowIndex: number
Returns Promise<CellType>
Overrides DataProvider.getValue

init

init(): Promise<void>
Initializes the data provider.

Returns Promise<void>
Inherited from DataProvider.init

setValue

setValue(value: CellType, columnId: string, rowId: RowId): Promise<void>
Persists a cell value for a given row id.
Parameters
- value: CellType
- columnId: string
- rowId: RowId
Returns Promise<void>
Overrides DataProvider.setValue

`Protected` `Static`assumeColumnDataType

assumeColumnDataType(columnSample: Column, columnId: string): ColumnDataType
Helper method to assume the data type of a column based on the sample of the column data.
Parameters
- columnSample: Column
  The sample of the column data to determine the data type from.
- columnId: string
  The id of the column to determine the data type for.
Returns ColumnDataType
Inherited from DataProvider.assumeColumnDataType