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

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

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

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

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

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

Плагины

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

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

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

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

Ссылки по теме

1. В разделе «Гиперссылки» описано, как добавить функцию Docs в режиме preset или plugin.
2. Подробнее об архитектуре Univer читайте в разделе «Архитектура Univer».

Снимок

Univer Docs использует IDocumentData в качестве формата снимка. Он описывает содержимое документа, стили уровня документа, верхние и нижние колонтитулы, рисунки, списки, таблицы и ресурсы плагинов.

Необязательное поле resources хранит данные, определённые плагинами.

Команда

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

Facade API подготавливает параметры и выполняет соответствующие команды Docs в фоновом режиме.

Facade API

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

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

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

Ссылки по теме

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

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

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