API générale
Les API Facade disponibles pour une application dépendent du type d'unité courante et des plugins enregistrés. Cette page couvre les API qu'une application Univer Bases utilise couramment.
Importation
import { FUniver } from '@univerjs/core/facade'import '@univerjs-pro/bases/facade'import '@univerjs/ui/facade'const univerAPI = FUniver.newAPI(univer)Commandes
La plupart des opérations dans Univer passent par le système de commande. Parce que chaque opération suit le même chemin, annuler, refaire et collaborer peut couvrir toutes les opérations.
Pour le design derrière, voir le Système de commande Univer.
Écoute des commandes
Utilisez Event.BeforeCommandExecute pour exécuter le code avant qu'une commande n'exécute, et Event.CommandExecuted à exécuter le code après qu'il ait terminé.
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)})Pour empêcher qu'une commande ne s'exécute, définissez event.cancel à true dans un auditeur BeforeCommandExecute.
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => { if (event.id === 'base.command.set-base-name') { event.cancel = true }})Les deux auditeurs retournent un IDisposable. Jetez les objets retournés lorsqu'ils ne sont plus nécessaires.
beforeDisposable.dispose()afterDisposable.dispose()disposable.dispose()Exécution de commandes
Lorsqu'un ID de commande et ses paramètres sont connus, FUniver.executeCommand exécute la commande directement. La commande Bases suivante renomme la base active :
const base = univerAPI.getActiveBase()if (base) { await univerAPI.executeCommand('base.command.set-base-name', { unitId: base.getId(), name: 'Notes du projet', })}API des événements
Les événements sur univerAPI.Event proviennent du noyau Univer et des plugins enregistrés dans l'application courante. Core fournit les événements de commande et d'unité que chaque produit partage; les plugins Bases ajoutent des événements pour les tables, les champs, les enregistrements, les vues et autres changements de Base. Avant d'utiliser un événement, confirmez que le plugin qui le fournit est enregistré.
Le Facade Events référence liste les noms d'événements et les types de paramètres disponibles dans la version actuelle.
S'abonner avec addEvent, puis disposer de l'objet retourné pour se désabonner :
const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, ({ id }) => { if (id === 'base.command.set-base-name') { console.log('Le nom du Base a changé') }})// Supprimez l’écouteur lorsqu’il n’est plus nécessairedisposable.dispose()Annulation et rétablissement
await univerAPI.undo()await univerAPI.redo()Presse-papiers système
Après l’enregistrement du plugin d’interface Bases, copy et paste agissent sur la sélection et la position du curseur actuelles dans le Base.
await univerAPI.copy()await univerAPI.paste()Copier et coller utilisez l'API de presse-papiers natif du navigateur. Ils peuvent échouer lorsque la page n'a pas de focus, lorsque l'appel ne provient pas d'une action de l'utilisateur, ou lorsque la permission de presse-notes n'est pas disponible. Voir le Documentation du presse-papiers MDN.
Interface utilisateur
Pour étendre les menus, la barre d'outils et d'autres zones de l'interface Bases, voir Bases Composantes de l'assurance-chômage.
WebSocket
Pour utiliser les API WebSocket, installer @univerjs/network, enregistrer UniverNetworkPlugin et importer son extension Facade.
import { UniverNetworkPlugin } from '@univerjs/network'import '@univerjs/network/facade'univer.registerPlugin(UniverNetworkPlugin)L'application peut ensuite s'abonner aux événements de socket, envoyer des messages et fermer la connexion:
const socket = univerAPI.createSocket('wss://example.com/bases')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
Facade expose les types d'énum communs sur univerAPI.Enum:
console.log(univerAPI.Enum.UniverInstanceType.UNIVER_BASE)console.log(univerAPI.Enum.BaseFieldType.Text)API des méthodes utilitaires
Les méthodes d'utilité partagées sont exposées sur univerAPI.Util :
console.log(univerAPI.Util.tools.isString('Univer Bases')) // trueQue pensez-vous de ce guide ?