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éTypeDescription
idstringIdentifiant unique de l’unité de document.
rev?numberRévision du document, utilisée pour l’édition collaborative.
locale?LocaleTypeLocale du document.
title?stringTitre du document.
body?IDocumentBodyCorps principal en texte enrichi. Détails
documentStyleIDocumentStyleParamè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?IDocumentSettingsParamètres d’exécution tels que zoomRatio.
resources?IResourcesRessources des plugins.
disabled?booleanIndique si le document est désactivé.
headers?IHeadersCorps des en-têtes indexés par identifiant d’en-tête.
footers?IFootersCorps des pieds de page indexés par identifiant de pied de page.
lists?IListsDéfinitions des listes utilisées par les puces des paragraphes.
drawings?IDrawingsObjets graphiques tels que des images.
drawingsOrder?string[]Ordre de rendu des objets graphiques.
tableSource?ITablesDé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:

  1. Créer un document Univer Docs
  2. Enregistrer un instantané Univer Docs
  3. Importer ou exporter des fichiers .docx
  4. 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 ?

© 2026 DreamNum Co., Ltd.