handsontable 12.1.2 → 12.2.0

package/plugins/columnSummary/columnSummary.mjs

@@ -1,5 +1,4 @@
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-
 import "core-js/modules/es.object.set-prototype-of.js";
 import "core-js/modules/es.object.get-prototype-of.js";
 import "core-js/modules/es.object.to-string.js";
@@ -14,47 +13,32 @@ import "core-js/modules/es.symbol.iterator.js";
 import "core-js/modules/es.array.iterator.js";
 import "core-js/modules/es.string.iterator.js";
 import "core-js/modules/web.dom-collections.iterator.js";
-
 var _templateObject;
-
 function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
-
 import "core-js/modules/es.array.concat.js";
-import "core-js/modules/es.regexp.exec.js";
-import "core-js/modules/es.string.split.js";
 import "core-js/modules/es.array.index-of.js";
+import "core-js/modules/es.regexp.exec.js";
 import "core-js/modules/es.string.replace.js";
-
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
 function _get() { if (typeof Reflect !== "undefined" && Reflect.get) { _get = Reflect.get.bind(); } else { _get = function _get(target, property, receiver) { var base = _superPropBase(target, property); if (!base) return; var desc = Object.getOwnPropertyDescriptor(base, property); if (desc.get) { return desc.get.call(arguments.length < 3 ? target : receiver); } return desc.value; }; } return _get.apply(this, arguments); }
-
 function _superPropBase(object, property) { while (!Object.prototype.hasOwnProperty.call(object, property)) { object = _getPrototypeOf(object); if (object === null) break; } return object; }
-
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
-
 function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
-
 function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
-
 function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
 function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
-
 import { BasePlugin } from "../base/index.mjs";
 import { objectEach } from "../../helpers/object.mjs";
 import Endpoints from "./endpoints.mjs";
 import { toSingleLine } from "../../helpers/templateLiteralTag.mjs";
+import { isNullishOrNaN } from "./utils.mjs";
 export var PLUGIN_KEY = 'columnSummary';
 export var PLUGIN_PRIORITY = 220;
+
 /**
  * @plugin ColumnSummary
  * @class ColumnSummary
@@ -82,6 +66,8 @@ export var PLUGIN_PRIORITY = 220;
  * | `customFunction` | No | Function | - | [Lets you add a custom summary function](@/guides/columns/column-summary.md#implementing-a-custom-summary-function) |
  *
  * @example
+ * ::: only-for javascript
+ * ```js
  * const container = document.getElementById('example');
  * const hot = new Handsontable(container, {
  *   data: getData(),
@@ -107,18 +93,44 @@ export var PLUGIN_PRIORITY = 220;
  *     }
  *   ]
  * });
+ * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * <HotTable
+ *   data={getData()}
+ *   colHeaders={true}
+ *   rowHeaders={true}
+ *   columnSummary={[
+ *     {
+ *       type: 'min',
+ *       destinationRow: 4,
+ *       destinationColumn: 1,
+ *     },
+ *     {
+ *       type: 'max',
+ *       destinationRow: 0,
+ *       destinationColumn: 3,
+ *       reversedRowCoords: true
+ *     },
+ *     {
+ *       type: 'sum',
+ *       destinationRow: 4,
+ *       destinationColumn: 5,
+ *       forceNumeric: true
+ *     }
+ *   ]}
+ * />
+ * ```
+ * :::
  */
-
 export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
   _inherits(ColumnSummary, _BasePlugin);
-
   var _super = _createSuper(ColumnSummary);
-
   function ColumnSummary(hotInstance) {
     var _this;
-
     _classCallCheck(this, ColumnSummary);
-
     _this = _super.call(this, hotInstance);
     /**
      * The Endpoints class instance. Used to make all endpoint-related operations.
@@ -126,36 +138,32 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @private
      * @type {null|Endpoints}
      */
-
     _this.endpoints = null;
     return _this;
   }
+
   /**
    * Checks if the plugin is enabled in the handsontable settings. This method is executed in {@link Hooks#beforeInit}
-   * hook and if it returns `true` than the {@link ColumnSummary#enablePlugin} method is called.
+   * hook and if it returns `true` then the {@link ColumnSummary#enablePlugin} method is called.
    *
    * @returns {boolean}
    */
