DataSource Props

In the API Reference below we'll use DATA_TYPE to refer to the TypeScript type that represents the data the component is bound to.

aggregationReducers

Record<string, DataSourceAggregationReducer>

batchOperationDelay

number

data

DATA_TYPE[]|Promise<DATA_TYPE[]|(params:DataSourceDataParams) => DATA_TYPE[]|Promise<DATA_TYPE[]>

defaultFilterValue

{field?, id?, filter: {type, operator, value}[]

defaultGroupRowsState

{collapsedRows:true|[][], expandedRows:true|[][]}

defaultRowDisabledState

{enabledRows,disabledRows}

defaultRowSelection

string|number|null|object

defaultSortInfo

DataSourceSingleSortInfo<T>|DataSourceSingleSortInfo<T>[]|null

defaultTreeExpandState

TreeExpandStateValue

defaultTreeSelection

TreeSelectionValue

filterDelay

Default: 200
number

filterFunction

({ data, dataArray, index, primaryKey }) => boolean

filterModedeprecated

'local'|'remote'

filterTypes

Record<string,{operators,emptyValues, defaultOperator}>

filterTypes.components.FilterEditor

filterValue

{field?, id?, filter: {type, operator, value}[]

groupBy

groupBy.column

Partial<InfiniteTableColumn<T>>

groupRowsState

{collapsedRows:true|[][], expandedRows:true|[][]}

isNodeCollapsed

(rowInfo: InfiniteTable_Tree_RowInfoParentNode<DATA_TYPE>, treeExpandState: TreeExpandState) => boolean

isNodeExpanded

(rowInfo: InfiniteTable_Tree_RowInfoParentNode<DATA_TYPE>, treeExpandState: TreeExpandState) => boolean

isNodeReadOnly

(rowInfo: InfiniteTable_Tree_RowInfoParentNode<DATA_TYPE>) => boolean

isRowDisabled

(rowInfo: InfiniteTableRowInfo<T>) => boolean

lazyLoad

Default: false
boolean|{batchSize:number}

livePagination

boolean

livePaginationCursor

string|number|((params) =>string|number)

nodesKey

string

onCellSelectionChange

(cellSelection, selectionMode='multi-cell') => void

onDataMutations

({ mutations, dataArray, primaryKeyField }) => void

onDataParamsChange

(dataParams: DataSourceDataParams<DATA_TYPE:>)=>void

onFilterValueChange

({field?, id?, filter: {type, operator, value}[]) => void

onGroupRowsStateChange

(state: GroupRowsState) => void

onLivePaginationCursorChange

(cursor)=> void

onNodeCollapse

(nodePath: NodePath, {dataSourceApi}) => void

onNodeExpand

(nodePath: NodePath, {dataSourceApi}) => void

onReady

(dataSourceApi: DataSourceApi<DATA_TYPE>) => void

onRowDisabledStateChange

(rowDisabledState) => void

onRowSelectionChange

(rowSelection, selectionMode='single-row'|'multi-row') => void

onSortInfoChange

(sortInfo | null) => void

onTreeExpandStateChange

(treeExpandState: TreeExpandStateValue, {dataSourceApi,nodePath, nodeState}) => void

onTreeSelectionChange

(treeSelection: TreeSelectionValue, context) => void

pivotBy

DataSourcePivotBy<DATA_TYPE>[]

primaryKey

string | (data: DATA_TYPE) => string

refetchKey

string|number|object

rowDisabledState

{enabledRows,disabledRows}

rowSelection

string|number|null|object

selectionMode

'single-row'|'multi-row'|'multi-cell'|false

shouldReloadData

{ sortInfo, groupBy, filterValue, pivotBy }

shouldReloadData.filterValue

boolean

shouldReloadData.sortInfo

boolean

sortFunction

(sortInfo:DataSourceSingleSortInfo<T>[], arr: T[]) => T[]

sortInfo

DataSourceSingleSortInfo<T>|DataSourceSingleSortInfo<T>[]|null

sortModedeprecated

'local'|'remote'

sortTypes

Record<string, ((a,b) => number)>

treeExpandState

TreeExpandStateValue

treeFilterFunction

({ data, filterTreeNode, primaryKey }) => DATA_TYPE | boolean

treeSelection

TreeSelectionValue

useGroupKeysForMultiRowSelection

Default: false
boolean