SortingColumn

external interface SortingColumn<TData : RowData>(source)

Inheritors

Properties

Link copied to clipboard
abstract val clearSorting: () -> Unit

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

Link copied to clipboard
abstract val getAutoSortDir: () -> SortDirection

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

Link copied to clipboard
abstract val getAutoSortingFn: () -> SortingFn<TData>

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

Link copied to clipboard
abstract val getCanMultiSort: () -> Boolean

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

Link copied to clipboard
abstract val getCanSort: () -> Boolean

Returns whether this column can be sorted. API Docs Guide

Link copied to clipboard
abstract val getFirstSortDir: () -> SortDirection

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

Link copied to clipboard
abstract val getIsSorted: () -> SortDirection?

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

Link copied to clipboard
abstract val getNextSortingOrder: () -> SortDirection?

Returns the next sorting order. API Docs Guide

Link copied to clipboard
abstract val getSortIndex: () -> Int

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

Link copied to clipboard
abstract val getSortingFn: () -> SortingFn<TData>

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

Link copied to clipboard
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

Link copied to clipboard
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