Visual Type Configuration Properties

This section describes the properties of visualization type configurations, possible values, and the definition of those values for creating or editing visual types (custom charts) for Self-Service Analytics.

You must be an administrator to manage custom visual types.

Properties

name - string name is the name of visual type the configuration file represents, and displays in the user interface. This name must be unique in your Self-Service Analytics instance, or it will overwrite or be overwritten by a visual type using the same name. type - string type is one of the properties Self-Service Analytics uses internally to represent and distinguish visual types. Built-in visuals have unique type properties. Any visual you add to the system should use the same value, CUSTOM. controls - array of strings controls is the list of things you enable this visual type to do. Supported values are included in the chart below:

Control	Description
UberStyle	Allows an instance of this visual type to use the Style Switcher to switch to other visual types.
Color	Allows an instance of this visual type to show the Color panel within the sidebar or pop-up editor.
Download	Allows instances of this visual type to be downloaded as an image, PDF, or configuration files.
Filters	Allows this visual type to be filtered using the filter editor in the sidebar or pop-up editor.
Publish	Enables this visualization for publication. If this control is not present, the “Filter” option is shown in a context menu.
Settings	Enables the settings panel in the sidebar or pop-up editor. Use the settings panel to edit the variables added to the visualization.
Sort	Enables the Sort & Limit panel in the sidebar or pop-up editor. This panel is used to sort and limit the data returned. Only certain variable types support sort and limit.
Subscribe	Allows the visual type to be the target of filters added from external sources and other visuals on the dashboard.
TimePlayer	Enables the Time panel in the sidebar or pop-up editor. This allows changing the field used for the time bar or turning off the time bar for each instance of the visual.
Undo	Allows users to undo changes they make to instances of this visualization.

Additional properties may be present in a visualization’s controls array but they may deprecated, irrelevant to a custom visual type that does not use the properties.

variables - array of objects variables are required for the configuration. This array of objects define data and non-data values associated with instances of this visualization. All supported variable configuration are included in the list below.

attribute
bool
box-plot-metric
color
float
group
histogram-group
integer
metric
multi-group
multilist
multi-metric
singlelist
string
text
ungrouped
ungroupedList

You can also maintain custom charts using the CLI. See Maintain Custom Charts Using the Custom Chart CLI.

attribute

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

attribute

Editor

attribute variables are represented in the side panel as a button that users use to select a field. This variable’s selected field is not used as part of the data request by default, but the name is provided for other uses or for manual configuration within the visualization’s code.

Variable Specific Properties

Property	Argument	Description
None.

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": "State",
	"type": "attribute",
	"descr": "A field which represents a US State",
	"attributeType": [
		"ATTRIBUTE"
	],
	"required": false
}

See Visual Type Configuration Properties.

bool

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

bool

Editor

bool variables are represented in the side panel as a simple switch.

Variable Specific Properties

Property	Argument	Description
None.

Generic Properties

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": "Show Metric Values",
	"type": "bool",
	"defaultValue": true,
	"colorMetric": false,
	"colorNumb": 0,
	"required": false
}

See Visual Type Configuration Properties.

box-plot-metric

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.

color

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

color

Editor

Edit color variables using the color panel. The visual type must include the control color in order to modify these variables.

Variable Specific Properties

Property	Argument	Description
`defaultValue`	string	A color in any CSS color format. The value`_inherit` uses the color from the currently selected theme.

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": "Label Color",
	"type": "color",
	"descr": "A color for the label",
	"defaultValue": "_inherit",
	"required": false
}

See Visual Type Configuration Properties.

float

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

float

Editor

Edit float variables using a standard browser number input. If minimum, maximum, or both values are specified in the config, a helper message shows below the input to notify the user of these ranges.

Variable Specific Properties

Property		Argument	Description
`defaultValue`		float
`config`		object	All properties are optional.
	`min`	float	The minimum value allowed for this variable. Inclusive.
	`max`	float	The maximum value allowed for this variable. Inclusive.

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": "Float Option",
	"type": "float",
	"descr": "A float value",
	"defaultValue": 1.5,
	"config": {
		"min": 1,
		"max": 22.3
		},
		"required": false
}

See Visual Type Configuration Properties.

group

The 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

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.

histogram-group

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.

integer

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

integer

Editor

Edit integer variables using a standard browser number input. If minimum, maximum, or both values are specified in the config, a helper message shows below the input to notify the user of these ranges.

Variable Specific Properties

Property		Argument	Description
`defaultValue`		integer
`config`		object	All properties are optional.
	`min`	integer	The minimum value allowed for this variable. Inclusive.
	`max`	integer	The maximum value allowed for this variable. Inclusive.

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": "Integer Option",
	"type": "integer",
	"descr": "An integer value",
	"defaultValue": 1,
	"config": {
		"min": 1,
		"max": 22
	},
	"required": false
}

See Visual Type Configuration Properties.

metric

The 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

metric

Editor

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

Variable Specific Properties

Property			Argument	Description
`colorSet`			string	The name of the color palette to use by default. The value`_inherit` uses the palette from the currently selected theme. Other available values include `DefaultSequential` and `DefaultQualitative`.
`metricType`			string	Set to `color` to enable this metric as the color metric. Only set this to one metric on the visualization.
`legendType`			string	Available values include `palette` and `range`.
`config`			object	All properties are optional.
	`displayNoneOption`		boolean	When set to `true`, users can select `None` when choosing a field for this variable.
