kotlin-tanstack-table-core/tanstack.table.core/Row

Row

external interface Row<TData : RowData> : CoreRow<TData> , VisibilityRow<TData> , ColumnPinningRow<TData> , RowPinningRow, ColumnFiltersRow<TData> , GroupingRow, RowSelectionRow, ExpandedRow(source)

Properties

columnFilters

abstract val columnFilters: ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, kotlin/Boolean>

The column filters map for the row. This object tracks whether a row is passing/failing specific filters by their column ID. API Docs Guide

columnFiltersMeta

abstract val columnFiltersMeta: ERROR CLASS: Symbol not found for ReadonlyRecord<kotlin/String, tanstack/table/core/FilterMeta>

The column filters meta map for the row. This object tracks any filter meta for a row as optionally provided during the filtering process. API Docs Guide

depth

abstract val depth: Int

The depth of the row (if nested or grouped) relative to the root row array. API Docs Guide

getAllCells

abstract val getAllCells: () -> ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Cell<TData, *>>

Returns all of the cells for the row. API Docs Guide

getCanExpand

abstract val getCanExpand: () -> Boolean

Returns whether the row can be expanded. API Docs Guide

getCanMultiSelect

abstract val getCanMultiSelect: () -> Boolean

Returns whether or not the row can multi-select. API Docs Guide

getCanPin

abstract val getCanPin: () -> Boolean

Returns whether or not the row can be pinned. API Docs Guide

getCanSelect

abstract val getCanSelect: () -> Boolean

Returns whether or not the row can be selected. API Docs Guide

getCanSelectSubRows

abstract val getCanSelectSubRows: () -> Boolean

Returns whether or not the row can select sub rows automatically when the parent row is selected. API Docs Guide

getCenterVisibleCells

abstract val getCenterVisibleCells: () -> ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Cell<TData, *>>

Returns all center pinned (unpinned) leaf cells in the row. API Docs Guide

getGroupingValue

abstract val getGroupingValue: (columnId: String) -> Any

Returns the grouping value for any row and column (including leaf rows). API Docs Guide

getIsAllParentsExpanded

abstract val getIsAllParentsExpanded: () -> Boolean

Returns whether all parent rows of the row are expanded. API Docs Guide

getIsAllSubRowsSelected

abstract val getIsAllSubRowsSelected: () -> Boolean

Returns whether or not all of the row's sub rows are selected. API Docs Guide

getIsExpanded

abstract val getIsExpanded: () -> Boolean

Returns whether the row is expanded. API Docs Guide

getIsGrouped

abstract val getIsGrouped: () -> Boolean

Returns whether or not the row is currently grouped. API Docs Guide

getIsPinned

abstract val getIsPinned: () -> RowPinningPosition

Returns the pinned position of the row. ('top', 'bottom' or false) API Docs Guide

getIsSelected

abstract val getIsSelected: () -> Boolean

Returns whether or not the row is selected. API Docs Guide

getIsSomeSelected

abstract val getIsSomeSelected: () -> Boolean

Returns whether or not some of the row's sub rows are selected. API Docs Guide

getLeafRows

abstract val getLeafRows: () -> ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Row<TData>>

Returns the leaf rows for the row, not including any parent rows. API Docs Guide

getLeftVisibleCells

abstract val getLeftVisibleCells: () -> ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Cell<TData, *>>

Returns all left pinned leaf cells in the row. API Docs Guide

getParentRow

abstract val getParentRow: () -> Row<TData>

Returns the parent row for the row, if it exists. API Docs Guide

getParentRows

abstract val getParentRows: () -> ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Row<TData>>

Returns the parent rows for the row, all the way up to a root row. API Docs Guide

getPinnedIndex

abstract val getPinnedIndex: () -> Int

Returns the numeric pinned index of the row within a pinned row group. API Docs Guide

getRightVisibleCells

abstract val getRightVisibleCells: () -> ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Cell<TData, *>>

Returns all right pinned leaf cells in the row. API Docs Guide

getToggleExpandedHandler

abstract val getToggleExpandedHandler: () -> () -> Unit

Returns a function that can be used to toggle the expanded state of the row. This function can be used to bind to an event handler to a button. API Docs Guide

getToggleSelectedHandler

abstract val getToggleSelectedHandler: () -> (event: Any) -> Unit

Returns a handler that can be used to toggle the row. API Docs Guide

getUniqueValues

abstract val getUniqueValues: (columnId: String) -> ERROR CLASS: Symbol not found for ReadonlyArray<kotlin/Any?>

Returns a unique array of values from the row for a given columnId. API Docs Guide

getValue

abstract val getValue: (columnId: String) -> Any?

Returns the value from the row for a given columnId. API Docs Guide

getVisibleCells

abstract val getVisibleCells: () -> ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Cell<TData, *>>

Returns an array of cells that account for column visibility for the row. API Docs Guide

groupingColumnId

abstract val groupingColumnId: String?

If this row is grouped, this is the id of the column that this row is grouped by. API Docs Guide

groupingValue

abstract val groupingValue: Any?

If this row is grouped, this is the unique/shared value for the groupingColumnId for all of the rows in this group. API Docs Guide

abstract val id: String

The resolved unique identifier for the row resolved via the options.getRowId option. Defaults to the row's index (or relative index if it is a subRow). API Docs Guide

index

abstract val index: Int

The index of the row within its parent array (or the root data array). API Docs Guide

original

abstract val original: TData

The original row object provided to the table. If the row is a grouped row, the original row object will be the first original in the group. API Docs Guide

originalSubRows

abstract val originalSubRows: ERROR CLASS: Symbol not found for ReadonlyArray<TData>??

An array of the original subRows as returned by the options.getSubRows option. API Docs Guide

parentId

abstract val parentId: String?

If nested, this row's parent row id. API Docs Guide

abstract val pin: (position: RowPinningPosition, includeLeafRows: Boolean?, includeParentRows: Boolean?) -> Unit

Pins a row to the 'top' or 'bottom', or unpins the row to the center if false is passed. API Docs Guide

renderValue

abstract val renderValue: (columnId: String) -> Any?

Renders the value for the row in a given columnId the same as getValue, but will return the renderFallbackValue if no value is found. API Docs Guide

subRows

abstract val subRows: ERROR CLASS: Symbol not found for ReadonlyArray<tanstack/table/core/Row<TData>>

An array of subRows for the row as returned and created by the options.getSubRows option. API Docs Guide

toggleExpanded

abstract val toggleExpanded: (expanded: Boolean?) -> Unit

Toggles the expanded state (or sets it if expanded is provided) for the row. API Docs Guide

toggleSelected

abstract val toggleSelected: (value: Boolean?, opts: RowSelectionRow.ToggleSelectedOptions?) -> Unit

Selects/deselects the row. API Docs Guide