feat: add optimization parameter to exporting excel

Author: yangdan8

docs/assets/guide/en/export/excel.md

@@ -137,3 +137,12 @@ const excelOption = {
 };
 await downloadExcel(await exportVTableToExcel(tableInstance, excelOption));
 ```
+
+### equestIdleCallback
+
+`@visactor/vtable-export` uses the `exceljs` library as a tool for exporting Excel files. If you need tosolve the impact on page performance during the export process, you can set the `optimization` parameter to enable `requestIdleCallback`.
+
+```js
+const excelOption = {};
+await downloadExcel(await exportVTableToExcel(tableInstance, excelOption， true));
+```

docs/assets/guide/zh/export/excel.md

@@ -137,3 +137,12 @@ const excelOption = {
 };
 await downloadExcel(await exportVTableToExcel(tableInstance, excelOption));
 ```
+
+### equestIdleCallback
+
+`@visactor/vtable-export`使用`exceljs`库作为导出 Excel 文件的工具，如果需要解决导出对页面性能影响，可以设置`requestIdleCallback`的启用参数`optimization`
+
+```js
+const excelOption = {};
+await downloadExcel(await exportVTableToExcel(tableInstance, excelOption， true));
+```

packages/vtable-export/src/excel/index.ts

@@ -33,7 +33,15 @@ export type ExportVTableToExcelOptions = {
   skipImageExportCellType?: SkipImageExportCellType[];
 };
 
-export async function exportVTableToExcel(tableInstance: IVTable, options?: ExportVTableToExcelOptions) {
+function requestIdleCallbackPromise(options?: IdleRequestOptions) {
+  return new Promise<IdleDeadline>((resolve) => {
+    requestIdleCallback((deadline) => {
+      resolve(deadline);
+    }, options);
+  });
+}
+
+export async function exportVTableToExcel(tableInstance: IVTable, options?: ExportVTableToExcelOptions, optimization = false) {
   const workbook = new ExcelJS.Workbook();
   const worksheet = workbook.addWorksheet('sheet1');
   worksheet.properties.defaultRowHeight = 40;
@@ -49,9 +57,9 @@ export async function exportVTableToExcel(tableInstance: IVTable, options?: Expo
   const SLICE_SIZE = 100;
   let currentRow = minRow;
 
-  function processSlice(deadline: IdleDeadline) {
+  function processSlice(deadline?: IdleDeadline) {
     return new Promise<void>(async resolve => {
-      while (currentRow <= maxRow && deadline.timeRemaining() > 0) {
+      while (currentRow <= maxRow && (!optimization || (deadline?.timeRemaining() > 0))) {
         const endRow = Math.min(currentRow + SLICE_SIZE - 1, maxRow);
         for (let col = minCol; col <= maxCol; col++) {
           const colWidth = tableInstance.getColWidth(col);
@@ -84,19 +92,23 @@ export async function exportVTableToExcel(tableInstance: IVTable, options?: Expo
       if (currentRow > maxRow) {
         resolve();
       } else {
-        requestIdleCallback(async nextDeadline => {
-          await processSlice(nextDeadline);
-          resolve();
-        });
+        let nextDeadline: IdleDeadline | undefined;
+        if (optimization) {
+          nextDeadline = await requestIdleCallbackPromise()
+        }
+        await processSlice(nextDeadline);
+        resolve();
       }
     });
   }
 
-  await new Promise<void>(resolve => {
-    requestIdleCallback(async deadline => {
-      await processSlice(deadline);
-      resolve();
-    });
+  await new Promise<void>(async resolve => {
+    let deadline: IdleDeadline | undefined;
+    if (optimization) {
+      deadline = await requestIdleCallbackPromise()
+    }
+    await processSlice(deadline);
+    resolve();
   });
 
   worksheet.columns = columns;