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.

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 dynamically 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.

Attribute Values

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

This attribute is available when parent's layout is neither "flex" nor "grid".

When parent's layout is neither "flex" nor "grid", this attribute defaults to x0y0.

Flex Grow

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

Attribute Values

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

This attribute is available when parent's layout is "flex".

The default value is: false.

Flex Shrink

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

Attribute Values

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

This attribute is available when parent's layout is "flex".

The default value is: false.

Column

Specifies the starting column of the object inside a grid container.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column index starting from 1.

This attribute is available when parent's layout is "grid".

note

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

Column Span

Specifies how many grid columns the object spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column span starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to 1.

note

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

Row

Specifies the starting row of the object inside a grid container.

Minimum value is 1.

Attribute Values

Value	Description
[empty]	Auto placement by the grid.
<int>	Row index starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to auto.

note

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

Row Span

Specifies how many grid rows the object spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Row span starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to 1.

note

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

Width

Sets the object's width in pixels.

Minimum value is 110.

Height

Sets the object's height in pixels.

Minimum value is 110.

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. See the Command API.
datapoint	Toggles a datapoint.

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.

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!

This attribute is available when action is "command".

When action is "command", this attribute defaults to the id attribute.

Datapoint

Specifies the datapoint.

Attribute Values

Value	Description
<string>	Datapoint name.

This attribute is available when action is "datapoint".

Data Format

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

Attribute Values

Value	Description
auto	Default value. 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.

This attribute is available when action is one of "command" or "".

When action is one of "command" or "", this attribute defaults to auto.

Value

Value

Specifies the current value.

This attribute is available when action is one of "command" or "".

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.

Alpha

Include transparency controls.

Attribute Values

Value	Description
false	Default value. False.
true	True.

This attribute is available when action is not "datapoint" and layout is not "swatches".

The default value is: false.

Color Mode

Initially selected color representation, chosen from Color Modes. If unavailable, the first allowed mode is used. Changing representation sends nothing by itself. With Data Format set to auto, it determines the format sent on subsequent color changes.

Attribute Values

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

This attribute is available when action is not "datapoint" and layout is not "swatches".

The default value is: rgb.

Color Modes

Available color representations, in order. RGB is the default. A selector appears beside editable values or channel sliders when more than one representation is available.

Attribute Values

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

This attribute is available when action is not "datapoint" and layout is not "swatches".

When action is not "datapoint" and layout is not "swatches", this attribute defaults to rgb.

Layout

Layout

Choose the color controls displayed in the panel.

Attribute Values

Value	Description
picker	Default value. Saturation/value area and hue bar.
sliders	Color preview and individual channel sliders. HEX uses a text field.
swatches	Color palette only.
tabbed	Switch between Picker, Sliders and configured Swatches without changing the color.

The default value is: picker.

Orientation

In Sliders, sets the direction of the channel sliders. In picker views, horizontal stacks the preview and editable fields in a column beside the picker; vertical places them below it, with the color mode selector on the same row when space allows.

Attribute Values

Value	Description
horizontal	Default value. Horizontal.
vertical	Vertical.

This attribute is available when layout is not "swatches".

The default value is: horizontal.

Label

The panel title. Leave empty for a title-free panel.

Power Switch

Display the power switch and device status.

Attribute Values

Value	Description
false	Default value. False.
true	True.

The default value is: false.

Show Fields

Show the color preview and editable values alongside the picker. In Tabbed layout, applies only to the Picker tab.

Attribute Values

Value	Description
false	Default value. False.
true	True.

This attribute is available when layout is one of "picker" or "tabbed".

When layout is one of "picker" or "tabbed", this attribute defaults to false.

Brightness

Show an additional brightness bar in the picker view. This adjusts HSV value.

Attribute Values

Value	Description
false	Default value. False.
true	True.

This attribute is available when action is not "datapoint" and layout is one of "picker" or "tabbed".

The default value is: false.

Panel

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

Attribute Values

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

The default value is: true.

Panel Color

Specifies the panel color.

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.

This attribute is available when panel is "true".

The default value is: default.

Panel Custom Color

Specifies the panel custom color.

Attribute Values

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

This attribute is available when panelstyle is "custom" or panelstyle is "glass" or panelcolor is "custom".

Swatches

Show Swatches

Show the color palette below the other controls.

Attribute Values

Value	Description
false	Default value. False.
true	True.

This attribute is available when layout is neither "swatches" nor "tabbed".

The default value is: false.

Colors

Ordered color list. Each item adds one swatch; leave its Color empty to reserve a slot. Use Load Preset to replace the list immediately with a starting palette; Undo restores the previous list. Lighting presets are RGB colors, not color-temperature controls.

Swatch Size

Color button size. Colors automatically wrap to fit the panel.

Attribute Values

Value	Description
small	Small.
medium	Default value. Medium.
large	Large.

The default value is: medium.

Allow Customization

Allow palette editing in the client. Select a swatch, then select it again to start or stop editing its color. While editing, color changes fill or update that swatch. Edit provides actions to add, remove and reset swatches. Changes are saved in this browser for this project and picker. Give the picker an ID to retain customizations across visits.

Attribute Values

Value	Description
false	Default value. False.
true	True.

The default value is: false.

View

Visible

Sets the object's visibility.

Attribute Values

Value	Description
true	Default value. Visible.
false	Hidden.

The default value is: true.

Enabled

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

Attribute Values

Value	Description
true	Default value. Enabled.
false	Disabled.

The default value is: true.

Blink

Blinks the object at the specified speed.

Attribute Values

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

The default value is: false.

Transition

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

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.

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.

Transition Duration

Specifies the transition duration in milliseconds.

Attribute Values

Value	Description
<integer>	Duration in milliseconds.

This attribute is available when transition is not "none".

When transition is not "none", this attribute defaults to 300.

note

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

Transition Delay

Specifies the transition delay in milliseconds.

Attribute Values

Value	Description
<integer>	Delay in milliseconds.

This attribute is available when transition is not "none".

When transition is not "none", this attribute defaults to 0.

note

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

Opacity

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

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.

The default value is: 1.0.

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.

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

note

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

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.

Attribute Values

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

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.

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.

Attribute Values

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

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.