Colorpicker

Displays a color picker panel.

Color pickers are used to select a color from a color palette.

The action controls what happens when the color is changed. If the action is command,

a command is sent to the server with the specified name and parameter. If the action is

datapoint, a datapoint is toggled.

Colorpicker tutorial

Attributes

Common

ID

Sets the object's ID.

The ID identifies the object and is used to reference it in UISet actions, allowing to change its attributes dynamically.

The ID is not unique, it can be shared among multiple objects to quickly change a common attribute.

IDs can't be changed with a UISet action, but they can have a Value Binding assigned to them. Value Bindings on IDs allow an object to be dinamically attached to a set of attribute values.

E.g. the following Value Binding switches the ID of the object between mybutton1 and mybutton2 based on the value of the UISet button.address:

Value binding:

="mybutton" + ui('button', 'address')

UISet:

UISet('button', 'address', '1') switches the ID to mybutton1

UISet('button', 'address', '2') switches the ID to mybutton2

Position and Size

Position

Sets the object's position.

The default value is: x0y0.

Attribute Values

Value	Description	Example
x<left>y<top>	Specify left/top coordinates in pixels.	x10y20

Flex Grow

Specifies if the objects should grow to fill the available space.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Objects expand to fill the available space.
false	Objects do not grow to fill the available space.

Flex Shrink

Specifies if the objects should shrink to fit the available space.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Objects shrink to fit the available space.
false	Objects do not shrink to fit the available space.

Width

Sets the object's width in pixels.

Minimum value is 1.

Height

Sets the object's height in pixels.

Minimum value is 1.

Action

Action

Specifies the action performed when clicked/tapped.

Attribute Values

Value	Description
none	No action.
command	Sends a command to the server, with the specified name and parameter.
datapoint	Toggles a datapoint.
command	Sends a DMX command.

Name

Specifies the name of the field, used to send a command to the server, along with the field's value as a parameter.

If the name starts with $, then the server will automatically set a variable with the same name as the command, containing the command's parameter.

The default value is: =id.

Attribute Values

Value	Description	Example
<string>	Command name.
$[variable name]	A command name that sets a variable.	$myvar
$[variable name]!	A command name that sets a persistent variable.	$myvar!

Data Format

Specifies the data format, which determines how the value is parsed when received (through a UISet) or sent.

The default value is: =mode.

Attribute Values

Value	Description
auto	The output format depends on the current mode.
rgb	RGB format: rgb(r,g,b) or rgba(r,g,b,a).
hsv	HSV format: hsv(h,s,v) or hsva(h,s,v,a).
hex	HEX format: #rrggbb or #rrggbbaa.

DMX Address

Specifies the DMX address.

Attribute Values

Value	Description
<string>	DMX address.

Datapoint

Specifies the datapoint.

Attribute Values

Value	Description
<string>	Datapoint name.

Value

Value

Specifies the current value.

Change Delay

Sets the delay in milliseconds by which changes are detected. If the field is working in autosend mode, this value determines the delay between the last button press and the value being sent to the server.

The default value is: 50.

Icon

Icon On

Specifies the icon when the color is on (not black).

The default value is: icon:sys#power-on.

Icon Off

Specifies the icon when the color is off (black).

The default value is: icon:sys#power-off.

Layout

Label

Specifies the label.

Attribute Values

Value	Description
<string>	Label text.

Panel

Shows a panel that frames the object. Its style can be modified.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Shows the panel.
false	Hides the panel.

Panel Color

Specifies the panel color.

The default value is: default.

Attribute Values

Value	Description
default	Default value. Default color.
primary	Primary color, used to highlight important areas.
warning	Warning color, used to highlight warning areas.
success	Success color, used to highlight success areas.
error	Error color, used to highlight error areas.
red,blue,yellow,green,yellow,purple,orange,green	Palette colors.
custom	Custom color, defined in the "Custom Color" attribute.

Panel Custom Color

Specifies the panel custom color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

Orientation

Specifies the orientation of the color picker.

The default value is: horizontal.

Attribute Values

Value	Description
horizontal	Default value. Horizontal.
vertical	Vertical.

HSV

Specifies whether the HSV picker area is visible.

The default value is: false.

Attribute Values

Value	Description
false	Default value. False.
true	True.

Alpha

Specifies whether the alpha slider is visible.

The default value is: false.

Attribute Values

Value	Description
false	Default value. False.
true	True.

