Import and export

Boards supports Mermaid source import and PPTX export through @univerjs-pro/boards-exchange-client.

Supported formats

The table describes the browser APIs on this page. Office file conversion requires a backend that supports the same document type and format.

Mermaid import inserts source text as Board elements through insertMermaidAsync; it is not an Office file importer. The export APIs produce .pptx and require a conversion backend. They do not provide PPTX import or image/PDF export. Any additional targets registered by the host application are separate capabilities.

Register the Board runtime first

univer.registerPlugin(UniverBoardsPlugin)univer.registerPlugin(UniverBoardsUIPlugin)univer.registerPlugin(UniverBoardsExchangeClientPlugin)

Register optional element plugins before importing data that may contain those elements:

univer.registerPlugin(UniverBoardsTablePlugin)univer.registerPlugin(UniverBoardsTableUIPlugin)univer.registerPlugin(UniverBoardsMindPlugin)univer.registerPlugin(UniverBoardsMindUIPlugin)

Snapshot handoff

For application-level persistence, save and restore the Board snapshot:

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.

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 Web SDK.