RowDataSourceControlled<T>

Represents a controlled data source in Graphite Grid, providing full control over how rows are rendered and displayed. Enables server-side data loading and bespoke data patterns.

Type parameters

Type parameter	Value
`T`	`unknown`

Properties

Name
getAllBranchIds?
Type
(params: object) => string[] | Promise<string[]>
Description
Returns all Ids of branch row nodes. Useful for supporting expand-all branches functionality.
Name
getAllBranchIdsAtDepth?
Type
(params: GetAllBranchIdsAtDepth<T>) => string[] | Promise<string[]>
Description
Returns all Ids of branch nodes at a particular depth. Useful for supporting branch expansions of pivots at a particular level.
Name
getAllChildrenIdsForRow?
Type
(rowId: string) => string[]
Description
Returns all child row Ids for a given row. Useful for supporting row selection of branch nodes where children should also be selected.
Name
getAllRowIds?
Type
() => Set<string>
Description
Returns all row Ids for the data set. Useful for supporting select-all functionality.
Name
getRowBottomCount?
Type
() => number
Description
Returns the count of rows pinned to the bottom of the grid.
Name
getRowById
Type
(rowId: string) => null | RowNode<T>
Description
Returns a row node given a row Id. May return null if the row node is not found.
Name
getRowCount
Type
() => number
Description
Returns the count of rows that are not pinned.
Name
getRowNode
Type
(params: GetRowNodeParams<T>) => RowNode<T>
Description
Returns a row node for a given index.
Name
getRowTopCount?
Type
() => number
Description
Returns the count of rows pinned to the top of the grid.
Name
init?
Type
(api: GraphiteGridApi<T>) => void
Description
Callback called once when the grid is ready.
Name
kind
Type
"controlled"
Description
The kind of the data source. Must be "controlled".
Name
refresh?
Type
(params: object) => void
Description
Refreshes the row data source. Causes Graphite Grid to recompute grid cells when grid state impacting the row data source changes.