handsontable 12.3.1 → 12.3.2-next-e75de58-20230322

package/plugins/formulas/formulas.mjs

@@ -116,14 +116,31 @@ export 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 () {
@@ -146,8 +163,25 @@ export 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", staticRegister('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;
   }
@@ -1214,13 +1248,6 @@ export var Formulas = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * Flag used to bypass hooks in internal operations.
-     *
-     * @private
-     * @type {boolean}
-     */
   }]);
   return Formulas;
 }(BasePlugin);

package/plugins/hiddenColumns/hiddenColumns.js

@@ -188,10 +188,22 @@ var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Cached plugin settings.
+     *
+     * @private
+     * @type {object}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _settings, {
       writable: true,
       value: {}
     });
+    /**
+     * Map of hidden columns by the plugin.
+     *
+     * @private
+     * @type {null|HidingMap}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _hiddenColumnsMap, {
       writable: true,
       value: null
@@ -611,13 +623,6 @@ var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * Cached plugin settings.
-     *
-     * @private
-     * @type {object}
-     */
   }]);
   return HiddenColumns;
 }(_base.BasePlugin);

package/plugins/hiddenColumns/hiddenColumns.mjs

@@ -181,10 +181,22 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Cached plugin settings.
+     *
+     * @private
+     * @type {object}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _settings, {
       writable: true,
       value: {}
     });
+    /**
+     * Map of hidden columns by the plugin.
+     *
+     * @private
+     * @type {null|HidingMap}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _hiddenColumnsMap, {
       writable: true,
       value: null
@@ -604,13 +616,6 @@ export var HiddenColumns = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * Cached plugin settings.
-     *
-     * @private
-     * @type {object}
-     */
   }]);
   return HiddenColumns;
 }(BasePlugin);

package/plugins/hiddenRows/hiddenRows.js

@@ -188,10 +188,22 @@ var HiddenRows = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Cached settings from Handsontable settings.
+     *
+     * @private
+     * @type {object}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _settings, {
       writable: true,
       value: {}
     });
+    /**
+     * Map of hidden rows by the plugin.
+     *
+     * @private
+     * @type {HidingMap|null}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _hiddenRowsMap, {
       writable: true,
       value: null
@@ -603,13 +615,6 @@ var HiddenRows = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * Cached settings from Handsontable settings.
-     *
-     * @private
-     * @type {object}
-     */
   }]);
   return HiddenRows;
 }(_base.BasePlugin);

package/plugins/hiddenRows/hiddenRows.mjs

@@ -181,10 +181,22 @@ export var HiddenRows = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Cached settings from Handsontable settings.
+     *
+     * @private
+     * @type {object}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _settings, {
       writable: true,
       value: {}
     });
+    /**
+     * Map of hidden rows by the plugin.
+     *
+     * @private
+     * @type {HidingMap|null}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _hiddenRowsMap, {
       writable: true,
       value: null
@@ -596,13 +608,6 @@ export var HiddenRows = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * Cached settings from Handsontable settings.
-     *
-     * @private
-     * @type {object}
-     */
   }]);
   return HiddenRows;
 }(BasePlugin);

package/plugins/nestedHeaders/nestedHeaders.js

@@ -119,17 +119,43 @@ var NestedHeaders = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * The state manager for the nested headers.
+     *
+     * @private
+     * @type {StateManager}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _stateManager, {
       writable: true,
       value: new _stateManager2.default()
     });
+    /**
+     * The instance of the ChangesObservable class that allows track the changes that happens in the
+     * column indexes.
+     *
+     * @private
+     * @type {ChangesObservable}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _hidingIndexMapObserver, {
       writable: true,
       value: null
     });
+    /**
+     * Custom helper for getting widths of the nested headers.
+     *
+     * @private
+     * @type {GhostTable}
+     */
+    // @TODO This should be changed after refactor handsontable/utils/ghostTable.
     _defineProperty(_assertThisInitialized(_this), "ghostTable", new _ghostTable.default(_this.hot, function (row, column) {
       return _this.getHeaderSettings(row, column);
     }));
+    /**
+     * The flag which determines that the nested header settings contains overlapping headers
+     * configuration.
+     *
+     * @type {boolean}
+     */
     _defineProperty(_assertThisInitialized(_this), "detectedOverlappedHeaders", false);
     return _this;
   }
