[Back to Parameters]

Number

A widget that allows users to enter integers or floats and supports basic numeric validation.

The range of acceptable values can be limited using minimum or minimumExclusive and maximum or maximumExclusive.

The number can also be limited to a certain step size by using multipleOf. For example, to allow digits up to two decimal places, set multipleOf to 0.01.

Key	Type	Required	Default	Description	UPM/TD
multipleOf	float			Restricts the number to be a multiple of this value1. Default is to allow as much precision as possible.
minimum	float			The minimum acceptable number, inclusive by default (x >= minimum) unless minimumExclusive is true.
minimumExclusive	bool		false	If true, the number must be strictly greater than the minimum (x > minimum).
maximum	float			The maximum acceptable number, inclusive by default (x <= maximum) unless maximumExclusive is true.
maximumExclusive	bool		false	If true, the number must be strictly less than the maximum (x < maximum).
showSlider	bool		false	Shows a slider widget bounded by minimum and maximum alongside the text entry field.
sliderTickIncrement	float		0	The interval between ticks on the slider. If 0, the tick increment will be automatically calculated.

Example

{
  "name": "somenumber",
  "type": "number",
  "valueType": "string",
  "prompt": "Minimum Separation",
  "multipleOf": 0.0001,
  "minimum": 0,
  "minimumExclusive": false
}

---

1. e.g. "multipleOf": 0.1 would allow any number up to one decimal place ↩