API Reference

IPdfUnitData

The data for a PDF unit. Use the PDF Facade for document content and editing operations.

Import

TypeScript

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

Definition

TypeScript

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

Package: @univerjs-pro/pdfs · Type definitions

How is this guide?