Skip to main content

Interface: FlowRadioGroupOptions

Options for placing a radio-button group through the flow layout API.

Extends

Properties

PropertyTypeDescriptionInherited from
actions?FieldActionsJavaScript actions attached to this field's /AA dictionary. Each action value is raw PDF JavaScript source code.RadioGroupOptions.actions
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
borderWidth?numberAnnotation or field border width in PDF points.RadioGroupOptions.borderWidth
description?stringField 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
encrypt?booleanWhether 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
itemsRadioGroupItemOptions[]Radio-button items in the group with their own positions.-
margin?FlowMarginShorthandCSS-like margin shorthand in PDF points.FlowBlockSpacingOptions.margin
marginBottom?numberBottom margin in PDF points.FlowBlockSpacingOptions.marginBottom
marginLeft?numberLeft margin in PDF points.FlowBlockSpacingOptions.marginLeft
marginRight?numberRight margin in PDF points.FlowBlockSpacingOptions.marginRight
marginTop?numberTop margin in PDF points.FlowBlockSpacingOptions.marginTop
readOnly?booleanWhether the form field is read-only.RadioGroupOptions.readOnly
required?booleanWhether the form field is required.RadioGroupOptions.required
structure?PdfStructureOptionsAdditional structure metadata for tagged PDF output.RadioGroupOptions.structure
tag?"Annot" | "Artifact"Structure tag used for tagged PDF output.RadioGroupOptions.tag
value?stringCurrent or default value for the option.RadioGroupOptions.value