API générale

Utilisez les commandes, événements, historique, presse-papiers, UI, WebSocket, énumérations et utilitaires communs dans une application PDF.

La racine Facade API combine le runtime partagé Univer avec les plugins enregistrés par l'application PDF. Cette page couvre les mécanismes qui se comportent de la même manière sur les produits Univer, et elle ne suppose pas l'expérience avec un autre type de document Univer. Pour les unités PDF et les points d'entrée de page, continuez avec API PDFs Univer.

Créer l'objet API

Créer un seul wrapper FUniver après l'enregistrement de l'instance Univer et des plugins requis:

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

Les entrées Facade importées avant cet appel ajoutent leurs méthodes au même objet.

Commandes

executeCommand() exécute une commande enregistrée asynchronement. Utilisez syncExecuteCommand() uniquement lorsque la commande prend explicitement en charge l'exécution synchrone. Pour les opérations PDF communes, les méthodes Facade restent le point d'entrée privilégié.

Événements

TypeScript
const commandLog = univerAPI.addEvent(  univerAPI.Event.CommandExecuted,  ({ id }) => console.log('Executed:', id))// Supprimez ensuite l'écouteur.commandLog.dispose()

Utilisez BeforeCommandExecute lorsque l'application doit inspecter ou annuler une commande. LifeCycleChanged rapporte les étapes communes de l'éditeur telles que Rendered et Steady.

Annuler et rétablir

Undo et redo s'appliquent à la Univer Unit qui a actuellement focalisé, et les deux promesses de retour:

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

PDF Facade change avec une opération inverse entrez l'historique de l'unité PDF ciblée.

Presse-papiers système

Lorsque UniverPdfsUIPlugin est enregistré et que l'édition PDF est activée, les méthodes copy() et paste() de l'interface utilisateur envoient les commandes de presse-papiers à l'unité PDF ciblée :

TypeScript
import '@univerjs/ui/facade'await univerAPI.copy()await univerAPI.paste()

Pour les objets PDF modifiables, le plugin PDF UI conserve la charge utile copiée dans la session courante du navigateur plutôt que de l'écrire au presse-papier du système d'exploitation. L'édition de texte native dans le navigateur suit toujours le comportement du presse-papiers du navigateur.

UI

L'interface utilisateur Facade affiche les messages, ouvre les dialogues et les barres latérales, enregistre les composants et contrôle les parties intégrées de l'interface utilisateur :

TypeScript
univerAPI.setUIVisible(univerAPI.Enum.BuiltInUIPart.TOOLBAR, true)

Ces méthodes nécessitent UniverUIPlugin, et les contrôles d'édition PDF nécessitent également UniverPdfsUIPlugin.

WebSocket

WebSocket est facultatif. Enregistrez le plugin Network et importez son point d'entrée Facade avant de créer l'objet API :

TypeScript
import { UniverNetworkPlugin } from '@univerjs/network'import '@univerjs/network/facade'univer.registerPlugin(UniverNetworkPlugin)const socket = univerAPI.createSocket('wss://example.com/pdfs')socket.open$.subscribe(() => socket.send('ready'))

Les protocoles de message, l'authentification, la reconnexion et le traitement des conflits de collaboration restent la responsabilité de l'application hôte.

Énumérations

univerAPI.Enum expose les enums d'exécution et ceux ajoutés par le PDF Facade:

TypeScript
const lifecycle = univerAPI.Enum.LifecycleStages.Steadyconst annotationType = univerAPI.Enum.PdfAnnotationType.HIGHLIGHT

Utilitaires

univerAPI.Util expose des aides partagées, notamment le formatage des nombres, les opérations sur les rectangles et les outils communs :

TypeScript
const payload = univerAPI.Util.tools.deepClone({  pageId: 'page-1',  selectedElementIds: ['element-1'],})

L'API commune complète est documentée dans le Référence de la façade.

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.