Univer Boards

Что такое Univer Boards

Univer Boards — это продукт Univer Office SDK для работы на холсте. Он подходит для случаев, когда документ представляет собой не таблицу, страницу или набор слайдов, а свободное рабочее пространство: здесь можно размещать белые доски, диаграммы, стикеры, соединительные линии, встроенные таблицы и интеллект-карты.

Univer Office SDK включает Web SDK для встроенных редакторов и обработки контента без интерфейса, Server SDK для совместной работы и импорта и экспорта файлов, а также AI SDK для рабочих процессов агентов.

Boards реализован как отдельный тип модуля Web SDK. Во время выполнения вы создаёте модуль UniverInstanceType.UNIVER_BOARD, а затем регистрируете плагины модели и интерфейса, необходимые для поддержки нужных элементов.

Совместимость с браузерами

Web SDK компилируется для Chrome 88, но это не означает полной поддержки всех распространённых сред. Мы стремимся обеспечить стабильную работу Web SDK в следующих браузерах и средах Node.js:

Если возникли проблемы с совместимостью, сначала попробуйте устранить их с помощью подходящих полифилов. Если проблема сохраняется, создайте issue.

Совместимость с Node.js

Web SDK может работать в среде Node.js и поддерживает версии v18.17.0 и выше.

Основные возможности

• Страницы и порядок элементов: страницы хранятся в pages, а доступные для отрисовки объекты — в elements каждой страницы; на обоих уровнях используются явные массивы порядка.
• Элементы холста: текст, фигуры, изображения, соединительные линии, группы, контейнеры и кросс-функциональные диаграммы.
• Редактирование через команды: изменения элементов, порядок и родительские связи проходят через единый слой команд с разрешениями и точками подключения для необязательной истории и совместного редактирования.
• Холст в браузере: отрисовка элементов, выделение, преобразования, буфер обмена, редактирование текста, управление областью просмотра и панели.
• Расширяемые адаптеры: необязательные возможности Boards, включая таблицы, интеллект-карты, диаграммы, ресурсы, печать и обмен.
• Хранение данных: создание, восстановление и сохранение снимка IBoardData со страницами, ресурсами, темами и состоянием активной страницы.

Как читать документацию

Слева на экране находится панель навигации по документации. Страницы расположены последовательно — от базовых тем к более сложным, поэтому при создании приложения их можно изучать шаг за шагом. При этом вы можете читать их в любом порядке или сразу переходить к тем страницам, которые относятся к вашему сценарию. В верхней части боковой панели также можно выбрать Univer Boards.

Справа на экране находится оглавление, с помощью которого удобно переходить между разделами страницы. Чтобы быстро найти нужную страницу, воспользуйтесь строкой поиска вверху или сочетанием клавиш для поиска (Ctrl+K или Cmd+K).

Для начала ознакомьтесь с руководством «Быстрый старт».

Необходимые знания

Хотя наша документация рассчитана на начинающих, для её ясности и сосредоточенности на Web SDK мы предполагаем некоторый базовый уровень знаний.

Чтобы получить от документации максимум пользы, рекомендуем знать основы JavaScript и его экосистемы.

Если вы хотите запускать Web SDK в Node.js, также потребуется базовое понимание Node.js.

Для совместного редактирования, общей истории или комментариев и преобразования файлов подключите нужные модули Univer Server SDK к своему backend. Приложение отвечает за аутентификацию, права, хранение и развёртывание. Для редактирования только в браузере эти сервисы не нужны.

Расширение Univer Boards

Web SDK обладает широкими возможностями расширения, поэтому его можно адаптировать под свои задачи.