MergeCells

Options

mergeCells

Ask AI

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 visual row index of the merged section’s beginning
col	The visual 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.

Read more:

• Merge cells

Default: false
Example

// enable the `MergeCells` plugin
mergeCells: true,

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

// enable the `MergeCells` plugin with enabled virtualization mode
// and merge specific cells at initialization
mergeCells: {
  virtualized: true,
  cells: [
    // merge cells from cell (1,1) to cell (3,3)
    {row: 1, col: 1, rowspan: 3, colspan: 3},
    // merge cells from cell (3,4) to cell (2,2)
    {row: 3, col: 4, rowspan: 2, colspan: 2},
    // merge cells from cell (5,6) to cell (3,3)
    {row: 5, col: 6, rowspan: 3, colspan: 3}
  ],
},

Members

DEFAULT_SETTINGS

Ask AI

Source code

MergeCells.DEFAULT_SETTINGS

Returns the default settings applied when the plugin is enabled without explicit configuration.

PLUGIN_KEY

Ask AI

Source code

MergeCells.PLUGIN_KEY

Returns the plugin key used to identify this plugin in Handsontable settings.

PLUGIN_PRIORITY

Ask AI

Source code

MergeCells.PLUGIN_PRIORITY

Returns the priority order used to determine the order in which plugins are initialized.

Methods

clearCollections

Ask AI

Source code

mergeCells.clearCollections()

Clears the merged cells from the merged cell container.

destroy

Ask AI

Source code

mergeCells.destroy()

Destroys the plugin instance. Removes the row index mapper local hook explicitly, because BasePlugin#destroy only clears addHook-managed hooks, not raw addLocalHook registrations.

disablePlugin

Ask AI

Source code

mergeCells.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Ask AI

Source code

mergeCells.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Ask AI

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

Ask AI

Source code

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

Merges the specified range.

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

Param	Type	Description
startRow	number	Visual start row of the merged cell.
startColumn	number	Visual start column of the merged cell.
endRow	number	Visual end row of the merged cell.
endColumn	number	Visual end column of the merged cell.

mergeSelection

Ask AI

Source code

mergeCells.mergeSelection([cellRange])

Merges the selection provided as a cell range.

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

unmerge

Ask AI

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	Visual start row of the merged cell.
startColumn	number	Visual start column of the merged cell.
endRow	number	Visual end row of the merged cell.
endColumn	number	Visual end column of the merged cell.

unmergeSelection

Ask AI

Source code

mergeCells.unmergeSelection([cellRange])

Unmerges the selection provided as a cell range.

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

updatePlugin

Ask AI

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