kotlin-tanstack-table-core/tanstack.table.core/Column

Column

external interface Column<TData : RowData, TValue> : CoreColumn<TData, TValue> , VisibilityColumn, ColumnPinningColumn, FacetedColumn<TData> , ColumnFiltersColumn<TData> , GlobalFilterColumn, SortingColumn<TData> , GroupingColumn<TData> , ColumnSizingColumn, ColumnOrderColumn(source)

Properties

accessorFn

abstract val accessorFn: AccessorFn<TData, TValue>?

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

clearSorting

abstract val clearSorting: () -> Unit

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

columnDef

abstract val columnDef: ColumnDef<TData, TValue>

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

columns

abstract val columns: <Error class: unknown class><Column<TData, TValue>>

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

depth

abstract val depth: Int

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

getAfter

abstract val getAfter: (position: ColumnOrderPosition?) -> Int

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.

getAggregationFn

abstract val getAggregationFn: () -> AggregationFn<TData>

Returns the aggregation function for the column. API Docs Guide

getAutoAggregationFn

abstract val getAutoAggregationFn: () -> AggregationFn<TData>

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

getAutoFilterFn

abstract val getAutoFilterFn: () -> FilterFn<TData>

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

getAutoSortDir

abstract val getAutoSortDir: () -> SortDirection

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

getAutoSortingFn

abstract val getAutoSortingFn: () -> SortingFn<TData>

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

getCanFilter

abstract val getCanFilter: () -> Boolean

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

getCanGlobalFilter

abstract val getCanGlobalFilter: () -> Boolean

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

getCanGroup

abstract val getCanGroup: () -> Boolean

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

getCanHide

abstract val getCanHide: () -> Boolean

Returns whether the column can be hidden API Docs Guide

getCanMultiSort

abstract val getCanMultiSort: () -> Boolean

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

getCanPin

abstract val getCanPin: () -> Boolean

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

getCanResize

abstract val getCanResize: () -> Boolean

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

getCanSort

abstract val getCanSort: () -> Boolean

Returns whether this column can be sorted. API Docs Guide

getFacetedMinMaxValues

abstract val getFacetedMinMaxValues: () -> <Error class: unknown class><Int, Int>?

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

getFacetedRowModel

abstract val getFacetedRowModel: () -> RowModel<TData>

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

getFacetedUniqueValues

abstract val getFacetedUniqueValues: () -> <Error class: unknown class><Any, Int>

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

getFilterFn

abstract val getFilterFn: () -> FilterFn<TData>

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

getFilterIndex

abstract val getFilterIndex: () -> Int

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

getFilterValue

abstract val getFilterValue: () -> Any

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

getFirstSortDir

abstract val getFirstSortDir: () -> SortDirection

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

getFlatColumns

abstract val getFlatColumns: () -> <Error class: unknown class><Column<TData, TValue>>

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

getGroupedIndex

abstract val getGroupedIndex: () -> Int

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

getIndex

abstract val getIndex: (position: ColumnOrderPosition?) -> Int

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

getIsFiltered

abstract val getIsFiltered: () -> Boolean

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

getIsFirstColumn

abstract val getIsFirstColumn: (position: ColumnOrderPosition?) -> Boolean

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

getIsGrouped

abstract val getIsGrouped: () -> Boolean

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

getIsLastColumn

abstract val getIsLastColumn: (position: ColumnOrderPosition?) -> Boolean

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

getIsPinned

abstract val getIsPinned: () -> ColumnPinningPosition

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

getIsResizing

abstract val getIsResizing: () -> Boolean

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

getIsSorted

abstract val getIsSorted: () -> SortDirection?

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

getIsVisible

abstract val getIsVisible: () -> Boolean

Returns whether the column is visible API Docs Guide

getLeafColumns

abstract val getLeafColumns: () -> <Error class: unknown class><Column<TData, TValue>>

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

getNextSortingOrder

abstract val getNextSortingOrder: () -> SortDirection?

Returns the next sorting order. API Docs Guide

getPinnedIndex

abstract val getPinnedIndex: () -> Int

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

getSize

abstract val getSize: () -> Int

Returns the current size of the column. API Docs Guide

getSortIndex

abstract val getSortIndex: () -> Int

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

getSortingFn

abstract val getSortingFn: () -> SortingFn<TData>

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

getStart

abstract val getStart: (position: ColumnOrderPosition?) -> Int

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

getToggleGroupingHandler

abstract val getToggleGroupingHandler: () -> () -> Unit

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

getToggleSortingHandler

abstract val getToggleSortingHandler: () -> (event: Any) -> Unit?

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

getToggleVisibilityHandler

abstract val getToggleVisibilityHandler: () -> (event: Any) -> Unit

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

abstract val id: String

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

parent

abstract val parent: Column<TData, TValue>?

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

abstract val pin: (position: ColumnPinningPosition) -> Unit

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

resetSize

abstract val resetSize: () -> Unit

Resets the column to its initial size. API Docs Guide

setFilterValue

abstract val setFilterValue: (updater: Updater<*>) -> Unit

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

toggleGrouping

abstract val toggleGrouping: () -> Unit

Toggles the grouping state of the column. API Docs Guide

toggleSorting

abstract val toggleSorting: (desc: Boolean?, isMulti: Boolean?) -> Unit

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

toggleVisibility

abstract val toggleVisibility: (value: Boolean?) -> Unit

Toggles the visibility of the column. API Docs Guide