[Back to Parameters]

Dropdown

A widget that allows a user to select a single item from a dropdown menu, or optionally input a string. Value can be saved as a string, number, or bool. To add a separator between items, add a choice item with a value of '-----'.

Specification

choices and choices/sets, and the latter's corresponding ~Settings object(s) (available to all parameter types, and described in the Parameters page), are key to defining an instance of this parameter.

Example

{
  "name": "somedropdown",
  "type": "dropdown",
  "valueType": "string",
  "prompt": "Geometry Type",
  "defaultValue": "poly",
  "choices": [
    {
      "value": "poly",
      "display": "polygon"
    },
    {
      "value": "point",
      "display": "point"
    },
    {
      "value": "line",
      "display": "line"
    }
  ]
}