@dhis2/analytics 26.2.0-alpha.2 → 26.2.0-cumulative-values-alpha.1

package/build/cjs/modules/pivotTable/PivotTableEngine.js

@@ -27,7 +27,8 @@ const defaultOptions = {
   showRowSubtotals: false,
   showColumnSubtotals: false,
   fixColumnHeaders: false,
-  fixRowHeaders: false
+  fixRowHeaders: false,
+  cumulativeValues: false
 };
 const defaultVisualizationProps = {
   fontSize: _pivotTableConstants.FONT_SIZE_OPTION_NORMAL,
@@ -182,6 +183,9 @@ class PivotTableEngine {
     _defineProperty(this, "data", []);
     _defineProperty(this, "rowMap", []);
     _defineProperty(this, "columnMap", []);
+    _defineProperty(this, "accumulators", {
+      rows: {}
+    });
     this.visualization = Object.assign({}, defaultVisualizationProps, visualization);
     this.legendSets = (legendSets || []).reduce((sets, set) => {
       sets[set.id] = set;
@@ -201,7 +205,8 @@ class PivotTableEngine {
       subtitle: visualization.hideSubtitle ? undefined : visualization.subtitle,
       // turn on fixed headers only when there are dimensions
       fixColumnHeaders: this.dimensionLookup.columns.length ? visualization.fixColumnHeaders : false,
-      fixRowHeaders: this.dimensionLookup.rows.length ? visualization.fixRowHeaders : false
+      fixRowHeaders: this.dimensionLookup.rows.length ? visualization.fixRowHeaders : false,
+      cumulativeValues: visualization.cumulativeValues
     };
     this.adaptiveClippingController = new _AdaptiveClippingController.AdaptiveClippingController(this);
     const doColumnSubtotals = this.options.showColumnSubtotals && this.dimensionLookup.rows.length > 1;
@@ -225,51 +230,68 @@ class PivotTableEngine {
       row,
       column
     });
+    const valueType = (dxDimension === null || dxDimension === void 0 ? void 0 : dxDimension.valueType) || _valueTypes.VALUE_TYPE_TEXT;
     const headers = [...this.getRawRowHeader(row), ...this.getRawColumnHeader(column)];
     const peId = (_headers$find = headers.find(header => (header === null || header === void 0 ? void 0 : header.dimensionItemType) === _dataTypes.DIMENSION_TYPE_PERIOD)) === null || _headers$find === void 0 ? void 0 : _headers$find.uid;
     const ouId = (_headers$find2 = headers.find(header => (header === null || header === void 0 ? void 0 : header.dimensionItemType) === _dataTypes.DIMENSION_TYPE_ORGANISATION_UNIT)) === null || _headers$find2 === void 0 ? void 0 : _headers$find2.uid;
-    if (!this.data[row] || !this.data[row][column]) {
-      return {
-        cellType,
-        empty: true,
-        ouId,
-        peId
-      };
-    }
-    const dataRow = this.data[row][column];
-    let rawValue = cellType === _pivotTableConstants.CELL_TYPE_VALUE ? dataRow[this.dimensionLookup.dataHeaders.value] : dataRow.value;
-    let renderedValue = rawValue;
-    const valueType = (dxDimension === null || dxDimension === void 0 ? void 0 : dxDimension.valueType) || _valueTypes.VALUE_TYPE_TEXT;
-    if (valueType === _valueTypes.VALUE_TYPE_NUMBER) {
-      rawValue = (0, _parseValue.parseValue)(rawValue);
-      switch (this.visualization.numberType) {
-        case _pivotTableConstants.NUMBER_TYPE_ROW_PERCENTAGE:
-          renderedValue = rawValue / this.percentageTotals[row].value;
-          break;
-        case _pivotTableConstants.NUMBER_TYPE_COLUMN_PERCENTAGE:
-          renderedValue = rawValue / this.percentageTotals[column].value;
-          break;
-        default:
-          break;
-      }
-    }
-    renderedValue = (0, _renderValue.renderValue)(renderedValue, valueType, this.visualization);
-    return {
+    const rawCell = {
       cellType,
-      empty: false,
       valueType,
-      rawValue,
-      renderedValue,
-      dxDimension,
       ouId,
       peId
     };
+    if (!this.data[row] || !this.data[row][column]) {
+      rawCell.empty = true;
+    } else {
+      const dataRow = this.data[row][column];
+      let rawValue = cellType === _pivotTableConstants.CELL_TYPE_VALUE ? dataRow[this.dimensionLookup.dataHeaders.value] : dataRow.value;
+      let renderedValue = rawValue;
+      if (valueType === _valueTypes.VALUE_TYPE_NUMBER) {
+        rawValue = (0, _parseValue.parseValue)(rawValue);
+        switch (this.visualization.numberType) {
+          case _pivotTableConstants.NUMBER_TYPE_ROW_PERCENTAGE:
+            renderedValue = rawValue / this.percentageTotals[row].value;
+            break;
+          case _pivotTableConstants.NUMBER_TYPE_COLUMN_PERCENTAGE:
+            renderedValue = rawValue / this.percentageTotals[column].value;
+            break;
+          default:
+            break;
+        }
+      }
+      renderedValue = (0, _renderValue.renderValue)(renderedValue, valueType, this.visualization);
+      rawCell.dxDimension = dxDimension;
+      rawCell.empty = false;
+      rawCell.rawValue = rawValue;
+      rawCell.renderedValue = renderedValue;
+    }
+    if (this.options.cumulativeValues) {
+      const cumulativeValue = this.getCumulative({
+        row,
+        column
+      });
+      if (cumulativeValue !== undefined && cumulativeValue !== null) {
+        // force to NUMBER for accumulated values
+        rawCell.valueType = valueType === undefined || valueType === null ? _valueTypes.VALUE_TYPE_NUMBER : valueType;
+        rawCell.empty = false;
+        rawCell.rawValue = cumulativeValue;
+        rawCell.renderedValue = (0, _renderValue.renderValue)(cumulativeValue, valueType, this.visualization);
+      }
+    }
+    return rawCell;
   }
-  get(_ref4) {
+  getCumulative(_ref4) {
     let {
       row,
       column
     } = _ref4;
+    return this.accumulators.rows[row][column];
+  }
+  get(_ref5) {
+    let {
+      row,
+      column
+    } = _ref5;
     const mappedRow = this.rowMap[row],
       mappedColumn = this.columnMap[column];
     if (!mappedRow && mappedRow !== 0 || !mappedColumn && mappedColumn !== 0) {
@@ -280,11 +302,11 @@ class PivotTableEngine {
       column: mappedColumn
     });
   }
-  getRawCellType(_ref5) {
+  getRawCellType(_ref6) {
     let {
       row,
       column
-    } = _ref5;
+    } = _ref6;
     const isRowTotal = this.doRowTotals && column === this.dataWidth - 1;
     const isColumnTotal = this.doColumnTotals && row === this.dataHeight - 1;
     if (isRowTotal || isColumnTotal) {
@@ -297,11 +319,11 @@ class PivotTableEngine {
     }
     return _pivotTableConstants.CELL_TYPE_VALUE;
   }
-  getCellType(_ref6) {
+  getCellType(_ref7) {
     let {
       row,
       column
-    } = _ref6;
+    } = _ref7;
     row = this.rowMap[row];
     column = this.columnMap[column];
     return this.getRawCellType({
@@ -331,29 +353,26 @@ class PivotTableEngine {
       return _d2I18n.default.t(this.dimensionLookup.rows[rowLevel].meta.name);
     }
   }
-  getCellDxDimension(_ref7) {
+  getCellDxDimension(_ref8) {
     let {
       row,
       column
-    } = _ref7;
+    } = _ref8;
     return this.getRawCellDxDimension({
       row: this.rowMap[row],
       column: this.columnMap[column]
     });
   }
-  getRawCellDxDimension(_ref8) {
+  getRawCellDxDimension(_ref9) {
     let {
       row,
       column
-    } = _ref8;
+    } = _ref9;
     if (!this.data[row]) {
       return undefined;
     }
     const cellValue = this.data[row][column];
-    if (!cellValue) {
-      return undefined;
-    }
-    if (!Array.isArray(cellValue)) {
+    if (cellValue && !Array.isArray(cellValue)) {
       // This is a total cell
       return {
         valueType: cellValue.valueType,
@@ -380,6 +399,11 @@ class PivotTableEngine {
       };
     }
 
+    // Empty cell
+    // The cell still needs to get the valueType to render correctly 0 and cumulative values
+    //
+    // OR
+    //
     // Data is in Filter
     // TODO : This assumes the server ignores text types, we should confirm this is the case
     return {
@@ -391,7 +415,7 @@ class PivotTableEngine {
     return !this.data[row] || this.data[row].length === 0;
   }
   columnIsEmpty(column) {
-    return !this.adaptiveClippingController.columns.sizes[column];
+    return !this.rowMap.some(row => this.data[row][column]);
   }
   getRawColumnHeader(column) {
     if (this.doRowTotals && column === this.dataWidth - 1) {
@@ -437,12 +461,12 @@ class PivotTableEngine {
   getRowHeader(row) {
     return this.getRawRowHeader(this.rowMap[row]);
   }
-  getDependantTotalCells(_ref9) {
+  getDependantTotalCells(_ref10) {
     var _this$dimensionLookup, _this$dimensionLookup2;
     let {
       row,
       column
-    } = _ref9;
+    } = _ref10;
     const rowSubtotalSize = ((_this$dimensionLookup = this.dimensionLookup.columns[0]) === null || _this$dimensionLookup === void 0 ? void 0 : _this$dimensionLookup.size) + 1;
     const rowSubtotal = rowSubtotalSize && this.doRowSubtotals && {
       row,
@@ -617,11 +641,11 @@ class PivotTableEngine {
       }
     }
   }
-  finalizeTotal(_ref10) {
+  finalizeTotal(_ref11) {
     let {
       row,
       column
-    } = _ref10;
+    } = _ref11;
     if (!this.data[row]) {
       return;
     }
@@ -717,6 +741,40 @@ class PivotTableEngine {
   resetColumnMap() {
     this.columnMap = this.options.hideEmptyColumns ? (0, _times.default)(this.dataWidth, n => n).filter(idx => !this.columnIsEmpty(idx)) : (0, _times.default)(this.dataWidth, n => n);
   }
+  resetAccumulators() {
+    if (this.options.cumulativeValues) {
+      this.rowMap.forEach(row => {
+        this.accumulators.rows[row] = {};
+        this.columnMap.reduce((acc, column) => {
+          const cellType = this.getRawCellType({
+            row,
+            column
+          });
+          const dxDimension = this.getRawCellDxDimension({
+            row,
+            column
+          });
+          const valueType = (dxDimension === null || dxDimension === void 0 ? void 0 : dxDimension.valueType) || _valueTypes.VALUE_TYPE_TEXT;
+
+          // only accumulate numeric values
+          // accumulating text values does not make sense
+          if (valueType === _valueTypes.VALUE_TYPE_NUMBER) {
+            if (this.data[row] && this.data[row][column]) {
+              const dataRow = this.data[row][column];
+              const rawValue = cellType === _pivotTableConstants.CELL_TYPE_VALUE ? dataRow[this.dimensionLookup.dataHeaders.value] : dataRow.value;
+              acc += (0, _parseValue.parseValue)(rawValue);
+            }
+            this.accumulators.rows[row][column] = acc;
+          }
+          return acc;
+        }, 0);
+      });
+    } else {
+      this.accumulators = {
+        rows: {}
+      };
+    }
+  }
   get cellPadding() {
     switch (this.visualization.displayDensity) {
       case _pivotTableConstants.DISPLAY_DENSITY_OPTION_COMPACT:
@@ -787,14 +845,18 @@ class PivotTableEngine {
       }
     });
     this.finalizeTotals();
-    this.rawData.rows.forEach(dataRow => {
-      const pos = lookup(dataRow, this.dimensionLookup, this);
-      if (pos) {
-        this.adaptiveClippingController.add(pos, this.getRaw(pos).renderedValue);
-      }
-    });
     this.resetRowMap();
     this.resetColumnMap();
+    this.resetAccumulators();
+    this.rowMap.forEach(row => {
+      this.columnMap.forEach(column => {
+        const pos = {
+          row,
+          column
+        };
+        this.adaptiveClippingController.add(pos, this.getRaw(pos).renderedValue);
+      });
+    });
     this.height = this.rowMap.length;
     this.width = this.columnMap.length;
     this.adaptiveClippingController.finalize();