ungrouped
This applies to: Visual Data Discovery
The ungrouped 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
ungrouped
Editor
ungrouped variables are represented by a series of buttons to allow users to select a set number of fields matched up with labels. Below the field buttons is a number input to choose a limit to the number of records that should be returned. By default, the labels provided are used to attempt to select the correct fields. If no fields match the labels, the first n fields are selected.
Variable Specific Properties
| Property | Argument | Description | |
|---|---|---|---|
config
|
object | All properties are required. | |
groupLevel
|
integer | The number of fields to be selected. | |
groupNames
|
array of strings | A list of labels for the fields. The length of this array should match the value set for groupLevel. |
|
limit
|
integer | The number of ungrouped records to return. | |
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": "Latitude/Longitude",
"type": "ungrouped",
"descr": "Latitude and Longitude fields",
"config": {
"groupLevel": 2,
"groupNames": [
"Latitude",
"Longitude"
],
"limit": 100000
},
"required": false
}