rapid-spreadjs 1.0.19 → 1.0.21

package/dist/index.esm.js

@@ -1,6 +1,6 @@
 import * as echarts from 'echarts';
 import * as math from 'mathjs';
-import { orderByJson } from 'rapid-utils';
+import { groupByJson, forEachJson, orderByJson } from 'rapid-utils';
 import { saveAs } from 'file-saver';
 
 /**
@@ -7289,7 +7289,18 @@ const SheetUtils = {
         sheet.setSelection(cellObj.row, cellObj.col, cellObj.rowCount, cellObj.colCount);
     },
     /**
-     * 获取某工作表中某范围集合中所有的单元格坐标对象集合
+     * 获取某工作表中某个范围中所有的单元格坐标对象集合
+     * 该方法适用的场景如：手动选择了某个单元格范围，在这个范围中可能包含独立的单元格，也可能包含合并的单元格，这时候就需要用到如下方法获取到所有单元格对象
+     * @param sheet 工作表实例
+     * @param selectRange 单元格范围，格式如：{ row: 0, col: 0, rowCount: 2, colCount: 2 }
+     * @param isMulColOrder 是否按照多列的顺序排序单元格（true：按照第一列从上到下、第二列从上到下……的顺序获取单元格数据、false：按照第一行从左到右、第二行从左到右……的顺序获取单元格数据）
+     * @returns 返回数组集合，格式如：[{ row: 0, col: 0, rowCount: 1, colCount: 1 }]
+     */
+    getAllCellObjsByRange: (sheet, selectRange, isMulColOrder = false) => {
+        return SheetUtils.getAllCellObjsByRanges(sheet, [selectRange], isMulColOrder);
+    },
+    /**
+     * 获取某工作表中多个范围集合中所有的单元格坐标对象集合
      * 该方法适用的场景如：手动选择了很多个单元格范围，在这些范围中可能包含独立的单元格，也可能包含合并的单元格，这时候就需要用到如下方法获取到所有单元格对象
      * @param sheet 工作表实例
      * @param selectRanges 单元格范围集合，格式如：[{ row: 0, col: 0, rowCount: 2, colCount: 2 }]
@@ -7376,6 +7387,29 @@ const SheetUtils = {
         const sheet = spread.getActiveSheet();
         return SheetUtils.getSheetSelectCellObjs(sheet, isMulColOrder);
     },
+    /**
+     * 获取某工作表指定范围单元格的坐标对象集合（二维数组，格式如：[[{row:0……}],[{row:0……}]]）
+     * @param sheet 工作表实例
+     * @param cellRange 单元格范围
+     * @param groupType 分组字段属性（row或col），默认为：row
+     * @returns 返回某工作表指定范围单元格的坐标对象集合（二维数组，格式如：[[{row:0……}],[{row:0……}]]）
+     */
+    getSheetCellObjsByGroup: (sheet, cellRange, groupType = 'row') => {
+        // 暂停绘制
+        sheet.suspendPaint();
+        const valCells = SheetUtils.getAllCellObjsByRange(sheet, cellRange);
+        // 按照JSON数组中某个字段进行分组（groupType为row或col）
+        const groupByCells = groupByJson(valCells, groupType);
+        // 最终返回结果（二维数组）
+        const retCells = [];
+        // 遍历分组JSON对象（groupByCells的格式为：{key1: [cell1, cell2, ...], key2: [cell1, cell2, ...], ...}）
+        forEachJson(groupByCells, (curGroupCells, key, source) => {
+            retCells.push(curGroupCells);
+        });
+        // 恢复绘制
+        sheet.resumePaint();
+        return retCells;
+    },
     /**
      * 获取某工作表选中单元格的值集合
      * @param sheet 工作表实例
@@ -7410,6 +7444,41 @@ const SheetUtils = {
         const sheet = spread.getActiveSheet();
         return SheetUtils.getSheetSelectVals(sheet, isMulColOrder, nullUndefinedReplaceVal);
     },
+    /**
+     * 获取某工作表指定范围单元格的值集合（二维数组，格式如：[[1,2,3],[4,5,6]]）
+     * @param sheet 工作表实例
+     * @param cellRange 单元格范围
+     * @param groupType 分组字段属性（row或col），默认为：row
+     * @param nullUndefinedReplaceVal 如果单元格的值为null或undefined，则将其替换为该值（如果不传入该参数，则不替换）
+     * @returns 返回某工作表指定范围单元格的值集合（二维数组，格式如：[[1,2,3],[4,5,6]]）
+     */
+    getSheetRangeValsByGroup: (sheet, cellRange, groupType = 'row', nullUndefinedReplaceVal) => {
+        // 暂停绘制
+        sheet.suspendPaint();
+        const valCells = SheetUtils.getAllCellObjsByRange(sheet, cellRange);
+        // 按照JSON数组中某个字段进行分组（groupType为row或col）
+        const groupByCells = groupByJson(valCells, groupType);
+        // 最终返回结果（二维数组）
+        const retVals = [];
+        // 遍历分组JSON对象（groupByCells的格式为：{key1: [cell1, cell2, ...], key2: [cell1, cell2, ...], ...}）
+        forEachJson(groupByCells, (curGroupCells, key, source) => {
+            // 当前按照row或col分组的单元格的值集合
+            const curVals = [];
+            // 遍历当前分组的所有单元格
+            forEachJson(curGroupCells, (item, index, source) => {
+                let cellVal = sheet.getValue(item.row, item.col);
+                // 如果cellVal为null或undefined，并且nullUndefinedReplaceVal不为null或undefined，则将cellVal替换为nullUndefinedReplaceVal
+                if (nullUndefinedReplaceVal != null && nullUndefinedReplaceVal != undefined && (cellVal === null || cellVal === undefined)) {
+                    cellVal = nullUndefinedReplaceVal;
+                }
+                curVals.push(cellVal);
+            });
+            retVals.push(curVals);
+        });
+        // 恢复绘制
+        sheet.resumePaint();
+        return retVals;
+    },
     /**
      * 获取单元格类型名称
      * @param GC GC对象