[Back to Parameters]
Checkbox
A widget used to represent a boolean choice. Saved as a YES or NO value.
| Key |
Type |
Required |
Default |
Description |
UPM/TD |
checkedValue |
str |
 |
"YES" |
The parameter value when the checkbox is checked. |
 |
uncheckedValue |
str |
 |
"NO" |
The parameter value when the checkbox is unchecked. |
 |
Deprecated
| Key |
Type |
Required |
Default |
Description |
UPM/TD |
textAlignRight |
bool |
 |
false |
If true display label on RHS. |
 |
Example
{
"name": "somecheckbox",
"type": "checkbox",
"valueType": "string",
"prompt": "Aggregate geometries",
"checkedValue": "YES",
"uncheckedValue": "NO",
"defaultValue": "NO"
}