attribute
This applies to: Visual Data Discovery
The attribute 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
attribute
Editor
attribute variables are represented in the side panel as a button that users use to select a field. This variable’s selected field is not used as part of the data request by default, but the name is provided for other uses or for manual configuration within the visualization’s code.
Variable Specific Properties
| Property | Argument | Decsription |
|---|---|---|
| None. |
Generic Properties
Generic properties apply to many variables.
| 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": "State",
"type": "attribute",
"descr": "A field which represents a US State",
"attributeType": [
"ATTRIBUTE"
],
"required": false
}