ungroupedList

This applies to: Visual Data Discovery

The ungroupedListvariable 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

ungroupedList

Editor

ungroupedList variables are represented by two styles of control depending on the presence or absence of the groupLevel and groupNames properties in the config.

If no groupLevel and groupNames properties are defined, the control provides only an arrangeable list of fields with an edit button which allows selecting or deselecting which fields should be included.

custom chart settings sidebar ungrouped list

If groupLevel and groupNames are defined in the config, the variable is represented by a combination of the UI from the ungroupedvariable and the UI shown above. This allows you to supply a set number of fields as named properties as well as an undefined number of additional fields for other purposes. When selecting the field for any named properties or for the additional fields list, the fields selected for other uses will not be selectable.

custom chart settings example

Variable Specific Properties

Property		Argument	Description
`config`		object	All properties are optional but `groupLevel` and `groupNames` should be provided together if they are provided.
	`groupLevel`	integer	The number of fields to select.
	`groupNames`	array of strings	A list of labels for the fields. The length of this array should match the value provided as `groupLevel`.
	`limit`	integer	The number of ungrouped records that should be returned.
	`additionalFieldsLabel`	string	The label that will be shown above the field list if `groupLevel` and `groupNames` are provided.

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: `ATTRIBUTE` `TIME` `NUMBER` `INTEGER`
`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": "Test Ungrouped List",
	"type": "ungroupedList",
	"descr": "Select multiple fields for ungrouped data",
	"attributeType": [
		"ATTRIBUTE",
		"INTEGER",
		"NUMBER"
	],
	"config": {
		"groupLevel": 2,
		"groupNames": [
			"Latitude",
			"Longitude"
		],
		"limit": 100000,
		"additionalFieldsLabel": "Extra Fields"
	}
	"required": false
}

See Visual Type Configuration Properties.