Interface: SignatureFieldOptions

Options for creating a signature form field.

Properties

Property	Type	Description
actions?	FieldActions	JavaScript actions attached to this field's /AA dictionary. Each action value is raw PDF JavaScript source code.
appearance?	string	Custom appearance stream content for the signature field. Example: "1 0 0 rg 0 0 100 20 re f"
borderWidth?	number	Annotation or field border width in PDF points.
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.
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).
height	number	Height in PDF points.
readOnly?	boolean	Whether the form field is read-only.
required?	boolean	Whether the form field is required.
structure?	PdfStructureOptions	Additional structure metadata for tagged PDF output.
tag?	"Annot" | "Artifact"	Structure tag used for tagged PDF output.
width	number	Width in PDF points.
x	number	Horizontal position in PDF points.
y	number	Vertical position in PDF points.