Import & Export
Plugins Info
Server RequiredDepends on server-side capabilities
Boards can participate in Pro import/export workflows through Board import and export adapters. The exact file formats depend on the Pro exchange services registered in your application.
Register the Board runtime first
TypeScript
univer.registerPlugin(UniverBoardsPlugin)univer.registerPlugin(UniverBoardsUIPlugin)univer.registerPlugin(UniverBoardsExchangeClientPlugin)Register optional element plugins before importing data that may contain those elements:
TypeScript
univer.registerPlugin(UniverBoardsTablePlugin)univer.registerPlugin(UniverBoardsTableUIPlugin)univer.registerPlugin(UniverBoardsMindPlugin)univer.registerPlugin(UniverBoardsMindUIPlugin)Snapshot handoff
For application-level persistence, save and restore the Board snapshot:
TypeScript
const board = univerAPI.getActiveBoard()const snapshot = board.getData()univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot)Interactive exchange
@univerjs-pro/boards-exchange-client registers Board export and Mermaid import APIs.
TypeScript
import '@univerjs-pro/exchange-client/facade'import '@univerjs-pro/boards-exchange-client/facade'const file = await univerAPI.exportBoardByUnitIdAsync(board.getId())if (file) univerAPI.downloadFile(file, 'board', 'pptx')await board.insertMermaidAsync('flowchart LR\n A[Draft] --> B[Review]')Use exportBoardBySnapshotAsync(snapshot) for detached data. transformSnapshotJsonToBoardDataAsync and transformBoardDataToSnapshotJsonAsync convert exchange-service snapshot blocks.
For license and deployment requirements, see Univer SDK Pro.
How is this guide?