handsontable 13.1.0 → 14.0.0-next-e8f87aa-20231030

package/pluginHooks.mjs

@@ -540,6 +540,34 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * @param {'init'|'remove'|'insert'|'move'|'update'} [source] A string that indicates what caused the change to the order of rows.
  */
 'afterRowSequenceChange',
+/**
+ * Fired before the vertical viewport scroll. Triggered by the [`scrollViewportTo()`](@/api/core.md#scrollviewportto)
+ * method or table internals.
+ *
+ * @since 14.0.0
+ * @event Hooks#beforeViewportScrollVertically
+ * @param {number} visualRow Visual row index.
+ * @returns {number} Returns modified row index (or the same as passed in the method argument) to which the viewport will be scrolled.
+ */
+'beforeViewportScrollVertically',
+/**
+ * Fired before the horizontal viewport scroll. Triggered by the [`scrollViewportTo()`](@/api/core.md#scrollviewportto)
+ * method or table internals.
+ *
+ * @since 14.0.0
+ * @event Hooks#beforeViewportScrollHorizontally
+ * @param {number} visualColumn Visual column index.
+ * @returns {number} Returns modified column index (or the same as passed in the method argument) to which the viewport will be scrolled.
+ */
+'beforeViewportScrollHorizontally',
+/**
+ * Fired before the vertical or horizontal viewport scroll. Triggered by the [`scrollViewportTo()`](@/api/core.md#scrollviewportto)
+ * method or table internals.
+ *
+ * @since 14.0.0
+ * @event Hooks#beforeViewportScroll
+ */
+'beforeViewportScroll',
 /**
  * Fired after the horizontal scroll event.
  *
@@ -552,6 +580,13 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * @event Hooks#afterScrollVertically
  */
 'afterScrollVertically',
+/**
+ * Fired after the vertical or horizontal scroll event.
+ *
+ * @since 14.0.0
+ * @event Hooks#afterScroll
+ */
+'afterScroll',
 /**
  * Fired after one or more cells are selected (e.g. During mouse move).
  *
@@ -655,6 +690,94 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * @param {number} selectionLayerLevel The number which indicates what selection layer is currently modified.
  */
 'afterSelectionEndByProp',
+/**
+ * Fired before one or more columns are selected (e.g. During mouse header click or {@link Core#selectColumns} API call).
+ *
+ * @since 14.0.0
+ * @event Hooks#beforeSelectColumns
+ * @param {CellCoords} from Selection start coords object.
+ * @param {CellCoords} to Selection end coords object.
+ * @param {CellCoords} highlight Selection cell focus coords object.
+ * @example
+ * ::: only-for javascript
+ * ```js
+ * new Handsontable(element, {
+ *   beforeSelectColumns: (from, to, highlight) => {
+ *     // Extend the column selection by one column left and one column right.
+ *     from.col = Math.max(from.col - 1, 0);
+ *     to.col = Math.min(to.col + 1, this.countCols() - 1);
+ *   }
+ * })
+ * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * <HotTable
+ *   beforeSelectColumns={(from, to, highlight) => {
+ *     // Extend the column selection by one column left and one column right.
+ *     from.col = Math.max(from.col - 1, 0);
+ *     to.col = Math.min(to.col + 1, this.countCols() - 1);
+ *   }}
+ * />
+ * ```
+ * :::
+ */
+'beforeSelectColumns',
+/**
+ * Fired after one or more columns are selected (e.g. During mouse header click or {@link Core#selectColumns} API call).
+ *
+ * @since 14.0.0
+ * @event Hooks#afterSelectColumns
+ * @param {CellCoords} from Selection start coords object.
+ * @param {CellCoords} to Selection end coords object.
+ * @param {CellCoords} highlight Selection cell focus coords object.
+ */
+'afterSelectColumns',
+/**
+ * Fired before one or more rows are selected (e.g. During mouse header click or {@link Core#selectRows} API call).
+ *
+ * @since 14.0.0
+ * @event Hooks#beforeSelectRows
+ * @param {CellCoords} from Selection start coords object.
+ * @param {CellCoords} to Selection end coords object.
+ * @param {CellCoords} highlight Selection cell focus coords object.
+ * @example
+ * ::: only-for javascript
+ * ```js
+ * new Handsontable(element, {
+ *   beforeSelectRows: (from, to, highlight) => {
+ *     // Extend the row selection by one row up and one row bottom more.
+ *     from.row = Math.max(from.row - 1, 0);
+ *     to.row = Math.min(to.row + 1, this.countRows() - 1);
+ *   }
+ * })
+ * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * <HotTable
+ *   beforeSelectRows={(from, to, highlight) => {
+ *     // Extend the row selection by one row up and one row bottom more.
+ *     from.row = Math.max(from.row - 1, 0);
+ *     to.row = Math.min(to.row + 1, this.countRows() - 1);
+ *   }}
+ * />
+ * ```
+ * :::
+ */
+'beforeSelectRows',
+/**
+ * Fired after one or more rows are selected (e.g. During mouse header click or {@link Core#selectRows} API call).
+ *
+ * @since 14.0.0
+ * @event Hooks#afterSelectRows
+ * @param {CellCoords} from Selection start coords object.
+ * @param {CellCoords} to Selection end coords object.
+ * @param {CellCoords} highlight Selection cell focus coords object.
+ */
+'afterSelectRows',
 /**
  * Fired after cell meta is changed.
  *
@@ -1077,6 +1200,38 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *                           If set to `false`, the rendering gets triggered by scrolling or moving the selection.
  */
 'afterRender',
