Structure du corps du document
IDocumentBody
IDocumentBody stocke le contenu du flux principal d’un document Univer Docs.
Le texte lui-même est stocké dans dataStream. Les styles et la structure sont stockés dans des tableaux parallèles, et chaque entrée est liée au texte par index.
Propriétés
| Propriété | Type | Description |
|---|---|---|
| dataStream | string | Le corps du document en texte simple. Les caractères spéciaux marquent les paragraphes, les casses de section, les tableaux et les blocs personnalisés. |
| textRuns? | ITextRun[] | Plages de style en ligne. |
| paragraphs? | IParagraph[] | Métadonnées et styles des paragraphes. |
| sectionBreaks? | ISectionBreak[] | Métadonnées des sauts de section. |
| customBlocks? | ICustomBlock[] | Espaces réservés pour les blocs définis par les plugins. |
| tables? | ICustomTable[] | Les définitions de tableau sont stockées dans IDocumentData.tableSource. |
| columnGroups? | ICustomColumnGroup[] | Marqueurs de groupes de colonnes. |
| blockRanges? | IDocumentBlockRange[] | Plages de blocs structurés, comme les encadrés, les citations et les blocs de code. |
| customRanges? | ICustomRange[] | Plages spéciales, comme les liens hypertextes, les champs, les signets, les commentaires, les mentions et les plages définies par les plugins. |
| customDecorations? | ICustomDecoration[] | Plages de décoration, comme la mise en évidence des commentaires. |
| payloads? | Record<string, string> | Charges utiles temporaires pour le copier-coller. Ce champ n’est pas conservé. |
dataStream
dataStream est la source faisant autorité du texte du corps. Un paragraphe se termine généralement par \r\n.
const body: IDocumentBody = { dataStream: 'Title\r\nHello Univer\r\n', paragraphs: [ { startIndex: 5, paragraphId: 'p-title' }, { startIndex: 19, paragraphId: 'p-body' }, ],}Caractères spéciaux
Certains éléments sont stockés comme caractères de contrôle dans dataStream et élargis par le rendeur :
| Caractère | Signification |
|---|---|
\r\n | Saut de paragraphe |
\n | Saut de section |
\f | Saut de page |
\v | Saut de colonne |
\t | Tabulation |
\0 | Fin du document |
\b | Espace réservé pour un bloc personnalisé |
Les tables et les plages personnalisées utilisent également des caractères de contrôle en interne. Lorsque vous travaillez avec des tables, des liens, des commentaires ou des fonctionnalités de niveau bloc, utilisez des API ou des commandes Facade au lieu d'écrire des caractères de commande à la main.
Relation avec IDocumentData
IDocumentBody couvre uniquement le flux principal du document. Toutes les autres ressources sont stockées sur IDocumentData:
tableSourcestocke les définitions des tableaux.drawingsstocke les images et les objets de dessin.headersetfooterscontiennent chacun leur propreIDocumentBody.listsstocke les définitions de listes auxquelles font référence les puces des paragraphes.resourcesstocke les données définies par les plugins.
Que pensez-vous de ce guide ?