Concepts de base
Univer Docs est composé de plugins, stocke un document dans un instantané, applique des modifications par le biais des commandes, et est normalement conduit à travers le Facade API. Cette page explique ces quatre concepts. Pour lancer un éditeur, continuez à l'installation et l'utilisation de base .
Concepts de base
Les autres pages utilisent ces quatre termes dans l'ensemble :
- Plugin
- Snapshot
- Commande
- Facade API
Plugins
Les plugins fournissent toutes les fonctionnalités de Univer et constituent le plus petit bloc de construction de l'architecture. Une application Univer consiste en un ensemble de plugins.
Un plugin joue l'un des deux rôles suivants :
- Il implémente une fonctionnalité.
@univerjs/docs-hyper-link, par exemple, ajoute le modèle et les commandes hyperliens à Univer Docs. - Il fournit une capacité de base.
@univerjs/engine-renderfournit le rendu.
N'incluez que les plugins nécessaires à votre application, de sorte que le code inutilisé n'est pas chargé. Lorsque les plugins disponibles ne couvrent pas une exigence, écrivez un plugin pour étendre Univer.
Liens connexes
- Hyperliens explique comment ajouter une fonctionnalité Docs en mode préréglé ou en mode plugin.
- Architecture Univer décrit plus en détail la composition interne de Univer.
Instantané
Univer Docs stocke un document sous la forme de IDocumentData. L'instantané décrit le corps du document, les styles de niveau document, les en-têtes et les pied de page, les dessins, les listes, les tableaux et les ressources du plugin.
Les données définies par un plugin résident dans le champ optionnel resources.
Attention
Un snapshot ne contient que des données. Il ne suit pas l'état du document pendant l'exécution de l'éditeur. Pour enregistrer l'état courant en tant qu'instantané, appelez la méthode snapsak sur le Facade API.
Commande
Dans Univer Docs, chaque changement de contenu ou de formatage passe par une commande. Cette conception rend possible le suivi du changement, la désactivation, le redécoupage et l'édition collaborative, et maintient les fonctionnalités connexes compatibles les unes avec les autres.
Le Facade API prépare les arguments et exécute la commande Docs correspondante.
Attention
Ne modifiez pas l'instantané directement. Une telle écriture n'a pas d'effet et laisse les vues et l'interface utilisateur hors de la date. Changez les données à travers les commandes ou la Facade API.
Facade API
Les applications Office sont intrinsèquement complexes, et l'architecture nécessaire pour les supporter est aussi complexe. Le Facade API supprime le besoin de travailler à ce niveau : il enveloppe les plugins de premier parti de Univer et expose des points d'entrée plus simples.
Le Facade API est toujours en développement actif. Si vous avez des questions ou des exigences, ouvrez un problème sur GitHub.
Il résume les détails sous-jacents, ce qui suffit pour le travail quotidien. Les fonctionnalités complexes peuvent encore nécessiter une compréhension de l'architecture de Univer et l'utilisation directe de l'API de bas niveau.
Liens connexes
Mode preset et mode plugin
Un preset est un paquet de plugins déjà configurés. Lorsque les deux modes incluent les mêmes plugins, ils fournissent les mêmes capacités. Présets réduisent le travail de configuration; le mode plugin laisse la composition et le chargement à l'application.
Gardez chaque dépendance Univer sur la même version. Si un preset inclut déjà un plugin, ne l'enregistrez pas une seconde fois.
| Mode plugin | Mode preset |
|---|---|
| La demande importe les extensions Facade elle-même | Le préréglage inclut les extensions Facade |
| L'application contrôle l'ordre d'enregistrement des plugins | Le preset gère les plugins qu'il inclut |
| Les greffons sont chargés sur demande | Charger les presets configurés à l’initialisation |
Que pensez-vous de ce guide ?