histogram-group

This applies to: Visual Data Discovery

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

histogram-group

Editor

histogram-group variables are not represented on the settings panel. Enable editing a histogram-group variable by adding an axis label for the variable using the createAxisLabel method on the controller. Other options are not presented to users.

Variable Specific Properties

Property			Argument	Description
config			object	Sets the default values for this variable.
	binType		string	How the system should bin the data.
		auto		Define this property to enable color configuration for this variable.
		count		Try to conform the number of bins to the given value.
		width		Try to conform range number of bins to the given value.
	binsCount		integer	Default number of bins to display when binType is set to count.
	binsCount		number	Default number of bins to display when binType is set to width.
	values		string	absolute suggests to the visual type that the actual sum of the bin should be y-axis values. relative suggests to the visual type that the values should be percentages of the whole sum of all bins.
	cumulative		boolean	If true, the chart should include a representation of the cumulative value as the bins move from left to right. Typically represented as an overlaid line.

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
None.

Samples

{
	"name": "Group By",
	"type": "histogram-group",
	"attributeType": [
		"INTEGER",
		"NUMBER"
	],
	"colorNumb": 0,
	"config": {
		"binsType": "auto",
		"binsCount": 10,
		"binsWidth": 100,
		"values": "absolute",
		"cumulative": false
	},
	"required": false
}

See Visual Type Configuration Properties.