kotlin-tanstack-table-core/tanstack.table.core/AccessorKeyColumnDef

AccessorKeyColumnDef

external interface AccessorKeyColumnDef<TData : RowData, TValue> : AccessorKeyColumnDefBase<TData, TValue> , ColumnIdentifiers<TData, TValue> (source)

Inheritors

Properties

Link copied to clipboard
abstract external val accessorKey: String?
Link copied to clipboard
abstract external val aggregatedCell: ColumnDefTemplate<CellContext<TData, TValue>>?

The cell to display each row for the column if the cell is an aggregate. If a function is passed, it will be passed a props object with the context of the cell and should return the property type for your adapter (the exact type depends on the adapter being used). API Docs Guide

Link copied to clipboard
abstract external val aggregationFn: AggregationFnOption<TData>?

The resolved aggregation function for the column. API Docs Guide

Link copied to clipboard
abstract external val cell: ColumnDefTemplate<CellContext<TData, TValue>>?
Link copied to clipboard
abstract external val enableColumnFilter: Boolean?

Enables/disables the column filter for this column. API Docs Guide

Link copied to clipboard
abstract external val enableGlobalFilter: Boolean?

Enables/disables the global filter for this column. API Docs Guide

Link copied to clipboard
abstract external val enableGrouping: Boolean?

Enables/disables grouping for this column. API Docs Guide

Link copied to clipboard
abstract external val enableHiding: Boolean?
Link copied to clipboard
abstract external val enableMultiSort: Boolean?

Enables/Disables multi-sorting for this column. API Docs Guide

Link copied to clipboard
abstract external val enablePinning: Boolean?

Enables/disables column pinning for this column. Defaults to true. API Docs Guide

Link copied to clipboard
abstract external val enableResizing: Boolean?

Enables or disables column resizing for the column. API Docs Guide

Link copied to clipboard
abstract external val enableSorting: Boolean?

Enables/Disables sorting for this column. API Docs Guide

Link copied to clipboard
abstract external val filterFn: FilterFnOption<TData>?

The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function. API Docs Guide

Link copied to clipboard
abstract external val footer: ColumnDefTemplate<HeaderContext<TData, TValue>>?
Link copied to clipboard
abstract external val getGroupingValue: (row: TData) -> Any?

Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from accessorKey / accessorFn will be used instead. API Docs Guide

Link copied to clipboard
abstract external val getUniqueValues: AccessorFn<TData, ReadonlyArray<Any?>>?
Link copied to clipboard
abstract external val header: StringOrTemplateHeader<TData, TValue>?
Link copied to clipboard
abstract external val id: String?
Link copied to clipboard
abstract external val invertSorting: Boolean?

Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring API Docs Guide

Link copied to clipboard
abstract external val maxSize: Int?

The maximum allowed size for the column API Docs Guide

Link copied to clipboard
abstract external val meta: ColumnMeta<TData, TValue>?
Link copied to clipboard
abstract external val minSize: Int?

The minimum allowed size for the column API Docs Guide

Link copied to clipboard
abstract external val size: Int?

The desired size for the column API Docs Guide

Link copied to clipboard
abstract external val sortDescFirst: Boolean?

Set to true for sorting toggles on this column to start in the descending direction. API Docs Guide

Link copied to clipboard
abstract external val sortingFn: SortingFnOption<TData>?

The sorting function to use with this column.

Link copied to clipboard
abstract external val sortUndefined: Comparable<*>?

The priority of undefined values when sorting this column.

Generated by Dokka
© 2026 Copyright