bool
This applies to: Visual Data Discovery
The bool variable is part of the array of objects you use to define data and non-data values for this visualization.
You must be an administrator to manage custom visual types.
Type
bool
Editor
bool variables are represented in the side panel as a simple switch.
Variable Specific Properties
| Property | Argument | Description |
|---|---|---|
| None. |
Generic Properties
| Property | Argument | Description |
|---|---|---|
name
|
string | The name of the property. It must be unique among all variables on the visualization. This name is used to access the data accessor and/or variable value on the controller provided to the visualization. |
descr
|
string | A description of the variable for your reference. This is not displayed in the UI. |
attributeType
|
array of strings |
A list of field types to include when selecting fields for this variable. Accepted values:
|
required
|
boolean | Triggers the UI to require a value for certain variable types. Not used for this variable type. |
Deprecated Properties
| Property |
|---|
| None. |
Samples
{
"name": "Show Metric Values",
"type": "bool",
"defaultValue": true,
"colorMetric": false,
"colorNumb": 0,
"required": false
}