+/**
+ * When the focus position is moved to the next or previous row caused by the {@link Options#autoWrapRow} option
+ * the hook is triggered.
+ *
+ * @since 14.0.0
+ * @event Hooks#beforeRowWrap
+ * @param {boolean} isWrapEnabled Tells whether the row wrapping is going to happen.
+ * There may be situations where the option does not work even though it is enabled.
+ * This is due to the priority of other options that may block the feature.
+ * For example, when the {@link Options#minSpareCols} is defined, the {@link Options#autoWrapRow} option is not checked.
+ * Thus, row wrapping is off.
+ * @param {CellCoords} newCoords The new focus position.
+ * @param {boolean} isFlipped `true` if the row index was flipped, `false` otherwise.
+ * Flipped index means that the user reached the last row and the focus is moved to the first row or vice versa.
+ */
+'beforeRowWrap',
+/**
+ * When the focus position is moved to the next or previous column caused by the {@link Options#autoWrapCol} option
+ * the hook is triggered.
+ *
+ * @since 14.0.0
+ * @event Hooks#beforeColumnWrap
+ * @param {boolean} isWrapEnabled Tells whether the column wrapping is going to happen.
+ * There may be situations where the option does not work even though it is enabled.
+ * This is due to the priority of other options that may block the feature.
+ * For example, when the {@link Options#minSpareRows} is defined, the {@link Options#autoWrapCol} option is not checked.
+ * Thus, column wrapping is off.
+ * @param {CellCoords} newCoords The new focus position.
+ * @param {boolean} isFlipped `true` if the column index was flipped, `false` otherwise.
+ * Flipped index means that the user reached the last column and the focus is moved to the first column or vice versa.
+ */
+'beforeColumnWrap',
 /**
  * Fired before cell meta is changed.
  *
@@ -1110,6 +1265,13 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * @param {CellCoords} coords CellCoords instance.
  */
 'beforeSetRangeEnd',
+/**
+ * Fired before applying selection coordinates to the renderable coordinates for Walkontable (rendering engine).
+ *
+ * @since 14.0.0
+ * @event Hooks#beforeSelectionHighlightSet
+ */
+'beforeSelectionHighlightSet',
 /**
  * Fired before the logic of handling a touch scroll, when user started scrolling on a touch-enabled device.
  *
@@ -1166,6 +1328,17 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * @param {number} column Visual column index.
  */
 'modifyColWidth',
