Controls

There are three different categories of controls:

Layout controls are used to control the layout child controls in the UI. Option controls allow the user to change the values of options for analyses. We’ve already seen some of these; the CheckBox, the ComboBox, etc. Display controls are for presenting static information such as labels.

Option Controls

As already seen earlier in this tutorial series, different option controls are ‘bound’ to different analysis options. The name of the option control typically needs to match the name of the option it is bound to. Changing the option control leads to changes to the underlying option, resulting in changes to the analysis.

Not all controls can be bound to any option. It wouldn’t be meaningful to bind a checkbox to a List option for example. The following lists the different option types, and the control types that can be bound to each:

Bool

You can use : CheckBox

- type: CheckBox
  name: #optionName

Or you can use : Label

This control is read only.

- type: Label
  name: #optionName
  format: bool

Integer

You can use : TextBox

Allows for the value to be edited.

- type: TextBox
  name: #optionName
  format: number

Or you can use : Label

This control is read only.

- type: Label
  name: #optionName
  format: number

Number

You can use : TextBox

Allows for the value to be edited.

- type: TextBox
  name: #optionName
  format: number

Or you can use : Label

This control is read only.

- type: Label
  name: #optionName
  format: number

String

You can use : TextBox

Allows for the value to be edited.

- type: TextBox
  name: #optionName

Or you can use : Label

This control is read only.

- type: Label
  name: #optionName

List

You can use : ComboBox

- type: ComboBox
  name: #optionName

Or you can use : RadioButton

Use multiple RadioButton’s linked to the different sub-options.

- type: RadioButton
  name: #uniqueName_1
  optionName: #optionName
  optionPart: #optionPartName_1

- type: RadioButton
  name: #uniqueName_2
  optionName: #optionName
  optionPart: #optionPartName_2



- type: RadioButton
  name: #uniqueName_N
  optionName: #optionName
  optionPart: #optionPartName_N

NMXList

You can use : CheckBox

Use multiple CheckBox’s linked to the different sub-options.

- type: CheckBox
  name: #uniqueName_1
  optionName: #optionName
  optionPart: #optionPartName_1

- type: CheckBox
  name: #uniqueName_2
  optionName: #optionName
  optionPart: #optionPartName_2



- type: CheckBox
  name: #uniqueName_N
  optionName: #optionName
  optionPart: #optionPartName_N

Variable

You can use : VariablesListBox

- type: VariableListBox
  name: #optionName
  isTarget: true
  maxItemCount: 1

Or you can use : ListBox

- type: ListBox
  name: #optionName
  isTarget: true
  maxItemCount: 1
  template:
    type: VariableLabel

Variables

You can use : VariablesListBox

- type: VariableListBox
  isTarget: true
  name: #optionName

Or you can use : ListBox

- type: ListBox
  name: #optionName
  isTarget: true
  template:
    type: VariableLabel

Terms

You can use : ListBox

- type: ListBox
  name: #optionName
  isTarget: true
  template:
    type: TermLabel

Pairs

You can use : VariablesListBox

  - type: VariablesListBox
    name: #optionName
    isTarget: true
    columns:
      - name: i1
        template:
          type: VariableLabel
      - name: i2
        template:
          type: VariableLabel

Or you can use : ListBox

  - type: ListBox
    name: #optionName
    isTarget: true
    columns:
      - name: i1
        template:
          type: VariableLabel
      - name: i2
        template:
          type: VariableLabel

Array

You can use : ListBox

- type: ListBox
  name: #optionName
  template:
    type: #depends on the option

This is jamovi’s most complicated control. The setup of it’s UI definition depends heavily on the way the option is setup. A more detailed explanation can be found here.

Next: Advanced customisation of the options UI