Comments Technical Reference
Summary
- Comment Options allows developers to configure which Cells can receive Comments
- Comment API provides run time access to Comments
Comment State
There is no Comment State due to the collaborative nature of comments.
Instead Comment Threads are stored using the functions provided in Comment Options.
Comment Options
The Comment Options section of Adaptable Options contains properties used to configure Comments:
| Property | Type | Description | Default |
|---|---|---|---|
| dateFormat | string | (() => string) | Date Format string for Comments timestamp | 'dd-MM-yyyy HH:mm:ss' |
| isCellCommentable | (commentableCellContext:CommentableCellContext) => boolean | Function to configure if a cell can contain Comments | |
| showCommentAction | 'hover' | 'menu' | Whether to show Comments by hovering (default) or via context menu | 'hover' |
| showPopupCloseButton | boolean | Show the Close Button in the Comments Popup | true |
Loading and Saving Comments
Comment Options contains 2 functions which developers must provide in order to load and save Comments:
| Method | Returns | Description |
|---|---|---|
| loadCommentThreads(commentLoadContext) | Promise<CommentThread[]> | Loads the Comment Threads |
| persistCommentThreads(commentThreads) | Promise<void> | Persists the current Comment Threads |
Comment Changed Event
The Comment Changed Event fires whenever a Comment changes.
CommentChangedInfo
The event comprises a single CommentChangeInfo object which provides all the current Comment Threads.
| Property | Type | Description |
|---|---|---|
| commentThreads | CommentThread[] | All current Comment Threads |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
Event Subscription
Subscribing to the Event is done the same way as with all Adaptable Events:
api.eventApi.on('CommentChanged', (eventInfo: CommentChangedInfo) => {
// do something with the info
});Comment API
Full programmatic access to Comments is available in Comment API section of Adaptable API.
| Method | Returns | Description |
|---|---|---|
| addComment(commentText, cellAddress) | void | Add a Comment to a Comment Thread |
| addCommentThread(commentThread) | void | Create a new Comment Thread |
| clearComments() | void | Clear all Comment Threads in the grid |
| deleteComment(comment, cellAddress) | void | Delete a Comment |
| deleteCommentThread(cellAddress) | void | Delete all Comments for a particular cell |
| editComment(comment, cellAddress) | void | Edit a Comment |
| getAllComments() | CommentThread[] | Return all Comment Threads in the grid |
| getCommentThreadForCell(cellAddress) | CommentThread | undefined | Return the Comment Thread for a particular cell |
| hideCommentsPopup() | void | Close the Comment Popup |
| setComments(commentThreads) | void | Sets the Comment Threads in the grid |