Web SDK

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

Познакомьтесь с плагинами, снимками, командами и Facade API Univer Sheets. Для создания редактора перейдите к установке и основам использования.

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

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

К основным понятиям относятся:

  • Плагин
  • Снимок
  • Команда
  • Facade API

Плагины

Все возможности Univer предоставляются плагинами — базовыми строительными блоками системы. Приложение Univer формируется из нескольких объединённых плагинов.

Плагины выполняют следующие задачи:

  1. Реализуют функции: например, @univerjs/sheets-filter добавляет фильтрацию.
  2. Предоставляют базовые возможности: например, @univerjs/engine-render отвечает за рендеринг.

Вы можете комбинировать плагины Univer, чтобы настроить приложение под свои требования и не загружать лишний код. Кроме того, вы можете создавать собственные плагины и расширять возможности Univer для конкретных задач.

Полезные ссылки

  1. Создание плагина для импорта CSV — узнайте, как написать плагин.
  2. Архитектура Univer — подробнее об архитектуре Univer.

Снимок

Чтобы загрузить документ в Univer, необходимо загрузить его снимок. Для каждого типа документа предусмотрен собственный формат снимка. В документации API описано, как сформировать снимок в соответствии с требованиями формата:

  1. Формат снимка электронной таблицы — IWorkbookData.
  2. Формат снимка документа — IDocumentData.

Функциональные плагины могут хранить ресурсы, например изображения, в поле resources. Подробнее см. в разделе Пользовательская модель плагина.

Внимание

Снимок Univer предназначен только для хранения данных. Во время выполнения он не отражает актуальное состояние документа. Чтобы сохранить текущее состояние документа как снимок, используйте соответствующий метод Facade API.

Команда

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

Если вы хотите изменять данные документа с помощью команд, см. раздел Как найти идентификатор команды. При изменении данных через Facade API этот API сам подготавливает параметры и выполняет команды внутри системы.

Внимание

Не изменяйте снимок напрямую. Такие изменения не вступят в силу и не приведут к обновлению представлений или интерфейса. Изменяйте данные с помощью команд или Facade API.

Facade API

Офисные приложения сложны, поэтому архитектура Univer также достаточно комплексна. Чтобы разработчикам было проще работать с Univer, мы предоставляем Facade API — оболочку над официальными плагинами Univer с более простыми интерфейсами.

Facade API активно развивается. Если у вас есть вопросы или пожелания, создайте issue на GitHub.

Facade API — это высокоуровневый API, скрывающий детали внутренней реализации. Он упрощает типовые задачи, однако для сложных функций может потребоваться понимание архитектуры Univer и прямое использование низкоуровневого API.

Полезные ссылки

  1. Использование Facade API
  2. Общий API
  3. API Univer Sheets

Режим пресетов и режим плагинов

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

Версии всех зависимостей Univer должны совпадать. Не регистрируйте повторно плагин, уже включённый в пресет.

Режим плагиновРежим пресетов
Явный импорт расширений FacadeРасширения Facade включены
Контроль порядка регистрацииПресет управляет своими плагинами
Загрузка плагинов по требованиюЗагрузка настроенных пресетов при инициализации

Насколько полезно это руководство?

© 2026 DreamNum Co., Ltd.