Interface: RadioGroupOptions

Options for creating a radio-button group 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 | { down?: string; normal?: string; rollover?: string; }	Custom appearance stream for the radio group. Can be a raw PDF content stream string, or an object with optional normal (/N), down (/D), and rollover (/R) appearance strings.
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).
items	RadioGroupItemOptions[]	Radio-button items in the group.
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.
value?	string	Current or default value for the option.