Row

Extends

• CoreRow<TData>.VisibilityRow<TData>.ColumnPinningRow<TData>.RowPinningRow.ColumnFiltersRow<TData>.GroupingRow.RowSelectionRow.ExpandedRow

Type Parameters

Type Parameter
TData extends RowData

Properties

Property	Type	Description	Inherited from
_getAllCellsByColumnId	() => Record<string, Cell<TData, unknown>>	-	CoreRow._getAllCellsByColumnId
_getAllVisibleCells	() => Cell<TData, unknown>[]	-	VisibilityRow._getAllVisibleCells
_groupingValuesCache	Record<string, any>	-	GroupingRow._groupingValuesCache
_uniqueValuesCache	Record<string, unknown>	-	CoreRow._uniqueValuesCache
_valuesCache	Record<string, unknown>	-	CoreRow._valuesCache
columnFilters	Record<string, boolean>	The column filters map for the row. This object tracks whether a row is passing/failing specific filters by their column ID. Link API Docs Link Guide	ColumnFiltersRow.columnFilters
columnFiltersMeta	Record<string, 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. Link API Docs Link Guide	ColumnFiltersRow.columnFiltersMeta
depth	number	The depth of the row (if nested or grouped) relative to the root row array. Link API Docs Link Guide	CoreRow.depth
getAllCells	() => Cell<TData, unknown>[]	Returns all of the cells for the row. Link API Docs Link Guide	CoreRow.getAllCells
getCanExpand	() => boolean	Returns whether the row can be expanded. Link API Docs Link Guide	ExpandedRow.getCanExpand
getCanMultiSelect	() => boolean	Returns whether or not the row can multi-select. Link API Docs Link Guide	RowSelectionRow.getCanMultiSelect
getCanPin	() => boolean	Returns whether or not the row can be pinned. Link API Docs Link Guide	RowPinningRow.getCanPin
getCanSelect	() => boolean	Returns whether or not the row can be selected. Link API Docs Link Guide	RowSelectionRow.getCanSelect
getCanSelectSubRows	() => boolean	Returns whether or not the row can select sub rows automatically when the parent row is selected. Link API Docs Link Guide	RowSelectionRow.getCanSelectSubRows
getCenterVisibleCells	() => Cell<TData, unknown>[]	Returns all center pinned (unpinned) leaf cells in the row. Link API Docs Link Guide	ColumnPinningRow.getCenterVisibleCells
getGroupingValue	(columnId: string) => unknown	Returns the grouping value for any row and column (including leaf rows). Link API Docs Link Guide	GroupingRow.getGroupingValue
getIsAllParentsExpanded	() => boolean	Returns whether all parent rows of the row are expanded. Link API Docs Link Guide	ExpandedRow.getIsAllParentsExpanded
getIsAllSubRowsSelected	() => boolean	Returns whether or not all of the row’s sub rows are selected. Link API Docs Link Guide	RowSelectionRow.getIsAllSubRowsSelected
getIsExpanded	() => boolean	Returns whether the row is expanded. Link API Docs Link Guide	ExpandedRow.getIsExpanded
getIsGrouped	() => boolean	Returns whether or not the row is currently grouped. Link API Docs Link Guide	GroupingRow.getIsGrouped
getIsPinned	() => RowPinningPosition	Returns the pinned position of the row. ('top', 'bottom' or false) Link API Docs Link Guide	RowPinningRow.getIsPinned
getIsSelected	() => boolean	Returns whether or not the row is selected. Link API Docs Link Guide	RowSelectionRow.getIsSelected
getIsSomeSelected	() => boolean	Returns whether or not some of the row’s sub rows are selected. Link API Docs Link Guide	RowSelectionRow.getIsSomeSelected
getLeafRows	() => Row<TData>[]	Returns the leaf rows for the row, not including any parent rows. Link API Docs Link Guide	CoreRow.getLeafRows
getLeftVisibleCells	() => Cell<TData, unknown>[]	Returns all left pinned leaf cells in the row. Link API Docs Link Guide	ColumnPinningRow.getLeftVisibleCells
getParentRow	() => Row<TData> | undefined	Returns the parent row for the row, if it exists. Link API Docs Link Guide	CoreRow.getParentRow
getParentRows	() => Row<TData>[]	Returns the parent rows for the row, all the way up to a root row. Link API Docs Link Guide	CoreRow.getParentRows
getPinnedIndex	() => number	Returns the numeric pinned index of the row within a pinned row group. Link API Docs Link Guide	RowPinningRow.getPinnedIndex
getRightVisibleCells	() => Cell<TData, unknown>[]	Returns all right pinned leaf cells in the row. Link API Docs Link Guide	ColumnPinningRow.getRightVisibleCells
getToggleExpandedHandler	() => () => void	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. Link API Docs Link Guide	ExpandedRow.getToggleExpandedHandler
getToggleSelectedHandler	() => (event: unknown) => void	Returns a handler that can be used to toggle the row. Link API Docs Link Guide	RowSelectionRow.getToggleSelectedHandler
getUniqueValues	<TValue>(columnId: string) => TValue[]	Returns a unique array of values from the row for a given columnId. Link API Docs Link Guide	CoreRow.getUniqueValues
getValue	<TValue>(columnId: string) => TValue	Returns the value from the row for a given columnId. Link API Docs Link Guide	CoreRow.getValue
getVisibleCells	() => Cell<TData, unknown>[]	Returns an array of cells that account for column visibility for the row. Link API Docs Link Guide	VisibilityRow.getVisibleCells
groupingColumnId?	string	If this row is grouped, this is the id of the column that this row is grouped by. Link API Docs Link Guide	GroupingRow.groupingColumnId
groupingValue?	unknown	If this row is grouped, this is the unique/shared value for the groupingColumnId for all of the rows in this group. Link API Docs Link Guide	GroupingRow.groupingValue
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). Link API Docs Link Guide	CoreRow.id
index	number	The index of the row within its parent array (or the root data array). Link API Docs Link Guide	CoreRow.index
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. Link API Docs Link Guide	CoreRow.original
originalSubRows?	TData[]	An array of the original subRows as returned by the options.getSubRows option. Link API Docs Link Guide	CoreRow.originalSubRows
parentId?	string	If nested, this row’s parent row id. Link API Docs Link Guide	CoreRow.parentId
pin	(position: RowPinningPosition, includeLeafRows?: boolean, includeParentRows?: boolean) => void	Pins a row to the 'top' or 'bottom', or unpins the row to the center if false is passed. Link API Docs Link Guide	RowPinningRow.pin
renderValue	<TValue>(columnId: string) => TValue	Renders the value for the row in a given columnId the same as getValue, but will return the renderFallbackValue if no value is found. Link API Docs Link Guide	CoreRow.renderValue
subRows	Row<TData>[]	An array of subRows for the row as returned and created by the options.getSubRows option. Link API Docs Link Guide	CoreRow.subRows
toggleExpanded	(expanded?: boolean) => void	Toggles the expanded state (or sets it if expanded is provided) for the row. Link API Docs Link Guide	ExpandedRow.toggleExpanded
toggleSelected	(value?: boolean, opts?: { selectChildren?: boolean; }) => void	Selects/deselects the row. Link API Docs Link Guide	RowSelectionRow.toggleSelected