API Univer Docs

Univer Docs est responsable de la composition des documents, et ses concepts suivent Microsoft Word de près.

Importation

TypeScript
import '@univerjs/docs/facade'import '@univerjs/docs-ui/facade'

Manipuler des documents

Dans une unité de document, unitId est l'identificateur unique du document, et les documents ne possèdent pas de subUnitId.

Le contenu texte est stocké dans la chaîne body.dataStream, qui ne contient aucune information de style.

Les informations de style sont stockées dans une structure de données séparée, qui renvoie au texte par des références d'index.

Les sauts de ligne, les sauts de page, les sections, les paragraphes et les tableaux sont chacun marqués par un caractère spécial dans le texte.

Les articles suivants décrivent la conception des structures de données du document : Architecture de documents et conception de modules Univer et Une exploration initiale de la conception de composition de documents Univer.

Créer un document

Appelez univerAPI.createDocument(data) pour créer un document. La méthode renvoie l'enveloppe de façade FDocument correspondante.

Son argument est un objet de données de document optionnel qui contient les données initiales. Le passage de {} crée un document vide.

Pour travailler avec l'instance sous-jacente univer au lieu de Facade API, appelez univer.createUnit(UniverInstanceType.UNIVER_DOC, data).

TypeScript
const doc = univerAPI.createDocument(data)

Obtenir le unitId d’un document

TypeScript
const doc = univerAPI.getActiveDocument()const unitId = doc?.getId()

Obtenir les données d’un document

TypeScript
const doc = univerAPI.getActiveDocument()const saveData = doc.save()

Supprimer un document

Lorsqu'un document n'est plus nécessaire, appelez dispose sur l'instance Univer pour le détruire.

TypeScript
univer.dispose()

Manipuler du texte

Les appels dans cette section modifient le texte dans la zone de texte riche.

Insérer du texte

Ajouter le texte spécifié à la fin de la zone de texte.

TypeScript
const doc = univerAPI.getActiveDocument()doc?.insertText(0, 'Univer')

Supprimer du texte

Supprimer le texte par des offsets de documents.

TypeScript
const doc = univerAPI.getActiveDocument()doc?.deleteRange({ startOffset: 0, endOffset: 1 })

Modifier le style

Définir un style de texte sur un paragraphe.

TypeScript
const doc = univerAPI.getActiveDocument()const paragraph = doc?.getParagraphs()[0]paragraph?.setStyle({  textStyle: {    cl: {      rgb: '#FF0000',    },  },})

Insérer un saut de page

\f est le caractère d'ouverture de page. L'insérer dans le document crée une rupture de page.

TypeScript
const doc = univerAPI.getActiveDocument()doc?.insertText(0, '\f')

Statistiques du document

Les statistiques sous-jacentes DocumentDataModel calculent pour l'ensemble du document ou pour les plages sélectionnées.

TypeScript
const doc = univerAPI.getActiveDocument()if (!doc) throw new Error('No active document')const statistics = await doc.getDocumentDataModel().getStatistics({  locale: univerAPI.Enum.LocaleType.FR_FR,})console.log(statistics.words, statistics.charactersWithSpaces, statistics.paragraphs)

getStatistics() renvoie le nombre de mots, de caractères et de paragraphes. Passez ranges pour compter uniquement le texte sélectionné, ou passez un AbortSignal dans signal afin d'annuler les calculs qui ne sont plus nécessaires.

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.