handsontable 0.0.0-next-df87bb0-20240604 → 0.0.0-next-7230ce6-20240605

package/plugins/mergeCells/cellsCollection.mjs

@@ -47,9 +47,15 @@ class MergedCellsCollection {
     /**
      * Array of merged cells.
      *
-     * @type {Array}
+     * @type {MergedCellCoords[]}
      */
     _defineProperty(this, "mergedCells", []);
+    /**
+     * Matrix of cells (row, col) that points to the instances of the MergedCellCoords objects.
+     *
+     * @type {Array}
+     */
+    _defineProperty(this, "mergedCellsMatrix", new Map());
     /**
      * The Handsontable instance.
      *
@@ -81,16 +87,11 @@ class MergedCellsCollection {
    * @returns {MergedCellCoords|boolean} Returns a wanted merged cell on success and `false` on failure.
    */
   get(row, column) {
-    const mergedCells = this.mergedCells;
-    let result = false;
-    arrayEach(mergedCells, mergedCell => {
-      if (mergedCell.row <= row && mergedCell.row + mergedCell.rowspan - 1 >= row && mergedCell.col <= column && mergedCell.col + mergedCell.colspan - 1 >= column) {
-        result = mergedCell;
-        return false;
-      }
-      return true;
-    });
-    return result;
+    var _this$mergedCellsMatr;
+    if (!this.mergedCellsMatrix.has(row)) {
+      return false;
+    }
+    return (_this$mergedCellsMatr = this.mergedCellsMatrix.get(row).get(column)) !== null && _this$mergedCellsMatr !== void 0 ? _this$mergedCellsMatr : false;
   }
 
   /**
@@ -100,9 +101,8 @@ class MergedCellsCollection {
    * @returns {MergedCellCoords|boolean}
    */
   getByRange(range) {
-    const mergedCells = this.mergedCells;
     let result = false;
-    arrayEach(mergedCells, mergedCell => {
+    arrayEach(this.mergedCells, mergedCell => {
       if (mergedCell.row <= range.from.row && mergedCell.row + mergedCell.rowspan - 1 >= range.to.row && mergedCell.col <= range.from.col && mergedCell.col + mergedCell.colspan - 1 >= range.to.col) {
         result = mergedCell;
         return result;
@@ -112,6 +112,59 @@ class MergedCellsCollection {
     return result;
   }
 
+  /**
+   * Filters merge cells objects provided by users from overlapping cells.
+   *
+   * @param {{ row: number, col: number, rowspan: number, colspan: number }} mergedCellsInfo The merged cell information object.
+   * Has to contain `row`, `col`, `colspan` and `rowspan` properties.
+   * @returns {Array<{ row: number, col: number, rowspan: number, colspan: number }>}
+   */
+  filterOverlappingMergeCells(mergedCellsInfo) {
+    const occupiedCells = new Set();
+    this.mergedCells.forEach(mergedCell => {
+      const {
+        row,
+        col,
+        colspan,
+        rowspan
+      } = mergedCell;
+      for (let r = row; r < row + rowspan; r++) {
+        for (let c = col; c < col + colspan; c++) {
+          occupiedCells.add(`r${r},c${c}`);
+        }
+      }
+    });
+    const filteredMergeCells = mergedCellsInfo.filter(mergedCell => {
+      const {
+        row,
+        col,
+        colspan,
+        rowspan
+      } = mergedCell;
+      const localOccupiedCells = new Set();
+      let isOverlapping = false;
+      for (let r = row; r < row + rowspan; r++) {
+        for (let c = col; c < col + colspan; c++) {
+          const cellId = `r${r},c${c}`;
+          if (occupiedCells.has(cellId)) {
+            warn(MergedCellsCollection.IS_OVERLAPPING_WARNING(mergedCell));
+            isOverlapping = true;
+            break;
+          }
+          localOccupiedCells.add(cellId);
+        }
+        if (isOverlapping) {
+          break;
+        }
+      }
+      if (!isOverlapping) {
+        occupiedCells.add(...localOccupiedCells);
+      }
+      return !isOverlapping;
+    });
+    return filteredMergeCells;
+  }
+
   /**
    * Get a merged cell contained in the provided range.
    *
@@ -121,7 +174,6 @@ class MergedCellsCollection {
    */
   getWithinRange(range) {
     let countPartials = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-    const mergedCells = this.mergedCells;
     const foundMergedCells = [];
     let testedRange = range;
     if (!testedRange.includesRange) {
@@ -129,7 +181,7 @@ class MergedCellsCollection {
       const to = this.hot._createCellCoords(testedRange.to.row, testedRange.to.col);
       testedRange = this.hot._createCellRange(from, from, to);
     }
-    arrayEach(mergedCells, mergedCell => {
+    arrayEach(this.mergedCells, mergedCell => {
       const mergedCellTopLeft = this.hot._createCellCoords(mergedCell.row, mergedCell.col);
       const mergedCellBottomRight = this.hot._createCellCoords(mergedCell.row + mergedCell.rowspan - 1, mergedCell.col + mergedCell.colspan - 1);
       const mergedCellRange = this.hot._createCellRange(mergedCellTopLeft, mergedCellTopLeft, mergedCellBottomRight);
@@ -148,22 +200,24 @@ class MergedCellsCollection {
    * Add a merged cell to the container.
    *
    * @param {object} mergedCellInfo The merged cell information object. Has to contain `row`, `col`, `colspan` and `rowspan` properties.
+   * @param {boolean} [auto=false] `true` if called internally by the plugin (usually in batch).
    * @returns {MergedCellCoords|boolean} Returns the new merged cell on success and `false` on failure.
    */
   add(mergedCellInfo) {
-    const mergedCells = this.mergedCells;
+    let auto = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     const row = mergedCellInfo.row;
     const column = mergedCellInfo.col;
     const rowspan = mergedCellInfo.rowspan;
     const colspan = mergedCellInfo.colspan;
     const newMergedCell = new MergedCellCoords(row, column, rowspan, colspan, this.hot._createCellCoords, this.hot._createCellRange);
     const alreadyExists = this.get(row, column);
-    const isOverlapping = this.isOverlapping(newMergedCell);
+    const isOverlapping = auto ? false : this.isOverlapping(newMergedCell);
     if (!alreadyExists && !isOverlapping) {
       if (this.hot) {
         newMergedCell.normalize(this.hot);
       }
-      mergedCells.push(newMergedCell);
+      this.mergedCells.push(newMergedCell);
+      _assertClassBrand(_MergedCellsCollection_brand, this, _addMergedCellToMatrix).call(this, newMergedCell);
       return newMergedCell;
     }
     warn(MergedCellsCollection.IS_OVERLAPPING_WARNING(newMergedCell));
@@ -179,12 +233,12 @@ class MergedCellsCollection {
    * @returns {MergedCellCoords|boolean} Returns the removed merged cell on success and `false` on failure.
    */
   remove(row, column) {
-    const mergedCells = this.mergedCells;
-    const wantedCollection = this.get(row, column);
-    const wantedCollectionIndex = wantedCollection ? this.mergedCells.indexOf(wantedCollection) : -1;
-    if (wantedCollection && wantedCollectionIndex !== -1) {
-      mergedCells.splice(wantedCollectionIndex, 1);
-      return wantedCollection;
+    const mergedCell = this.get(row, column);
+    const mergedCellIndex = mergedCell ? this.mergedCells.indexOf(mergedCell) : -1;
+    if (mergedCell && mergedCellIndex !== -1) {
+      this.mergedCells.splice(mergedCellIndex, 1);
+      _assertClassBrand(_MergedCellsCollection_brand, this, _removeMergedCellFromMatrix).call(this, mergedCell);
+      return mergedCell;
     }
     return false;
   }
@@ -193,16 +247,16 @@ class MergedCellsCollection {
    * Clear all the merged cells.
    */
   clear() {
-    const mergedCells = this.mergedCells;
     const mergedCellParentsToClear = [];
     const hiddenCollectionElements = [];
-    arrayEach(mergedCells, mergedCell => {
+    arrayEach(this.mergedCells, mergedCell => {
       const TD = this.hot.getCell(mergedCell.row, mergedCell.col);
       if (TD) {
         mergedCellParentsToClear.push([TD, this.get(mergedCell.row, mergedCell.col), mergedCell.row, mergedCell.col]);
       }
     });
     this.mergedCells.length = 0;
+    this.mergedCellsMatrix = new Map();
     arrayEach(mergedCellParentsToClear, (mergedCell, i) => {
       rangeEach(0, mergedCell.rowspan - 1, j => {
         rangeEach(0, mergedCell.colspan - 1, k => {
@@ -225,23 +279,21 @@ class MergedCellsCollection {
   }
 
   /**
-   * Check if the provided merged cell overlaps with the others in the container.
+   * Check if the provided merged cell overlaps with the others already added.
    *
    * @param {MergedCellCoords} mergedCell The merged cell to check against all others in the container.
    * @returns {boolean} `true` if the provided merged cell overlaps with the others, `false` otherwise.
    */
   isOverlapping(mergedCell) {
-    const mergedCellRange = this.hot._createCellRange(this.hot._createCellCoords(0, 0), this.hot._createCellCoords(mergedCell.row, mergedCell.col), this.hot._createCellCoords(mergedCell.row + mergedCell.rowspan - 1, mergedCell.col + mergedCell.colspan - 1));
-    let result = false;
-    arrayEach(this.mergedCells, col => {
-      const currentRange = this.hot._createCellRange(this.hot._createCellCoords(0, 0), this.hot._createCellCoords(col.row, col.col), this.hot._createCellCoords(col.row + col.rowspan - 1, col.col + col.colspan - 1));
-      if (currentRange.overlaps(mergedCellRange)) {
-        result = true;
-        return false;
+    const mergedCellRange = mergedCell.getRange();
+    for (let i = 0; i < this.mergedCells.length; i++) {
+      const otherMergedCell = this.mergedCells[i];
+      const otherMergedCellRange = otherMergedCell.getRange();
+      if (otherMergedCellRange.overlaps(mergedCellRange)) {
+        return true;
       }
-      return true;
-    });
-    return result;
+    }
+    return false;
   }
 
   /**
@@ -376,15 +428,24 @@ class MergedCellsCollection {
       default:
     }
     arrayEach(this.mergedCells, currentMerge => {
+      _assertClassBrand(_MergedCellsCollection_brand, this, _removeMergedCellFromMatrix).call(this, currentMerge);
       currentMerge.shift(shiftVector, index);
+      _assertClassBrand(_MergedCellsCollection_brand, this, _addMergedCellToMatrix).call(this, currentMerge);
     });
     rangeEachReverse(this.mergedCells.length - 1, 0, i => {
       const currentMerge = this.mergedCells[i];
       if (currentMerge && currentMerge.removed) {
         this.mergedCells.splice(this.mergedCells.indexOf(currentMerge), 1);
+        _assertClassBrand(_MergedCellsCollection_brand, this, _removeMergedCellFromMatrix).call(this, currentMerge);
       }
     });
   }
+
+  /**
+   * Adds a merged cell to the matrix.
+   *
+   * @param {MergedCellCoords} mergedCell The merged cell to add.
+   */
 }
 function _getNonIntersectingIndexes(range, axis) {
   let scanDirection = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 1;
@@ -413,4 +474,26 @@ function _getNonIntersectingIndexes(range, axis) {
     return Array.from(set);
   })));
 }
+function _addMergedCellToMatrix(mergedCell) {
+  for (let row = mergedCell.row; row < mergedCell.row + mergedCell.rowspan; row++) {
+    for (let col = mergedCell.col; col < mergedCell.col + mergedCell.colspan; col++) {
+      if (!this.mergedCellsMatrix.has(row)) {
+        this.mergedCellsMatrix.set(row, new Map());
+      }
+      this.mergedCellsMatrix.get(row).set(col, mergedCell);
+    }
+  }
+}
+/**
+ * Removes a merged cell from the matrix.
+ *
+ * @param {MergedCellCoords} mergedCell The merged cell to remove.
+ */
+function _removeMergedCellFromMatrix(mergedCell) {
+  for (let row = mergedCell.row; row < mergedCell.row + mergedCell.rowspan; row++) {
+    for (let col = mergedCell.col; col < mergedCell.col + mergedCell.colspan; col++) {
+      this.mergedCellsMatrix.get(row).delete(col);
+    }
+  }
+}
 export default MergedCellsCollection;

package/plugins/mergeCells/mergeCells.js

@@ -445,36 +445,42 @@ class MergeCells extends _base.BasePlugin {
    * @param {Array|boolean} settings The settings provided to the plugin.
    */
   generateFromSettings(settings) {
-    if (Array.isArray(settings)) {
-      const populatedNulls = [];
-      (0, _array.arrayEach)(settings, setting => {
-        if (!this.validateSetting(setting)) {
-          return;
-        }
-        const highlight = this.hot._createCellCoords(setting.row, setting.col);
-        const rangeEnd = this.hot._createCellCoords(setting.row + setting.rowspan - 1, setting.col + setting.colspan - 1);
-        const mergeRange = this.hot._createCellRange(highlight, highlight, rangeEnd);
-
-        // Merging without data population.
-        this.mergeRange(mergeRange, true, true);
-        (0, _number.rangeEach)(setting.row, setting.row + setting.rowspan - 1, rowIndex => {
-          (0, _number.rangeEach)(setting.col, setting.col + setting.colspan - 1, columnIndex => {
-            // Not resetting a cell representing a merge area's value.
-            if ((rowIndex === setting.row && columnIndex === setting.col) === false) {
-              populatedNulls.push([rowIndex, columnIndex, null]);
-            }
-          });
-        });
-      });
+    if (!Array.isArray(settings)) {
+      return;
+    }
+    const validSettings = settings.filter(mergeCellInfo => this.validateSetting(mergeCellInfo));
+    const nonOverlappingSettings = this.mergedCellsCollection.filterOverlappingMergeCells(validSettings);
+    const populatedNulls = [];
+    nonOverlappingSettings.forEach(mergeCellInfo => {
+      const {
+        row,
+        col,
+        rowspan,
+        colspan
+      } = mergeCellInfo;
+      const from = this.hot._createCellCoords(row, col);
+      const to = this.hot._createCellCoords(row + rowspan - 1, col + colspan - 1);
+      const mergeRange = this.hot._createCellRange(from, from, to);
 
-      // There are no merged cells. Thus, no data population is needed.
-      if (populatedNulls.length === 0) {
-        return;
+      // Merging without data population.
+      this.mergeRange(mergeRange, true, true);
+      for (let r = row; r < row + rowspan; r++) {
+        for (let c = col; c < col + colspan; c++) {
+          // Not resetting a cell representing a merge area's value.
+          if (r !== row || c !== col) {
+            populatedNulls.push([r, c, null]);
+          }
+        }
       }
+    });
 
-      // TODO: Change the `source` argument to a more meaningful value, e.g. `${this.pluginName}.clearCells`.
-      this.hot.setDataAtCell(populatedNulls, undefined, undefined, this.pluginName);
+    // There are no merged cells. Thus, no data population is needed.
+    if (populatedNulls.length === 0) {
+      return;
     }
+
+    // TODO: Change the `source` argument to a more meaningful value, e.g. `${this.pluginName}.clearCells`.
+    this.hot.setDataAtCell(populatedNulls, undefined, undefined, this.pluginName);
   }
 
   /**
@@ -580,7 +586,7 @@ class MergeCells extends _base.BasePlugin {
       });
     });
     this.hot.setCellMeta(mergeParent.row, mergeParent.col, 'spanned', true);
-    const mergedCellAdded = this.mergedCellsCollection.add(mergeParent);
+    const mergedCellAdded = this.mergedCellsCollection.add(mergeParent, auto);
     if (mergedCellAdded) {
       if (preventPopulation) {
         populationInfo = [mergeParent.row, mergeParent.col, clearedData];
@@ -1124,9 +1130,9 @@ function _addMergeActionsToContextMenu(defaultOptions) {
  */
 function _onAfterRenderer(TD, row, col) {
   const mergedCell = this.mergedCellsCollection.get(row, col);
-  // We shouldn't override data in the collection.
-  const mergedCellCopy = (0, _object.isObject)(mergedCell) ? (0, _object.clone)(mergedCell) : undefined;
-  if ((0, _object.isObject)(mergedCellCopy)) {
+  if ((0, _object.isObject)(mergedCell)) {
+    // We shouldn't override data in the collection.
+    const mergedCellCopy = (0, _object.clone)(mergedCell);
     const {
       rowIndexMapper: rowMapper,
       columnIndexMapper: columnMapper
@@ -1151,8 +1157,10 @@ function _onAfterRenderer(TD, row, col) {
     mergedCellCopy.rowspan = Math.min(mergedCellCopy.rowspan, maxRowSpan);
     // The `colSpan` property for a `TD` element should be at most equal to number of rendered columns in the merge area.
     mergedCellCopy.colspan = Math.min(mergedCellCopy.colspan, maxColSpan);
+    (0, _utils.applySpanProperties)(TD, mergedCellCopy, row, col);
+  } else {
+    (0, _utils.applySpanProperties)(TD, null, row, col);
   }
-  (0, _utils.applySpanProperties)(TD, mergedCellCopy, row, col);
 }
 /**
  * Clears the last selected coordinates before setting a new selection range.

package/plugins/mergeCells/mergeCells.mjs

@@ -441,36 +441,42 @@ export class MergeCells extends BasePlugin {
    * @param {Array|boolean} settings The settings provided to the plugin.
    */
   generateFromSettings(settings) {
-    if (Array.isArray(settings)) {
-      const populatedNulls = [];
-      arrayEach(settings, setting => {
-        if (!this.validateSetting(setting)) {
-          return;
-        }
-        const highlight = this.hot._createCellCoords(setting.row, setting.col);
-        const rangeEnd = this.hot._createCellCoords(setting.row + setting.rowspan - 1, setting.col + setting.colspan - 1);
-        const mergeRange = this.hot._createCellRange(highlight, highlight, rangeEnd);
-
-        // Merging without data population.
-        this.mergeRange(mergeRange, true, true);
-        rangeEach(setting.row, setting.row + setting.rowspan - 1, rowIndex => {
-          rangeEach(setting.col, setting.col + setting.colspan - 1, columnIndex => {
-            // Not resetting a cell representing a merge area's value.
-            if ((rowIndex === setting.row && columnIndex === setting.col) === false) {
-              populatedNulls.push([rowIndex, columnIndex, null]);
-            }
-          });
-        });
-      });
+    if (!Array.isArray(settings)) {
+      return;
+    }
+    const validSettings = settings.filter(mergeCellInfo => this.validateSetting(mergeCellInfo));
+    const nonOverlappingSettings = this.mergedCellsCollection.filterOverlappingMergeCells(validSettings);
+    const populatedNulls = [];
+    nonOverlappingSettings.forEach(mergeCellInfo => {
+      const {
+        row,
+        col,
+        rowspan,
+        colspan
+      } = mergeCellInfo;
+      const from = this.hot._createCellCoords(row, col);
+      const to = this.hot._createCellCoords(row + rowspan - 1, col + colspan - 1);
+      const mergeRange = this.hot._createCellRange(from, from, to);
 
-      // There are no merged cells. Thus, no data population is needed.
-      if (populatedNulls.length === 0) {
-        return;
+      // Merging without data population.
+      this.mergeRange(mergeRange, true, true);
+      for (let r = row; r < row + rowspan; r++) {
+        for (let c = col; c < col + colspan; c++) {
+          // Not resetting a cell representing a merge area's value.
+          if (r !== row || c !== col) {
+            populatedNulls.push([r, c, null]);
+          }
+        }
       }
+    });
 
-      // TODO: Change the `source` argument to a more meaningful value, e.g. `${this.pluginName}.clearCells`.
-      this.hot.setDataAtCell(populatedNulls, undefined, undefined, this.pluginName);
+    // There are no merged cells. Thus, no data population is needed.
+    if (populatedNulls.length === 0) {
+      return;
     }
+
+    // TODO: Change the `source` argument to a more meaningful value, e.g. `${this.pluginName}.clearCells`.
+    this.hot.setDataAtCell(populatedNulls, undefined, undefined, this.pluginName);
   }
 
   /**
@@ -576,7 +582,7 @@ export class MergeCells extends BasePlugin {
       });
     });
     this.hot.setCellMeta(mergeParent.row, mergeParent.col, 'spanned', true);
-    const mergedCellAdded = this.mergedCellsCollection.add(mergeParent);
+    const mergedCellAdded = this.mergedCellsCollection.add(mergeParent, auto);
     if (mergedCellAdded) {
       if (preventPopulation) {
         populationInfo = [mergeParent.row, mergeParent.col, clearedData];
@@ -1119,9 +1125,9 @@ function _addMergeActionsToContextMenu(defaultOptions) {
  */
 function _onAfterRenderer(TD, row, col) {
   const mergedCell = this.mergedCellsCollection.get(row, col);
-  // We shouldn't override data in the collection.
-  const mergedCellCopy = isObject(mergedCell) ? clone(mergedCell) : undefined;
-  if (isObject(mergedCellCopy)) {
+  if (isObject(mergedCell)) {
+    // We shouldn't override data in the collection.
+    const mergedCellCopy = clone(mergedCell);
     const {
       rowIndexMapper: rowMapper,
       columnIndexMapper: columnMapper
@@ -1146,8 +1152,10 @@ function _onAfterRenderer(TD, row, col) {
     mergedCellCopy.rowspan = Math.min(mergedCellCopy.rowspan, maxRowSpan);
     // The `colSpan` property for a `TD` element should be at most equal to number of rendered columns in the merge area.
     mergedCellCopy.colspan = Math.min(mergedCellCopy.colspan, maxColSpan);
+    applySpanProperties(TD, mergedCellCopy, row, col);
+  } else {
+    applySpanProperties(TD, null, row, col);
   }
-  applySpanProperties(TD, mergedCellCopy, row, col);
 }
 /**
  * Clears the last selected coordinates before setting a new selection range.

package/shortcuts/context.d.ts

@@ -14,7 +14,7 @@ interface Shortcut {
 export interface Context {
   addShortcut(shortcut: Shortcut): void;
   addShortcuts(shortcuts: Shortcut[]): void;
-  getShortcuts(): Shortcut[];
+  getShortcuts(keys: string[]): Shortcut[];
   hasShortcut(keys: string[]): boolean;
   removeShortcutsByKeys(keys: string[]): void;
   removeShortcutsByGroup(group: string): void;