Description

This plugin allows setting and managing cell comments by either an option in the context menu or with the use of the API.

To enable the plugin, you'll need to set the comments property of the config object to true:

or an object with extra predefined plugin config:

To add comments at the table initialization, define the comment property in the cell config array as in an example below.

Example

Options

Source code

comments.comments : boolean | Array<object>

The comments option configures the Comments plugin.

You can set the comments option to one of the following:

If you set the comments option to an object, you can configure the following comment options:

Read more:

• Comments
• Context menu
• width
• height
• readOnly
• commentedCellClassName

Default: false
Example

Members

range

Source code

comments.range : object

Current cell range, an object with from property, with row and col properties (e.q. {from: {row: 1, col: 6}}).

Methods

clearRange

Source code

comments.clearRange()

Clears the currently selected cell.

destroy

Source code

comments.destroy()

Destroys the plugin instance.

disablePlugin

Source code

comments.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Source code

comments.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

focusEditor

Source code

comments.focusEditor()

Focuses the comments editor element.

Source code

comments.getComment() ⇒ string | undefined

Gets comment from a cell according to previously set range (see Comments#setRange).

Returns: string | undefined - Returns a content of the comment.

Source code

comments.getCommentAtCell(row, column) ⇒ string | undefined

Gets comment from a cell at the provided coordinates.

Returns: string | undefined - Returns a content of the comment.

Source code

comments.getCommentMeta(row, column, property) ⇒ Mixed

Gets the comment related meta information.

hide

Source code

comments.hide()

Hides the comment editor.

isEnabled

Source code

comments.isEnabled() ⇒ boolean

Checks if the plugin is enabled in the handsontable settings. This method is executed in Hooks#beforeInit hook and if it returns true then the Comments#enablePlugin method is called.

refreshEditor

Source code

comments.refreshEditor([force])

Refreshes comment editor position and styling.

Source code

comments.removeComment([forceRender])

Removes a comment from a cell according to previously set range (see Comments#setRange).

Source code

comments.removeCommentAtCell(row, column, [forceRender])

Removes a comment from a specified cell.

Source code

comments.setComment(value)

Sets a comment for a cell according to the previously set range (see Comments#setRange).

Source code

comments.setCommentAtCell(row, column, value)

Sets a comment for a specified cell.

setRange

Source code

comments.setRange(range)

Sets the current cell range to be able to use general methods like Comments#setComment, Comments#removeComment, Comments#show.

show

Source code

comments.show() ⇒ boolean

Shows the comment editor accordingly to the previously set range (see Comments#setRange).

Returns: boolean - Returns true if comment editor was shown.

showAtCell

Source code

comments.showAtCell(row, column) ⇒ boolean

Shows comment editor according to cell coordinates.

Returns: boolean - Returns true if comment editor was shown.

Source code

comments.updateCommentMeta(row, column, metaObject)

Sets or update the comment-related cell meta.

updatePlugin

Source code

comments.updatePlugin()

Updates the plugin's state.

This method is executed when updateSettings() is invoked with any of the following configuration options:

• comments