Univer Boards API
Узнайте, как использовать Facade API в приложении Univer Boards.
Facade API предоставляет прикладной уровень поверх сервисов и моделей модулей Univer. Используйте его для типичных операций с досками: создания досок, чтения активных страниц, добавления элементов, обновления контейнеров и управления дорожками.
Внимание
Изменения Board выполняются синхронно и возвращают boolean или nullable-объект. Проверяйте возвращаемое значение.
Подключение точки входа Facade
Boards распространяется в виде плагинов Web SDK. Импортируйте точку входа Facade для возможностей Boards, которые использует ваше приложение:
import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/boards/facade'Создайте объект API после регистрации экземпляра Univer и необходимых плагинов:
const univerAPI = FUniver.newAPI(univer)Создание и чтение доски
Используйте createBoard, чтобы создать модуль доски через уровень Facade. В низкоуровневом коде конфигурации создавайте модуль с помощью univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot).
const board = univerAPI.createBoard({ id: 'board-demo', name: 'Board Demo',})const activeBoard = univerAPI.getActiveBoard()const sameBoard = univerAPI.getBoard(board.getId())Переход к основным возможностям
Возвращённый объект FBoard служит точкой входа к активной странице и её содержимому. Подробные операции описаны в отдельных руководствах:
- Элементы — чтение, вставка, соединение, преобразование, размещение и удаление элементов Board.
- Контейнеры и дорожки — группы с рамками, принадлежность элементов и структура дорожек.
Справочные материалы
Насколько полезно это руководство?