Interface UseServerDataSourceOptions<T>

Options for useServerDataSource.

interface UseServerDataSourceOptions<T> {
    dataSource: HxDataSource<T>;
    filterModel: FilterModelMap;
    maxCachedBlocks?: number;
    onError?: (error: unknown) => void;
    page: number;
    pageSize: number;
    sortModel: SortModelItem[];
}

Type Parameters

T
The row type.

Index

Properties

dataSource filterModel maxCachedBlocks? onError? page pageSize sortModel

Properties

dataSource

dataSource: HxDataSource<T>

Where rows come from. Memoise it, or every render refetches.

filterModel

filterModel: FilterModelMap

Active filters, keyed by column id.

`Optional`maxCachedBlocks

maxCachedBlocks?: number

Blocks to keep around so paging back and forth does not refetch.

Default Value

`Optional`onError

onError?: (error: unknown) => void

Called when a fetch throws. Aborted requests are not reported.

page

page: number

Zero-based page index.

pageSize

pageSize: number

Rows per page.

sortModel

sortModel: SortModelItem[]

Active sorts, primary first.