Appearance
zeropdf / PdfStructureOptions
Interface: PdfStructureOptions
Defined in: src/types.ts:315
Accessibility metadata and attributes for tagged PDF structure elements.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
actualText? | string | Replacement text exposed to assistive technology. | src/types.ts:319 |
altText? | string | Alternate text for tagged non-text content. | src/types.ts:317 |
artifactType? | "Pagination" | "Layout" | "Page" | Artifact type classification for tagged PDF content. "Pagination" for headers/footers, "Layout" for typographic ornaments, "Page" for watermarks. Emitted as /Type in the /Artifact BMC/EMC pair. | src/types.ts:338 |
associatedFiles? | object[] | Associated files embedded in the structure element. Each file is emitted as an EmbeddedFile stream and Filespec, and referenced from the StructElem /AF array. | src/types.ts:344 |
attributes? | Record<string, PdfStructureAttributeValue> | Structure attributes to emit for the tagged element. | src/types.ts:325 |
boundingBox? | PdfBoundingBox | Bounding box associated with the structure element. | src/types.ts:323 |
expansion? | string | Abbreviation or acronym expansion for the structure element (/E). Used by screen readers (PDF/UA accessibility attribute). | src/types.ts:356 |
language? | string | BCP 47 language tag for document or structure content. | src/types.ts:321 |
mathML? | string | MathML markup for a Formula structure element. Emitted as an associated file (Subtype application/mathml+xml, AFRelationship=Supplement) and referenced from the StructElem /AF array. Required by PDF/UA Mathematics for accessible mathematical content. | src/types.ts:332 |
phoneme? | string | Pronunciation guide for the structure element (/Phoneme). Used by screen readers (PDF/UA accessibility attribute). | src/types.ts:351 |