Handsontable Documentation

Class: MergeCells

MergeCells

Plugin, which allows merging cells in the table (using the initial configuration, API or context menu).

Example

const hot = new Handsontable(document.getElementById('example'), {
 data: getData(),
 mergeCells: [
   {row: 0, col: 3, rowspan: 3, colspan: 3},
   {row: 2, col: 6, rowspan: 2, colspan: 2},
   {row: 4, col: 8, rowspan: 3, colspan: 3}
 ],

Methods

plugins/mergeCells/mergeCells.js#L270 clearCollections()

Clears the merged cells from the merged cell container.

plugins/mergeCells/mergeCells.js#L125 disablePlugin()

Disables the plugin functionality for this Handsontable instance.

plugins/mergeCells/mergeCells.js#L87 enablePlugin()

Enables the plugin functionality for this Handsontable instance.

plugins/mergeCells/mergeCells.js#L80 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 MergeCells#enablePlugin method is called.

Returns: {Boolean}

plugins/mergeCells/mergeCells.js#L473 merge(startRow, startColumn, endRow, endColumn)

Merges the specified range.

Parameters:

Name	Type	Description
`startRow`	Number	Start row of the merged cell.
`startColumn`	Number	Start column of the merged cell.
`endRow`	Number	End row of the merged cell.
`endColumn`	Number	End column of the merged cell.

Fires:

plugins/mergeCells/mergeCells.js#L311 mergeSelection(cellRange)

Merges the selection provided as a cell range.

Parameters:

Name	Type	Description
`cellRange`	CellRange	optional Selection cell range.

plugins/mergeCells/mergeCells.js#L490 unmerge(startRow, startColumn, endRow, endColumn)

Unmerges the merged cell in the provided range.

Parameters:

Name	Type	Description
`startRow`	Number	Start row of the merged cell.
`startColumn`	Number	Start column of the merged cell.
`endRow`	Number	End row of the merged cell.
`endColumn`	Number	End column of the merged cell.

Fires:

plugins/mergeCells/mergeCells.js#L330 unmergeSelection(cellRange)

Unmerges the selection provided as a cell range.

Parameters:

Name	Type	Description
`cellRange`	CellRange	optional Selection cell range.

plugins/mergeCells/mergeCells.js#L134 updatePlugin()

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