API REFERENCE
addCellComment
Adds a cell comment in an active collaboration session and returns its ID or null.
What does this API do?
Adds a cell comment in an active collaboration session and returns its ID or null.
API for Pro features: Cell notes editing
Exact input and result types
addCellComment(rowId: string | number, field: string, text: string, parentId?: string): Promise<string | null>| Arguments | Required | Type |
|---|---|---|
| rowId | Required | string | number |
| field | Required | string |
| text | Required | string |
| parentId | Optional | string |
The return type is Promise<string | null>.
Usage flow
After registering and initializing the Grid element, call grid.addCellComment(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
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.