Appearance
a11ydocs / FlowRadioGroupOptions
Interface: FlowRadioGroupOptions
Defined in: src/types.ts:1279
Options for placing a radio-button group through the flow layout API.
Extends
Omit<RadioGroupOptions,"items">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
actions? | FieldActions | JavaScript actions attached to this field's /AA dictionary. Each action value is raw PDF JavaScript source code. | RadioGroupOptions.actions | 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. | RadioGroupOptions.appearance | src/types.ts:2792 |
borderWidth? | number | Annotation or field border width in PDF points. | RadioGroupOptions.borderWidth | 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. | RadioGroupOptions.description | 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). | RadioGroupOptions.encrypt | src/types.ts:2786 |
items | RadioGroupItemOptions[] | Radio-button items in the group with their own positions. | - | src/types.ts:1281 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin | src/types.ts:1137 |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom | src/types.ts:1143 |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft | src/types.ts:1145 |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight | src/types.ts:1141 |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop | src/types.ts:1139 |
readOnly? | boolean | Whether the form field is read-only. | RadioGroupOptions.readOnly | src/types.ts:2778 |
required? | boolean | Whether the form field is required. | RadioGroupOptions.required | src/types.ts:2780 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | RadioGroupOptions.structure | src/types.ts:2801 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | RadioGroupOptions.tag | src/types.ts:2799 |
value? | string | Current or default value for the option. | RadioGroupOptions.value | src/types.ts:2774 |