group

The group variable is part of the array of objects you use to define data and non-data values for this visualization.

Note: You must be an administrator to manage custom visual types.

Type

group

Editor

group variables are not represented on the settings panel. Enable editing a 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	All properties are optional.
	`groupColorSet`		string	The name of the color palette to use. 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	Define as `true` to show the legend by default.
`defaultValue`			object	Define defaulting sort and limit properties for this variable. All properties are optional.
	`limit`		integer	Limit to the number of groups to return.
	`sort`		object
		`dir`	string	Default sort direction. Valid values are `asc` or `desc`.

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": "Group By",
	"type": "group",
	"descr": "The group property",
	"attributeType": [
		"ATTRIBUTE",
		"TIME",
		"NUMBER",
		"INTEGER"
	],
	"defaultValue": {
		"limit": 20
	},
	"colorNumb": 0,
		"config": {
			"groupColorSet": "_inherit",
			"colorGroupIndex": 0,
			"autoShowColorLegend": true
		},
		"required": true
}

See Visual Type Configuration Properties.

CMP-ZenDesk-v25.4.log-966709946.zip
40 KB Download