Быстрый старт

Перед установкой Univer Boards ознакомьтесь с четырьмя понятиями, которые используются во всём API и документации. Они описывают, как Board компонуется, хранится, изменяется и управляется.

Основные понятия

Плагины

Функции Univer поставляются в виде плагинов. @univerjs-pro/boards предоставляет модель, команды и UniverBoardsPlugin, а @univerjs-pro/boards-ui — холст, интерфейс редактирования и UniverBoardsUIPlugin. Пакеты форматированного текста, рисования, рукописного ввода и редактирования фигур являются техническими зависимостями рендеринга, которые регистрируются при настройке. Знать другие продукты Univer заранее не требуется. Таблицы и интеллект-карты подключаются как необязательные плагины Board.

Регистрируйте только те продуктовые плагины, которые нужны приложению. Полная настройка браузера и её зависимости описаны в руководстве по установке.

Снимок и модель данных

IBoardData — формат хранения одного модуля Board. Страницы находятся в pages, а их порядок — в pageOrder. В каждой странице элементы хранятся в elements, а порядок их отрисовки — в elementOrder. Ресурсы, темы, активная страница, масштаб и настройки Board также входят в снимок.

Снимок используется для создания, сохранения и восстановления Board. После запуска модуля не изменяйте объект снимка напрямую. Схема описана в разделах Структура данных Board и Элементы Board.

Команды

Изменения во время выполнения проходят через команды. Добавление элемента, изменение его трансформации, перемещение в контейнер или смена состояния страницы через команды либо Facade сохраняет согласованность модели, холста, отмены/повтора и совместного редактирования.

В коде приложения отдавайте предпочтение Facade API. Используйте идентификаторы команд напрямую только для низкоуровневой интеграции, которой нет в Facade.

Facade API

Facade API оборачивает модель и команды Board объектом FBoard и дескрипторами элементов. Импортируйте @univerjs-pro/boards/facade, а после регистрации плагинов создайте API с помощью FUniver.newAPI(univer). Через него можно создать или найти Board, получить активную страницу и элементы, управлять контейнерами и дорожками.

Перейдите к разделу Установка и основы использования, а затем используйте руководство по Boards Facade API для создания и изменения содержимого Board.