comments: true
```.

or an object with extra predefined plugin config:

```js
comments: {
  displayDelay: 1000
}
```.

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

const hot = new Handsontable(document.getElementById('example'), {
  data: getData(),
  comments: true,
  cell: [
    {row: 1, col: 1, comment: {value: 'Foo'}},
    {row: 2, col: 2, comment: {value: 'Bar'}}
  ]
});

// Access to the Comments plugin instance:
const commentsPlugin = hot.getPlugin('comments');

// Manage comments programmatically:
commentsPlugin.setCommentAtCell(1, 6, 'Comment contents');
commentsPlugin.showAtCell(1, 6);
commentsPlugin.removeCommentAtCell(1, 6);

// You can also set range once and use proper methods:
commentsPlugin.setRange({from: {row: 1, col: 6}});
commentsPlugin.setComment('Comment contents');
commentsPlugin.show();
commentsPlugin.removeComment();

Members

rangeobject

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

Methods

Source code

clearRange()

Clears the currently selected cell.

Source code

destroy()

Destroys the plugin instance.

Source code

disablePlugin()

Disables the plugin functionality for this Handsontable instance.

Source code

enablePlugin()

Enables the plugin functionality for this Handsontable instance.

Source code

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

getCommentAtCell(row, column){string|undefined}

Gets comment from a cell at the provided coordinates.

Parameters:

Name	Type	Description
row	number	Visual row index.
column	number	Visual column index.

Returns: {string|undefined} Returns a content of the comment.

Source code

getCommentMeta(row, column, property){Mixed}

Gets the comment related meta information.

Parameters:

Name	Type	Description
row	number	Visual row index.
column	number	Visual column index.
property	string	Cell meta property.

Returns: {Mixed}

Source code

hide()

Hides the comment editor.

Source code

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 than the Comments#enablePlugin method is called.

Returns: {boolean}

Source code

refreshEditor(force)

Refreshes comment editor position and styling.

Parameters:

Name	Type	Default	Description
force	boolean	false	optional If true then recalculation will be forced.

Source code

removeComment(forceRender)

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

Parameters:

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

Source code

removeCommentAtCell(row, column, forceRender)

Removes a comment from a specified cell.

Parameters:

Name	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.

Source code

setComment(value)

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

Parameters:

Name	Type	Description
value	string	Comment contents.

Source code

setCommentAtCell(row, column, value)

Sets a comment for a specified cell.

Parameters:

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

Source code

setRange(range)

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

Parameters:

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

Source code

show(){boolean}

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

Returns: {boolean} Returns true if comment editor was shown.

Source code

showAtCell(row, column){boolean}

Shows comment editor according to cell coordinates.

Parameters:

Name	Type	Description
row	number	Visual row index.
column	number	Visual column index.

Returns: {boolean} Returns true if comment editor was shown.

Source code

updateCommentMeta(row, column, metaObject)

Sets or update the comment-related cell meta.

Parameters:

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

Source code

updatePlugin()

Updates the plugin state. This method is executed when Core#updateSettings is invoked.