GridApi

TypeScript
declare class GridApi<T = any> extends BaseApi
Extends

BaseApi

Methods

MethodDescription
getCellValue(cellPosition)
getCellValueFromRowData(columnId, rowData)
getPrimaryKeyField()Returns primaryKey value
getPrimaryKeyValue(rowData)
getRowDataByPrimaryKey(primaryKey)
setRowHeight(rowHeight)
setZebraStripes(zebraStripes)

Method Details

getCellValue

TypeScript
getCellValue(cellPosition: CellPosition): T | undefined;
Parameters
ParameterType
cellPositionCellPosition
Returns

T | undefined

getCellValueFromRowData

TypeScript
getCellValueFromRowData(columnId: string, rowData: any): any;
Parameters
ParameterType
columnIdstring
rowDataany
Returns

any

getPrimaryKeyField

Returns primaryKey value

TypeScript
getPrimaryKeyField(): string;
Returns

string

getPrimaryKeyValue

TypeScript
getPrimaryKeyValue(rowData: unknown): string | number | undefined;
Parameters
ParameterType
rowDataunknown
Returns

string | number | undefined

getRowDataByPrimaryKey

TypeScript
getRowDataByPrimaryKey(primaryKey: string): T | undefined;
Parameters
ParameterType
primaryKeystring
Returns

T | undefined

setRowHeight

TypeScript
setRowHeight(rowHeight: number): void;
Parameters
ParameterType
rowHeightnumber
Returns

void

setZebraStripes

TypeScript
setZebraStripes(zebraStripes: boolean): void;
Parameters
ParameterType
zebraStripesboolean
Returns

void