IDocumentData

A document snapshot containing its body, styles, page settings, and resources. Use FDocument to edit a live document and preserve its structure.

Import

import type { IDocumentData } from '@univerjs/core'

Definition

interface IDocumentData extends IReferenceSource {  id: string  rev?: number  locale?: LocaleType  title?: string  body?: IDocumentBody  notes?: Record<string, IDocumentNote>  noteSettings?: INoteSettings  documentStyle: IDocumentStyle  styles?: IDocStyles  settings?: IDocumentSettings  resources?: IResources  disabled?: boolean}

Fields

id

Required · string

unit ID

rev

Optional · number | undefined

Revision of this document. Would be used in collaborated editing. Starts with zero.

locale

Optional · LocaleType | undefined

title

Optional · string | undefined

body

Optional · IDocumentBody | undefined

notes

Optional · Record<string, IDocumentNote> | undefined

Independent rich-text segments addressed by footnote or endnote references in the main body.

noteSettings

Optional · INoteSettings | undefined

documentStyle

Required · IDocumentStyle

styles

Optional · IDocStyles | undefined

OOXML-compatible named document styles keyed by stable style id.

settings

Optional · IDocumentSettings | undefined

resources

Optional · IResources | undefined

disabled

Optional · boolean | undefined

tableSource

Optional · ITables | undefined

footers

Optional · IFooters | undefined

headers

Optional · IHeaders | undefined

footnotes

Optional · Record<string, IDocxNoteStory> | undefined

endnotes

Optional · Record<string, IDocxNoteStory> | undefined

lists

Optional · ILists | undefined

drawings

Optional · IDrawings | undefined

drawingsOrder

Optional · string[] | undefined

headerFooterDrawingsOrder

Optional · string[] | undefined

Related types

• IReferenceSource
• LocaleType
• IDocumentBody
• IDocumentNote
• Record
• INoteSettings
• IDocumentStyle
• IDocStyles
• IDocumentSettings
• IResources

Package: @univerjs/core · Type definitions