API REFERENCE

getCellComments

Reads collaboration comments associated with a row ID and field.

What does this API do?

Reads collaboration comments associated with a row ID and field.

API for Pro features: Cell notes editing

Exact input and result types

typescript

getCellComments(rowId: string | number, field: string): Promise<GridCellComment[]>

Arguments	Required	Type
rowId	Required	string \| number
field	Required	string

The return type is Promise<GridCellComment[]>.

Usage flow

After registering and initializing the Grid element, call grid.getCellComments(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Read related types

GridCellComment

Feature explanations and examples

Cell notes
Cell notes add review context or explanations without changing the value. Standalone notes and collaboration comment threads use different storage and APIs, so choose the appropriate workflow first.