+/**
+ * Fired when focusing a cell or a header element. Allows replacing the element to be focused by returning a
+ * different HTML element.
+ *
+ * @since 14.0.0
+ * @event Hooks#modifyFocusedElement
+ * @param {number} row Row index.
+ * @param {number} column Column index.
+ * @param {HTMLElement|undefined} focusedElement The element to be focused.
+ */
+'modifyFocusedElement',
 /**
  * Fired when a row header index is about to be modified by a callback function.
  *
@@ -1223,6 +1396,16 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * @returns {undefined|number[]}
  */
 'modifyGetCellCoords',
+/**
+ * Used to modify the cell coordinates when the table is activated (going into the listen mode).
+ *
+ * @event Hooks#modifyFocusOnTabNavigation
+ * @since 14.0.0
+ * @param {'from_above' | 'from_below'} tabActivationDir The browsers Tab navigation direction. Depending on
+ * whether the user activated the table from the element above or below, another cell can be selected.
+ * @param {CellCoords} visualCoords The coords that will be used to select a cell.
+ */
+'modifyFocusOnTabNavigation',
 /**
  * Allows modify the visual row index that is used to retrieve the row header element (TH) before it's
  * highlighted (proper CSS class names are added). Modifying the visual row index allows building a custom
@@ -1320,26 +1503,35 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin before copying the values to the clipboard and before clearing values of
  * the selected cells. This hook is fired when {@link Options#copyPaste} option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#beforeCut
- * @param {Array[]} data An array of arrays which contains data to cut.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                       which will be cut out.
+ * @param {object} clipboardData Information about cut action which is going to happen.
+ * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
  * @returns {*} If returns `false` then operation of the cutting out is canceled.
  * @example
  * ::: only-for javascript
  * ```js
- * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * new Handsontable(element, {
- *   beforeCut: function(data, coords) {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforeCut: function(clipboardData) {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }
  * });
  * // To cancel a cutting action, just return `false`.
  * new Handsontable(element, {
- *   beforeCut: function(data, coords) {
+ *   beforeCut: function(clipboardData) {
  *     return false;
  *   }
  * });
@@ -1348,18 +1540,18 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *
  * ::: only-for react
  * ```jsx
- * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * <HotTable
- *   beforeCut={(data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforeCut={(clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }}
  * />
  * // To cancel a cutting action, just return `false`.
  * <HotTable
- *   beforeCut={(data, coords) => {
+ *   beforeCut={(clipboardData) => {
  *     return false;
  *   }}
  * />
@@ -1371,33 +1563,50 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin after data was cut out from the table. This hook is fired when
  * {@link Options#copyPaste} option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#afterCut
- * @param {Array[]} data An array of arrays with the cut data.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                       which was cut out.
+ * @param {object} clipboardData Information about already performed cut action.
+ * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
  */
 'afterCut',
 /**
  * Fired before values are copied to the clipboard.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#beforeCopy
- * @param {Array[]} data An array of arrays which contains data to copied.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                         which will copied.
- * @param {{ columnHeadersCount: number }} copiedHeadersCount (Since 12.3.0) The number of copied column headers.
+ * @param {object} clipboardData Information about copy action which is going to happen.
+ * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
  * @returns {*} If returns `false` then copying is canceled.
  *
  * @example
  * ::: only-for javascript
  * ```js
- * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * ...
  * new Handsontable(document.getElementById('example'), {
- *   beforeCopy: (data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforeCopy: (clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }
  * });
  * ...
@@ -1405,7 +1614,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * // To cancel copying, return false from the callback.
  * ...
  * new Handsontable(document.getElementById('example'), {
- *   beforeCopy: (data, coords) => {
+ *   beforeCopy: (clipboardData) => {
  *     return false;
  *   }
  * });
@@ -1415,14 +1624,14 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *
  * ::: only-for react
  * ```jsx
- * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * ...
  * <HotTable
- *   beforeCopy={(data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforeCopy={(clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }}
  * />
  * ...
@@ -1430,7 +1639,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * // To cancel copying, return false from the callback.
  * ...
  * <HotTable
- *   beforeCopy={(data, coords) => {
+ *   beforeCopy={(clipboardData) => {
  *     return false;
  *   }}
  * />
@@ -1443,37 +1652,55 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin after data are pasted into table. This hook is fired when {@link Options#copyPaste}
  * option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#afterCopy
- * @param {Array[]} data An array of arrays which contains the copied data.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                         which was copied.
- * @param {{ columnHeadersCount: number }} copiedHeadersCount (Since 12.3.0) The number of copied column headers.
+ * @param {object} clipboardData Information about already performed copy action.
+ * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
  */
 'afterCopy',
 /**
  * Fired by {@link CopyPaste} plugin before values are pasted into table. This hook is fired when
  * {@link Options#copyPaste} option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#beforePaste
- * @param {Array[]} data An array of arrays which contains data to paste.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                       that correspond to the previously selected area.
+ * @param {object} clipboardData Information about paste action which is going to happen.
+ * @param {Function} clipboardData.removeRow Remove row from the pasted dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the pasted dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the pasted dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the pasted dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getSource Gets information about source of the copied data
+ * (Handsontable, table or string).
  * @returns {*} If returns `false` then pasting is canceled.
  * @example
  * ```js
  * ::: only-for javascript
- * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * new Handsontable(example, {
- *   beforePaste: (data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforePaste: (clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }
  * });
  * // To cancel pasting, return false from the callback.
  * new Handsontable(example, {
- *   beforePaste: (data, coords) => {
+ *   beforePaste: (clipboardData) => {
  *     return false;
  *   }
  * });
@@ -1482,18 +1709,18 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *
  * ::: only-for react
  * ```jsx
- * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
  * <HotTable
- *   beforePaste={(data, coords) => {
- *     // data -> [[1, 2, 3], [4, 5, 6]]
- *     data.splice(0, 1);
- *     // data -> [[4, 5, 6]]
- *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
+ *   beforePaste={(clipboardData) => {
+ *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
+ *    clipboardData.removeRows([0]);
+ *    clipboardData.removeColumns([0]);
+ *     // clipboardData.getData() -> [[5, 6]]
  *   }}
  * />
  * // To cancel pasting, return false from the callback.
  * <HotTable
- *   beforePaste={(data, coords) => {
+ *   beforePaste={(clipboardData) => {
  *     return false;
  *   }}
  * />
@@ -1505,10 +1732,20 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin after values are pasted into table. This hook is fired when
  * {@link Options#copyPaste} option is enabled.
  *
+ * Note: Please keep in mind since @14.0.0 the method arguments has been changed.
+ *
  * @event Hooks#afterPaste
- * @param {Array[]} data An array of arrays with the pasted data.
- * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
- *                       that correspond to the previously selected area.
+ * @param {object} clipboardData Information about already performed paste action.
+ * @param {Function} clipboardData.removeRow Remove row from the pasted dataset.
+ * @param {Function} clipboardData.removeColumn Remove column from the pasted dataset.
+ * @param {Function} clipboardData.insertAtRow Insert values at row index.
+ * @param {Function} clipboardData.insertAtColumn Insert values at column index.
+ * @param {Function} clipboardData.setCellAt Change headers or cells in the pasted dataset.
+ * @param {Function} clipboardData.getCellAt Get headers or cells from the pasted dataset.
+ * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
+ * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
+ * @param {Function} clipboardData.getSource Gets information about source of the copied data
+ * (Handsontable, table or string).
  */
 'afterPaste',
 /**
@@ -2380,7 +2617,7 @@ const REMOVED_HOOKS = new Map([['modifyRow', '8.0.0'], ['modifyCol', '8.0.0'], [
  * @type {Map<string, string>}
  */
 /* eslint-enable jsdoc/require-description-complete-sentence */
