Highcharts Grid
    Preparing search index...

    Interface RemoteDataProviderOptions

    A base interface for the data provider options (grid.options.data).

    interface RemoteDataProviderOptions {
        autogenerateColumns?: boolean;
        chunkSize?: number;
        chunksLimit?: number;
        dataSource?: DataSourceOptions;
        fetchCallback?: (
            this: RemoteDataProvider,
            query: QueryingController,
            offset: number,
            limit: number,
            signal?: AbortSignal,
        ) => Promise<RemoteFetchCallbackResult>;
        idColumn?: string;
        providerType: "remote";
        requestPolicy?: "all" | "latest";
        setValueCallback?: (
            this: RemoteDataProvider,
            columnId: string,
            rowId: RowId,
            value: CellType,
        ) => Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autogenerateColumns? chunkSize? chunksLimit? dataSource? fetchCallback? idColumn? providerType requestPolicy? setValueCallback?

    Properties

    autogenerateColumns?: boolean

    Whether columns should be generated automatically from data source column ids.

    If set to false, only columns explicitly configured in columns[] (or referenced by header) will be rendered.

    With autogenerateColumns: true and no header, source columns are rendered in provider order, and custom configured columns are appended at the end in their definition order.

    grid-lite/basic/autogenerate-columns-disabled Manual columns only

    true
    chunkSize?: number

    The number of rows to fetch per chunk.

    chunksLimit?: number

    Maximum number of chunks to keep in memory. When exceeded, the least recently used (LRU) chunk is evicted. If not set, all chunks are kept.

    dataSource?: DataSourceOptions

    Serialized data source configuration, alternatively to fetchCallback.

    grid-pro/demo/serverside-data Server-side data source

    fetchCallback?: (
        this: RemoteDataProvider,
        query: QueryingController,
        offset: number,
        limit: number,
        signal?: AbortSignal,
    ) => Promise<RemoteFetchCallbackResult>

    Custom callback to fetch data from the remote server. Has higher priority than dataSource.

    Type Declaration

      • (
            this: RemoteDataProvider,
            query: QueryingController,
            offset: number,
            limit: number,
            signal?: AbortSignal,
        ): Promise<RemoteFetchCallbackResult>

      • Parameters

        • this: RemoteDataProvider
        • query: QueryingController

          The current query state (sorting, filtering, pagination).

        • offset: number

          Zero-based index of the first row to fetch.

        • limit: number

          Number of rows to fetch.

        • Optionalsignal: AbortSignal

          Abort signal that fires when the request is superseded by a newer one.

        Returns Promise<RemoteFetchCallbackResult>

        A RemoteFetchCallbackResult with columns, totalRowCount, and optionally rowIds and pageSize. See RemoteFetchCallbackResult for field descriptions.

    grid-pro/options/remote-fetch-callback Remote fetch callback

    idColumn?: string

    The column ID that contains the stable, unique row IDs. If not provided, the row IDs will be extracted from the result.rowIds property if available. If result.rowIds is also not defined, the row IDs will default to the indices of the rows in their display order.

    providerType: "remote"

    The remote data provider type.

    'remote'
    requestPolicy?: "all" | "latest"

    Request policy for rapid query changes. latest aborts or ignores in-flight requests so only the final query updates the cache.

    'latest'
    setValueCallback?: (
        this: RemoteDataProvider,
        columnId: string,
        rowId: RowId,
        value: CellType,
    ) => Promise<void>

    Callback to persist value changes to the remote server. If not provided, cell value editing will not be possible.

    The callback receives the column ID, row ID and value to set.

    Settings

    On This Page

    Properties