rapid-spreadjs 1.0.3 → 1.0.6

package/package.json

@@ -1,13 +1,14 @@
 {
     "name": "rapid-spreadjs",
-    "version": "1.0.3",
-    "description": "SpreadJS常用公用处理函数。",
-    "main": "./src/index.js",
-    "types": "dist/types/src/index.d.ts",
-    "license": "MIT",
+    "version": "1.0.6",
+    "description": "SpreadJS常用公用处理函数，包括设计器、工作簿和工作表的相关处理函数。",
+    "type": "module",
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js",
+    "types": "dist/index.d.ts",
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",
-        "build": "tsc && babel src -d dist"
+        "build": "rollup -c"
     },
     "keywords": [
         "utils",
@@ -23,13 +24,16 @@
         "email": "qubernet@163.com",
         "url": "https://www.cnblogs.com/qubernet"
     },
-    "homepage": "https://www.cnblogs.com/qubernet",
-    "dependencies": {
-        "typescript": "^5.7.3"
-    },
+    "license": "MIT",
     "devDependencies": {
-        "@babel/cli": "^7.26.4",
-        "@babel/core": "^7.26.9",
-        "@babel/preset-env": "^7.26.9"
+        "@rollup/plugin-terser": "^0.4.4",
+        "@rollup/plugin-typescript": "^12.1.2",
+        "rollup": "^4.34.9",
+        "tslib": "^2.8.1",
+        "typescript": "^5.8.2"
+    },
+    "dependencies": {
+        "@types/file-saver": "^2.0.7",
+        "file-saver": "^2.0.5"
     }
 }

package/rollup.config.js

@@ -0,0 +1,51 @@
+import typescript from "@rollup/plugin-typescript";
+import terser from "@rollup/plugin-terser";
+
+export default {
+    input: "src/index.ts",
+    output: [
+        // 未压缩的ES模块
+        {
+            file: "dist/index.esm.js",
+            format: "es",
+            sourcemap: true, // 可选：生成SourceMap
+        },
+        // 压缩后的ES模块
+        {
+            file: "dist/index.esm.min.js",
+            format: "es",
+            plugins: [
+                // 仅针对此输出启用压缩
+                terser({
+                    compress: { drop_console: true }, // 删除console语句
+                    format: { comments: false }, // 移除注释
+                }),
+            ],
+            sourcemap: true,
+        },
+        // 未压缩的CommonJS模块
+        {
+            file: "dist/index.cjs.js",
+            format: "cjs",
+            sourcemap: true,
+        },
+        // 压缩后的CommonJS模块
+        {
+            file: "dist/index.cjs.min.js",
+            format: "cjs",
+            plugins: [
+                terser({
+                    compress: { drop_console: true },
+                    format: { comments: false },
+                }),
+            ],
+            sourcemap: true,
+        },
+    ],
+    plugins: [
+        typescript({
+            tsconfig: "./tsconfig.json",
+            // exclude: ["**/*.test.ts"],
+        }),
+    ],
+};

package/src/index.ts

@@ -0,0 +1,11 @@
+/** 导出/types/sheet.ts中的所有type */
+export * from "./types/sheet";
+
+/** 导出/utils/common.ts中的所有属性或函数 */
+export * from "./utils/common";
+
+/** 导出/utils/sheet.ts中的所有属性或函数 */
+export * from "./utils/sheet";
+
+/** 导出/utils/wookbook.ts中的所有属性或函数 */
+export * from "./utils/wookbook";

package/src/utils/common.ts

@@ -0,0 +1,22 @@
+/**
+ * 公用工具函数
+ */
+export const CommonUtils = {
+    /**
+     * 获取列的英文字母
+     * @param colIndex 列的索引
+     * @returns 返回英文字母
+     */
+    getColLetterName: (colIndex: number): string => {
+        colIndex += 1;
+
+        let letter = "";
+        while (colIndex > 0) {
+            const remainder = (colIndex - 1) % 26;
+            letter = String.fromCharCode(remainder + 65) + letter;
+            colIndex = Math.floor((colIndex - 1) / 26);
+        }
+
+        return letter.toUpperCase();
+    },
+};

package/src/utils/sheet.ts

@@ -1,3 +1,4 @@
+// 导入单元格实体
 import { CellModel } from "../types/sheet";
 
 /**
@@ -9,7 +10,7 @@ export const SheetUtils = {
      * @param spread 工作簿对象
      * @returns 返回选中单元格的集合，格式如：[{row:,col:,rowCount:,colCount:}]
      */
