float

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

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.

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