Appearance
zeropdf / SignatureFieldOptions
Interface: SignatureFieldOptions
Defined in: src/types.ts:2775
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:2805 |
appearance? | string | Custom appearance stream content for the signature field. Example: "1 0 0 rg 0 0 100 20 re f" | src/types.ts:2800 |
borderWidth? | number | Annotation or field border width in PDF points. | src/types.ts:2785 |
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:2795 |
height | number | Height in PDF points. | src/types.ts:2783 |
readOnly? | boolean | Whether the form field is read-only. | src/types.ts:2787 |
required? | boolean | Whether the form field is required. | src/types.ts:2789 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | src/types.ts:2809 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | src/types.ts:2807 |
width | number | Width in PDF points. | src/types.ts:2781 |
x | number | Horizontal position in PDF points. | src/types.ts:2777 |
y | number | Vertical position in PDF points. | src/types.ts:2779 |