handsontable 12.3.1 → 12.3.2-next-e75de58-20230322

package/plugins/collapsibleColumns/collapsibleColumns.js

@@ -160,9 +160,33 @@ var CollapsibleColumns = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Cached reference to the NestedHeaders plugin.
+     *
+     * @private
+     * @type {NestedHeaders}
+     */
     _defineProperty(_assertThisInitialized(_this), "nestedHeadersPlugin", null);
+    /**
+     * Event manager instance reference.
+     *
+     * @private
+     * @type {EventManager}
+     */
     _defineProperty(_assertThisInitialized(_this), "eventManager", new _eventManager.default(_assertThisInitialized(_this)));
+    /**
+     * The NestedHeaders plugin StateManager instance.
+     *
+     * @private
+     * @type {StateManager}
+     */
     _defineProperty(_assertThisInitialized(_this), "headerStateManager", null);
+    /**
+     * Map of collapsed columns by the plugin.
+     *
+     * @private
+     * @type {HidingMap|null}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _collapsedColumnsMap, {
       writable: true,
       value: null
@@ -584,13 +608,6 @@ var CollapsibleColumns = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return [PLUGIN_KEY].concat(SETTING_KEYS);
     }
-
-    /**
-     * Cached reference to the NestedHeaders plugin.
-     *
-     * @private
-     * @type {NestedHeaders}
-     */
   }]);
   return CollapsibleColumns;
 }(_base.BasePlugin);

package/plugins/collapsibleColumns/collapsibleColumns.mjs

@@ -153,9 +153,33 @@ export var CollapsibleColumns = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Cached reference to the NestedHeaders plugin.
+     *
+     * @private
+     * @type {NestedHeaders}
+     */
     _defineProperty(_assertThisInitialized(_this), "nestedHeadersPlugin", null);
+    /**
+     * Event manager instance reference.
+     *
+     * @private
+     * @type {EventManager}
+     */
     _defineProperty(_assertThisInitialized(_this), "eventManager", new EventManager(_assertThisInitialized(_this)));
+    /**
+     * The NestedHeaders plugin StateManager instance.
+     *
+     * @private
+     * @type {StateManager}
+     */
     _defineProperty(_assertThisInitialized(_this), "headerStateManager", null);
+    /**
+     * Map of collapsed columns by the plugin.
+     *
+     * @private
+     * @type {HidingMap|null}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _collapsedColumnsMap, {
       writable: true,
       value: null
@@ -577,13 +601,6 @@ export var CollapsibleColumns = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return [PLUGIN_KEY].concat(SETTING_KEYS);
     }
-
-    /**
-     * Cached reference to the NestedHeaders plugin.
-     *
-     * @private
-     * @type {NestedHeaders}
-     */
   }]);
   return CollapsibleColumns;
 }(BasePlugin);

package/plugins/copyPaste/copyPaste.js

@@ -143,35 +143,115 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Counts how many column headers will be copied based on the passed range.
+     *
+     * @private
+     * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
+     * @returns {{ columnHeadersCount: number }} Returns an object with keys that holds
+     *                                           information with the number of copied headers.
+     */
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _countCopiedHeaders);
+    /**
+     * The maximum number of columns than can be copied to the clipboard.
+     *
+     * @type {number}
+     * @default Infinity
+     */
     _defineProperty(_assertThisInitialized(_this), "columnsLimit", Infinity);
+    /**
+     * The maximum number of rows than can be copied to the clipboard.
+     *
+     * @type {number}
+     * @default Infinity
+     */
     _defineProperty(_assertThisInitialized(_this), "rowsLimit", Infinity);
+    /**
+     * When pasting:
+     * - `'overwrite'`: overwrite the currently-selected cells
+     * - `'shift_down'`: move currently-selected cells down
+     * - `'shift_right'`: move currently-selected cells to the right
+     *
+     * @type {string}
+     * @default 'overwrite'
+     */
     _defineProperty(_assertThisInitialized(_this), "pasteMode", 'overwrite');
