DisplayVariable

Additional display specific Template pertaining to a particular input variable.

JSON representation
{
  "name": string,
  "title": string,
  "alternateDefaults": [
    {
      object (AlternateDefaultInput)
    }
  ],
  "regexValidation": string,
  "validation": string,
  "enumValueLabels": [
    {
      object (ValueLabelInput)
    }
  ],
  "level": integer,
  "subtext": string,
  "properties": {
    string: {
      object (DisplayVariable)
    },
    ...
  },
  "min": number,
  "max": number
}
Fields
name

string

Required. The variable name from the corresponding standard Template file.

title

string

Required. Visible title for the variable on the UI.

alternateDefaults[]

object (AlternateDefaultInput)

Optional. Alternate defaults for the input.

regexValidation

string

Optional. Regex based validation rules for the variable.

validation

string

Optional. Text describing the validation rules for the property. Typically shown after an invalid input. Optional. UTF-8 text. No markup. At most 128 characters.

enumValueLabels[]

object (ValueLabelInput)

Optional. Labels for enum values. Values must be UTF-8 text with no markup, and at most 64 characters.

level

integer

Optional. Indicates the "advanced" level of the input property. Level 0 (default) will always be shown. Level 1 corresponds to one expansion (user clicks "show advanced options" or "more options"). Higher levels correspond to further expansions, or they may be collapsed to level 1 by the UI implementation. Optional.

subtext

string

Optional. Property subtext, displayed below the title.

properties

map (key: string, value: object (DisplayVariable))

Optional. properties is a map defining all the fields of the input variable.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

min

number

Optional. Minimum value for numeric types.

max

number

Optional. Maximum value for numeric types.

ValueLabelInput

Value label input for a UI.

JSON representation
{
  "value": string,
  "label": string
}
Fields
value

string

Optional. Value of the enum.

label

string

Optional. Label of the enum.