DataSource API
When rendering the DataSource
component, you can get access to the API by getting it from the onReady
callback prop.
<DataSource<DATA_TYPE>
onReady={(api: DataSourceApi<DATA_TYPE>) => {
// api is accessible here
// you may want to store a reference to it in a ref or somewhere in your app state
}}
You can also get it from the InfiniteTable
onReady
callback prop:
<InfiniteTable<DATA_TYPE>
columns={[...]}
onReady={(
{api, dataSourceApi}: {
api: InfiniteTableApi<DATA_TYPE>,
dataSourceApi: DataSourceApi<DATAT_TYPE>
}) => {
// both api and dataSourceApi are accessible here
}}
/>
For API on row/group selection, see the Selection API page.
addData
Adds the specified data at the end of the data source.
addDataArray
Adds an array of data at the end of the data source
clearAllData
Clears all data in the DataSource.
getDataByNodePath
Retrieves the data object for the specified node path.
getDataByNodePath
Retrieves the data object for the node with the specified path. If the node is not found, returns null
. See related getDataByIndex
. See related getRowInfoByNodePath
.
getDataByPrimaryKey
Retrieves the data object for the specified primary key.
getIndexByPrimaryKey
Retrieves the index of a row by its primary key. If the row is not found, returns -1
. See related getPrimaryKeyByIndex
getOriginalDataArray
Returns the data array that was last loaded by the DataSource
getPrimaryKeyByIndex
Retrieves the primary key of a row by its current index. If the row is not found, returns undefined
. See related getIndexByPrimaryKey
getRowInfoArray
Returns the current row info array. See the type definition of the row info object.
getRowInfoByIndex
Retrieves the row info object for the row at the specified index. If none found, returns null
. See related getRowInfoByPrimaryKey
.
getRowInfoByNodePath
Retrieves the row info object for the node with the specified path. If the node is not found, returns null
. See related getDataByNodePath
.
getRowInfoByPrimaryKey
Retrieves the row info object for the row with the specified primary key. If none found, returns null
.
insertData
Inserts the given data at the specified position relative to the given primary key.
insertDataArray
Inserts an array of data at the specified position (and relative to the given primary key).
isRowDisabled
Returns true
if the row with the specified primary key is disabled, false
otherwise.
isRowDisabledAt
Returns true
if the row at the specified index is disabled, false
otherwise.
onReady
Called only once, after the DataSource component has been mounted.
removeData
Removes the data item that matches the given data object.
removeDataArray
Removes the data items that match the given data objects.
removeDataArrayByPrimaryKeys
Removes the data items with the specified primary keys.
removeDataByNodePath
Removes the node specified by the specified node path.
removeDataByPrimaryKey
Removes the data item with the specified primary key.
replaceAllData
Replaces all data in the DataSource with the provided data.
setRowEnabled
Sets the enable/disable state for the row with the specified primary key.
setRowEnabledAt
Sets the enable/disable state for the row at the specified index.
treeApi
A reference to the Tree API.
updateData
Updates the data item to match the given data object. For updating tree nodes by path, see the updateDataByNodePath
method.
updateDataArray
Updates an array of data items to match the given data objects.
updateDataArrayByNodePath
Updates the data for the nodes specified by the node paths.
updateDataByNodePath
Updates the data for the node specified by the node path.