kotlin-tanstack-table-core/tanstack.table.core/GroupingOptionsBase

GroupingOptionsBase

external interface GroupingOptionsBase<TData : RowData>(source)

Inheritors

GroupingOptions

Properties

enableGrouping

abstract var enableGrouping: Boolean?

Enables/disables grouping for the table. API Docs Guide

getGroupedRowModel

abstract var getGroupedRowModel: (table: Table<TData>) -> () -> RowModel<TData>?

Returns the row model after grouping has taken place, but no further. API Docs Guide

groupedColumnMode

abstract var groupedColumnMode: GroupingColumnMode?

Grouping columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here. API Docs Guide

manualGrouping

abstract var manualGrouping: Boolean?

Enables manual grouping. If this option is set to true, the table will not automatically group rows using getGroupedRowModel() and instead will expect you to manually group the rows before passing them to the table. This is useful if you are doing server-side grouping and aggregation. API Docs Guide

onGroupingChange

abstract var onGroupingChange: OnChangeFn<GroupingState>?

If this function is provided, it will be called when the grouping state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the tableOptions.state.grouping option. API Docs Guide