@univerjs-pro/boards

本 API 页面目前提供英文正文。代码签名与标识符不随界面语言变化。

Board data model, element schema, commands, mutations, adapter services, and Facade APIs for Univer Boards.

TypeScript

import { UniverBoardsPlugin } from '@univerjs-pro/boards'import '@univerjs-pro/boards/facade'univer.registerPlugin(UniverBoardsPlugin)

Entry Points

Facade: @univerjs-pro/boards/facade

The Facade can read, set, and clear the active page background with getBackground(), setImageBackground(options), and clearBackground(). See the Boards Facade reference for an image example.

The same entry provides insertInk(options) and getInks(), plus IBoardInkFacadeInsertOptions and the BoardInkTool, BoardInkPointType, and BoardInkHandleKind enums. Ink coordinates use Board coordinates; insertion derives element bounds and uses the normal command path. getInks() returns Ink elements in z-order, including hidden or locked elements. See the Ink insertion example.

你觉得这篇文档如何？