Highcharts Grid
    Preparing search index...

    Interface DataSourceOptions

    Serialized configuration alternatively to fetchCallback.

    interface DataSourceOptions {
        fetchTimeout?: number;
        omitEmpty?: boolean;
        parseResponse?: (res: Response) => Promise<RemoteFetchCallbackResult>;
        templateVariables?: Record<string, (state: QueryState) => string>;
        urlTemplate: string;
    }
    Index

    Properties

    fetchTimeout? omitEmpty? parseResponse? templateVariables? urlTemplate

    Properties

    fetchTimeout?: number

    Timeout (ms) for the remote request. Set to 0 to disable.

    30000
    omitEmpty?: boolean

    If true, empty query parameters are omitted from the URL.

    true
    parseResponse?: (res: Response) => Promise<RemoteFetchCallbackResult>

    Callback to parse the response from the remote server into a RemoteFetchCallbackResult object with the following fields:

    • columns (required) — column data keyed by column ID, where each value is an array of cell values for the fetched rows.

    • totalRowCount (required) — total number of rows available on the server for the current query (used to calculate page count and scrollbar size).

    • rowIds (optional) — stable identifiers for the fetched rows. When omitted, the Grid assigns sequential numeric IDs starting from offset.

    • pageSize (optional) — effective page size used by the backend for this response. Return this when the server can clamp or otherwise adjust the requested page size so the Grid can keep chunk indexing aligned with the actual response.

    templateVariables?: Record<string, (state: QueryState) => string>

    Custom template variables to be replaced in the urlTemplate, extending or overriding the built-in set (page, pageSize, offset, limit, filter, sortBy, sortOrder). Each entry is a function that receives the current QueryState and returns the string value to substitute.

    urlTemplate: string

    The URL template to be used to fetch data from the remote server. Available template variables:

    • page - The current page number.
    • pageSize - The current page size.
    • offset - The current offset ((page - 1) * pageSize).
    • limit - Alias to pageSize.
    • filter - The filter conditions.
    • sortBy - The sort by conditions.
    • sortOrder - The sort order.

    Example: https://api.example.com/data?page={page}&pageSize={pageSize}

    This list can be extended by adding custom template variables to the templateVariables option.

    Settings

    On This Page

    Properties