+    /**
+     * The UI container for the secondary focusable element.
+     *
+     * @type {HTMLElement}
+     */
     _defineProperty(_assertThisInitialized(_this), "uiContainer", _this.hot.rootDocument.body);
+    /**
+     * Shows the "Copy with headers" item in the context menu and extends the context menu with the
+     * `'copy_with_column_headers'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnHeaders, {
       writable: true,
       value: false
     });
+    /**
+     * Shows the "Copy with group headers" item in the context menu and extends the context menu with the
+     * `'copy_with_column_group headers'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnGroupHeaders, {
       writable: true,
       value: false
     });
+    /**
+     * Shows the "Copy headers only" item in the context menu and extends the context menu with the
+     * `'copy_column_headers_only'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnHeadersOnly, {
       writable: true,
       value: false
     });
+    /**
+     * Defines the data range to copy. Possible values:
+     *  * `'cells-only'` Copy selected cells only;
+     *  * `'column-headers-only'` Copy column headers only;
+     *  * `'with-all-column-headers'` Copy cells with all column headers;
+     *  * `'with-column-headers'` Copy cells with column headers;
+     *
+     * @type {'cells-only' | 'column-headers-only' | 'with-all-column-headers' | 'with-column-headers'}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _copyMode, {
       writable: true,
       value: 'cells-only'
     });
+    /**
+     * Flag that is used to prevent copying when the native shortcut was not pressed.
+     *
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _isTriggeredByCopy, {
       writable: true,
       value: false
     });
+    /**
+     * Flag that is used to prevent cutting when the native shortcut was not pressed.
+     *
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _isTriggeredByCut, {
       writable: true,
       value: false
     });
+    /**
+     * Class that helps generate copyable ranges based on the current selection for different copy mode
+     * types.
+     *
+     * @type {CopyableRangesFactory}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _copyableRangesFactory, {
       writable: true,
       value: new _copyableRanges.CopyableRangesFactory({
@@ -192,7 +272,19 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
         }
       })
     });
+    /**
+     * Ranges of the cells coordinates, which should be used to copy/cut/paste actions.
+     *
+     * @private
+     * @type {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>}
+     */
     _defineProperty(_assertThisInitialized(_this), "copyableRanges", []);
+    /**
+     * Provides focusable element to support IME and copy/paste/cut actions.
+     *
+     * @private
+     * @type {FocusableWrapper}
+     */
     _defineProperty(_assertThisInitialized(_this), "focusableElement", void 0);
     return _this;
   }
@@ -501,15 +593,6 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       var _this$hot$getActiveEd2;
       return (_this$hot$getActiveEd2 = this.hot.getActiveEditor()) === null || _this$hot$getActiveEd2 === void 0 ? void 0 : _this$hot$getActiveEd2.isOpened();
     }
-
-    /**
-     * Counts how many column headers will be copied based on the passed range.
-     *
-     * @private
-     * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
-     * @returns {{ columnHeadersCount: number }} Returns an object with keys that holds
-     *                                           information with the number of copied headers.
-     */
   }, {
     key: "populateValues",
     value:
@@ -795,13 +878,6 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * The maximum number of columns than can be copied to the clipboard.
-     *
-     * @type {number}
-     * @default Infinity
-     */
   }]);
   return CopyPaste;
 }(_base.BasePlugin);

package/plugins/copyPaste/copyPaste.mjs

@@ -136,35 +136,115 @@ export var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Counts how many column headers will be copied based on the passed range.
+     *
+     * @private
+     * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
+     * @returns {{ columnHeadersCount: number }} Returns an object with keys that holds
+     *                                           information with the number of copied headers.
+     */
     _classPrivateMethodInitSpec(_assertThisInitialized(_this), _countCopiedHeaders);
