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

Row

A row in the table. Integer-typed depth / index use Int; values read through getValue / getUniqueValues / renderValue are typed Any? because Kotlin cannot carry the original <TValue> per-call type argument.

Constructors

Row

constructor()

Properties

_getAllCellsByColumnId

lateinit var _getAllCellsByColumnId: () -> Map<String, Cell<TData, Any?>>

Returns this row's cells indexed by column id.

_getAllVisibleCells

lateinit var _getAllVisibleCells: () -> List<Cell<TData, Any?>>

Returns every cell on this row whose column is visible.

_groupingValuesCache

var _groupingValuesCache: MutableMap<String, Any?>

Internal cache backing aggregated getValue lookups. Mutated by key.

_uniqueValuesCache

var _uniqueValuesCache: MutableMap<String, Any?>

Internal cache backing getUniqueValues. Mutated by key.

_valuesCache

var _valuesCache: MutableMap<String, Any?>

Internal cache backing getValue. Mutated by key.

columnFilters

var columnFilters: MutableMap<String, Boolean>

Per-column-filter pass/fail flags. Mutated by the filtering pipeline.

columnFiltersMeta

var columnFiltersMeta: MutableMap<String, FilterMeta>

Per-column-filter caller-supplied metadata. Mutated by filter fns.

depth

var depth: Int

Nesting depth (0 for top-level rows).

getAllCells

lateinit var getAllCells: () -> List<Cell<TData, Any?>>

Returns every cell on this row in column order.

getCanExpand

lateinit var getCanExpand: () -> Boolean

True when this row can be expanded.

getCanMultiSelect

lateinit var getCanMultiSelect: () -> Boolean

True when multi-select is allowed for this row.

getCanPin

lateinit var getCanPin: () -> Boolean

True when this row can be pinned.

getCanSelect

lateinit var getCanSelect: () -> Boolean

True when this row can be selected at all.

getCanSelectSubRows

lateinit var getCanSelectSubRows: () -> Boolean

True when this row's sub-rows can be selected.

getCenterVisibleCells

lateinit var getCenterVisibleCells: () -> List<Cell<TData, Any?>>

Returns the visible cells in the center (unpinned) section.

getGroupingValue

lateinit var getGroupingValue: (columnId: String) -> Any?

Returns the grouping key for columnId on this row.

getIsAllParentsExpanded

lateinit var getIsAllParentsExpanded: () -> Boolean

True when every ancestor up to the root is expanded.

getIsAllSubRowsSelected

lateinit var getIsAllSubRowsSelected: () -> Boolean

True when every sub-row of this row is selected.

getIsExpanded

lateinit var getIsExpanded: () -> Boolean

True when this row is currently expanded.

getIsGrouped

lateinit var getIsGrouped: () -> Boolean

True when this row is a grouping parent (synthesised during grouping).

getIsPinned

lateinit var getIsPinned: () -> RowPinningPosition

Returns the row's current pinned position.

getIsSelected

lateinit var getIsSelected: () -> Boolean

True when this row is currently selected.

getIsSomeSelected

lateinit var getIsSomeSelected: () -> Boolean

True when some, but not all, of this row's sub-rows are selected.

getLeafRows

lateinit var getLeafRows: () -> List<Row<TData>>

Returns every leaf descendant of this row (flattened).

getLeftVisibleCells

lateinit var getLeftVisibleCells: () -> List<Cell<TData, Any?>>

Returns the visible cells in the left-pinned section.

getParentRow

lateinit var getParentRow: () -> Row<TData>?

Returns the parent row, or null when this is a root row.

getParentRows

lateinit var getParentRows: () -> List<Row<TData>>

Returns every ancestor row from root down to the immediate parent.

getPinnedIndex

lateinit var getPinnedIndex: () -> Int

Index of this row within its pinned group.

getRightVisibleCells

lateinit var getRightVisibleCells: () -> List<Cell<TData, Any?>>

Returns the visible cells in the right-pinned section.

getToggleExpandedHandler

lateinit var getToggleExpandedHandler: () -> () -> Unit

Returns a click handler that toggles expansion for this row.

getToggleSelectedHandler

lateinit var getToggleSelectedHandler: () -> (event: Any?) -> Unit

Returns an event handler that toggles this row's selection from a checkbox-style event target. The event parameter is platform-specific.

getUniqueValues

lateinit var getUniqueValues: (columnId: String) -> List<Any?>

Returns the column-keyed unique values for columnId.

getValue

lateinit var getValue: (columnId: String) -> Any?

Returns the raw value at columnId for this row.

getVisibleCells

lateinit var getVisibleCells: () -> List<Cell<TData, Any?>>

Returns the visible cells (left + center + right pinned sections).

groupingColumnId

var groupingColumnId: String?

Column id that produced this group (non-null on grouped parent rows).

groupingValue

var groupingValue: Any?

Grouping value that produced this group (non-null on grouped parent rows).

lateinit var id: String

Stable row id.

index

var index: Int

Index of this row within its parent's sub-rows (or top-level rows).

leafRows

var leafRows: List<Row<TData>>?

Leaf rows under this group, populated by getGroupedRowModel. Null for non-grouped rows.

original

var original: TData

The original data record this row was built from. Set by createRow at construction time; the null-backed default is never observed.

originalSubRows

var originalSubRows: List<TData>?

Original (unfiltered) sub-row data, when known.

parentId

var parentId: String?

Parent row id, or null when this is a root row.

lateinit var pin: (RowPinningPosition, includeLeafRows: Boolean?, includeParentRows: Boolean?) -> Unit

Pin this row to position, optionally pinning its leaves/parents too.

position

var position: String?

Pinned-position tag attached to rows produced by the RowPinning feature's _getPinnedRows. null for unpinned rows; otherwise "top" or "bottom".

renderValue

lateinit var renderValue: (columnId: String) -> Any?

Returns the value at columnId, falling back to renderFallbackValue when null.

subRows

var subRows: List<Row<TData>>

Sub-rows in their current order; may be re-sorted/filtered by row-model builders.

toggleExpanded

lateinit var toggleExpanded: (expanded: Boolean?) -> Unit

Sets the expanded state; pass null to toggle.

toggleSelected

lateinit var toggleSelected: (value: Boolean?, opts: RowSelectionToggleOpts?) -> Unit

Toggles selection. Pass null for value to flip the current state; use RowSelectionToggleOpts to control whether sub-rows are also toggled.

Functions

shallowCopy

fun shallowCopy(): Row<TData>

Returns a shallow copy of this row. The copy carries every property by reference (function members close over the original row); the caller is free to overwrite specific fields (such as position or subRows) on the returned instance.