导入导出
本页的 API 需要转换后端。请先按导入导出集成完成文件上传、转换、任务查询和下载的配置,再配置前端插件。快照 API 同样需要该后端,但不需要创建协同文档。
导出失败时,参见许可证错误码与任务失败处理。
导入的 Office 附件的处理方式,参见 OLE 预览、在线转换和导出来源选择。
支持的格式
下表列出本页前端 API 支持的格式。Office 文件转换还需要后端支持相同的文档类型和格式。
| 导入 | 导出 |
|---|---|
.xls, .xlsx, .csv, .tsv | .xlsx, .csv, .tsv |
CSV、TSV 只导出一个工作表,不保留工作簿样式和其他工作表。导出时传入 ExchangeFormat.CSV 或 ExchangeFormat.TSV 以及 sheetId,默认使用 XLSX。即使转换后端支持 .xlsm,前端 API 也不接受该格式。
Facade API
导入
插件模式提示
仅插件模式需要手动引入 Facade 包。预设模式已内置对应的包,无需再次导入。
import '@univerjs-pro/exchange-client/facade'import '@univerjs-pro/sheets-exchange-client/facade'导入 .xlsx
导入 .xlsx 文件并获取 unitId
注意事项
该方法依赖协同服务:导入后会在服务端创建文档并返回 unitId。未启用协同服务时,请改用快照导入。
启用协同编辑后,每个文档都有唯一的 unitId。向 univerAPI.importSheetToUnitIdAsync 传入 file,该方法返回 unitId,用于打开文档。file 可以是 File 对象,也可以是远程文件的 URL。
import '@univerjs-pro/collaboration-client/facade'const unitId = await univerAPI.importSheetToUnitIdAsync(file)if (unitId) { await univerAPI.getCollaboration().loadSheetAsync(unitId)}导入 .xlsx 文件并获取 IWorkbookData
快照导入不依赖协同服务;需要协同文档时,请改用 unitId 导入。univerAPI.importSheetToSnapshotAsync 导入 .xlsx 文件,返回 IWorkbookData 格式的文档数据。
// 接受 File 对象const snapshot = await univerAPI.importSheetToSnapshotAsync(file)// 或者接受远程文件的 URL// const snapshot = await univerAPI.importSheetToSnapshotAsync('https://example.com/filename.xlsx');// 通过快照创建一个新的工作簿if (snapshot) univerAPI.createWorkbook(snapshot)导出 .xlsx
通过 unitId 导出 .xlsx 文件
注意事项
通过 unitId 导出依赖协同服务。未启用协同服务时,请改用快照导出。
启用协同编辑后,每个文档都有唯一的 unitId。将该 unitId 传给 univerAPI.exportSheetByUnitIdAsync,该方法返回一个 File 对象。
const fWorkbook = univerAPI.getActiveWorkbook()const unitId = fWorkbook.getId()const file = await univerAPI.exportSheetByUnitIdAsync(unitId)// 通过 Facade API 下载文件if (file) univerAPI.downloadFile(file, 'univer', 'xlsx')通过 IWorkbookData 导出 .xlsx 文件
将 IWorkbookData 传给 univerAPI.exportSheetBySnapshotAsync,该方法返回一个 File 对象。
const fWorkbook = univerAPI.getActiveWorkbook()const snapshot = fWorkbook.save()const file = await univerAPI.exportSheetBySnapshotAsync(snapshot)// 通过 Facade API 下载文件if (file) univerAPI.downloadFile(file, 'univer', 'xlsx')移除内置导入导出菜单和 UI 交互
注意事项
从 1.2.0 版本开始,Univer 不再内置导入导出菜单和 UI 交互。底层服务和 Facade API 仍然可用。
如果应用仍需保留这些菜单和交互,可参考内置导入导出菜单和 UI 交互迁移方案,通过自定义插件恢复这些功能。示例提供完整源码,支持在线查看和下载。
你觉得这篇文档如何?