rapid-spreadjs 1.0.5 → 1.0.6

package/src/utils/wookbook.ts

@@ -0,0 +1,188 @@
+// 导出Excel文件所需的第三方包
+import { saveAs } from "file-saver";
+
+/**
+ * SpreadJS工作簿工具函数
+ */
+export const WorkbookUtils = {
+    /**
+     * 打印所有工作表
+     * @param GC GC对象
+     * @param spread 工作簿实例
+     */
+    print: (GC: any, spread: any) => {
+        // 得到Sheet个数
+        const sheetCount = spread.getSheetCount();
+
+        for (let i = 0; i < sheetCount; i++) {
+            const sheet = spread.getSheet(i);
+
+            // 获取每个工作表的打印信息
+            let printInfo = sheet.printInfo();
+
+            // 隐藏行和列的头部信息
+            printInfo.showRowHeader(
+                GC.Spread.Sheets.Print.PrintVisibilityType.hide
+            );
+            printInfo.showColumnHeader(
+                GC.Spread.Sheets.Print.PrintVisibilityType.hide
+            );
+
+            // // 显示和隐藏打印区域的辅助线
+            // spread.getSheet(0).isPrintLineVisible(true);
+            // spread.getSheet(0).isPrintLineVisible(!true);
+
+            // 设置打印区域，这里是固定的，在业务应用中需要根据实际情况修改打印区域
+            printInfo.rowStart(0);
+            printInfo.rowEnd(sheet.getRowCount()); //printInfo.rowEnd(41);
+            printInfo.columnStart(0);
+            printInfo.columnEnd(76);
+
+            // 设置SpreadJS自身的边距为合适的距离
+            printInfo.margin({
+                /**
+                 * 设置默认边距
+                 * 单位是：以百分之一英寸为单位
+                 *      也就是，如果我们需要设置左边距为25mm，需要将25mm先转换为英寸，然后再用这个英寸*100就是要设置的边距
+                 *      即：(25mm转换为英寸的结果)*100
+                 *
+                 * 参考文档：
+                 *     https://demo.grapecity.com.cn/spreadjs/help/api/classes/GC.Spread.Sheets.Print.PrintInfo#margin
+                 *     https://www.67tool.com/converter/length
+                 */
+                // 纵表
+                top: 0.5905511999999999 * 100,
+                bottom: 0.5905511999999999 * 100,
+                left: 0.9842520000000001 * 100,
+                right: 0.5905511999999999 * 100,
+
+                // // 横表
+                // top: 0.9842520000000001 * 100,
+                // bottom: 0.5905511999999999 * 100,
+                // left: 0.5905511999999999 * 100,
+                // right: 0.5905511999999999 * 100,
+
+                // top: 0,
+                // bottom: 0,
+                // left: 0,
+                // right: 0,
+                header: 0,
+                footer: 0,
+            });
+
+            // 设置打印的纸张
+            printInfo.paperSize(
+                new GC.Spread.Sheets.Print.PaperSize(
+                    GC.Spread.Sheets.Print.PaperKind.a4
+                )
+            );
+
+            sheet.printInfo(printInfo);
+        }
+
+        // 调用打印方法
+        spread.print();
+    },
+
+    /**
+     * 导出为Excel文件
+     * 如支持导出自定义公式的值等功能
+     * @param GC Spread的GC对象
+     * @param spread 原始Spread对象
+     * @param fileName 导出的文件名称，不传则为第一个工作表的名称
+     */
+    exportToExcel: (GC: any, spread: any, fileName: string = "") => {
+        // 导出模板为JSON对象，此处设置了参数includeBindingSource，改参数代表包含数据绑定的值
+        const json = spread.toJSON({ includeBindingSource: true });
+
+        // 需要移除的自定义公式名称集合（该变量的作用是，在导出Excel前，将工作簿中所有的自定义公式移除掉，其他内置的公式保留）
+        const removeCustomFormulas = [
+            "YJMAX",
+            "YJMIN",
+            "YJMID",
+            "YJGETNUM",
+            "YJGETS",
+            "YJGETCV",
+            "YJINTERPOLATIONMETHOD",
+            "YJINTERPOLATIONMETHOD_Y",
+        ];
+
+        // 临时工作簿
+        const tempSpread = new GC.Spread.Sheets.Workbook();
+        tempSpread.fromJSON(json);
+
+        // 暂停绘制
+        tempSpread.suspendPaint();
+
+        // 获取Sheet数量
+        const sheetCount = tempSpread.getSheetCount();
+
+        for (let iSheet = 0; iSheet < sheetCount; iSheet++) {
+            // 当前工作表
+            const sheet = tempSpread.getSheet(iSheet);
+
+            // 暂停公式的计算，提高性能
+            sheet.suspendCalcService();
+
+            for (var i = 0; i < sheet.getRowCount(); i++) {
+                for (var j = 0; j < sheet.getColumnCount(); j++) {
+                    // 获取单元格的公式
+                    const cellFormula = sheet.getFormula(i, j);
+
+                    // 如果cellFormula不为null或undefined，则说明该单元格引用了公式
+                    if (
+                        cellFormula != null &&
+                        cellFormula != undefined &&
+                        removeCustomFormulas.some(
+                            (item) => cellFormula.indexOf(item) > -1
+                        )
+                    ) {
+                        // 获取单元格的值
+                        const cellVal = sheet.getValue(i, j);
+
+                        // 移除单元格引用的公式
+                        sheet.getCell(i, j).formula(undefined);
+
+                        // 设置单元格的值
+                        sheet.setValue(i, j, cellVal);
+                    }
+                }
+            }
+
+            // 恢复计算
+            sheet.resumeCalcService(false);
+        }
+
+        // 恢复绘制
+        tempSpread.resumePaint();
+
+        if (fileName == "") {
+            fileName = tempSpread.getSheet(0).name();
+        }
+
+        let options = {
+            fileType: GC.Spread.Sheets.FileType.excel,
+            includeBindingSource: true,
+            includeStyles: true,
+            includeFormulas: true,
+            saveAsView: false,
+            rowHeadersAsFrozenColumns: false,
+            columnHeadersAsFrozenRows: false,
+            includeAutoMergedCells: false,
+            includeCalcModelCache: false,
+            includeUnusedNames: true,
+            includeEmptyRegionCells: true,
+        };
+
+        tempSpread.export(
+            (blob: any) => {
+                saveAs(blob, `${fileName}.xlsx`);
+            },
+            () => {},
+            options
+        );
+
+        // 销毁临时工作簿
+        tempSpread.destroy();
+    },
+};

