GetChildRowsParams
Since v2.0.0
Parameters for fetching child rows of a parent node.
The context is opaque — provided by the requesting plugin and passed through
to the user’s getChildRows callback verbatim. Each plugin sets a source
discriminator so listeners can filter incoming child events.
Known context shapes:
- Tree:
{ source: 'tree', parentNode: TreeRow, nodePath: string[] } - GroupingRows:
{ source: 'grouping-rows', group: GroupDefinition, groupPath: string[] } - MasterDetail:
{ source: 'master-detail', row: TRow, rowIndex: number }
Child rows are fetched as a single batch — no pagination.
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
sortModel? | { field: string; direction: desc | asc }[] | Active sort columns, in priority order. Empty array when unsorted. |
filterModel? | Record<string, unknown> | Active filter model keyed by field name. Empty object when no filters are applied. |
context | { source: string } | Opaque context from the requesting plugin. Contains a source discriminator string and plugin-specific fields. ServerSide does not interpret this object. |
signal | AbortSignal | Cancellation signal for the request. Aborted when: - the requesting plugin supersedes the request (TreePlugin: the parent row was replaced by a refetch and the replacement rendered before the children arrived) - the plugin detaches or the grid disconnects v3.9.2+ |
Property Details
Section titled “Property Details”signal
Section titled “signal”Cancellation signal for the request. Aborted when:
- the requesting plugin supersedes the request (TreePlugin: the parent row was replaced by a refetch and the replacement rendered before the children arrived)
- the plugin detaches or the grid disconnects
A result for an aborted request is discarded. Pass it to fetch(url, { signal })
to cancel the HTTP request; data sources that ignore it keep working.