[Back to Parameters]

Listbox

A widget that allows a user to select items from a list

Specification

choices and choiceSettings/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. If a single display choice is associated with more than one value, then all the values will be selected when that display string is selected.

key	type	required	default value	description
singleSelection	boolean	no	false	If true the user is only allowed to select a single item.
allowOrdering	boolean	no	false	If true, the interface will allow the user to customize the order of the selected values.
inline	boolean	no	false	If true the selection dialog will be shown in the dialog itself.

deprecated

key	type	required	default value	description
delimiter	char	no	' '	The delimiter to use when valueType is string or stringEncoded.

Example

{
  "name": "somelistbox",
  "type": "listbox",
  "valueType": "string_encoded",
  "prompt": "Geometry Type(s)",
  "defaultValue": "poly",
  "choices": [
    {
      "value": "poly",
      "display": "polygon"
    },
    {
      "value": "point",
      "display": "point"
    },
    {
      "value": "line",
      "display": "line"
    }
  ]
}