Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Syntax

BA_createRadioGroup(label, options, defaultValue, isDisabled[, isRequired, fieldDescription])

Description

Excerpt

Creates a radio group.

Parameters

Parameter name

Type

Required

Description

label

string

Yes

Field label

optionsstring []YesThe list of selectable options.

defaultValue

string

Yes

A default value (one of the provided options) or an empty string

isDisabledbooleanYesSpecifies whether the field is read-only or not
isRequiredbooleanNoSpecifies whether the field should be marked as required with a dark red asterisk. Note that marking the field as required does not add any validation.
fieldDescriptionstringNoA description of the field to be displayed under the input box.

Return type

string []

Examples

Code Block
BA_createRadioGroup("radio 1", {"option 1", "option 2"}, "option 2", true, false, "select some options");
BA_createRadioGroup("radio 2", {"option 1", "option 2"}, "", false, true, "select some options");

Image Added