When you define your list of parameters, all can include the following options.
Field | Required | Description |
name | True | The name of the parameter. This must be a combination of lower case letters, numbers, and dashes and must be unique to your script. |
type | True | The type of the parameter (see options below) |
description | False | A description which is presented to the user when they run your form. |
required | False | Whether your parameter is required or optional. Defaults to true. |
default | False | A default value for your parameter. |
The type
of your parameter and other settings dictates how it is presented in your form. Datapane supports the following form fields.
Form Field |
| Extra options | Default value |
Text input |
| |
|
Slider |
| Both |
|
Integer input |
| One of |
|
Float input |
| |
|
Boolean input |
| |
|
Dropdown |
| | The first choice supplied |
Date picker |
| |
|
Time picker |
| |
|
Date and time picker |
| |
|
List Input |
| If provided with no |
|
Multi Select Input |
| If provided with |
|