Table

Sets the page index to 0. API Docs Guide

Returns all columns in the table in their normalized and nested hierarchy. API Docs Guide

Returns all columns in the table flattened to a single level. API Docs Guide

Returns all leaf-node columns in the table flattened to a single level. This does not include parent columns. API Docs Guide

Returns all bottom pinned rows. API Docs Guide

Returns whether the table can go to the next page. API Docs Guide

Returns whether the table can go to the previous page. API Docs Guide

Returns whether there are any rows that can be expanded. API Docs Guide

If pinning, returns headers for all columns that are not pinned, including parent headers. API Docs Guide

If pinning, returns the footer groups for columns that are not pinned. API Docs Guide

If pinning, returns the header groups for columns that are not pinned. API Docs Guide

Returns all center pinned (unpinned) leaf columns. API Docs Guide

If pinning, returns headers for all columns that are not pinned, (not including parent headers). API Docs Guide

Returns all rows that are not pinned to the top or bottom. API Docs Guide

If pinning, returns the total size of the center portion of the table by calculating the sum of the sizes of all unpinned/center leaf-columns. API Docs Guide

If column pinning, returns a flat array of leaf-node columns that are visible in the unpinned/center portion of the table. API Docs Guide

Returns a single column by its ID. API Docs Guide

Returns the core row model before any processing has been applied. API Docs Guide

Returns the maximum depth of the expanded rows. API Docs Guide

Returns the row model after expansion has been applied. API Docs Guide

Returns the row model for the table after column filtering has been applied. API Docs Guide

Returns the row model of all rows that are selected after filtering has been applied. API Docs Guide

Returns headers for all columns in the table, including parent headers. API Docs Guide

Returns the footer groups for the table. API Docs Guide

Currently, this function returns the built-in includesString filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided. API Docs Guide

Currently, this function returns the built-in includesString filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided. API Docs Guide

Returns the row model for the table after global filtering has been applied. API Docs Guide

Returns the faceted unique values for the global filter. API Docs Guide

Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter. API Docs Guide

Returns the row model for the table after grouping has been applied. API Docs Guide

Returns the row model of all rows that are selected after grouping has been applied. API Docs Guide

Returns all header groups for the table. API Docs Guide

Returns whether all columns are visible API Docs Guide

Returns whether or not all rows on the current page are selected. API Docs Guide

Returns whether all rows are currently expanded. API Docs Guide

Returns whether or not all rows in the table are selected. API Docs Guide

Returns whether or not any columns are pinned. Optionally specify to only check for pinned columns in either the left or right position. API Docs Guide

Returns whether any columns are visible API Docs Guide

Returns whether or not any rows on the current page are selected. API Docs Guide

Returns whether there are any rows that are currently expanded. API Docs Guide

Returns whether or not any rows are pinned. Optionally specify to only check for pinned rows in either the top or bottom position. API Docs Guide

Returns whether or not any rows in the table are selected. API Docs Guide

Returns headers for all leaf columns in the table, (not including parent headers). API Docs Guide

If pinning, returns headers for all left pinned columns in the table, including parent headers. API Docs Guide

If pinning, returns the footer groups for the left pinned columns. API Docs Guide

If pinning, returns the header groups for the left pinned columns. API Docs Guide

Returns all left pinned leaf columns. API Docs Guide

If pinning, returns headers for all left pinned leaf columns in the table, (not including parent headers). API Docs Guide

Returns the total size of the left portion of the table by calculating the sum of the sizes of all left leaf-columns. API Docs Guide

If column pinning, returns a flat array of leaf-node columns that are visible in the left portion of the table. API Docs Guide

Returns the page count. If manually paginating or controlling the pagination state, this will come directly from the options.pageCount table option, otherwise it will be calculated from the table data using the total row count and current page size. API Docs Guide

Returns an array of page options (zero-index-based) for the current page size. API Docs Guide

Returns the row model for the table after pagination has been applied. API Docs Guide

Returns the row model before expansion has been applied. API Docs Guide

Returns the row model for the table before any column filtering has been applied. API Docs Guide

Returns the row model for the table before any grouping has been applied. API Docs Guide

Returns the row model for the table before any pagination has been applied. API Docs Guide

Returns the core row model of all rows before row selection has been applied. API Docs Guide

Returns the row model for the table before any sorting has been applied. API Docs Guide

If pinning, returns headers for all right pinned columns in the table, including parent headers. API Docs Guide

If pinning, returns the footer groups for the right pinned columns. API Docs Guide

If pinning, returns the header groups for the right pinned columns. API Docs Guide

Returns all right pinned leaf columns. API Docs Guide

If pinning, returns headers for all right pinned leaf columns in the table, (not including parent headers). API Docs Guide

Returns the total size of the right portion of the table by calculating the sum of the sizes of all right leaf-columns. API Docs Guide

If column pinning, returns a flat array of leaf-node columns that are visible in the right portion of the table. API Docs Guide

