Numeric input
What is a Numeric input
Numeric input is an input component that allows you to enter a numeric value to be treated as a number (i.e. not a string). The value can be entered by the user or later fetched from an uploaded dataset (bulk-run).
When to use the Numeric input component
The Numeric input component is suitable for situations when a number is needed for an analysis that involves some math or counting. For instance, when a process needs to be executed x number of times.
How to add a Numeric input to my custom Tool
The Numeric input component is listed under User inputs. You can add it to your Tool using the main section or the side-bar.
Numeric input setting
- Title: the title of your input component
- Description: To describe what this input is or will be used for, etc.
- Variable name: located on the bottom left and marked in green, you can rename the variable and use the name to access the data in your Tool
- Optional/Required: located on the top right, as the name suggests, unlike an optional component, a required components must be provided before your analysis starts.
Set a default value
To set a default value for an input component, enter the value and click on the small setting icon on the bottom right. Next click on
Set current value.
Keep in mind that the entered value must be a number and when used in a code step it must be treated as a number.
Access the entered number
To access the entered text use the variable mode {{}} and the input step name. Under the default setting it is accessible
via {{number}} (or params.number in a JavaScript step).