Knob

The knob object allows users to input a value by rotating a knob.

The knob can be rotated by dragging it with the mouse or by using the arrow keys.

The value is sent as a command to the server:

• when the user changes it, if Auto Send it true

• when a button with submit action is pressed (sending multiple fields at once)

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

Height

Sets the object's height in pixels.

Minimum value is 100.

Action

Action

Specifies the action to be performed when the user moves the slider.

Attribute Values

Value	Description
none	Default value. No action.
command	Sends a command. See the Command API.
datapoint	Sets a datapoint.

The default value is: none.

Name

Specifies the name of the command.

Attribute Values

Value	Description
<string>	Command name.

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
<datapoint>	Datapoint.

This attribute is available when action is "datapoint".

Value

Value

Specifies the slider value. Leave empty to use the minimum of Range.

Attribute Values

Value	Description
<string>	Value.

This attribute is available when action is not "datapoint".

Range

Specifies the range of the slider. A datapoint state in value/max format overrides this range with 0,max.

Attribute Values

Value	Description
<min,max>	Min, max values.

The default value is: 0,100.

Unit

Unit displayed on value label, or % for percentage.

Attribute Values

Value	Description
<string>	Displays the unit after the value.
%	Displays the value as percentage. If there's a custom range (different from 0-100) the percentage is calculated.

Change Delay

Defines the time interval between value changes for sending values to the server.

Attribute Values

Value	Description
<number>	Delay in milliseconds.

The default value is: 50.

Inverse

Specifies wether the slider is inverted.

Attribute Values

Value	Description
false	Default value. Normal.
true	Inverted.

The default value is: false.

Layout

Label

Specifies a label for the slider.

Attribute Values

Value	Description
<string>	Label.

Orientation

Specifies the orientation of the slider.

Attribute Values

Value	Description
horizontal	Default value. Horizontal.
vertical	Vertical.

The default value is: horizontal.

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.

Display Value

Specifies wether the value is displayed.

Attribute Values

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

The default value is: false.

Display Pending Value

Specifies wether the pending value is displayed. The pending value is the value that is being sent to the server.

Attribute Values

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

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

The default value is: false.

Button Layout

Specifies the button layout.

Attribute Values

Value	Description
none	Default value. No buttons.
toggle	Toggle button.
switch	Power switch.
both	On/off buttons.

The default value is: none.

Off Value

Specifies the value to be sent when the off button is pressed. It also acts as a threshold to determine the state: any value above it is considered on. If a value is specified, the On Value will default to the maximum value of the range.

Attribute Values

Value	Description
<string>	Value.

This attribute is available when buttonlayout is one of "toggle" or "switch".

When buttonlayout is one of "toggle" or "switch", this attribute defaults to off.

Handle Size

Specifies the handle size.

Attribute Values

Value	Description	Example
small	Default value. Small size.
medium	Medium size.
large	Large size.
<int>	Custom size in pixels.	30

The default value is: small.

note

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

Style

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

Handle Color

Specifies the button color.

Attribute Values

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

The default value is: default.

Custom Handle Color

Specifies the handle color.

Attribute Values

Value	Description
<html color>	Any valid HTML color.

This attribute is available when handlecolor is "custom".

Bar Color

Specifies the bar 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.

Custom Bar Color

Specifies the bar color.

Attribute Values

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

This attribute is available when barcolor is "custom".

Icon

Icon On

Specifies the icon for the on state.

Attribute Values

Value	Description
<icon>	Icon.

This attribute is available when buttonlayout is one of "toggle" or "both".

When buttonlayout is one of "toggle" or "both", this attribute defaults to icon:sys#power-on.

Icon Off

Specifies the icon for the off state.

Attribute Values

Value	Description
<icon>	Icon.

This attribute is available when buttonlayout is one of "toggle" or "both".

When buttonlayout is one of "toggle" or "both", this attribute defaults to icon:sys#power-off.

Label Typography

Font Family

Specifies the font family.

The default value is: default.

Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

The default value is: 14.

Font Color

Specifies the text CSS color.

Attribute Values

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

Font Weight

Specifies the weight of the font.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

The default value is: normal.

Italic

Show the text in italics.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

The default value is: false.

Small Caps

Sets the font to small caps.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

The default value is: false.

Decoration

Specifies the text decoration.

Attribute Values

Value	Description
none	Default value. No decoration.
underline	Underline.
overline	Overline.
line-through	Line through.

The default value is: none.

Line Height

Sets the line height of the text.

Attribute Values

Value	Description
<float>	Specify the line height as a multiple of the font size.

The default value is: 1.0.

Value Typography

Value Font Family

Specifies the font family.

The default value is: default.

Value Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

The default value is: 14.

Value Font Color

Specifies the text CSS color.

Attribute Values

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

Value Font Weight

Specifies the weight of the font.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

The default value is: normal.

Value Italic

Show the text in italics.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

The default value is: false.

Value Small Caps

Sets the font to small caps.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

The default value is: false.

Value Decoration

Specifies the text decoration.

Attribute Values

Value	Description
none	Default value. No decoration.
underline	Underline.
overline	Overline.
line-through	Line through.

The default value is: none.

Value Line Height

Sets the line height of the text.

Attribute Values

Value	Description
<float>	Specify the line height as a multiple of the font size.

The default value is: 1.0.

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.