@@ -761,13 +787,6 @@ var NestedHeaders = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * The state manager for the nested headers.
-     *
-     * @private
-     * @type {StateManager}
-     */
   }]);
   return NestedHeaders;
 }(_base.BasePlugin);

package/plugins/nestedHeaders/nestedHeaders.mjs

@@ -112,17 +112,43 @@ export var NestedHeaders = /*#__PURE__*/function (_BasePlugin) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * The state manager for the nested headers.
+     *
+     * @private
+     * @type {StateManager}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _stateManager, {
       writable: true,
       value: new StateManager()
     });
+    /**
+     * The instance of the ChangesObservable class that allows track the changes that happens in the
+     * column indexes.
+     *
+     * @private
+     * @type {ChangesObservable}
+     */
     _classPrivateFieldInitSpec(_assertThisInitialized(_this), _hidingIndexMapObserver, {
       writable: true,
       value: null
     });
+    /**
+     * Custom helper for getting widths of the nested headers.
+     *
+     * @private
+     * @type {GhostTable}
+     */
+    // @TODO This should be changed after refactor handsontable/utils/ghostTable.
     _defineProperty(_assertThisInitialized(_this), "ghostTable", new GhostTable(_this.hot, function (row, column) {
       return _this.getHeaderSettings(row, column);
     }));
+    /**
+     * The flag which determines that the nested header settings contains overlapping headers
+     * configuration.
+     *
+     * @type {boolean}
+     */
     _defineProperty(_assertThisInitialized(_this), "detectedOverlappedHeaders", false);
     return _this;
   }
@@ -754,13 +780,6 @@ export var NestedHeaders = /*#__PURE__*/function (_BasePlugin) {
     get: function get() {
       return PLUGIN_PRIORITY;
     }
-
-    /**
-     * The state manager for the nested headers.
-     *
-     * @private
-     * @type {StateManager}
-     */
   }]);
   return NestedHeaders;
 }(BasePlugin);

package/plugins/nestedHeaders/stateManager/index.js

