table-core/io.github.tanstacktable.core/ColumnDef

ColumnDef

class ColumnDef<TData, TValue>

Definition of a column. Carries the identifier (id/header), the accessor (accessorKey or accessorFn), nested columns for group columns, plus the feature-specific configuration (enableSorting, filterFn, size, ...). All fields are nullable; which fields you set determines what kind of column you build.

Constructors

constructor()

Types

object Companion

Properties

var accessorFn: AccessorFn<TData, TValue>?

Accessor function — non-null on accessor-fn columns.

var accessorKey: String?

Accessor key. Non-null on accessor-key columns. May be a dot-separated path ("user.address.city"); the path is resolved at runtime.

var aggregatedCell: ColumnDefTemplate?

Aggregated-cell template — used to render grouped/aggregated cells.

var aggregationFn: AggregationFnOption<TData>?

Aggregation fn for this column — see AggregationFnOption.

var cell: ColumnDefTemplate?

Cell template — a string or a (CellContext) -> Any? renderer.

var columns: List<ColumnDef<TData, Any?>>?

Child column defs — non-null on group columns.

enableColumnFilter

var enableColumnFilter: Boolean?

enableGlobalFilter

var enableGlobalFilter: Boolean?

var enableGrouping: Boolean?

var enableHiding: Boolean?

enableMultiSort

var enableMultiSort: Boolean?

var enablePinning: Boolean?

var enableResizing: Boolean?

var enableSorting: Boolean?

var filterFn: FilterFnOption<TData>?

Filter fn for this column — see FilterFnOption.

var footer: ColumnDefTemplate?

Footer template — a string or a (HeaderContext) -> Any? renderer.

getGroupingValue

var getGroupingValue: (row: TData) -> Any??

Returns the grouping key for a row. Defaults to the cell value when omitted.

getUniqueValues

var getUniqueValues: AccessorFn<TData, List<Any?>>?

Per-column override for getUniqueValues.

var header: StringOrTemplateHeader?

Header template — a string or a (HeaderContext) -> Any? renderer.

var id: String?

Explicit column id. Required for display columns; for accessor-key columns it defaults to accessorKey when omitted.

var invertSorting: Boolean?

var maxSize: Double?

Maximum size in pixels. Defaults to the platform max-safe integer.

var meta: ColumnMeta<TData, TValue>?

Caller-supplied per-column metadata.

var minSize: Double?

Minimum size in pixels.

var size: Double?

Preferred size in pixels.

var sortDescFirst: Boolean?

var sortingFn: SortingFnOption<TData>?

Sort fn for this column — see SortingFnOption.

var sortUndefined: Any?

How null/undefined values are sorted. One of false, -1, 1, "first" or "last". Typed as Any? because Kotlin cannot express this mixed union directly.