Skip to main content
Version: 4.2 (beta)

Timer

The UI object for the timer.

It's used to set a timer with the specific Timer ID.

The timer object generates TIMER events and userTimerEvent() Java callbacks on activation and reset.

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​
ValueDescriptionExample
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​
ValueDescription
falseDefault value. Objects do not grow to fill the available space.
trueObjects 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​
ValueDescription
falseDefault value. Objects do not shrink to fit the available space.
trueObjects 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​
ValueDescription
<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​
ValueDescription
<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​
ValueDescription
[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​
ValueDescription
<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.

Possible values are from 260 to 320.

Height​

Sets the object's height in pixels.

Possible values are from 240 to 400.

Common​

Timer ID​

Specifies the timer ID, as defined in the System Settings or Timers parameter in the hsyco.ini file.

Attribute Values​
ValueDescription
<timer>Timer ID.

Label​

Label​

Specifies the label.

Attribute Values​
ValueDescription
<string>Label text.

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​
ValueDescriptionExample
<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​
ValueDescriptionExample
<html color>Color in any html accepted format.#ff0000

Font Weight​

Specifies the weight of the font.

Attribute Values​
ValueDescription
normalDefault value. Normal.
boldBold.
bolderBolder.
lighterLighter.

The default value is: normal.

Italic​

Show the text in italics.

Attribute Values​
ValueDescription
falseDefault value. Normal.
trueItalics.

The default value is: false.

Small Caps​

Sets the font to small caps.

Attribute Values​
ValueDescription
falseDefault value. Normal.
trueSmall caps.

The default value is: false.

Decoration​

Specifies the text decoration.

Attribute Values​
ValueDescription
noneDefault value. No decoration.
underlineUnderline.
overlineOverline.
line-throughLine through.

The default value is: none.

Line Height​

Sets the line height of the text.

Attribute Values​
ValueDescription
<float>Specify the line height as a multiple of the font size.

The default value is: 1.0.

Text Align​

Sets the horizontal alignment of the text.

Attribute Values​
ValueDescription
noneNo alignment.
leftLeft alignment.
rightRight alignment.
centerDefault value. Center alignment.
justifyJustified alignment.

The default value is: center.

Panel​

Panel​

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

Attribute Values​
ValueDescription
trueDefault value. Shows the panel.
falseHides the panel.

The default value is: true.

Panel Color​

Specifies the panel color.

Attribute Values​
ValueDescription
defaultDefault value. Default color.
primaryPrimary color, used to highlight important areas.
warningWarning color, used to highlight warning areas.
successSuccess color, used to highlight success areas.
errorError color, used to highlight error areas.
red,blue,yellow,green,yellow,purple,orange,greenPalette colors.
customCustom 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​
ValueDescriptionExample
<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".

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​
ValueDescription
falseDefault value. Object is included in the UI.
trueObject 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.