Column

A column in the table. Integer-typed depth, getIndex, getPinnedIndex, getSortIndex, getGroupedIndex and getFilterIndex use Int; sizing values (getSize, getStart, getAfter) use Double because resize math can produce fractional pixel values.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

Internal min/max-values getter, populated when getFacetedMinMaxValues is configured.

Link copied to clipboard

Internal faceted row-model getter, populated when getFacetedRowModel is configured.

Link copied to clipboard

Internal unique-values getter, populated when getFacetedUniqueValues is configured.

Link copied to clipboard

Accessor function — present on accessor-fn columns; null otherwise.

Link copied to clipboard
lateinit var clearSorting: () -> Unit

Clears any sorting on this column.

Link copied to clipboard

The ColumnDef this column was built from.

Link copied to clipboard

Direct child columns. Set to [] by createColumn and overwritten by getAllColumns's recurseColumns with the resolved children.

Link copied to clipboard
var depth: Int

Nesting level: 0 for a root column.

Link copied to clipboard
lateinit var getAfter: (position: Any?) -> Double

Returns this column's end offset for the given position.

Link copied to clipboard
lateinit var getAggregationFn: () -> AggregationFn<TData>?

Returns the active aggregation fn for this column, or null when none.

Link copied to clipboard

Returns the inferred aggregation fn for this column, or null when none.

Link copied to clipboard
lateinit var getAutoFilterFn: () -> FilterFn<TData>?

Returns the inferred filter fn for this column, or null when none can be inferred.

Link copied to clipboard
lateinit var getAutoSortDir: () -> SortDirection

Returns the inferred sort direction for this column.

Link copied to clipboard
lateinit var getAutoSortingFn: () -> SortingFn<TData>

Returns the inferred sort function for this column.

Link copied to clipboard
lateinit var getCanFilter: () -> Boolean

True when this column can be filtered.

Link copied to clipboard
lateinit var getCanGlobalFilter: () -> Boolean

True when this column participates in global filtering.

Link copied to clipboard
lateinit var getCanGroup: () -> Boolean

True when this column can be grouped.

Link copied to clipboard
lateinit var getCanHide: () -> Boolean

True when this column can be hidden.

Link copied to clipboard
lateinit var getCanMultiSort: () -> Boolean

True when this column can participate in multi-sort.

Link copied to clipboard
lateinit var getCanPin: () -> Boolean

True when this column can be pinned.

Link copied to clipboard
lateinit var getCanResize: () -> Boolean

True when this column can be resized.

Link copied to clipboard
lateinit var getCanSort: () -> Boolean

True when this column can be sorted.

Link copied to clipboard
lateinit var getFacetedMinMaxValues: () -> Pair<Double, Double>?

Returns the (min, max) of this column's faceted values, or null when none.

Link copied to clipboard
lateinit var getFacetedRowModel: () -> RowModel<TData>

Returns the row model for this column's facets.

Link copied to clipboard
lateinit var getFacetedUniqueValues: () -> Map<Any?, Int>

Returns a value -> count map of this column's facets.

Link copied to clipboard
lateinit var getFilterFn: () -> FilterFn<TData>?

Returns the active filter fn for this column, or null when unfiltered.

Link copied to clipboard
lateinit var getFilterIndex: () -> Int

Index of this column in the column-filters state, or -1 when absent.

Link copied to clipboard
lateinit var getFilterValue: () -> Any?

Returns the current filter value for this column.

Link copied to clipboard
lateinit var getFirstSortDir: () -> SortDirection

Returns the direction this column will sort in first.

Link copied to clipboard
lateinit var getFlatColumns: () -> List<Column<TData, TValue>>

Returns this column flattened (this column plus all descendants).

Link copied to clipboard
lateinit var getGroupedIndex: () -> Int

Index of this column in the grouping state, or -1 when absent.

Link copied to clipboard
lateinit var getIndex: (position: Any?) -> Int

Position-aware column index. position is one of ColumnPinningPosition, the string "center", or null for the unpinned/centered index.

Link copied to clipboard
lateinit var getIsFiltered: () -> Boolean

True when this column is currently filtered.

Link copied to clipboard
lateinit var getIsFirstColumn: (position: Any?) -> Boolean

True when this column is the first column at position.

Link copied to clipboard
lateinit var getIsGrouped: () -> Boolean

True when this column is currently grouped.

Link copied to clipboard
lateinit var getIsLastColumn: (position: Any?) -> Boolean

True when this column is the last column at position.

Link copied to clipboard

The column's current pinned position.

Link copied to clipboard
lateinit var getIsResizing: () -> Boolean

True when this column is currently being resized.

Link copied to clipboard
lateinit var getIsSorted: () -> Any?

Returns the current sort state: either false (unsorted) or a SortDirection. Typed as Any? because the runtime union cannot be expressed directly in Kotlin.

Link copied to clipboard
lateinit var getIsVisible: () -> Boolean

True when this column is currently visible.

Link copied to clipboard
lateinit var getLeafColumns: () -> List<Column<TData, TValue>>

Returns the leaf descendants of this column.

Link copied to clipboard
lateinit var getNextSortingOrder: (multi: Boolean?) -> Any?

Returns the next sort direction in the sort cycle: either a SortDirection or false. Typed as Any? for the same reason as getIsSorted.

Link copied to clipboard
lateinit var getPinnedIndex: () -> Int

Index of this column within its pinned group.

Link copied to clipboard
lateinit var getSize: () -> Double

Returns the column's current rendered size in pixels.

Link copied to clipboard
lateinit var getSortIndex: () -> Int

Index of this column in the sorting state, or -1 when absent.

Link copied to clipboard
lateinit var getSortingFn: () -> SortingFn<TData>

Returns the active sort function for this column.

Link copied to clipboard
lateinit var getStart: (position: Any?) -> Double

Returns this column's start offset for the given position.

Link copied to clipboard
lateinit var getToggleGroupingHandler: () -> () -> Unit

Returns a click handler that toggles grouping for this column.

Link copied to clipboard
lateinit var getToggleSortingHandler: () -> (event: Any?) -> Unit?

Returns a header click handler that toggles sorting, or null when the column cannot be sorted. The event parameter is platform-specific.

Link copied to clipboard
lateinit var getToggleVisibilityHandler: () -> (event: Any?) -> Unit

Returns a checkbox-style event handler that toggles visibility from event.target.checked. The event parameter is platform-specific; here it is Any?.

Link copied to clipboard
lateinit var id: String

Stable column id.

Link copied to clipboard

The parent column, or null for a root column.

Link copied to clipboard
lateinit var pin: (ColumnPinningPosition) -> Unit

Pin this column to the given position.

Link copied to clipboard
lateinit var resetSize: () -> Unit

Resets this column's size to its default.

Link copied to clipboard
lateinit var setFilterValue: (Updater) -> Unit

Updates this column's filter value via an Updater.

Link copied to clipboard
lateinit var toggleGrouping: () -> Unit

Toggles grouping for this column.

Link copied to clipboard
lateinit var toggleSorting: (desc: Boolean?, isMulti: Boolean?) -> Unit

Toggles sorting; pass desc/null to set/clear desc and isMulti for multi-sort.

Link copied to clipboard
lateinit var toggleVisibility: (value: Boolean?) -> Unit

Sets visibility; pass null to toggle.