Skip to content

modern-pdf-lib


modern-pdf-lib / StructureElementOptions

Interface: StructureElementOptions

Defined in: src/accessibility/structureTree.ts:77

Optional attributes for a structure element.

Properties

actualText?

optional actualText: string

Defined in: src/accessibility/structureTree.ts:83

Replacement text that may be used instead of the element's content.


altText?

optional altText: string

Defined in: src/accessibility/structureTree.ts:81

Alternative text for the element (required for images by PDF/UA).


id?

optional id: string

Defined in: src/accessibility/structureTree.ts:87

An optional unique identifier for the element.


language?

optional language: string

Defined in: src/accessibility/structureTree.ts:85

The natural language for this element (BCP 47, e.g. "en-US").


title?

optional title: string

Defined in: src/accessibility/structureTree.ts:79

The element title (a human-readable label).

Released under the MIT License.