multi-group

This applies to: Visual Data Discovery

The multi-group 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

multi-group

Editor

multi-group variables are not represented on the settings panel. Enable editing a multi-group variable by adding an axis label for the variable using the createAxisLabel method on the controller.

Variable Specific Properties

Property Argument Description
config object  
groupLevel array of integers A label to show for each grouping level. The number of entries in this array should match the value set for groupLevel.
groupNames array of strings The number of grouping levels to allow.
groupTypes array of strings

The set of field types to allow for each grouping level. Each entry should be a space-delimited list of all field types to allow. The number of entries in this array should match the value set for groupLevel. Accepted values:

  • ATTRIBUTE
  • TIME
  • NUMBER
  • INTEGER
  • MONEY
  • NONE
groupTypes string The name of the color palette to use by default. The value_inherit uses the palette from the currently selected theme.
colorGroupIndex integer Define this property to enable color configuration for this variable.
autoShowColorLegend boolean If true, show a legend for this variable by default.

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
colorNumb integer The number of colors to include in the color palette by default. 0 will choose the smallest palette available.
required boolean Triggers the UI to require a value for certain variable types. Not used for this variable type.

Deprecated Properties

Property
colorMetric
groupType

Samples

{
	"name": "Multi Group By",
	"type": "multi-group",
	"descr": "Multiple, layered groups",
	"attributeType": [
		"ATTRIBUTE",
		"TIME"
	],
	"colorNumb": 0,
	"config": {
		"groupLevel": 2,
		"groupNames": [
			"Group 1",
			"Group 2"
		],
		"groupLimits": [
			50,
			20
		],
		"groupTypes": [
			"ATTRIBUTE TIME NUMBER INTEGER MONEY",
			"ATTRIBUTE TIME NUMBER INTEGER MONEY NONE"
		],
		"groupColorSet": "_inherit",
		"colorGroupIndex": 0,
		"autoShowColorLegend": true
	},
	"required": true
}

See Visual Type Configuration Properties.