Row Instance

Accessed via table.getRowModel().rows or table.getRow(id).

Properties

PropertyTypeDescription
idstringUnique row identifier
indexnumberRow index in the current array
originalTDataThe original data object
depthnumberNesting depth (0 for top-level)
parentIdstring | undefinedParent row ID (tree data)
subRowsRow[]Child rows (tree data)
groupingColumnIdstring | undefinedColumn ID this row groups by
groupingValueunknownGroup key value

Value Access

MethodReturnDescription
getValue<TValue>(columnId)TValueGet the typed value for a column
renderValue<TValue>(columnId)TValueGet render-ready value

Cell Access

MethodReturnDescription
getAllCells()Cell[]All cells in this row
getVisibleCells()Cell[]Visible cells only
getLeftVisibleCells()Cell[]Left-pinned visible cells
getRightVisibleCells()Cell[]Right-pinned visible cells
getCenterVisibleCells()Cell[]Unpinned visible cells

Selection

MethodReturnDescription
getIsSelected()booleanIs this row selected?
getIsSomeSelected()booleanSome sub-rows selected?
getIsAllSubRowsSelected()booleanAll sub-rows selected?
getCanSelect()booleanCan this row be selected?
getCanMultiSelect()booleanCan participate in multi-select?
getCanSelectSubRows()booleanCan sub-rows be auto-selected?
toggleSelected(value?, opts?)voidSelect/deselect this row
getToggleSelectedHandler()(event) => voidEvent handler for selection toggle

Expanding

MethodReturnDescription
getIsExpanded()booleanIs this row expanded?
getCanExpand()booleanCan this row be expanded?
getIsGrouped()booleanIs this a group row?
toggleExpanded(expanded?)voidToggle expansion
getToggleExpandedHandler()(event) => voidEvent handler for expand toggle

Pinning

MethodReturnDescription
getIsPinned()RowPinningPosition | false'top', 'bottom', or false
getCanPin()booleanCan this row be pinned?
pin(position, includeLeaf?, includeParent?)voidPin to 'top', 'bottom', or unpin

Grouping

MethodReturnDescription
getGroupingValue(columnId)unknownGet the grouping value for a column
getLeafRows()Row[]Get all leaf rows under this group