@@ -79,14 +79,32 @@ var _stateMatrix = /*#__PURE__*/new WeakMap();
 var StateManager = /*#__PURE__*/function () {
   function StateManager() {
     _classCallCheck(this, StateManager);
+    /**
+     * The instance of the source settings class.
+     *
+     * @private
+     * @type {SourceSettings}
+     */
     _classPrivateFieldInitSpec(this, _sourceSettings, {
       writable: true,
       value: new _sourceSettings2.default()
     });
+    /**
+     * The instance of the headers tree. The tree is generated after setting new configuration data.
+     *
+     * @private
+     * @type {HeadersTree}
+     */
     _classPrivateFieldInitSpec(this, _headersTree, {
       writable: true,
       value: new _headersTree2.default(_classPrivateFieldGet(this, _sourceSettings))
     });
+    /**
+     * Cached matrix which is generated from the tree structure.
+     *
+     * @private
+     * @type {Array[]}
+     */
     _classPrivateFieldInitSpec(this, _stateMatrix, {
       writable: true,
       value: [[]]

package/plugins/nestedHeaders/stateManager/index.mjs

@@ -74,14 +74,32 @@ var _stateMatrix = /*#__PURE__*/new WeakMap();
 var StateManager = /*#__PURE__*/function () {
   function StateManager() {
     _classCallCheck(this, StateManager);
+    /**
+     * The instance of the source settings class.
+     *
+     * @private
+     * @type {SourceSettings}
+     */
     _classPrivateFieldInitSpec(this, _sourceSettings, {
       writable: true,
       value: new SourceSettings()
     });
+    /**
+     * The instance of the headers tree. The tree is generated after setting new configuration data.
+     *
+     * @private
+     * @type {HeadersTree}
+     */
     _classPrivateFieldInitSpec(this, _headersTree, {
       writable: true,
       value: new HeadersTree(_classPrivateFieldGet(this, _sourceSettings))
     });
+    /**
+     * Cached matrix which is generated from the tree structure.
+     *
+     * @private
+     * @type {Array[]}
+     */
     _classPrivateFieldInitSpec(this, _stateMatrix, {
       writable: true,
       value: [[]]

package/plugins/nestedHeaders/stateManager/sourceSettings.js

@@ -63,14 +63,33 @@ var _columnsLimit = /*#__PURE__*/new WeakMap();
 var SourceSettings = /*#__PURE__*/function () {
   function SourceSettings() {
     _classCallCheck(this, SourceSettings);
+    /**
+     * The normalized source data (normalized user-defined settings for nested headers).
+     *
+     * @private
+     * @type {Array[]}
+     */
     _classPrivateFieldInitSpec(this, _data, {
       writable: true,
       value: []
     });
+    /**
+     * The total length of the nested header layers.
+     *
+     * @private
+     * @type {number}
+     */
     _classPrivateFieldInitSpec(this, _dataLength, {
       writable: true,
       value: 0
     });
+    /**
+     * Columns count limit value trims source settings to that value. If columns
+     * count limit intersects nested header, the header's colspan value is reduced
+     * to keep the whole structure stable (trimmed precisely where the limit is set).
+     *
+     * @type {number}
+     */
     _classPrivateFieldInitSpec(this, _columnsLimit, {
       writable: true,
       value: Infinity

package/plugins/nestedHeaders/stateManager/sourceSettings.mjs

@@ -58,14 +58,33 @@ var _columnsLimit = /*#__PURE__*/new WeakMap();
 var SourceSettings = /*#__PURE__*/function () {
   function SourceSettings() {
     _classCallCheck(this, SourceSettings);
+    /**
+     * The normalized source data (normalized user-defined settings for nested headers).
+     *
+     * @private
+     * @type {Array[]}
+     */
     _classPrivateFieldInitSpec(this, _data, {
       writable: true,
       value: []
     });
+    /**
+     * The total length of the nested header layers.
+     *
+     * @private
+     * @type {number}
+     */
     _classPrivateFieldInitSpec(this, _dataLength, {
       writable: true,
       value: 0
     });
+    /**
+     * Columns count limit value trims source settings to that value. If columns
+     * count limit intersects nested header, the header's colspan value is reduced
+     * to keep the whole structure stable (trimmed precisely where the limit is set).
+     *
+     * @type {number}
+     */
     _classPrivateFieldInitSpec(this, _columnsLimit, {
       writable: true,
       value: Infinity

package/translations/changesObservable/observer.js

@@ -39,6 +39,13 @@ var _currentInitialChanges = /*#__PURE__*/new WeakMap();
 var ChangesObserver = /*#__PURE__*/function () {
   function ChangesObserver() {
     _classCallCheck(this, ChangesObserver);
+    /**
+     * The field holds initial changes that will be used to notify the callbacks added using
+     * subscribe method. Regardless of the moment of listening for changes, the subscriber
+     * will be notified once with all changes made before subscribing.
+     *
+     * @type {Array}
+     */
     _classPrivateFieldInitSpec(this, _currentInitialChanges, {
       writable: true,
       value: []

package/translations/changesObservable/observer.mjs

@@ -34,6 +34,13 @@ var _currentInitialChanges = /*#__PURE__*/new WeakMap();
 export var ChangesObserver = /*#__PURE__*/function () {
   function ChangesObserver() {
     _classCallCheck(this, ChangesObserver);
+    /**
+     * The field holds initial changes that will be used to notify the callbacks added using
+     * subscribe method. Regardless of the moment of listening for changes, the subscriber
+     * will be notified once with all changes made before subscribing.
+     *
+     * @type {Array}
+     */
     _classPrivateFieldInitSpec(this, _currentInitialChanges, {
       writable: true,
       value: []

package/translations/maps/linkedPhysicalIndexToValueMap.js

@@ -71,6 +71,12 @@ var LinkedPhysicalIndexToValueMap = /*#__PURE__*/function (_IndexMap) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Indexes and values corresponding to them (entries) are stored in a certain order.
+     *
+     * @private
+     * @type {Array<number>}
+     */
     _defineProperty(_assertThisInitialized(_this), "orderOfIndexes", []);
     return _this;
   }

package/translations/maps/linkedPhysicalIndexToValueMap.mjs

@@ -67,6 +67,12 @@ export var LinkedPhysicalIndexToValueMap = /*#__PURE__*/function (_IndexMap) {
       args[_key] = arguments[_key];
     }
     _this = _super.call.apply(_super, [this].concat(args));
+    /**
+     * Indexes and values corresponding to them (entries) are stored in a certain order.
+     *
+     * @private
+     * @type {Array<number>}
+     */
     _defineProperty(_assertThisInitialized(_this), "orderOfIndexes", []);
     return _this;
   }