-
-
   _createClass(ColumnSummary, [{
     key: "isEnabled",
     value: function isEnabled() {
       return !!this.hot.getSettings()[PLUGIN_KEY];
     }
+
     /**
      * Enables the plugin functionality for this Handsontable instance.
      */
-
   }, {
     key: "enablePlugin",
     value: function enablePlugin() {
       var _this2 = this;
-
       if (this.enabled) {
         return;
       }
-
       this.settings = this.hot.getSettings()[PLUGIN_KEY];
       this.endpoints = new Endpoints(this, this.settings);
       this.addHook('afterInit', function () {
@@ -167,65 +175,52 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
       this.addHook('beforeCreateRow', function (index, amount, source) {
         return _this2.endpoints.resetSetupBeforeStructureAlteration('insert_row', index, amount, null, source);
       }); // eslint-disable-line max-len
-
       this.addHook('beforeCreateCol', function (index, amount, source) {
         return _this2.endpoints.resetSetupBeforeStructureAlteration('insert_col', index, amount, null, source);
       }); // eslint-disable-line max-len
-
       this.addHook('beforeRemoveRow', function () {
         var _this2$endpoints;
-
         for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
           args[_key] = arguments[_key];
         }
-
         return (_this2$endpoints = _this2.endpoints).resetSetupBeforeStructureAlteration.apply(_this2$endpoints, ['remove_row'].concat(args));
       });
       this.addHook('beforeRemoveCol', function () {
         var _this2$endpoints2;
-
         for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
           args[_key2] = arguments[_key2];
         }
-
         return (_this2$endpoints2 = _this2.endpoints).resetSetupBeforeStructureAlteration.apply(_this2$endpoints2, ['remove_col'].concat(args));
       });
       this.addHook('afterCreateRow', function (index, amount, source) {
         return _this2.endpoints.resetSetupAfterStructureAlteration('insert_row', index, amount, null, source);
       }); // eslint-disable-line max-len
-
       this.addHook('afterCreateCol', function (index, amount, source) {
         return _this2.endpoints.resetSetupAfterStructureAlteration('insert_col', index, amount, null, source);
       }); // eslint-disable-line max-len
-
       this.addHook('afterRemoveRow', function () {
         var _this2$endpoints3;
-
         for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
           args[_key3] = arguments[_key3];
         }
-
         return (_this2$endpoints3 = _this2.endpoints).resetSetupAfterStructureAlteration.apply(_this2$endpoints3, ['remove_row'].concat(args));
       });
       this.addHook('afterRemoveCol', function () {
         var _this2$endpoints4;
-
         for (var _len4 = arguments.length, args = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
           args[_key4] = arguments[_key4];
         }
-
         return (_this2$endpoints4 = _this2.endpoints).resetSetupAfterStructureAlteration.apply(_this2$endpoints4, ['remove_col'].concat(args));
       });
       this.addHook('afterRowMove', function () {
         return _this2.onAfterRowMove.apply(_this2, arguments);
       });
-
       _get(_getPrototypeOf(ColumnSummary.prototype), "enablePlugin", this).call(this);
     }
+
     /**
      * Disables the plugin functionality for this Handsontable instance.
      */
-
   }, {
     key: "disablePlugin",
     value: function disablePlugin() {
@@ -233,13 +228,13 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
       this.settings = null;
       this.currentEndpoint = null;
     }
+
     /**
      * Calculates math for a single endpoint.
      *
      * @private
      * @param {object} endpoint Contains information about the endpoint.
      */
-
   }, {
     key: "calculate",
     value: function calculate(endpoint) {
@@ -247,31 +242,26 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
         case 'sum':
           endpoint.result = this.calculateSum(endpoint);
           break;
-
         case 'min':
           endpoint.result = this.calculateMinMax(endpoint, endpoint.type);
           break;
-
         case 'max':
           endpoint.result = this.calculateMinMax(endpoint, endpoint.type);
           break;
-
         case 'count':
           endpoint.result = this.countEntries(endpoint);
           break;
-
         case 'average':
           endpoint.result = this.calculateAverage(endpoint);
           break;
-
         case 'custom':
           endpoint.result = endpoint.customFunction.call(this, endpoint);
           break;
-
         default:
           break;
       }
     }
+
     /**
      * Calculates sum of the values contained in ranges provided in the plugin config.
      *
@@ -279,18 +269,17 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {object} endpoint Contains the endpoint information.
      * @returns {number} Sum for the selected range.
      */
-
   }, {
     key: "calculateSum",
     value: function calculateSum(endpoint) {
       var _this3 = this;
-
       var sum = 0;
       objectEach(endpoint.ranges, function (range) {
         sum += _this3.getPartialSum(range, endpoint.sourceColumn);
       });
       return sum;
     }
+
     /**
      * Returns partial sum of values from a single row range.
      *
@@ -299,7 +288,6 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {number} col Column index.
      * @returns {number} The partial sum.
      */
-
   }, {
     key: "getPartialSum",
     value: function getPartialSum(rowRange, col) {
@@ -307,22 +295,23 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
       var i = rowRange[1] || rowRange[0];
       var cellValue = null;
       var biggestDecimalPlacesCount = 0;
-
       do {
-        cellValue = this.getCellValue(i, col) || 0;
-        var decimalPlaces = ("".concat(cellValue).split('.')[1] || []).length || 1;
-
-        if (decimalPlaces > biggestDecimalPlacesCount) {
-          biggestDecimalPlacesCount = decimalPlaces;
+        cellValue = this.getCellValue(i, col);
+        cellValue = isNullishOrNaN(cellValue) ? null : cellValue;
+        if (cellValue !== null) {
+          var decimalPlaces = ("".concat(cellValue).split('.')[1] || []).length || 1;
+          if (decimalPlaces > biggestDecimalPlacesCount) {
+            biggestDecimalPlacesCount = decimalPlaces;
+          }
         }
-
         sum += cellValue || 0;
         i -= 1;
-      } while (i >= rowRange[0]); // Workaround for e.g. 802.2 + 1.1 = 803.3000000000001
-
+      } while (i >= rowRange[0]);
 
+      // Workaround for e.g. 802.2 + 1.1 = 803.3000000000001
       return Math.round(sum * Math.pow(10, biggestDecimalPlacesCount)) / Math.pow(10, biggestDecimalPlacesCount);
     }
+
     /**
      * Calculates the minimal value for the selected ranges.
      *
@@ -331,30 +320,24 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {string} type `'min'` or `'max'`.
      * @returns {number} Min or Max value.
      */
-
   }, {
     key: "calculateMinMax",
     value: function calculateMinMax(endpoint, type) {
       var _this4 = this;
-
       var result = null;
       objectEach(endpoint.ranges, function (range) {
         var partialResult = _this4.getPartialMinMax(range, endpoint.sourceColumn, type);
-
         if (result === null && partialResult !== null) {
           result = partialResult;
         }
-
         if (partialResult !== null) {
           switch (type) {
             case 'min':
               result = Math.min(result, partialResult);
               break;
-
             case 'max':
               result = Math.max(result, partialResult);
               break;
-
             default:
               break;
           }
@@ -362,6 +345,7 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
       });
       return result === null ? 'Not enough data' : result;
     }
+
     /**
      * Returns a local minimum of the provided sub-range.
      *
@@ -369,19 +353,17 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {Array} rowRange Range for the calculation.
      * @param {number} col Column index.
      * @param {string} type `'min'` or `'max'`.
-     * @returns {number} Min or max value.
+     * @returns {number|null} Min or max value.
      */
-
   }, {
     key: "getPartialMinMax",
     value: function getPartialMinMax(rowRange, col, type) {
       var result = null;
       var i = rowRange[1] || rowRange[0];
       var cellValue;
-
       do {
-        cellValue = this.getCellValue(i, col) || null;
-
+        cellValue = this.getCellValue(i, col);
+        cellValue = isNullishOrNaN(cellValue) ? null : cellValue;
         if (result === null) {
           result = cellValue;
         } else if (cellValue !== null) {
@@ -389,21 +371,18 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
             case 'min':
               result = Math.min(result, cellValue);
               break;
-
             case 'max':
               result = Math.max(result, cellValue);
               break;
-
             default:
               break;
           }
         }
-
         i -= 1;
       } while (i >= rowRange[0]);
-
       return result;
     }
+
     /**
      * Counts empty cells in the provided row range.
      *
@@ -412,26 +391,23 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {number} col Column index.
      * @returns {number} Empty cells count.
      */
-
   }, {
     key: "countEmpty",
     value: function countEmpty(rowRange, col) {
       var cellValue;
       var counter = 0;
       var i = rowRange[1] || rowRange[0];
-
       do {
         cellValue = this.getCellValue(i, col);
-
-        if (!cellValue) {
+        cellValue = isNullishOrNaN(cellValue) ? null : cellValue;
+        if (cellValue === null) {
           counter += 1;
         }
-
         i -= 1;
       } while (i >= rowRange[0]);
-
       return counter;
     }
+
     /**
      * Counts non-empty cells in the provided row range.
      *
@@ -439,24 +415,21 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {object} endpoint Contains the endpoint information.
      * @returns {number} Entry count.
      */
-
   }, {
     key: "countEntries",
     value: function countEntries(endpoint) {
       var _this5 = this;
-
       var result = 0;
       var ranges = endpoint.ranges;
       objectEach(ranges, function (range) {
         var partial = range[1] === void 0 ? 1 : range[1] - range[0] + 1;
-
         var emptyCount = _this5.countEmpty(range, endpoint.sourceColumn);
-
         result += partial;
         result -= emptyCount;
       });
       return result;
     }
+
     /**
      * Calculates the average value from the cells in the range.
      *
@@ -464,7 +437,6 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {object} endpoint Contains the endpoint information.
      * @returns {number} Avarage value.
      */
-
   }, {
     key: "calculateAverage",
     value: function calculateAverage(endpoint) {
@@ -472,6 +444,7 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
       var entriesCount = this.countEntries(endpoint);
       return sum / entriesCount;
     }
+
     /**
      * Returns a cell value, taking into consideration a basic validation.
      *
@@ -480,7 +453,6 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {number} col Column index.
      * @returns {string} The cell value.
      */
-
   }, {
     key: "getCellValue",
     value: function getCellValue(row, col) {
@@ -488,43 +460,38 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
       var visualColumnIndex = this.hot.toVisualColumn(col);
       var cellValue = this.hot.getSourceDataAtCell(row, col);
       var cellClassName = '';
-
       if (visualRowIndex !== null && visualColumnIndex !== null) {
         cellClassName = this.hot.getCellMeta(visualRowIndex, visualColumnIndex).className || '';
       }
-
       if (cellClassName.indexOf('columnSummaryResult') > -1) {
         return null;
       }
-
       if (this.endpoints.currentEndpoint.forceNumeric) {
         if (typeof cellValue === 'string') {
           cellValue = cellValue.replace(/,/, '.');
         }
-
         cellValue = parseFloat(cellValue);
       }
-
       if (isNaN(cellValue)) {
         if (!this.endpoints.currentEndpoint.suppressDataTypeErrors) {
           throw new Error(toSingleLine(_templateObject || (_templateObject = _taggedTemplateLiteral(["ColumnSummary plugin: cell at (", ", ", ") is not in a \n          numeric format. Cannot do the calculation."], ["ColumnSummary plugin: cell at (", ", ", ") is not in a\\x20\n          numeric format. Cannot do the calculation."])), row, col));
         }
       }
-
       return cellValue;
     }
+
     /**
      * `afterInit` hook callback.
      *
      * @private
      */
-
   }, {
     key: "onAfterInit",
     value: function onAfterInit() {
       this.endpoints.endpoints = this.endpoints.parseSettings();
       this.endpoints.refreshAllEndpoints(true);
     }
+
     /**
      * `afterChange` hook callback.
      *
@@ -532,7 +499,6 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {Array} changes 2D array containing information about each of the edited cells.
      * @param {string} source The string that identifies source of changes.
      */
-
   }, {
     key: "onAfterChange",
     value: function onAfterChange(changes, source) {
@@ -540,6 +506,7 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
         this.endpoints.refreshChangedEndpoints(changes);
       }
     }
+
     /**
      * `beforeRowMove` hook callback.
      *
@@ -548,7 +515,6 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
      * @param {number} finalIndex Visual row index, being a start index for the moved rows. Points to where the elements will be placed after the moving action.
      * To check the visualization of the final index, please take a look at [documentation](@/guides/rows/row-moving.md).
      */
-
   }, {
     key: "onAfterRowMove",
     value: function onAfterRowMove(rows, finalIndex) {
@@ -566,6 +532,5 @@ export var ColumnSummary = /*#__PURE__*/function (_BasePlugin) {
       return PLUGIN_PRIORITY;
     }
   }]);
-
   return ColumnSummary;
 }(BasePlugin);