Appearance
a11ydocs / RadioGroupOptions
Interface: RadioGroupOptions
Defined in: src/types.ts:2764
Options for creating a radio-button group 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:2797 |
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. | src/types.ts:2792 |
borderWidth? | number | Annotation or field border width in PDF points. | src/types.ts:2776 |
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:2770 |
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:2786 |
items | RadioGroupItemOptions[] | Radio-button items in the group. | src/types.ts:2772 |
readOnly? | boolean | Whether the form field is read-only. | src/types.ts:2778 |
required? | boolean | Whether the form field is required. | src/types.ts:2780 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | src/types.ts:2801 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | src/types.ts:2799 |
value? | string | Current or default value for the option. | src/types.ts:2774 |