-const DEPRECATED_HOOKS = new Map([]);
+const DEPRECATED_HOOKS = new Map([['beforeRemoveCellClassNames', 'The hook "beforeRemoveCellClassNames" is deprecated and will be removed in the next major release.']]);
 class Hooks {
   static getSingleton() {
     return getGlobalSingleton();

package/plugins/autoColumnSize/autoColumnSize.d.ts

@@ -4,6 +4,8 @@ import { BasePlugin } from '../base';
 export interface DetailedSettings {
   syncLimit?: string | number;
   useHeaders?: boolean;
+  samplingRatio?: number;
+  allowSampleDuplicates?: boolean;
 }
 
 export type Settings = boolean | DetailedSettings;

package/plugins/autoColumnSize/autoColumnSize.js

@@ -16,10 +16,8 @@ var _translations = require("../../translations");
 var _mixed = require("../../helpers/mixed");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 _pluginHooks.default.getSingleton().register('modifyAutoColumnSizeSeed');
-const PLUGIN_KEY = 'autoColumnSize';
-exports.PLUGIN_KEY = PLUGIN_KEY;
-const PLUGIN_PRIORITY = 10;
-exports.PLUGIN_PRIORITY = PLUGIN_PRIORITY;
+const PLUGIN_KEY = exports.PLUGIN_KEY = 'autoColumnSize';
+const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 10;
 const privatePool = new WeakMap();
 const COLUMN_SIZE_MAP_NAME = 'autoColumnSize';
 

package/plugins/autoRowSize/autoRowSize.d.ts

@@ -3,6 +3,8 @@ import { BasePlugin } from '../base';
 
 export interface DetailedSettings {
   syncLimit?: string | number;
+  samplingRatio?: number;
+  allowSampleDuplicates?: boolean;
 }
 
 export type Settings = boolean | DetailedSettings;

package/plugins/autoRowSize/autoRowSize.js

@@ -12,10 +12,8 @@ var _samplesGenerator = _interopRequireDefault(require("../../utils/samplesGener
 var _string = require("../../helpers/string");
 var _translations = require("../../translations");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const PLUGIN_KEY = 'autoRowSize';
-exports.PLUGIN_KEY = PLUGIN_KEY;
-const PLUGIN_PRIORITY = 40;
-exports.PLUGIN_PRIORITY = PLUGIN_PRIORITY;
+const PLUGIN_KEY = exports.PLUGIN_KEY = 'autoRowSize';
+const PLUGIN_PRIORITY = exports.PLUGIN_PRIORITY = 40;
 const ROW_WIDTHS_MAP_NAME = 'autoRowSize';
 
 /* eslint-disable jsdoc/require-description-complete-sentence */
@@ -147,12 +145,19 @@ class AutoRowSize extends _base.BasePlugin {
      * @private
      * @type {SamplesGenerator}
      */
-    this.samplesGenerator = new _samplesGenerator.default((row, col) => {
+    this.samplesGenerator = new _samplesGenerator.default((row, column) => {
+      if (row >= 0 && column >= 0) {
+        const cellMeta = this.hot.getCellMeta(row, column);
+        if (cellMeta.hidden) {
+          // do not generate samples for cells that are covered by merged cell (null values)
+          return false;
+        }
+      }
       let cellValue;
       if (row >= 0) {
-        cellValue = this.hot.getDataAtCell(row, col);
+        cellValue = this.hot.getDataAtCell(row, column);
       } else if (row === -1) {
-        cellValue = this.hot.getColHeader(col);
+        cellValue = this.hot.getColHeader(column);
       }
       return {
         value: cellValue
@@ -187,7 +192,7 @@ class AutoRowSize extends _base.BasePlugin {
     this.hot.rowIndexMapper.registerMap(ROW_WIDTHS_MAP_NAME, this.rowHeightsMap);
 
     // Leave the listener active to allow auto-sizing the rows when the plugin is disabled.
-    // This is necesseary for height recalculation for resize handler doubleclick (ManualRowResize).
+    // This is necessary for height recalculation for resize handler doubleclick (ManualRowResize).
     this.addHook('beforeRowResize', (size, row, isDblClick) => this.onBeforeRowResize(size, row, isDblClick));
   }
 
@@ -577,11 +582,11 @@ class AutoRowSize extends _base.BasePlugin {
       this.recalculateAllRowsHeight();
     } else {
       // first load - initialization
-      setTimeout(() => {
+      this.hot._registerTimeout(() => {
         if (this.hot) {
           this.recalculateAllRowsHeight();
         }
-      }, 0);
+      });
     }
   }