API générale

Le Facade API disponible en Univer dépend du type d'unité actuel et des plugins enregistrés. Cette page couvre les API courantes utilisées dans une application Univer Boards.

Importation

TypeScript
import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/boards/facade'const univerAPI = FUniver.newAPI(univer)

Commandes

La plupart des opérations de Univer sont enregistrées avec le système de commande. Ce chemin d'exécution unique supporte l'annulation, le redécoupage et la collaboration.

Pour la justification de la conception, voir la Système de commande Univer.

Écoute des commandes

Event.BeforeCommandExecute s'allume avant qu'une commande ne s'exécute, et Event.CommandExecuted se déclenche après qu'elle se soit terminée.

TypeScript
const beforeDisposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, ({ id, params }) => {  console.log('Avant la commande :', id, params)})const afterDisposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id, params }) => {  console.log('Commande exécutée :', id, params)})

Un auditeur BeforeCommandExecute peut empêcher une commande de fonctionner en configurant event.cancel à true.

TypeScript
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => {  if (event.id === 'board.command.set-name') {    event.cancel = true  }})

Chaque auditeur renvoie un IDisposable. Jetez-le lorsque l'auditeur n'est plus nécessaire.

TypeScript
beforeDisposable.dispose()afterDisposable.dispose()disposable.dispose()

Exécution de commandes

Lorsque l'ID de la commande et ses paramètres sont connus, exécutez la commande avec FUniver.executeCommand. La commande Boards suivante renomme le Board actif :

TypeScript
const board = univerAPI.getActiveBoard()if (board) {  await univerAPI.executeCommand('board.command.set-name', {    unitId: board.getId(),    name: 'Notes du projet',  })}

API des événements

univerAPI.Event liste les noms d'événements du noyau Univer et des plugins enregistrés dans l'application courante. Core fournit les événements de commande et d'unité partagés, et les plugins peuvent ajouter les leurs. Confirmez que le plugin fournissant un événement est enregistré avant d'utiliser l'événement.

Le Facade Events référence liste les noms d'événements et les types de paramètres dans la version courante.

Abonnez-vous à addEvent et éliminez l'objet retourné pour vous désabonner :

TypeScript
const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id }) => {  if (id === 'board.command.set-name') {    console.log('Le nom du Board a changé')  }})// Supprimez l’écouteur lorsqu’il n’est plus nécessairedisposable.dispose()

Annulation et rétablissement

TypeScript
await univerAPI.undo()await univerAPI.redo()

Interface utilisateur

Pour étendre les menus, la barre d'outils et d'autres zones d'interface des cartes, consultez Composantes des régimes d'assurance-chômage.

WebSocket

Pour utiliser les API WebSocket, installez @univerjs/network, enregistrez UniverNetworkPlugin, puis importez son extension Facade.

TypeScript
import { UniverNetworkPlugin } from '@univerjs/network'import '@univerjs/network/facade'univer.registerPlugin(UniverNetworkPlugin)

Après l'enregistrement, la socket prend en charge l'abonnement aux événements de socket, l'envoi de messages et la fermeture de la connexion:

TypeScript
const socket = univerAPI.createSocket('wss://example.com/boards')socket.open$.subscribe(() => {  socket.send('hello')})socket.message$.subscribe((message) => {  console.log('Message WebSocket :', message.data)})socket.error$.subscribe((error) => {  console.error('Erreur WebSocket :', error)})socket.close()

API des énumérations

Les types d'énum communs sont exposés sur univerAPI.Enum:

TypeScript
console.log(univerAPI.Enum.UniverInstanceType.UNIVER_BOARD)console.log(univerAPI.Enum.BoardElementType.Shape)

API des méthodes utilitaires

Les utilitaires partagés sont exposés sur univerAPI.Util :

TypeScript
console.log(univerAPI.Util.tools.isString('Univer Boards')) // true

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.