MergeCells

Plugin: MergeCells

Description

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

Example

1
<HotTable
2
  data={getData()}
3
  // enable plugin
4
  mergeCells={[
5
   {row: 0, col: 3, rowspan: 3, colspan: 3},
6
   {row: 2, col: 6, rowspan: 2, colspan: 2},
7
   {row: 4, col: 8, rowspan: 3, colspan: 3}
8
  ]}
9
/>

Options

mergeCells

Source code

mergeCells.mergeCells : boolean | Array<object>

The mergeCells option configures the MergeCells plugin.

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

Setting	Description
`true`	Enable the `MergeCells` plugin
`false`	Disable the `MergeCells` plugin
An array of objects	- Enable the `MergeCells` plugin - Merge specific cells at initialization
{ virtualized: true }	Enable the `MergeCells` plugin with enabled virtualization mode

To merge specific cells at Handsontable’s initialization, set the mergeCells option to an array of objects, with the following properties:

Property	Description
`row`	The row index of the merged section’s beginning
`col`	The column index of the merged section’s beginning
`rowspan`	The width (as a number of rows) of the merged section
`colspan`	The height (as a number of columns ) of the merged section

This option can only be set at the grid level. It has no effect when set in the columns, cells, or cell options.

Merge cells

Default: false
Example

1
// enable the `MergeCells` plugin
2
mergeCells: true,
3

4
// enable the `MergeCells` plugin
5
// and merge specific cells at initialization
6
mergeCells: [
7
  // merge cells from cell (1,1) to cell (3,3)
8
  {row: 1, col: 1, rowspan: 3, colspan: 3},
9
  // merge cells from cell (3,4) to cell (2,2)
10
  {row: 3, col: 4, rowspan: 2, colspan: 2},
11
  // merge cells from cell (5,6) to cell (3,3)
12
  {row: 5, col: 6, rowspan: 3, colspan: 3}
13
],
14

15
// enable the `MergeCells` plugin with enabled virtualization mode
16
// and merge specific cells at initialization
17
mergeCells: {
18
  virtualized: true,
19
  cells: [
20
    // merge cells from cell (1,1) to cell (3,3)
21
    {row: 1, col: 1, rowspan: 3, colspan: 3},
22
    // merge cells from cell (3,4) to cell (2,2)
23
    {row: 3, col: 4, rowspan: 2, colspan: 2},
24
    // merge cells from cell (5,6) to cell (3,3)
25
    {row: 5, col: 6, rowspan: 3, colspan: 3}
26
  ],
27
},

Methods

clearCollections

Source code

mergeCells.clearCollections()

Clears the merged cells from the merged cell container.

disablePlugin

Source code

mergeCells.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Source code

mergeCells.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Source code

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

merge

Source code

mergeCells.merge(startRow, startColumn, endRow, endColumn)

Merges the specified range.

Emits: Hooks#event:beforeMergeCells, Hooks#event:afterMergeCells

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

mergeSelection

Source code

mergeCells.mergeSelection([cellRange])

Merges the selection provided as a cell range.

Param	Type	Description
[cellRange]	`CellRange`	`optional` Selection cell range.

unmerge

Source code

mergeCells.unmerge(startRow, startColumn, endRow, endColumn)

Unmerges the merged cell in the provided range.

Emits: Hooks#event:beforeUnmergeCells, Hooks#event:afterUnmergeCells

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

unmergeSelection

Source code

mergeCells.unmergeSelection([cellRange])

Unmerges the selection provided as a cell range.

Param	Type	Description
[cellRange]	`CellRange`	`optional` Selection cell range.

updatePlugin

Source code

mergeCells.updatePlugin()

Updates the plugin’s state.

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

mergeCells