box-plot-metric

This applies to: Visual Data Discovery

The box-plot-metric 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

box-plot-metric

Editor

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

Variable Specific Properties

Property Argument Description
defaultValue object Allows you to set the default configuration for the specified field.
  func string Set to percentiles. This is the only value supported.
  args array of integers

A list of the percentiles to calculated. Supported values:

  • 0
  • 25
  • 50
  • 75
  • 100

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": "Box Plot Metric",
	"type": "box-plot-metric",
	"attributeType": [
		"INTEGER",
		"NUMBER"
	],
	"defaultValue": {
		"func": "percentiles",
		"args": [
			0,
			25,
			50,
			75,
			100
		]
	},
	"colorNumb": 0,
	"required": false
}

See Visual Type Configuration Properties.