rapid-spreadjs 1.0.18 → 1.0.20

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 }]
@@ -7410,6 +7421,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对象
@@ -7677,11 +7723,39 @@ const SheetUtils = {
     },
 };
 
-// 导出Excel文件所需的第三方包
 /**
  * SpreadJS工作簿工具函数属性
  */
 const WorkbookUtils = {
+    /**
+     * 加载在线sjs文件
+     * @param spread 工作簿对象
+     * @param fileUrl 在线sjs文件地址
+     * @param succFunc 文件打开成功后的回调函数，返回的第一个参数为spread工作簿对象
+     * @param errorFunc 文件打开失败后的回调函数，返回的第一个参数为错误信息
+     */
+    loadSjsFile: (spread, fileUrl, succFunc, errorFunc) => __awaiter(void 0, void 0, void 0, function* () {
+        // 获取文件响应结果
+        const response = yield fetch(fileUrl, { method: 'GET' });
+        // 获取成功
+        if (response.ok) {
+            // 文件的字节流对象
+            const blob = yield response.blob();
+            // 将Blob转换为File或Blob对象
+            new File([blob], 'template.sjs', { type: 'application/octet-stream' });
+            const sjsBlob = new Blob([blob], { type: 'application/zip' });
+            // SpreadJS打开文件
+            spread.open(sjsBlob, () => {
+                if (typeof succFunc === 'function') {
+                    succFunc(spread);
+                }
+            }, (e) => {
+                if (typeof errorFunc === 'function') {
+                    errorFunc(e);
+                }
+            });
+        }
+    }),
     /**
      * 打印所有工作表
      * @param GC GC对象
@@ -7748,20 +7822,11 @@ const WorkbookUtils = {
      * @param spread 原始Spread对象
      * @param fileName 导出的文件名称，不传则为第一个工作表的名称
      */
-    exportToExcel: (GC, spread, fileName = "") => {
+    exportToExcel: (GC, spread, fileName = '') => {
         // 导出模板为JSON对象，此处设置了参数includeBindingSource，改参数代表包含数据绑定的值
         const json = spread.toJSON({ includeBindingSource: true });
         // 需要移除的自定义公式名称集合（该变量的作用是，在导出Excel前，将工作簿中所有的自定义公式移除掉，其他内置的公式保留）
-        const removeCustomFormulas = [
-            "YJMAX",
-            "YJMIN",
-            "YJMID",
-            "YJGETNUM",
-            "YJGETS",
-            "YJGETCV",
-            "YJINTERPOLATIONMETHOD",
-            "YJINTERPOLATIONMETHOD_Y",
-        ];
+        const removeCustomFormulas = ['YJMAX', 'YJMIN', 'YJMID', 'YJGETNUM', 'YJGETS', 'YJGETCV', 'YJINTERPOLATIONMETHOD', 'YJINTERPOLATIONMETHOD_Y'];
         // 临时工作簿
         const tempSpread = new GC.Spread.Sheets.Workbook();
         tempSpread.fromJSON(json);
@@ -7779,9 +7844,7 @@ const WorkbookUtils = {
                     // 获取单元格的公式
                     const cellFormula = sheet.getFormula(i, j);
                     // 如果cellFormula不为null或undefined，则说明该单元格引用了公式
-                    if (cellFormula != null &&
-                        cellFormula != undefined &&
-                        removeCustomFormulas.some((item) => cellFormula.indexOf(item) > -1)) {
+                    if (cellFormula != null && cellFormula != undefined && removeCustomFormulas.some((item) => cellFormula.indexOf(item) > -1)) {
                         // 获取单元格的值
                         const cellVal = sheet.getValue(i, j);
                         // 移除单元格引用的公式
@@ -7796,7 +7859,7 @@ const WorkbookUtils = {
         }
         // 恢复绘制
         tempSpread.resumePaint();
-        if (fileName == "") {
+        if (fileName == '') {
             fileName = tempSpread.getSheet(0).name();
         }
         let options = {