+    /**
+     * The maximum number of columns than can be copied to the clipboard.
+     *
+     * @type {number}
+     * @default Infinity
+     */
     _defineProperty(_assertThisInitialized(_this), "columnsLimit", Infinity);
+    /**
+     * The maximum number of rows than can be copied to the clipboard.
+     *
+     * @type {number}
+     * @default Infinity
+     */
     _defineProperty(_assertThisInitialized(_this), "rowsLimit", Infinity);
+    /**
+     * When pasting:
+     * - `'overwrite'`: overwrite the currently-selected cells
+     * - `'shift_down'`: move currently-selected cells down
+     * - `'shift_right'`: move currently-selected cells to the right
+     *
+     * @type {string}
+     * @default 'overwrite'
+     */
     _defineProperty(_assertThisInitialized(_this), "pasteMode", 'overwrite');
+    /**
+     * The UI container for the secondary focusable element.
+     *
+     * @type {HTMLElement}
+     */
     _defineProperty(_assertThisInitialized(_this), "uiContainer", _this.hot.rootDocument.body);
+    /**
+     * Shows the "Copy with headers" item in the context menu and extends the context menu with the
+     * `'copy_with_column_headers'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnHeaders, {
       writable: true,
       value: false
     });
+    /**
+     * Shows the "Copy with group headers" item in the context menu and extends the context menu with the
+     * `'copy_with_column_group headers'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnGroupHeaders, {
       writable: true,
       value: false
     });
+    /**
+     * Shows the "Copy headers only" item in the context menu and extends the context menu with the
+     * `'copy_column_headers_only'` option that can be used for creating custom menus arrangements.
+     *
+     * @type {boolean}
+     * @default false
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _enableCopyColumnHeadersOnly, {
       writable: true,
       value: false
     });
+    /**
+     * Defines the data range to copy. Possible values:
+     *  * `'cells-only'` Copy selected cells only;
+     *  * `'column-headers-only'` Copy column headers only;
+     *  * `'with-all-column-headers'` Copy cells with all column headers;
+     *  * `'with-column-headers'` Copy cells with column headers;
+     *
+     * @type {'cells-only' | 'column-headers-only' | 'with-all-column-headers' | 'with-column-headers'}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _copyMode, {
       writable: true,
       value: 'cells-only'
     });
+    /**
+     * Flag that is used to prevent copying when the native shortcut was not pressed.
+     *
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _isTriggeredByCopy, {
       writable: true,
       value: false
     });
+    /**
+     * Flag that is used to prevent cutting when the native shortcut was not pressed.
+     *
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _isTriggeredByCut, {
       writable: true,
       value: false
     });
+    /**
+     * Class that helps generate copyable ranges based on the current selection for different copy mode
+     * types.
+     *
+     * @type {CopyableRangesFactory}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _copyableRangesFactory, {
       writable: true,
       value: new CopyableRangesFactory({
@@ -185,7 +265,19 @@ export var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
         }
       })
     });
+    /**
+     * Ranges of the cells coordinates, which should be used to copy/cut/paste actions.
+     *
+     * @private
+     * @type {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>}
+     */
     _defineProperty(_assertThisInitialized(_this), "copyableRanges", []);
+    /**
+     * Provides focusable element to support IME and copy/paste/cut actions.
+     *
+     * @private
+     * @type {FocusableWrapper}
+     */
     _defineProperty(_assertThisInitialized(_this), "focusableElement", void 0);
     return _this;
   }
@@ -494,15 +586,6 @@ export var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       var _this$hot$getActiveEd2;
       return (_this$hot$getActiveEd2 = this.hot.getActiveEditor()) === null || _this$hot$getActiveEd2 === void 0 ? void 0 : _this$hot$getActiveEd2.isOpened();
     }