`defaultValue`			array of object	Enable to allow setting of a default configuration for the chosen field.
	`name`		string	A value of `none` combined with `config.displayNoneOption` set to `true` will default the selected field to `None`. A value of `count` will automatically select the `Volume`metric.
	`colorConfig`		object
		`autoShowColorLegend`	boolean	If `true`, show a legend for this variable by default.
		`colorNumb`	integer	The number of colors to include in the color palette by default. 0 will choose the smallest palette available.
		`legendType`	string	Available values include `palette` and `range`.
		`colorScaleType`	string	Available values include `gradient` and `distinct`.

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": "Bar Color", "type": "metric", "attributeType": [ "INTEGER", "NUMBER" ], "defaultValue": [ { "name": "count", "colorConfig": { "colorNumb": 3, "legendType": "palette", "autoShowColorLegend": true } } ], "config": { "displayNoneOption": true }, "colorNumb": 3, "colorSet": "_inherit", "metricType": "color", "legendType": "palette", "required": false }

See Visual Type Configuration Properties.

multi-group

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.

multi-metric

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

multi-metric

Editor

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

Variable Specific Properties

Property			Argument	Description
`colorSet`			string	The name of the color palette to use by default. The value`_inherit` uses the palette from the currently selected theme. Other available values include `DefaultSequential` and `DefaultQualitative`.
`metricType`			string	Set to `color` to enable this metric as the color metric. Only set this to one metric on the visualization.
`legendType`			string	Available values include `palette` and `range`.
`defaultValue`			array of object	Enable to allow setting of a default configuration for the chosen field.
	`name`		string	A value of `none` combined with `config.displayNoneOption` set to `true` will default the selected field to `None`. A value of `count` will automatically select the `Volume`metric.
	`colorConfig`		object
		`autoShowColorLegend`	boolean	If `true`, show a legend for this variable by default.
		`colorNumb`	integer	The number of colors to include in the color palette by default. 0 will choose the smallest palette available.
		`legendType`	string	Available values include `palette` and `range`.
		`colorScaleType`	string	Available values include `gradient` and `distinct`.

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`

Samples

{ "name": "Y1 Axis", "type": "multi-metric", "attributeType": [ "INTEGER", "NUMBER" ], "defaultValue": [ { "colorConfig": { "autoShowColorLegend": true } } ], "colorNumb": 4, "metricType": "color", "colorSet": "_inherit", "legendType": "palette", "required": false }

See Visual Type Configuration Properties.

multilist

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

multilist

Editor

multilist have two modes:

If the values property is provided, the variable is represented by a multi-select tag input.
If values is not provided, the variable is represented by a control that provides an arrangeable list of fields that includes an edit button. Users can select which fields should and should not be included.

Variable Specific Properties

Property	Argument	Description
`defaultValue`	array of strings	Only applicable for the static value list.
`values`	array of strings	The options made available to users for selection.

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

Static Values

{ "name": "Test Static Value Multilist", "type": "multilist", "descr": "Select multiple values. Order is not selectable", "values": [ "Value 1", "Value 2", "Value 3", "Value 4" ], "defaultValue": [ "Value 2", "Value 3" ], "required": false }

Field Selection

{ "name": "Test Field Multilist", "type": "multilist", "descr": "Select and arrange multiple fields", "attributeType": [ "ATTRIBUTE", "TIME", "NUMBER", "INTEGER" ], "defaultValue": [], "required": false }

See Visual Type Configuration Properties.

singlelist

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

singlelist

Editor

singlelist variables are represented in the settings sidebar as a simple drop down.

Variable Specific Properties

Property	Argument	Description
`defaultValue`	string
`values`	array of strings	The options you make available for users to select from.

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": "Tile Provider", "type": "singlelist", "descr": "Map tile provider", "values": [ "OpenStreetMap (no API key required)", "MapQuest", "MapBox", "N/A" ], "defaultValue": "OpenStreetMap (no API key required)", "required": false }

See Visual Type Configuration Properties.

string

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

string

Editor

Users can edit string variables using a standard browser text input.

Variable Specific Properties

Property	Argument	Description
`defaultValue`	string

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": "Tile Provider API Key", "type": "string", "descr": "API key for the tile provider chosen. OpenStreetMap does not require an API key.", "required": false }

See Visual Type Configuration Properties.

text

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

text

Editor

Users can edit text variables using a standard browser text input.

Variable Specific Properties

Property	Argument	Description
`defaultValue`	string

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": "Text Property", "type": "text", "descr": "API key for the tile provider chosen. OpenStreetMap does not require an API key.", "required": false }

See Visual Type Configuration Properties.

ungrouped

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

ungrouped

Editor

ungrouped variables are represented by a series of buttons to allow users to select a set number of fields matched up with labels. Below the field buttons is a number input to choose a limit to the number of records that should be returned. By default, the labels provided are used to attempt to select the correct fields. If no fields match the labels, the first n fields are selected.

Variable Specific Properties

Property		Argument	Description
`config`		object	All properties are required.
	`groupLevel`	integer	The number of fields to be selected.
	`groupNames`	array of strings	A list of labels for the fields. The length of this array should match the value set for `groupLevel`.
	`limit`	integer	The number of ungrouped records to return.

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": "Latitude/Longitude", "type": "ungrouped", "descr": "Latitude and Longitude fields", "config": { "groupLevel": 2, "groupNames": [ "Latitude", "Longitude" ], "limit": 100000 }, "required": false }

See Visual Type Configuration Properties.

ungroupedList

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.

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.

​Properties

​attribute

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​bool

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​box-plot-metric

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​color

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​float

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​group

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​histogram-group

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​integer

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​metric

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​multi-group

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​multi-metric

​Type

​Editor

​Variable Specific Properties

​Generic Properties

​Deprecated Properties

​Samples

​multilist

​Type

Properties

attribute

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

bool

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

box-plot-metric

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

color

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

float

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

group

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

histogram-group

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

integer

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

metric

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

multi-group

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

multi-metric

Type

Editor

Variable Specific Properties

Generic Properties

Deprecated Properties

Samples

multilist

Type