Class: CopyPaste

CopyPaste

plugins/copyPaste/copyPaste.js#L29

This plugin enables the copy/paste functionality in the Handsontable. The functionality works for API, Context Menu,
using keyboard shortcuts and menu bar from the browser.
Possible values:

  • true (to enable default options),
  • false (to disable completely)

or an object with values:

See the copy/paste demo for examples.

Example
// Enables the plugin with default values
copyPaste: true,
// Enables the plugin with custom values
copyPaste: {
  columnsLimit: 25,
  rowsLimit: 50,
  pasteMode: 'shift_down',
},

Members

columnsLimitNumber

Maximum number of columns than can be copied to clipboard using CTRL + C.

Default Value: 1000

pasteModeString

Defines paste (CTRL + V) behavior.

  • Default value "overwrite" will paste clipboard value over current selection.
  • When set to "shift_down", clipboard data will be pasted in place of current selection, while all selected cells are moved down.
  • When set to "shift_right", clipboard data will be pasted in place of current selection, while all selected cells are moved right.
Default Value: 'overwrite'

rowsLimitNumber

Maximum number of rows than can be copied to clipboard using CTRL + C.

Default Value: 1000

Methods

plugins/copyPaste/copyPaste.js#L168

copy()

Copies the selected cell into the clipboard.

plugins/copyPaste/copyPaste.js#L180

cut()

Cuts the selected cell into the clipboard.

plugins/copyPaste/copyPaste.js#L595

destroy()

Destroys the plugin instance.

plugins/copyPaste/copyPaste.js#L157

disablePlugin()

Disables the plugin functionality for this Handsontable instance.

plugins/copyPaste/copyPaste.js#L114

enablePlugin()

Enables the plugin functionality for this Handsontable instance.

plugins/copyPaste/copyPaste.js#L195

getRangedCopyableData(ranges){String}

Creates copyable text releated to range objects.

Parameters:
Name Type Description
ranges Array.<Object>

Array of objects with properties startRow, endRow, startCol and endCol.
Returns: {String} Returns string which will be copied into clipboard.
plugins/copyPaste/copyPaste.js#L233

getRangedData(ranges){Array.<Array>}

Creates copyable text releated to range objects.

Parameters:
Name Type Description
ranges Array.<Object>

Array of objects with properties startRow, startCol, endRow and endCol.
Returns: {Array.<Array>} Returns array of arrays which will be copied into clipboard.
plugins/copyPaste/copyPaste.js#L107

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

Returns: {Boolean}
plugins/copyPaste/copyPaste.js#L270

paste(value)

Simulates the paste action.

Parameters:
Name Type Description
value String optional

Value to paste.
plugins/copyPaste/copyPaste.js#L291

setCopyableText()

Prepares copyable text from the cells selection in the invisible textarea.

plugins/copyPaste/copyPaste.js#L146

updatePlugin()

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