@flatfile/plugin-export-workbook

这个 @flatfile/plugin-export-workbook 插件将 Flatfile 工作簿中的数据导出为可下载 .xlsx 文档.

事件类型 : listener.on('job:ready')

支持的文件类型 : .xlsx

嵌入Flatfile时,该插件应被部署在服务器侧听器中. 学多点

参数

jobName - 说吧 string - (可选)

插件会点出的工作名称 。 如果没有提供, workbook:downloadWorkbook 将被使用.

excludedSheets - 说吧 string[] - (可选)

导出时要排除的一系列工作表

excludeFields - 说吧 string[] - (可选)

要从导出中排除的一系列字段

excludeMessages - 说吧 boolean - (可选)

如果选中的话, 记录中的信息将被排除在导出的数据之外 .

recordFilter - 说吧 Flatfile.Filter - (可选)

允许过滤导出的记录到 valid 或者说 error。默认情况下,所有记录都将被导出

includeRecordIds - 说吧 boolean - (可选)

包括记录的ID

autoDownload - 说吧 boolean - (可选)

导出后自动下载文件

debug - 说吧 boolean - (可选)

这个 debug 参数允许您为开发目的切换或关闭帮助调试消息.

sheetOptions - 说吧 Record<string, ExportSheetOptions> - (可选)

工作表流图到 ExportSheetOptions 实例,提供工作表特定导出选项:

• skipColumnHeaders - 说吧 boolean - (可选) - 允许省略列头
• origin - 说吧 number | SheetAddress - (可选) - 允许抵消工作表的开始 。 参数为行号或对象 column 财务报告和审定财务报表 row。 。 。 .

用法 :

listener.use(
  exportWorkbookPlugin({
    sheetOptions: {
      SomeSheetSlug: {
        // Start the sheet at 5
        origin: 5,
        // Omit column headers
        skipColumnHeaders: true,
      },
      SomeOtherSheetSlug: {
        // Start the sheet at row 10 column 2
        origin: {row: 10, column: 2},
      },
    },
  })

columnNameTransformer - 说吧 ColumnNameTransformerCallback - (可选)

回调函数允许更改工作簿中列名的显示方式 。 该函数接受两个参数: columnName 财务报告和审定财务报表 sheetSlug 并返回新的列名.

使用量

在工作簿(不是工作表)上必须配置一个操作名为"download Workbook"的动作才能被触发.

workbook.config.json

  // ... inside Workbook configuration
  "actions": [
    {
      "operation": "downloadWorkbook",
      "mode": "foreground",
      "label": "Download Excel Workbook",
      "description": "Downloads Excel Workbook of Data",
      "primary": true
    }
  ]
  // ...

安装

npm i @flatfile/plugin-export-workbook

listener.js

import type { FlatfileListener } from "@flatfile/listener";

import { exportWorkbookPlugin } from "@flatfile/plugin-export-workbook";

export default function (listener: FlatfileListener) {
  listener.use(exportWorkbookPlugin());
}