-
-    /**
-     * Counts how many column headers will be copied based on the passed range.
-     *
-     * @private
-     * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
-     * @returns {{ columnHeadersCount: number }} Returns an object with keys that holds
-     *                                           information with the number of copied headers.
-     */
   }, {
     key: "populateValues",
     value:
@@ -788,13 +871,6 @@ export var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * The maximum number of columns than can be copied to the clipboard.
-     *
-     * @type {number}
-     * @default Infinity
-     */
   }]);
   return CopyPaste;
 }(BasePlugin);

package/plugins/copyPaste/copyableRanges.js

@@ -90,7 +90,21 @@ var CopyableRangesFactory = /*#__PURE__*/function () {
       columnsLimit = _ref.columnsLimit,
       countColumnHeaders = _ref.countColumnHeaders;
     _classCallCheck(this, CopyableRangesFactory);
+    /**
+     * Trimmed the rows range to the limit.
+     *
+     * @param {*} startRow The lowest row index in the range.
+     * @param {*} endRow The highest row index in the range.
+     * @returns {number} Returns trimmed row index if it exceeds the limit.
+     */
     _classPrivateMethodInitSpec(this, _trimRowsRange);
+    /**
+     * Trimmed the columns range to the limit.
+     *
+     * @param {*} startColumn The lowest column index in the range.
+     * @param {*} endColumn The highest column index in the range.
+     * @returns {number} Returns trimmed column index if it exceeds the limit.
+     */
     _classPrivateMethodInitSpec(this, _trimColumnsRange);
     _classPrivateFieldInitSpec(this, _selectedRange, {
       writable: true,
@@ -218,14 +232,6 @@ var CopyableRangesFactory = /*#__PURE__*/function () {
         endCol: finalEndCol
       };
     }
-
-    /**
-     * Trimmed the columns range to the limit.
-     *
-     * @param {*} startColumn The lowest column index in the range.
-     * @param {*} endColumn The highest column index in the range.
-     * @returns {number} Returns trimmed column index if it exceeds the limit.
-     */
   }]);
   return CopyableRangesFactory;
 }();

package/plugins/copyPaste/copyableRanges.mjs

@@ -85,7 +85,21 @@ export var CopyableRangesFactory = /*#__PURE__*/function () {
       columnsLimit = _ref.columnsLimit,
       countColumnHeaders = _ref.countColumnHeaders;
     _classCallCheck(this, CopyableRangesFactory);
+    /**
+     * Trimmed the rows range to the limit.
+     *
+     * @param {*} startRow The lowest row index in the range.
+     * @param {*} endRow The highest row index in the range.
+     * @returns {number} Returns trimmed row index if it exceeds the limit.
+     */
     _classPrivateMethodInitSpec(this, _trimRowsRange);
+    /**
+     * Trimmed the columns range to the limit.
+     *
+     * @param {*} startColumn The lowest column index in the range.
+     * @param {*} endColumn The highest column index in the range.
+     * @returns {number} Returns trimmed column index if it exceeds the limit.
+     */
     _classPrivateMethodInitSpec(this, _trimColumnsRange);
     _classPrivateFieldInitSpec(this, _selectedRange, {
       writable: true,
@@ -213,14 +227,6 @@ export var CopyableRangesFactory = /*#__PURE__*/function () {
         endCol: finalEndCol
       };
     }
-
-    /**
-     * Trimmed the columns range to the limit.
-     *
-     * @param {*} startColumn The lowest column index in the range.
-     * @param {*} endColumn The highest column index in the range.
-     * @returns {number} Returns trimmed column index if it exceeds the limit.
-     */
   }]);
   return CopyableRangesFactory;
 }();

package/plugins/customBorders/customBorders.js

@@ -129,6 +129,12 @@ var CustomBorders = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Saved borders.
+     *
+     * @private
+     * @type {Array}
+     */
     _defineProperty(_assertThisInitialized(_this), "savedBorders", []);
     return _this;
   }
