Appearance
a11ydocs / PdfDocumentJson
Interface: PdfDocumentJson
Defined in: src/document-json.ts:121
A complete, JSON-serializable description of a PDF document. Pass it to renderDocumentJson to produce PDF bytes.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
autoOutline? | readonly | boolean | TemplateAutoOutlineOptions | Auto-generate a bookmarks tree from headings. | src/document-json.ts:153 |
blocks | readonly | readonly JsonBlock[] | Body blocks. Required and non-empty. A block flows by default, or is placed at absolute coordinates when it carries an x/x1/cx anchor (see JsonPositionedBlock). | src/document-json.ts:165 |
compress? | readonly | boolean | Compress content streams. Defaults to the engine default. | src/document-json.ts:135 |
conformance? | readonly | DocumentConformanceProfile | Validate and emit a PDF/A or PDF/UA conformance profile. | src/document-json.ts:133 |
defaultFont? | readonly | string | Name of a declared font (or built-in font) used as the document default. | src/document-json.ts:143 |
defaultPageSize? | readonly | PageSize | Default page size for pages that do not specify one. | src/document-json.ts:139 |
defaults? | readonly | TextDefaults | Document-wide text defaults. | src/document-json.ts:145 |
encryption? | readonly | DocumentEncryptionOptions | Password-encrypt the output. | src/document-json.ts:137 |
fonts? | readonly | readonly JsonFontDeclaration[] | Fonts to load and register before rendering. | src/document-json.ts:141 |
footer? | readonly | readonly JsonBlock[] | Blocks rendered at the bottom of every page (page tokens interpolated). | src/document-json.ts:159 |
header? | readonly | readonly JsonBlock[] | Blocks rendered at the top of every page (page tokens interpolated). | src/document-json.ts:157 |
info? | readonly | DocumentInfo | Information dictionary values. | src/document-json.ts:125 |
language? | readonly | string | BCP 47 language tag for the document. | src/document-json.ts:129 |
page? | readonly | TemplatePageOptions | Page geometry and margins. | src/document-json.ts:147 |
pageNumber? | readonly | TemplatePageNumberOptions | Automatic page numbering. | src/document-json.ts:151 |
strictLayout? | readonly | | boolean | TemplateStrictLayoutOptions | Strict layout checks for fixed templates. | src/document-json.ts:155 |
styles? | readonly | TemplateStylesheet | Reusable named styles. | src/document-json.ts:149 |
tagged? | readonly | boolean | Emit a tagged (accessible) structure tree. | src/document-json.ts:131 |
title? | readonly | string | Document title (information dictionary, XMP, and display-title preference). | src/document-json.ts:123 |
xmpMetadata? | readonly | XmpMetadataInput | XMP metadata packet or structured input. | src/document-json.ts:127 |