# IDocumentData

- Human documentation: [https://docs.univer.ai/reference/types/document-data](https://docs.univer.ai/reference/types/document-data)

- Agent Markdown: [https://docs.univer.ai/reference/types/document-data.md](https://docs.univer.ai/reference/types/document-data.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [types/document-data.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/types/document-data.mdx)

---

A document snapshot containing its body, styles, page settings, and resources. Use [`FDocument`](https://docs.univer.ai/reference/facade/document.md) to edit a live document and preserve its structure.

## Import

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

## Definition

```ts
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`

### `lists`

Optional · `ILists | undefined`

### `drawings`

Optional · `IDrawings | undefined`

### `drawingsOrder`

Optional · `string[] | undefined`

### `headerFooterDrawingsOrder`

Optional · `string[] | undefined`

## Related types

* [`IReferenceSource`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/types/interfaces/i-document-data.d.ts)
* [`LocaleType`](https://docs.univer.ai/reference/enums/locale-type.md)
* [`IDocumentBody`](https://docs.univer.ai/reference/types/document-body.md)
* [`IDocumentNote`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/types/interfaces/i-document-data.d.ts)
* [`Record`](https://unpkg.com/@typescript/typescript-darwin-arm64@7.0.2/lib/lib.es5.d.ts)
* [`INoteSettings`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/types/interfaces/i-document-data.d.ts)
* [`IDocumentStyle`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/types/interfaces/i-document-data.d.ts)
* [`IDocStyles`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/types/interfaces/i-document-data.d.ts)
* [`IDocumentSettings`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/types/interfaces/i-document-data.d.ts)
* [`IResources`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/services/resource-manager/type.d.ts)

**Package:** [`@univerjs/core`](https://docs.univer.ai/reference/packages/plugins/univerjs/core.md) · [Type definitions](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/types/interfaces/i-document-data.d.ts)