Versions Compared

Key

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

Syntax:

 BA_createCheckboxGroup(label, options, defaultValues, isDisabled)

Since version 2.0.8 and 2.6.1:

 BA_createCheckboxGroup(label, options, defaultValues, isDisabled[, isRequired, fieldDescription])

Description:

Excerpt

Creates a checkbox group.

Parameters:

Parameter name

Type

Required

Description

label

string

Yes

The label of the field

optionsstring []YesThe list of selectable options.

defaultValue

string []

Yes

A sub-list of the options provided or an empty array

isDisabledbooleanYesSpecifies whether the field is read-only or not
isRequiredbooleanNoSpecifies if the field is 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 immediately under the input box.

Return type:

string []

Examples:

...