Appearance
zeropdf / SignatureFieldOptions
Interface: SignatureFieldOptions
Defined in: src/types.ts:2805
Options for creating a signature form field.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
actions? | FieldActions | JavaScript actions attached to this field's /AA dictionary. Each action value is raw PDF JavaScript source code. | src/types.ts:2841 |
appearance? | string | Custom appearance stream content for the signature field. Example: "1 0 0 rg 0 0 100 20 re f" | src/types.ts:2836 |
borderWidth? | number | Annotation or field border width in PDF points. | src/types.ts:2821 |
description? | string | Field description, emitted as /TU (the field's user-facing name). Assistive technology reads it as the field's accessible name, and it satisfies the "form fields have a description" accessibility check. | src/types.ts:2811 |
encrypt? | boolean | Whether the field value follows document encryption. When false, the field value is not encrypted (useful for searchable fields). Defaults to true (follow document encryption). | src/types.ts:2831 |
height | number | Height in PDF points. | src/types.ts:2819 |
readOnly? | boolean | Whether the form field is read-only. | src/types.ts:2823 |
required? | boolean | Whether the form field is required. | src/types.ts:2825 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | src/types.ts:2845 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | src/types.ts:2843 |
width | number | Width in PDF points. | src/types.ts:2817 |
x | number | Horizontal position in PDF points. | src/types.ts:2813 |
y | number | Vertical position in PDF points. | src/types.ts:2815 |