# IPdfUnitData

> Language fallback: requested `zh-CN`; content is `en-US`.

- Human documentation: [https://docs.univer.ai/zh-CN/reference/types/pdf-unit-data](https://docs.univer.ai/zh-CN/reference/types/pdf-unit-data)

- Agent Markdown: [https://docs.univer.ai/zh-CN/reference/types/pdf-unit-data.md](https://docs.univer.ai/zh-CN/reference/types/pdf-unit-data.md)

- Requested language: `zh-CN`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

The data for a PDF unit. Use the [PDF Facade](https://docs.univer.ai/zh-CN/reference/facade/pdf.md) for document content and editing operations.

## Import

```ts
import type { IPdfUnitData } from '@univerjs-pro/pdfs'
```

## Definition

```ts
interface IPdfUnitData {
  schema: typeof PDF_UNIT_SCHEMA
  schemaVersion: typeof PDF_UNIT_SCHEMA_VERSION

  id: string

  rev: number
  name: string
  sourceDocumentRef: IPdfSourceDocumentRef

  document: IPdfDocument

  documentShell?: IPdfDocumentShell

  editState: IPdfDurableEditState
  resourceBindings?: Record<PdfAssetId, PdfDurableResourceBinding>

  fragmentBindings?: Record<string, IPdfFragmentArtifactBinding>
  capabilityReport?: IPdfCapabilityReport
  fragmentIndex?: IPdfUnitFragmentIndex
  metadata?: Record<string, PdfJsonValue>
}
```

## Fields

### `schema`

Required · `"univer-pdf-unit"`

### `schemaVersion`

Required · `1`

### `id`

Required · `string`

Canonical identity shared by collaboration, storage, resources, and export.

### `rev`

Required · `number`

Authoritative Unit revision. Revision numbering starts at one.

### `name`

Required · `string`

### `sourceDocumentRef`

Required · `IPdfSourceDocumentRef`

### `document`

Required · `IPdfDocument`

Immutable imported baseline whose id is normalized to the Unit id.

### `documentShell`

Optional · `IPdfDocumentShell | undefined`

Persisted page directory and immutable fragment indexes for block-backed Units.

### `editState`

Required · `IPdfDurableEditState`

Sole durable location for accepted frontend editing intent.

### `resourceBindings`

Optional · `Record<string, PdfDurableResourceBinding> | undefined`

### `fragmentBindings`

Optional · `Record<string, IPdfFragmentArtifactBinding> | undefined`

Runtime file bindings supplied by the snapshot protocol, excluded from originalMeta.

### `capabilityReport`

Optional · `IPdfCapabilityReport | undefined`

### `fragmentIndex`

Optional · `IPdfUnitFragmentIndex | undefined`

### `metadata`

Optional · `Record<string, PdfJsonValue> | undefined`

## Related types

* [`IPdfSourceDocumentRef`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/unit/types.d.ts)
* [`IPdfDocument`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/types.d.ts)
* [`IPdfDocumentShell`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/unit/types.d.ts)
* [`IPdfDurableEditState`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/editor/types.d.ts)
* [`PdfAssetId`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/types.d.ts)
* [`PdfDurableResourceBinding`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/unit/types.d.ts)
* [`Record`](https://unpkg.com/@typescript/typescript-darwin-arm64@7.0.2/lib/lib.es5.d.ts)
* [`IPdfFragmentArtifactBinding`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/unit/types.d.ts)
* [`IPdfCapabilityReport`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/unit/types.d.ts)
* [`IPdfUnitFragmentIndex`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/unit/types.d.ts)
* [`PdfJsonValue`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/types.d.ts)

**Package:** [`@univerjs-pro/pdfs`](https://docs.univer.ai/zh-CN/reference/packages/plugins/univerjs-pro/pdfs.md) · [Type definitions](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/unit/types.d.ts)