Interface GridRowProApi

interface GridRowProApi {
    getRowGroupChildren: ((params: GridRowGroupChildrenGetterParams) => GridRowId[]);
    setRowChildrenExpansion: ((id: GridRowId, isExpanded: boolean) => void);
    setRowIndex: ((rowId: GridRowId, targetIndex: number) => void);
}

Hierarchy (view full)

GridRowProApi
- GridApiPro

Index

Properties

getRowGroupChildren setRowChildrenExpansion setRowIndex

Properties

getRowGroupChildren

getRowGroupChildren: ((params: GridRowGroupChildrenGetterParams) => GridRowId[])

Gets the rows of a grouping criteria. Only contains the rows provided to the grid, not the rows automatically generated by it.

Type declaration

- (params): GridRowId[]
- Parameters
  - params: GridRowGroupChildrenGetterParams
    Object containing parameters for the getter.
  Returns GridRowId[]
  The id of each row in the grouping criteria.

setRowChildrenExpansion

setRowChildrenExpansion: ((id: GridRowId, isExpanded: boolean) => void)

Expand or collapse a row children.

Type declaration

- (id, isExpanded): void
- Parameters
  - id: GridRowId
    the ID of the row to expand or collapse.
  - isExpanded: boolean
    A boolean indicating if the row must be expanded or collapsed.
  Returns void

setRowIndex

setRowIndex: ((rowId: GridRowId, targetIndex: number) => void)

Moves a row from its original position to the position given by targetIndex.

Type declaration

- (rowId, targetIndex): void
- Parameters
  - rowId: GridRowId
    The row id
  - targetIndex: number
    The new position (0-based).
  Returns void