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.

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

    Template variables to be replaced in the urlTemplate.

    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