DataSource Props

Specifies the functions to use for aggregating data. The object is a map where the keys are ids for aggregations and values are object of the shape described below.

The delay in milliseconds to wait before mutations are applied. This is useful to batch multiple mutations together.

Specifies the data the component is bound to.

Uncontrolled prop used for filtering. Can be used for both client-side and server-side filtering.

The uncontrolled prop for managing row enabled/disabled state. For the controlled version see rowDisabledState. For listening to row disabled state changes, see onRowDisabledStateChange.

Describes the selected row(s) in the DataSource

Information for sorting the data. This is an uncontrolled prop.

Specifies the expand/collapse state of the tree nodes. See TreeExpandStateValue for the shape of this object. For the controlled version, see treeExpandState.

Determines what nodes are selected and deselected. For the controlled version see treeSelection.

The delay in milliseconds before the filter is applied. This is useful when you want to wait for the user to finish typing before applying the filter.

A function to be used for client-side filtering.

Explicitly configures where filtering will take place. Update to use the shouldReloadData.filterValue prop.

Specifies the available types of filters for the columns.

A custom React component to be used as an editor for the current filter type

Controlled prop used for filtering. Can be used for both client-side and server-side filtering.

An array of objects with field properties, that control how rows are being grouped.

An object that configures how the column for the current group should look like

Decides if the current (non-leaf) node is collapsed. See related treeExpandState prop.

Decides if the current (non-leaf) node is expanded.

Decides if the current (non-leaf) node can be expanded or collapsed and if the tree icon is disabled.

This function ultimately decides the disabled state of a row. It overrides both defaultRowDisabledState/rowDisabledState props.

Whether the datasource will load data lazily - useful for server-side grouping and pivoting. If set to true or to an object (with batchSize property), the data prop must be a function that returns a promise.

Whether the component should use live pagination.

A cursor value for live pagination. A good value for this is the id of the last item in the data array. It can also be defined as a function

The name of the property in the data object that contains the child nodes for each tree node.

A function to be called when the cellSelection changes.

Callback prop to be called when the data changes via the DataSource API.

A function to be called when data-related state changes.

Callback prop called when the filterValue changes.

A function to be called when the livePaginationCursor changes.

Called when a node is collapsed. See related onNodeExpand and onTreeExpandStateChange props.

Called when a node is expanded. See related onNodeCollapse and onTreeExpandStateChange props.

The callback that is called when the DataSource is ready. The dataSourceApi is passed as the first argument.

Called when the row disabled state changes.

A function to be called when the rowSelection changes.

Called when sorting changes on the DataSource.

Called when the tree expand state changes.

Called when the tree selection changes. See treeSelection.

An array of objects with field properties that control how pivoting works. Pivoting is very often associated with aggregations, so see related aggregationReducers for more details.

The name of the id/primary key property of an item in the data array. The value of this property needs to be unique.

A value that can be used to trigger a re-fetch of the data.

Manages row enabled/disabled state. For the uncontrolled version see defaultRowDisabledState. For listening to row disabled state changes, see onRowDisabledStateChange.

Describes the selected row(s) in the DataSource

Specifies the type of selection that should be enabled.

Specifies which changes in the data-related props should trigger a reload of the data source - applicable when data is a function.

Explicitly configures where filtering will take place and if changes in the filterValue should trigger a reload of the data source - applicable when data is a function. Replaces the deprecated filterMode

Specifies if changes in the sortInfo should trigger a reload of the data source - applicable when data is a function. Replaces the deprecated sortMode.

Custom sorting function to replace the multisort function used by default.

Information for sorting the data. This is a controlled prop.

Specifies where the sorting should be done. Use shouldReloadData.sortInfo instead.

Describes the available sorting functions used for local sorting. The object you provide will be merged into the default sort types.

Specifies the expand/collapse state of the tree nodes. See TreeExpandStateValue for the shape of this object. For the uncontrolled version, see defaultTreeExpandState.

A function to be used for filtering a TreeDataSource.

Determines what nodes are selected and deselected. For the uncontrolled version see defaultTreeSelection.

Specifies whether rowSelection contains group keys or only row ids/primary keys.