package/tsconfig.json

@@ -11,9 +11,10 @@
         // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 
         /* Language and Environment */
-        "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+        "target": "es6" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
         // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
         // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+        // "libReplacement": true,                           /* Enable lib replacement. */
         // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
         // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
         // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
@@ -25,10 +26,9 @@
         // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
         /* Modules */
-        "module": "commonjs" /* Specify what module code is generated. */,
+        "module": "esnext" /* Specify what module code is generated. */,
         // "rootDir": "./",                                  /* Specify the root folder within your source files. */
         // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
-        "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
         // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
         // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
         // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
@@ -47,19 +47,19 @@
         // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
 
         /* JavaScript Support */
-        "allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
+        // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
         // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
         // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
 
         /* Emit */
         "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
         // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-        "emitDeclarationOnly": true /* Only output d.ts files and not JavaScript files. */,
+        // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
         // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
         // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
         // "noEmit": true,                                   /* Disable emitting files from a compilation. */
         // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-        "outDir": "dist/types" /* Specify an output folder for all emitted files. */,
+        "outDir": "./dist" /* Specify an output folder for all emitted files. */,
         // "removeComments": true,                           /* Disable emitting comments. */
         // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
         // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
@@ -72,12 +72,13 @@
         // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
         // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
         // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-        // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+        "declarationDir": "./dist" /* Specify the output directory for generated declaration files. */,
 
         /* Interop Constraints */
         // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
         // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
         // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+        // "erasableSyntaxOnly": true,                       /* Do not allow runtime constructs that are not part of ECMAScript. */
         // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
         "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
         // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */

package/.babelrc

@@ -1,3 +0,0 @@
-{
-    "presets": ["@babel/preset-env"]
-}

package/dist/index.js

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _sheet = require("./utils/sheet");
-Object.keys(_sheet).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _sheet[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _sheet[key];
-    }
-  });
-});
-var _wookbook = require("./utils/wookbook");
-Object.keys(_wookbook).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _wookbook[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _wookbook[key];
-    }
-  });
-});

package/dist/types/index.d.ts

@@ -1 +0,0 @@
-export * from "./utils/sheet";

package/dist/types/utils/sheet.d.ts

@@ -1,24 +0,0 @@
-import { CellModel } from "../types/sheet";
-/**
- * SpreadJS工作表工具函数
- */
-export declare const SheetUtils: {
-    /**
-     * 获取当前活动工作表选中的单元格集合
-     * @param spread 工作簿对象
-     * @returns 返回选中单元格的集合，格式如：[{row:,col:,rowCount:,colCount:}]
-     */
-    getActiveSheetSelectCells: (spread: any) => any;
-    /**
-     * 设置当前活动工作表某个单元格范围为选中状态
-     * @param spread 工作簿对象
-     * @param cellObj 设置选中的单元格，格式如：{row:0,col:0,rowCount:1,colCount:1}
-     */
-    setActiveSheetSelectCells: (spread: any, cellObj: CellModel) => void;
-};
-/**
- * 测试的函数
- * @param num 传入的参数
- * @returns 返回传入的参数+1
- */
-export declare const TestFunc: (num: number) => number;

package/src/index.js

@@ -1,2 +0,0 @@
-export * from "./utils/sheet";
-export * from "./utils/wookbook";