Text list
Input a list of string values
What is a Text list input
Text list input is an input component that allows you to enter a list of text values (e.g. list of states).
When to use the Text list input component
The Text input component is suitable for situations where we have multiple string values that needs to be kept and reached independent of each other.
How to add a Text list input to my custom Tool
The Text list input component is listed under User inputs. You can add it to your Tool using the main section or the side-bar.
Text list 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.
Access the entered list of text
To access the entered text use the variable mode {{}} and the input step name. Under the default setting it is accessible
via {{list}} (or params.list in a JavaScript step).