DataTable/io.github.stephenwanjala.datatable/DataTableLayout

DataTableLayout

@Immutable

data class DataTableLayout(val columnWidths: Map<String, Dp> = emptyMap(), val hiddenColumns: Set<String> = emptySet(), val columnOrder: List<String> = emptyList(), val sortBy: SortState = SortState(), val multiSortBy: List<SortState> = emptyList(), val filters: Map<String, String> = emptyMap())(source)

A snapshot of how a user has arranged a table: column widths, which columns they hid, the order they put them in, the sort they left it under, and the filters they typed.

Everything a user changes about a grid is here, and nothing about the data is — a layout is keyed entirely by DataTableHeader.key, so it survives the rows being replaced, and can be saved against a user rather than against a query.

Capture one with DataTableState.captureLayout and put it back with DataTableState.applyLayout. To store it between sessions, either use encodeToString, or map these fields onto your own serializable type — they are all plain data, and Dp is a Float in dp behind Dp.value.

A layout is applied by key, so one saved before a column was added, removed, or renamed still applies: entries naming columns that no longer exist are ignored, and columns the layout has never heard of keep their declared width and sit after the ones it names.

Constructors

DataTableLayout

constructor(columnWidths: Map<String, Dp> = emptyMap(), hiddenColumns: Set<String> = emptySet(), columnOrder: List<String> = emptyList(), sortBy: SortState = SortState(), multiSortBy: List<SortState> = emptyList(), filters: Map<String, String> = emptyMap())

Types

Companion

object Companion

Reads back what encodeToString wrote.

Properties

columnOrder

val columnOrder: List<String>

Column keys in the order the user put them. Columns missing from the list follow the ones in it, in declaration order — which is where a column added since the layout was saved appears.

columnWidths

val columnWidths: Map<String, Dp>

Widths the user dragged columns to. A column absent from the map keeps the width its header declares.

filters

val filters: Map<String, String>

Filter queries per column. Worth dropping — layout.copy(filters = emptyMap()) — where a saved layout should restore the shape of a table but not narrow what it shows.

hiddenColumns

val hiddenColumns: Set<String>

Columns the user hid. This adds to DataTableHeader.visible = false rather than overriding it: a column a caller declared unavailable stays unavailable however the layout was saved.

multiSortBy

val multiSortBy: List<SortState>

The multi-column sort in force, which takes precedence over sortBy.

sortBy

val sortBy: SortState

The single-column sort in force.

Functions

encodeToString

fun encodeToString(): String

Encodes this layout as one line-based string, for a preferences store, a database column, or a file.