Documentation

Programmatic Control API

Take full control of your table with the programmatic API. Using tableRef, you can read and modify table state, apply filters and sorting, access data, and much more - all from your code. Perfect for building custom controls, implementing save/restore functionality, or creating advanced data workflows.

No status message

CodeSandbox

API Methods

The following methods are available on the tableRef for programmatic control of sorting and filtering.

Sorting and Filtering Methods

Property	Required	Description

`getSortState` () => SortColumn \| null	Optional	Returns the current sort state of the table. Returns null if no sorting is applied, or a SortColumn object containing the sorted column and direction. Useful for persisting table state, synchronizing with external state management, or implementing custom sort UI.
`applySortState` (props?: { accessor: Accessor; direction?: SortDirection }) => Promise<void>	Optional	Programmatically applies a sort state to the table. Pass a column accessor and optional direction to sort, or undefined to clear sorting. If direction is omitted, the sort cycles through: asc → desc → removed. This method is async and returns a Promise. Perfect for implementing custom sort controls or coordinating sorting with external data sources.
`getFilterState` () => TableFilterState	Optional	Returns the current filter state of the table as a TableFilterState object. The object contains all active filters keyed by unique filter IDs. Each filter includes the column accessor, operator, and values. Useful for debugging, persisting filter state, or building custom filter UI.
`applyFilter` (filter: FilterCondition) => Promise<void>	Optional	Programmatically applies a filter to a specific column. Accepts a FilterCondition object specifying the column accessor, filter operator, and value(s). This method is async and returns a Promise. Supports all filter operators including equals, contains, greaterThan, between, and more. Perfect for implementing custom filter UI, applying saved filters, or creating filter presets.
`clearFilter` (accessor: Accessor) => Promise<void>	Optional	Clears the filter for a specific column identified by its accessor. This method is async and returns a Promise. Only removes filters applied to the specified column, leaving other column filters intact. Useful for implementing 'clear filter' buttons on individual columns or resetting specific filters programmatically.
`clearAllFilters` () => Promise<void>	Optional	Clears all active filters from the table at once. This method is async and returns a Promise. Resets the table to show all data without any filtering applied. Perfect for 'reset all filters' buttons or starting fresh with filter state.