Returns the row with the given ID. API Docs Guide

Returns the row count. If manually paginating or controlling the pagination state, this will come directly from the options.rowCount table option, otherwise it will be calculated from the table data. API Docs Guide

Returns the final model after all processing from other used features has been applied. This is the row model that is most commonly used for rendering. API Docs Guide

Returns the row model of all rows that are selected. API Docs Guide

Returns the row model for the table after sorting has been applied. API Docs Guide

Call this function to get the table's current state. It's recommended to use this function and its state, especially when managing the table state manually. It is the exact same state used internally by the table for every feature and function it provides. API Docs Guide

Returns a handler for toggling the visibility of all columns, meant to be bound to a input[type=checkbox] element. API Docs Guide

Returns a handler that can be used to toggle all rows on the current page. API Docs Guide

Returns a handler that can be used to toggle the expanded state of all rows. This handler is meant to be used with an input[type=checkbox] element. API Docs Guide

Returns a handler that can be used to toggle all rows in the table. API Docs Guide

Returns all top pinned rows. API Docs Guide

Returns the total size of the table by calculating the sum of the sizes of all leaf-columns. API Docs Guide

Returns a flat array of columns that are visible, including parent columns. API Docs Guide

Returns a flat array of leaf-node columns that are visible. API Docs Guide

This is the resolved initial state of the table. API Docs Guide

Sets the page index to the last page. API Docs Guide

Increments the page index by one, if possible. API Docs Guide

A read-only reference to the table's current options. API Docs Guide

Decrements the page index by one, if possible. API Docs Guide

Call this function to reset the table state to the initial state. API Docs Guide

Resets the columnFilters state to initialState.columnFilters, or true can be passed to force a default blank state reset to []. API Docs Guide

Resets the columnOrder state to initialState.columnOrder, or true can be passed to force a default blank state reset to []. API Docs Guide

Resets the columnPinning state to initialState.columnPinning, or true can be passed to force a default blank state reset to { left: [], right: [], }. API Docs Guide

Resets column sizing to its initial state. If defaultState is true, the default state for the table will be used instead of the initialValue provided to the table. API Docs Guide

Resets the column visibility state to the initial state. If defaultState is provided, the state will be reset to {} API Docs Guide

Resets the expanded state of the table to the initial state. API Docs Guide

Resets the globalFilter state to initialState.globalFilter, or true can be passed to force a default blank state reset to undefined. API Docs Guide

Resets the grouping state to initialState.grouping, or true can be passed to force a default blank state reset to []. API Docs Guide

Resets column sizing info to its initial state. If defaultState is true, the default state for the table will be used instead of the initialValue provided to the table. API Docs Guide

Resets the page index to its initial state. If defaultState is true, the page index will be reset to 0 regardless of initial state. API Docs Guide

Resets the page size to its initial state. If defaultState is true, the page size will be reset to 10 regardless of initial state. API Docs Guide

Resets the pagination state to initialState.pagination, or true can be passed to force a default blank state reset to []. API Docs Guide

Resets the rowPinning state to initialState.rowPinning, or true can be passed to force a default blank state reset to { top: [], bottom: [], }. API Docs Guide

Resets the rowSelection state to the initialState.rowSelection, or true can be passed to force a default blank state reset to {}. API Docs Guide

Resets the sorting state to initialState.sorting, or true can be passed to force a default blank state reset to []. API Docs Guide

Sets or updates the state.columnFilters state. API Docs Guide

Sets or updates the state.columnOrder state. API Docs Guide

Sets or updates the state.columnPinning state. API Docs Guide

Sets the column sizing state using an updater function or a value. This will trigger the underlying onColumnSizingChange function if one is passed to the table options, otherwise the state will be managed automatically by the table. API Docs Guide

Sets the column sizing info state using an updater function or a value. This will trigger the underlying onColumnSizingInfoChange function if one is passed to the table options, otherwise the state will be managed automatically by the table. API Docs Guide

Sets or updates the state.columnVisibility state. API Docs Guide

Updates the expanded state of the table via an update function or value. API Docs Guide

Sets or updates the state.globalFilter state. API Docs Guide

Updates the grouping state of the table via an update function or value. API Docs Guide

This function can be used to update the table options. API Docs Guide

Updates the page index using the provided function or value in the state.pagination.pageIndex state. API Docs Guide

Updates the page size using the provided function or value in the state.pagination.pageSize state. API Docs Guide

Sets or updates the state.pagination state. API Docs Guide

Sets or updates the state.rowPinning state. API Docs Guide

Sets or updates the state.rowSelection state. API Docs Guide

Sets or updates the state.sorting state. API Docs Guide

Call this function to update the table state. API Docs Guide

Toggles the visibility of all columns. API Docs Guide

Selects/deselects all rows on the current page. API Docs Guide

Toggles the expanded state for all rows. API Docs Guide

Selects/deselects all rows in the table. API Docs Guide