API REFERENCE

deleteCellComment

Deletes a collaboration comment and returns success.

What does this API do?

Deletes a collaboration comment and returns success.

API for Pro features: Cell notes editing

Exact input and result types

typescript
deleteCellComment(rowId: string | number, field: string, commentId: string): Promise<boolean>
ArgumentsRequiredType
rowIdRequiredstring | number
fieldRequiredstring
commentIdRequiredstring

The return type is Promise<boolean>.

Usage flow

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

Feature explanations and examples