@@ -879,13 +885,6 @@ var CustomBorders = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * Saved borders.
-     *
-     * @private
-     * @type {Array}
-     */
   }]);
   return CustomBorders;
 }(_base.BasePlugin);

package/plugins/customBorders/customBorders.mjs

@@ -120,6 +120,12 @@ export var CustomBorders = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Saved borders.
+     *
+     * @private
+     * @type {Array}
+     */
     _defineProperty(_assertThisInitialized(_this), "savedBorders", []);
     return _this;
   }
@@ -870,13 +876,6 @@ export var CustomBorders = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * Saved borders.
-     *
-     * @private
-     * @type {Array}
-     */
   }]);
   return CustomBorders;
 }(BasePlugin);

package/plugins/filters/filters.js

@@ -154,14 +154,6 @@ var Filters = /*#__PURE__*/function (_BasePlugin) {
      * @type {Map}
      */
     _this.components = new Map([['filter_by_condition', null], ['filter_operators', null], ['filter_by_condition2', null], ['filter_by_value', null], ['filter_action_bar', null]]);
-    /**
-     * Object containing information about last selected column physical and visual index for added filter conditions.
-     *
-     * @private
-     * @type {object}
-     * @default null
-     */
-    _this.lastSelectedColumn = null;
     /**
      * Map of skipped rows by plugin.
      *

package/plugins/filters/filters.mjs

@@ -144,14 +144,6 @@ export var Filters = /*#__PURE__*/function (_BasePlugin) {
      * @type {Map}
      */
     _this.components = new Map([['filter_by_condition', null], ['filter_operators', null], ['filter_by_condition2', null], ['filter_by_value', null], ['filter_action_bar', null]]);
-    /**
-     * Object containing information about last selected column physical and visual index for added filter conditions.
-     *
-     * @private
-     * @type {object}
-     * @default null
-     */
-    _this.lastSelectedColumn = null;
     /**
      * Map of skipped rows by plugin.
      *

package/plugins/formulas/formulas.js

@@ -123,14 +123,31 @@ var Formulas = /*#__PURE__*/function (_BasePlugin) {
       _args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(_args));
+    /**
+     * Flag used to bypass hooks in internal operations.
+     *
+     * @private
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _internalOperationPending, {
       writable: true,
       value: false
     });
+    /**
+     * Flag needed to mark if Handsontable was initialized with no data.
+     * (Required to work around the fact, that Handsontable auto-generates sample data, when no data is provided).
+     *
+     * @type {boolean}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _hotWasInitializedWithEmptyData, {
       writable: true,
       value: false
     });
+    /**
+     * The list of the HyperFormula listeners.
+     *
+     * @type {Array}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _engineListeners, {
       writable: true,
       value: [['valuesUpdated', function () {
@@ -153,8 +170,25 @@ var Formulas = /*#__PURE__*/function (_BasePlugin) {
         return (_this7 = _this).onEngineSheetRemoved.apply(_this7, arguments);
       }]]
     });
+    /**
+     * Static register used to set up one global HyperFormula instance.
+     * TODO: currently used in tests, might be removed later.
+     *
+     * @private
+     * @type {object}
+     */
     _defineProperty(_assertThisInitialized(_this), "staticRegister", (0, _staticRegister.default)('formulas'));
+    /**
+     * The engine instance that will be used for this instance of Handsontable.
+     *
+     * @type {HyperFormula|null}
+     */
     _defineProperty(_assertThisInitialized(_this), "engine", null);
+    /**
+     * HyperFormula's sheet name.
+     *
+     * @type {string|null}
+     */
     _defineProperty(_assertThisInitialized(_this), "sheetName", null);
     return _this;
   }
@@ -1221,13 +1255,6 @@ var Formulas = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * Flag used to bypass hooks in internal operations.
-     *
-     * @private
-     * @type {boolean}
-     */
   }]);
   return Formulas;
 }(_base.BasePlugin);