Lightness

Specifies whether the lightness slider is visible.

The default value is: false.

Attribute Values

Value	Description
false	Default value. False.
true	True.

Preview

Specifies whether the preview is visible.

The default value is: false.

Attribute Values

Value	Description
false	Default value. False.
true	True.

Fields

Specifies whether the fields are visible.

The default value is: false.

Attribute Values

Value	Description
false	Default value. False.
true	True.

Mode Button

Specifies whether the mode button is visible.

The default value is: false.

Attribute Values

Value	Description
false	Default value. False.
true	True.

Modes

Specifies the available modes.

The default value is: rgb,hsv,hex.

Attribute Values

Value	Description
rgb	Rgb.
hsv	Hsv.
hex	Hex.

Mode

Specifies the current mode.

The default value is: rgb.

Attribute Values

Value	Description
rgb	Default value. Rgb.
hsv	Hsv.
hex	Hex.

On Off Button

Specifies whether the on/off button is visible.

The default value is: false.

Attribute Values

Value	Description
false	Default value. False.
true	True.

Swatches

Specifies the number of visible swatches, buttons with preset colors.

The default value is: none.

Attribute Values

Value	Description	Example
none	Default value. No swatches.
auto	Automatic number of swatches.
<int>	Specific number of swatches.	8

Swatches

Swatch Size

Specifies the size of the swatches.

The default value is: auto.

Attribute Values

Value	Description
<int>	Swatch size in pixels.

Editable Swatches

Specifies whether the swatches are editable.

The default value is: true.

Attribute Values

Value	Description
false	False.
true	Default value. True.

Swatch Colors

Specifies the swatch colors.

Attribute Values

Value	Description
<string>	A comma-separated list of colors.

View

Visible

Sets the object's visibility.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Visible.
false	Hidden.

Enabled

Specifies if the object is enabled or disabled. A disabled object appears as grayed out and can't be interacted with.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Enabled.
false	Disabled.

Blink

Blinks the object at the specified speed.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Not blinking.
slow	Blinks slowly.
fast	Blinks fast.

Transition

Specifies the transition effect when the object is shown or hidden.

The default value is: none.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
none	Default value. No transition.
fade	Fade in/out.
fade-left	Slide from left and fade in/out.
fade-right	Slide from right and fade in/out.
fade-up	Slide from top and fade in/out.
fade-down	Slide from bottom and fade in/out.
slide-left	Slide from left.
slide-right	Slide from right.
slide-up	Slide from top.
slide-down	Slide from bottom.
zoom-in	Zoom in.
zoom-out	Zoom out.
3d-flip-left	3D flip from left.
3d-flip-right	3D flip from right.

Transition Duration

Specifies the transition duration in milliseconds.

The default value is: 300.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<integer>	Duration in milliseconds.

Transition Delay

Specifies the transition delay in milliseconds.

The default value is: 0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<integer>	Delay in milliseconds.

Opacity

Sets the object's opacity. Opacity is the degree to which content behind an object is hidden.

The default value is: 1.0.

Attribute Values

Value	Description
0	The object is fully transparent.
>0.0, <1.0	The object is translucent (content behind the element can be seen).
1.0	Default value. The object is fully opaque.

Rotation

Specifies the degrees by which the object is rotated. A positive number rotates it clockwise, while a negative value rotates it counter-clockwise.

The default value is: 0.

CSS Class

Specifies a CSS Class that applies to the object, useful to customize its appearance. Custom CSS Classes are specified within the custom.css file.

Margin

Specifies the margin of the object. The margin is the space outside the object's border.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description	Example
<int>	Specify the margin in pixels for all sides of the object.
<top> <right> <bottom> <left>	Specify the margin in pixels for each side of the object.	10 20 30 40

View Scale

Specifies the scale of the object. The scale is the ratio between the object's size and the size of the view it is contained in.

The default value is: 1.0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<float>	Specify the scale for both width and height of the object.

Meta

Comment

Specifies a comment, visible only in the Project Editor. It can be used to add a note or a tag to the object. The filter in the object's SELECT panel applies to the comment as well.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Exclude

Excludes the object from the UI. Useful to temporarily hide an object without deleting it. Different from the "Visible" attribute, which hides the object in the UI but keeps it in the project, allowing it to be shown again with a UISet.

The default value is: false.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Attribute Values

Value	Description
false	Default value. Object is included in the UI.
true	Object is excluded from the UI.