Cell notes PRO
Connect cell comments and resolution status.
Identify notes by row ID and column name, and provide storage for reading, adding, updating, and deleting them.
View code
Sample data included in the code · 6 rows
Usage guide
#Leave a review note on an order amount or share questions and resolution status for a cell.
Integration steps
- Prepare note storage
Identify notes by row ID and column name, and provide storage for reading, adding, updating, and deleting them.
- Connect an adapter
Connect Grid note operations to storage through cellNotesAdapter. Check note versions when multiple people edit.
- Verify writing and reloading
Write a cell note in your app, reopen the view, and read it again. Also inspect results when saving fails or another user changes it.
Save cell-related feedback to read later or manage resolution state through the appropriate workflow.
The sample table has no note storage connected. Enabling notes does not automatically create local or collaboration storage.
Useful terms
- adapter
- An object connecting Grid operations to a real storage API.
- revision
- A version value distinguishing concurrent note edits.
Using this feature in your product requires the Pro runtime and a valid license.
API reference
#Other properties2
| Attribute / Property | Type / Default | Description |
|---|---|---|
PRO cellNotes | booleanDefault: false | Standalone notes for uniquely identified, readable cells (Grid Pro). |
PRO cellNotesAdapter | GridCellNotesAdapterDefault: undefined | Atomic revision-aware persistence; no implicit local or collaboration storage. |
Events2
| Events | Detail type | Description |
|---|---|---|
PRO | { rowId: string; field: string; comments: GridCellComment[] } | Fires when a cell's comment thread changes, local or remote . |
PRO | { rowId: string; field: string; comment: GridCellComment } | Fires when a newly-arrived comment |
Methods6
| Method / Arguments | Return type | Description |
|---|---|---|
PRO rowId: string | number, field: string | Promise<void> | Open the comment thread panel for a cell (also Shift+F2 on the active cell). |
PRO | Promise<void> | Close the comment thread panel. |
PRO rowId: string | number, field: string, text: string, parentId?: string | Promise<string | null> | Add a comment to a cell's thread (Pro, requires an active collaboration session). Returns the comment id, or null when unavailable. |
PRO rowId: string | number, field: string | Promise<GridCellComment[]> | A cell's comment thread, ordered by creation time. |
PRO rowId: string | number, field: string, commentId: string, resolved: boolean | Promise<boolean> | Mark a comment resolved/unresolved. False when the comment is unknown. |
PRO rowId: string | number, field: string, commentId: string | Promise<boolean> | Delete a comment (CRDT tombstone — removed on every replica). |
Explore each feature
Learn when to use each feature and how to configure it. Each guide identifies live examples and features you connect in your app.