-    getActiveSheetSelectCells: (spread: any) => {
+    getActiveSheetSelectCells: (spread: any): Array<CellModel> => {
         const sheet = spread.getActiveSheet();
 
         return sheet.getSelections();
@@ -30,6 +31,399 @@ export const SheetUtils = {
             cellObj.colCount
         );
     },
+
+    /**
+     * 获取某工作表中某范围集合中所有的单元格坐标对象集合
+     * 该方法适用的场景如：手动选择了很多个单元格范围，在这些范围中可能包含独立的单元格，也可能包含合并的单元格，这时候就需要用到如下方法获取到所有单元格对象
+     * @param sheet 工作表实例
+     * @param selectRanges 单元格范围集合，格式如：[{ row: 0, col: 0, rowCount: 2, colCount: 2 }]
+     * @param isMulColOrder 是否按照多列的顺序排序单元格（true：按照第一列从上到下、第二列从上到下……的顺序获取单元格数据、false：按照第一行从左到右、第二行从左到右……的顺序获取单元格数据）
+     * 返回数组集合，格式如：[{ row: 0, col: 0, rowCount: 1, colCount: 1 }]
+     */
+    getAllCellObjsByRanges: (
+        sheet: any,
+        selectRanges: Array<CellModel>,
+        isMulColOrder: boolean = false
+    ) => {
+        // 得到所有的单元格坐标对象集合，格式如：[{ row: 0, col: 0, rowCount: 1, colCount: 1 }]
+        let allCellObjs: Array<CellModel> = [];
+
+        selectRanges.forEach((item, index) => {
+            // 得到当前item中所有合并的单元格对象集合
+            const itemSpanCells = sheet.getSpans(item);
+            itemSpanCells.forEach((itemSpanCell: CellModel) => {
+                allCellObjs.push({
+                    row: itemSpanCell.row,
+                    col: itemSpanCell.col,
+                    rowCount: itemSpanCell.rowCount,
+                    colCount: itemSpanCell.colCount,
+                });
+            });
+
+            if (
+                item.row === undefined ||
+                item.col === undefined ||
+                item.rowCount === undefined ||
+                item.colCount === undefined
+            ) {
+                throw new Error("row、col、rowCount、colCount is required.");
+            }
+
+            // 遍历item中涉及到的所有单元格
+            for (let i = item.row; i < +item.row + item.rowCount; i++) {
+                for (let j = item.col; j < item.col + item.colCount; j++) {
+                    const curSpanCellObj = sheet.getSpan(i, j);
+
+                    // 检查当前单元格是否为合并单元格
+                    if (curSpanCellObj == null) {
+                        allCellObjs.push({
+                            row: i,
+                            col: j,
+                            rowCount: 1,
+                            colCount: 1,
+                        });
+                    }
+                }
+            }
+        });
+
+        // 常规顺序
+        if (!isMulColOrder) {
+            // 对单元格集合对象对象进行排序，先按row后按col进行升序排序（注意：此处非常重要，如果不排序，获取到的单元格顺序有可能是乱的【不完全按照模板顺序返回】）
+            allCellObjs.sort((a: CellModel, b: CellModel) => {
+                if (
+                    a.row === undefined ||
+                    b.row === undefined ||
+                    a.col === undefined ||
+                    b.col === undefined
+                ) {
+                    throw new Error("row、col is required.");
+                }
+
+                if (a.row == b.row) {
+                    return a.col - b.col;
+                }
+
+                return a.row - b.row;
+            });
+        }
+
+        return allCellObjs;
+    },
+
+    /**
+     * 获取某工作表中所有的单元格坐标对象集合
+     * @param sheet 工作表实例
+     * 返回数组集合，格式如：[{ col: 0, colCount: 2, row: 0, rowCount: 1 }]
+     */
+    getSheetAllCellObjs: (sheet: any): Array<CellModel> => {
+        // 得到当前Sheet单元格范围
+        const curSheetCellRange = [
+            {
+                row: 0,
+                col: 0,
+                rowCount: sheet.getRowCount(),
+                colCount: sheet.getColumnCount(),
+            },
+        ];
+
+        // 得到所有的单元格坐标对象集合，格式如：[{ col: 0, colCount: 2, row: 0, rowCount: 1 }]
+        const allCellObjs = SheetUtils.getAllCellObjsByRanges(
+            sheet,
+            curSheetCellRange
+        );
+
+        return allCellObjs;
+    },
+
+    /**
+     * 获取某工作表中选中的所有单元格坐标对象集合
+     * @param spread 工作簿实例
+     * 返回数组集合，格式如：[{ col: 0, row: 0 }]
+     */
+    getActiveSheetSelectCellObjs: (spread: any): Array<CellModel> => {
+        // 当前激活的Sheet
+        const sheet = spread.getActiveSheet();
+
+        // 得到当前Sheet中选择的单元格范围集合
+        const curSheetCellRange = sheet.getSelections();
+
+        // 得到所有的单元格坐标对象集合，格式如：[{ col: 0, colCount: 2, row: 0, rowCount: 1 }]
+        const allCellObjs = SheetUtils.getAllCellObjsByRanges(
+            sheet,
+            curSheetCellRange
+        );
+
+        return allCellObjs;
+    },
+
+    /**
+     * 获取单元格类型名称
+     * @param GC GC对象
+     * @param sheet 工作表实例
+     * @param row 单元格行索引
+     * @param col 单元格列索引
+     * @returns 返回单元格类型名称，如：button、radio、checkbox、checkboxList、hyperLink、comboBox、date、dateRange、calc
+     */
+    getCellType: (
+        GC: any,
+        sheet: any,
+        row: number,
+        col: number
+    ): string | undefined => {
+        let cellTypeName;
+
+        // 先根据getCellType来获取
+        const cellType = sheet.getCellType(row, col);
+
+        if (cellType instanceof GC.Spread.Sheets.CellTypes.Button) {
+            cellTypeName = "button";
+        } else if (
+            cellType instanceof GC.Spread.Sheets.CellTypes.RadioButtonList
+        ) {
+            cellTypeName = "radio";
+        } else if (cellType instanceof GC.Spread.Sheets.CellTypes.CheckBox) {
+            cellTypeName = "checkbox";
+        } else if (
+            cellType instanceof GC.Spread.Sheets.CellTypes.CheckBoxList
+        ) {
+            cellTypeName = "checkboxList";
+        } else if (cellType instanceof GC.Spread.Sheets.CellTypes.HyperLink) {
+            cellTypeName = "hyperLink";
+        } else if (cellType instanceof GC.Spread.Sheets.CellTypes.ComboBox) {
+            cellTypeName = "comboBox";
+        }
+
+        // 根据getStyle来获取
+        if (cellTypeName == undefined || cellTypeName == null) {
+            const cellStyle = sheet.getStyle(row, col);
+
+            if (
+                cellStyle &&
+                cellStyle.cellButtons &&
+                cellStyle.cellButtons.length > 0
+            ) {
+                if (cellStyle.cellButtons[0].command == "openDateTimePicker") {
+                    if (cellStyle.dropDowns && cellStyle.dropDowns.length > 0) {
+                        if (cellStyle.dropDowns[0].option.showDateRange) {
+                            cellTypeName = "dateRange";
+                        } else {
+                            cellTypeName = "date";
+                        }
+                    }
+                } else if (
+                    cellStyle.cellButtons[0].command == "openCalculator"
+                ) {
+                    cellTypeName = "calc";
+                }
+            }
+        }
+
+        return cellTypeName;
+    },
+
+    /**
+     * 设置工作簿中所有工作表的缩放比例
+     * @param scale 缩放比例，默认为：1（100%）
+     */
+    setSheetZoom: (spread: any, scale: number) => {
+        // 暂停绘制
+        spread.suspendPaint();
+
+        const sheetCount = spread.getSheetCount();
+        for (let i = 0; i < sheetCount; i++) {
+            const sheet = spread.getSheet(i);
+
+            sheet.zoom(scale);
+        }
+
+        // 恢复绘制
+        spread.resumePaint();
+    },
+
+    /**
+     * 设置当前激活的工作表中选中的单元格背景颜色
+     * @param spread 工作簿实例
+     * @param color 背景颜色
+     */
+    setActiveSheetBgColor: (spread: any, color: string) => {
+        const sheet = spread.getActiveSheet();
+
+        // 暂停绘制
+        sheet.suspendPaint();
+
+        //#region 方式1：通过getRange进行批量设置，推荐使用该方法来实现
+
+        // 获取选择的多个单元格范围集合
+        const selections = SheetUtils.getActiveSheetSelectCells(spread);
+
+        // 循环每个选中的单元格范围
+        selections.forEach((sel: CellModel) => {
+            // 批量设置每个选中的单元格范围的背景颜色
+            sheet
+                .getRange(sel.row, sel.col, sel.rowCount, sel.colCount)
+                .backColor(color);
+        });
+
+        //#endregion
+
+        //#region 方式2：通过getCell获取单元格样式对每个单元格进行设置，此方式效率相对较低，不推荐
+
+        // // 当前激活的工作表中所有选择的单元格
+        // const selectCells = SheetUtils.getActiveSheetSelectCellObjs(spread);
+
+        // selectCells.forEach(item => {
+        //   // 获取单元格对象
+        //   const cellObj = sheet.getCell(item.row, item.col);
+
+        //   // 获取单元格样式
+        //   let cellStyle = sheet.getStyle(item.row, item.col);
+        //   if (!cellStyle) {
+        //     // 不存在样式则new一个
+        //     cellStyle = new GC.Spread.Sheets.Style();
+        //   }
+
+        //   // 设置单元格背景颜色
+        //   cellStyle.backColor = color;
+
+        //   // 重新设置单元格样式
+        //   cellObj.setStyle(cellStyle);
+        // });
+
+        //#endregion
+
+        // 恢复绘制
+        sheet.resumePaint();
+    },
+
+    /**
+     * 设置工作簿中所有工作表是否显示分页线
+     * @param scale 缩放比例，默认为：1（100%）
+     */
+    setSheetShowPrintPageLine: (spread: any, isShow: boolean) => {
+        // 暂停绘制
+        spread.suspendPaint();
+
+        const sheetCount = spread.getSheetCount();
+        for (let i = 0; i < sheetCount; i++) {
+            const sheet = spread.getSheet(i);
+
+            var isVisible = sheet.isPrintLineVisible();
+            sheet.isPrintLineVisible(!isVisible);
+        }
+
+        // 恢复绘制
+        spread.resumePaint();
+    },
+
+    /**
+     * 忽略工作工作表元格中指定字符串不显示，如：#DIV/0!、#VALUE!等
+     * @param GC GC对象
+     */
+    ignoreSheetShowStrs: (GC: any) => {
+        // 忽略的字符串集合
+        const ignoreStrs: Array<string> = [
+            "#DIV/0!",
+            "#VALUE!",
+            "#NAME?",
+            "#N/A",
+            "#NULL!",
+            "#NUM!",
+            "#REF!",
+        ];
+
+        // paint对象
+        const ignorePaint = GC.Spread.Sheets.CellTypes.Text.prototype.paint;
+
+        // 重写paint函数
+        GC.Spread.Sheets.CellTypes.Text.prototype.paint = function (
+            ctx: any,
+            value: any,
+            x: any,
+            y: any,
+            w: any,
+            h: any,
+            style: any,
+            options: any
+        ) {
+            // 如果在忽略的字符串集合中有匹配的结果，则将其显示为空字符串
+            if (ignoreStrs.some((item) => item == value)) {
+                ignorePaint.call(this, ctx, "/", x, y, w, h, style, options);
+            } else {
+                ignorePaint.apply(this, arguments);
+            }
+
+            // // 或使用如下代码
+            // if (ignoreStrs.some((item) => item == value)) {
+            // 	value = '';
+            // }
+            // ignorePaint.apply(this, [ctx, value, x, y, w, h, style, options]);
+        };
+    },
+
+    /**
+     * 设置工作表显示辅助线（底部和右侧的辅助线）
+     * @param sheet 工作表实例
+     * @param width 宽度（像素）
+     * @param height 高度（像素）
+     * @param lineWidth 辅助线宽度（默认为：1像素）
+     * @param colorStr 辅助线颜色（默认为：#409eff）
+     * @param isHb 是否为横表（默认为：false）
+     */
+    setSheetAuxiliaryLine: (
+        GC: any,
+        sheet: any,
+        width: number,
+        height: number,
+        lineWidth: number = 1,
+        colorStr: string = "#409eff",
+        isHb: boolean = false
+    ) => {
+        // 创建底部和右侧的浮动对象
+        let floatBottom = new GC.Spread.Sheets.FloatingObjects.FloatingObject(
+                `floatLineBottom${isHb ? "Hb" : ""}`,
+                0,
+                height,
+                width,
+                lineWidth
+            ),
+            floatRight = new GC.Spread.Sheets.FloatingObjects.FloatingObject(
+                `floatLineRight${isHb ? "Hb" : ""}`,
+                width,
+                0,
+                lineWidth,
+                height
+            );
+
+        // 创建底部和右侧的div对象
+        let divBottom = document.createElement("div"),
+            divRight = document.createElement("div");
+
+        // 设置底部div对象样式
+        divBottom.style.width = `${width}px`;
+        divBottom.style.height = "1px";
+        divBottom.style.borderBottom = `${lineWidth}px dashed ${colorStr}`;
+
+        // 设置右侧div对象样式
+        divRight.style.width = "1px";
+        divRight.style.height = `${height}px`;
+        divRight.style.borderLeft = `${lineWidth}px dashed ${colorStr}`;
+
+        // floatBottom.fixedPosition(true);
+        // floatRight.fixedPosition(true);
+
+        // 设置底部和右侧浮动对象不允许改变大小、不允许拖动和设置浮动对象的内容
+        floatBottom.allowResize(false);
+        floatBottom.allowMove(false);
+        floatBottom.content(divBottom);
+        floatRight.allowResize(false);
+        floatRight.allowMove(false);
+        floatRight.content(divRight);
+
+        // 将浮动元素添加到工作表中
+        sheet.floatingObjects.add(floatBottom);
+        sheet.floatingObjects.add(floatRight);
+    },
 };
 
 /**