[Back to Parameters]
Checkbox
A widget used to represent a yes/no choice. Saved as a boolean value.
Specification
| key |
type |
required |
default value |
description |
| checkedValue |
string |
no |
'YES' |
The value to be sent to the backend when the checkbox is checked. |
| uncheckedValue |
string |
no |
'NO' |
The value to be sent to the backend when the checkbox is unchecked. |
deprecated
| key |
type |
required |
default value |
description |
| textAlignRight |
boolean |
no |
false |
If true display label on RHS. |
Example
{
"name": "somecheckbox",
"type": "checkbox",
"valueType": "bool",
"prompt": "Aggregate geometries",
"checkedValue": "YES",
"uncheckedValue": "NO",
"defaultValue": "NO"
}