Column

The resolved accessor function to use when extracting the value for the column from each row. Will only be defined if the column def has a valid accessor key or function defined. API Docs Guide

Removes this column from the table's sorting state API Docs Guide

The original column def used to create the column. API Docs Guide

The child column (if the column is a group column). Will be an empty array if the column is not a group column. API Docs Guide

The depth of the column (if grouped) relative to the root column def array. API Docs Guide

Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all succeeding (right) headers in relation to the current column.

Returns the aggregation function for the column. API Docs Guide

Returns the automatically inferred aggregation function for the column. API Docs Guide

Returns an automatically calculated filter function for the column based off of the columns first known value. API Docs Guide

Returns a sort direction automatically inferred based on the columns values. API Docs Guide

Returns a sorting function automatically inferred based on the columns values. API Docs Guide

Returns whether or not the column can be column filtered. API Docs Guide

Returns whether or not the column can be globally filtered. Set to false to disable a column from being scanned during global filtering. API Docs Guide

Returns whether or not the column can be grouped. API Docs Guide

Returns whether the column can be hidden API Docs Guide

Returns whether this column can be multi-sorted. API Docs Guide

Returns whether or not the column can be pinned. API Docs Guide

Returns true if the column can be resized. API Docs Guide

Returns whether this column can be sorted. API Docs Guide

A function that computes and returns a min/max tuple derived from column.getFacetedRowModel. Useful for displaying faceted result values.

Returns the row model with all other column filters applied, excluding its own filter. Useful for displaying faceted result counts.

A function that computes and returns a Map of unique values and their occurrences derived from column.getFacetedRowModel. Useful for displaying faceted result values.

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

Returns the index (including -1) of the column filter in the table's state.columnFilters array. API Docs Guide

Returns the current filter value for the column. API Docs Guide

Returns the first direction that should be used when sorting this column. API Docs Guide

Returns the flattened array of this column and all child/grand-child columns for this column. API Docs Guide

Returns the index of the column in the grouping state. API Docs Guide

Returns the index of the column in the order of the visible columns. Optionally pass a position parameter to get the index of the column in a sub-section of the table API Docs Guide

Returns whether or not the column is currently filtered. API Docs Guide

Returns true if the column is the first column in the order of the visible columns. Optionally pass a position parameter to check if the column is the first in a sub-section of the table. API Docs Guide

Returns whether or not the column is currently grouped. API Docs Guide

Returns true if the column is the last column in the order of the visible columns. Optionally pass a position parameter to check if the column is the last in a sub-section of the table. API Docs Guide

Returns the pinned position of the column. ('left', 'right' or false) API Docs Guide

Returns true if the column is currently being resized. API Docs Guide

Returns the current sort direction of this column. API Docs Guide

Returns whether the column is visible API Docs Guide

Returns an array of all leaf-node columns for this column. If a column has no children, it is considered the only leaf-node column. API Docs Guide

Returns the next sorting order. API Docs Guide

Returns the numeric pinned index of the column within a pinned column group. API Docs Guide

Returns the current size of the column. API Docs Guide

Returns the index position of this column's sorting within the sorting state API Docs Guide

Returns the resolved sorting function to be used for this column API Docs Guide

Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding (left) headers in relation to the current column. API Docs Guide

Returns a function that toggles the grouping state of the column. This is useful for passing to the onClick prop of a button. API Docs Guide

Returns a function that can be used to toggle this column's sorting state. This is useful for attaching a click handler to the column header. API Docs Guide

Returns a function that can be used to toggle the column visibility. This function can be used to bind to an event handler to a checkbox. API Docs Guide

The resolved unique identifier for the column resolved in this priority:

The parent column for this column. Will be undefined if this is a root column. API Docs Guide

Pins a column to the 'left' or 'right', or unpins the column to the center if false is passed. API Docs Guide

Resets the column to its initial size. API Docs Guide

A function that sets the current filter value for the column. You can pass it a value or an updater function for immutability-safe operations on existing values. API Docs Guide

Toggles the grouping state of the column. API Docs Guide

Toggles this columns sorting state. If desc is provided, it will force the sort direction to that value. If isMulti is provided, it will additivity multi-sort the column (or toggle it if it is already sorted). API Docs Guide

Toggles the visibility of the column. API Docs Guide