Comments

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.

getComment

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.

getCommentAtCell

Source code

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

Gets comment from a cell at the provided coordinates.

Param	Type	Description
row	`number`	Visual row index.
column	`number`	Visual column index.

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

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.

Param	Type	Default	Description
[force]	`boolean`	`false`	`optional` If `true` then recalculation will be forced.

removeComment

Source code

comments.removeComment([forceRender])

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

Param	Type	Default	Description
[forceRender]	`boolean`	`true`	`optional` If set to `true`, the table will be re-rendered at the end of the operation.

removeCommentAtCell

Source code

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

Removes a comment from a specified cell.

Param	Type	Default	Description
row	`number`		Visual row index.
column	`number`		Visual column index.
[forceRender]	`boolean`	`true`	`optional` If `true`, the table will be re-rendered at the end of the operation.

setComment

Source code

comments.setComment(value)

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

Param	Type	Description
value	`string`	Comment contents.

setCommentAtCell

Source code

comments.setCommentAtCell(row, column, value)

Sets a comment for a specified cell.

Param	Type	Description
row	`number`	Visual row index.
column	`number`	Visual column index.
value	`string`	Comment contents.

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.

Param	Type	Description
range	`object`	Object with `from` property, each with `row` and `col` properties.

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.

Param	Type	Description
row	`number`	Visual row index.
column	`number`	Visual column index.

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

updateCommentMeta

Source code

comments.updateCommentMeta(row, column, metaObject)

Sets or update the comment-related cell meta.

Param	Type	Description
row	`number`	Visual row index.
column	`number`	Visual column index.
metaObject	`object`	Object defining all the comment-related meta information.

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