Structure des données d’un document
IDocumentData
IDocumentData est le format d'instantané pour Univer Docs.
Un snapshot décrit une unité de document entière: corps de texte, styles de niveau de document, en-têtes et pied de page, dessins, listes, tableaux et ressources de plugin.
Propriétés
| Propriété | Type | Description |
|---|---|---|
| id | string | Identifiant unique de l’unité de document. |
| rev? | number | Révision du document, utilisée pour l’édition collaborative. |
| locale? | LocaleType | Locale du document. |
| title? | string | Titre du document. |
| body? | IDocumentBody | Corps principal en texte enrichi. Détails |
| documentStyle | IDocumentStyle | Paramètres de page, de mise en page, d’en-tête et de pied de page, ainsi que styles de texte par défaut appliqués à l’ensemble du document. |
| settings? | IDocumentSettings | Paramètres d’exécution tels que zoomRatio. |
| resources? | IResources | Ressources des plugins. |
| disabled? | boolean | Indique si le document est désactivé. |
| headers? | IHeaders | Corps des en-têtes indexés par identifiant d’en-tête. |
| footers? | IFooters | Corps des pieds de page indexés par identifiant de pied de page. |
| lists? | ILists | Définitions des listes utilisées par les puces des paragraphes. |
| drawings? | IDrawings | Objets graphiques tels que des images. |
| drawingsOrder? | string[] | Ordre de rendu des objets graphiques. |
| tableSource? | ITables | Définitions des tableaux référencés par le corps du document. |
Exemple
TypeScript
const documentData: IDocumentData = { id: 'doc-1', title: 'Demo Document', locale: LocaleType.EN_US, body: { dataStream: 'Hello Univer\r\n', textRuns: [ { st: 0, ed: 12, ts: { fs: 14 }, }, ], paragraphs: [ { startIndex: 12, paragraphId: 'paragraph-1', }, ], }, documentStyle: { pageSize: { width: 595, height: 842 }, marginTop: 72, marginBottom: 72, marginLeft: 72, marginRight: 72, },}Utilisation
IDocumentData est principalement utilisé en quatre endroits:
- Créer un document Univer Docs
- Enregistrer un instantané Univer Docs
- Importer ou exporter des fichiers
.docx - Stocker du texte enrichi dans des cellules Sheets à l’aide de
ICellData.p
Un instantané est des données persistantes. Ne le mutez pas directement pendant qu'un document est en cours d'exécution; utilisez des API ou des commandes Facade pour modifier le contenu du document.
Que pensez-vous de ce guide ?