Infinite Table API
When rendering the
InfiniteTable
component, you can get access to the API by getting it from the onReady
callback prop.const onReady = ( {api, dataSourceApi}: { api: InfiniteTableApi<DATA_TYPE>, dataSourceApi: 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 } <InfiniteTable<DATA_TYPE> columns={[...]} onReady={onReady}
COPY
For API on row/group selection, see the Selection API page.
See the Infinite Table Cell Selection API page for the cell selection API. See the Infinite Table Column API page for the column API. See the Infinite Table Keyboard Navigation API page for the keyboard navigation API.
See the Infinite Table Row Details API page for the row detail API (when master-detail is configured). See the Tree API page for the tree API (when using the
<TreeDataSource />
component).cancelEdit
() => void
cellSelectionApi
InfiniteTableCellSelectionApi
clearColumnFilter
(columnId: string) => void
collapseGroupRow
(groupKeys: any[]) => boolean
confirmEdit
(value?: any) => void
expandGroupRow
(groupKeys: any[]) => boolean
getCellValue
({columnId, rowIndex?, primaryKey? }) => any
getCellValues
({columnId, rowIndex?, primaryKey? }) => ({value, rawValue, formattedValue })
getColumnApi
(colIdOrIndex: string|number) => InfiniteTableColumnAPI
getSortingForColumn
(columnId: string)=> 1|-1|null
getVerticalRenderRange
() => { renderStartIndex, renderEndIndex }
hideContextMenu
() => void
onReady
({ api, dataSourceApi }) => void
rejectEdit
(error: Error) => void
rowDetailApi
InfiniteTableRowDetailApi
rowSelectionApi
InfiniteTableRowSelectionApi
scrollCellIntoView
(rowIndex: number; colIdOrIndex: string | number) => boolean
scrollColumnIntoView
(colId: string) => boolean
scrollLeft
getter<number>|setter<number>
scrollRowIntoView
(rowIndex: number) => boolean
scrollTop
getter<number>|setter<number>
setColumnFilter
(columnId: string, value: any) =>void
setColumnOrder
(columnIds: string[] | true) => void
setSortingForColumn
(columnId: string, dir: 1|-1|null) => void
startEdit
({ rowIndex, columnId }) => Promise<boolean>
toggleGroupRow
(groupKeys: any[]) => void
toggleSortingForColumn
(columnId: string, options?) => void