Skip to content

[Back to Parameters]

Color

A widget used to select a color value. Value is saved as a comma-delimited string, unless componentValueType is hex, in which case the two-digit hex values are concatenated with no delimiter.

Key Type Required Default Description UPM/TD
colorSpace enum: rgb, hsv,
cmyk, hsl
❌ rgb Keyword for color representation type. ✔
alpha bool ❌ false If true, append an alpha band as an extra element at the end of the value. ✔
componentValueType enum:
int (range 0–255),
float (range 0.0–1.0),
hex (range 00–FF)
❌ int The format to use for each component value. ✔

Deprecated

Key Type Required Default Description
valueFormat fstr ❌ ➖ Format string where %1 is a placeholder for the raw parameter value.

Example

{
  "name": "somecolor",
  "type": "color",
  "valueType": "string",
  "prompt": "Layer color",
  "defaultValue": "#0000ff",
  "colorSpace": "rgb",
  "alpha": false,
  "componentValueType": "hex",
  "valueFormat": "#%1"
}