Class: Comments

Comments

plugins/comments/comments.js#L78

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:

comments: true

or an object with extra predefined plugin config:

comments: {
  displayDelay: 1000
}

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

Example
const hot = new Handsontable(document.getElementById('example'), {
  date: 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

plugins/comments/comments.js#L218

clearRange()

Clears the currently selected cell.

plugins/comments/comments.js#L762

destroy()

Destroys the plugin instance.

plugins/comments/comments.js#L188

disablePlugin()

Disables the plugin functionality for this Handsontable instance.

plugins/comments/comments.js#L143

enablePlugin()

Enables the plugin functionality for this Handsontable instance.

plugins/comments/comments.js#L323

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.
plugins/comments/comments.js#L337

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.
plugins/comments/comments.js#L480

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}
plugins/comments/comments.js#L380

hide()

Hides the comment editor.

plugins/comments/comments.js#L136

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}
plugins/comments/comments.js#L391

refreshEditor(force)

Refreshes comment editor position and styling.

Parameters:
Name Type Default Description
force Boolean false optional

If true then recalculation will be forced.
plugins/comments/comments.js#L290

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.
plugins/comments/comments.js#L311

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.
plugins/comments/comments.js#L251

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.
plugins/comments/comments.js#L278

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.
plugins/comments/comments.js#L211

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.
plugins/comments/comments.js#L346

show(){Boolean}

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

Returns: {Boolean} Returns true if comment editor was shown.
plugins/comments/comments.js#L369

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.
plugins/comments/comments.js#L458

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.
plugins/comments/comments.js#L177

updatePlugin()

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