Общий API
Набор Facade API в Univer зависит от типа текущего юнита и зарегистрированных плагинов. На этой странице описаны общие API приложения Univer Boards.
Импорт
import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/boards/facade'const univerAPI = FUniver.newAPI(univer)Команды
Большинство операций Univer регистрируются в системе команд. Единый путь выполнения поддерживает отмену, повтор действий и совместную работу.
Подробнее об устройстве системы читайте в разделе Система команд Univer.
Прослушивание команд
Используйте Event.BeforeCommandExecute для логики перед выполнением команды и Event.CommandExecuted — после её завершения.
const beforeDisposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, ({ id, params }) => { console.log('Перед командой:', id, params)})const afterDisposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id, params }) => { console.log('Команда выполнена:', id, params)})Чтобы отменить команду, установите event.cancel в true в обработчике BeforeCommandExecute.
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => { if (event.id === 'board.command.set-name') { event.cancel = true }})Обработчики возвращают IDisposable. Освобождайте их, когда они больше не нужны.
beforeDisposable.dispose()afterDisposable.dispose()disposable.dispose()Выполнение команд
Если известны идентификатор команды и её параметры, выполните её через FUniver.executeCommand. Например, следующая команда Boards переименовывает активный Board.
const board = univerAPI.getActiveBoard()if (board) { await univerAPI.executeCommand('board.command.set-name', { unitId: board.getId(), name: 'Заметки проекта', })}API событий
События в univerAPI.Event предоставляются ядром Univer и плагинами, зарегистрированными в приложении. Ядро предоставляет общие события команд и модулей, а зарегистрированные плагины могут расширять этот набор. Перед использованием события убедитесь, что предоставляющий его плагин зарегистрирован.
Имена событий и типы параметров текущей версии приведены в справочнике Facade Events.
Подпишитесь через addEvent и освободите возвращённый объект, чтобы отменить подписку.
const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id }) => { if (id === 'board.command.set-name') { console.log('Имя Board изменено') }})// Удалите обработчик, когда он больше не нуженdisposable.dispose()Отмена и повтор действий
await univerAPI.undo()await univerAPI.redo()UI
О расширении меню, панели инструментов и других областей интерфейса читайте в разделе Компоненты интерфейса Boards.
WebSocket
Для работы с WebSocket установите @univerjs/network, зарегистрируйте UniverNetworkPlugin и импортируйте его Facade-расширение.
import { UniverNetworkPlugin } from '@univerjs/network'import '@univerjs/network/facade'univer.registerPlugin(UniverNetworkPlugin)После этого можно подписываться на события сокета, отправлять сообщения и закрывать соединение.
const socket = univerAPI.createSocket('wss://example.com/boards')socket.open$.subscribe(() => socket.send('hello'))socket.message$.subscribe((message) => console.log('Сообщение WebSocket:', message.data))socket.error$.subscribe((error) => console.error('Ошибка WebSocket:', error))socket.close()API перечислений
Общие перечисления доступны через univerAPI.Enum.
console.log(univerAPI.Enum.UniverInstanceType.UNIVER_BOARD)console.log(univerAPI.Enum.BoardElementType.Shape)API вспомогательных методов
Общие вспомогательные методы доступны через univerAPI.Util.
console.log(univerAPI.Util.tools.isString('Univer Boards')) // trueНасколько полезно это руководство?