Time
Displays a time picker panel.
Its value is sent as a command to the server on a submit action or when it changes, if Auto Send it true.
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".
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.
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.
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.
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 150.
Height
Sets the object's height in pixels.
Minimum value is 136.
Field
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! |
By default, this attribute uses the id attribute.
Value
Specifies the value of the field.
The format is specified by the Data Format attribute.
"now" sets the current time.
Time math expressions support chained offsets and one rounding step, for example now+1h, now/h, or now+90m/h.
Absolute anchors can use value||math, for example 15:30||/h.
Time units are h=hour, m=minute, s=second, ms=millisecond.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <string> | Value of the field formatted as specified in Data Format. | 15:30 |
| now | Current time of the browser. | |
| [+|-][h|m|s|ms] | Relative time, where h=hour, m=minute, s=second, ms=millisecond. | +1h |
| now/m | Start of the current minute. |
Auto Send
Specifies whether the value is automatically sent on change or is sent through a button with submit action.
Attribute Values
| Value | Description |
|---|---|
| auto | Default value. The value is sent only if there's no buttons with submit action in the same or a parent container. |
| true | The value is sent automatically on change. |
| false | The value is not automatically sent. |
The default value is: auto.
Required
Specifies if the field is required when submitting multiple fields with a submit button. If true, an empty/null value is considered not valid. When there are non valid fields, the submit button focuses the first non valid field instead of sending data to the server, to prompt the user to fill in the required fields.
Attribute Values
| Value | Description |
|---|---|
| false | Default value. The field is not required. |
| true | The field is required. |
The default value is: false.
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: 250.
Interval
Specifies whether the time picker selects a single time or an interval.
Attribute Values
| Value | Description |
|---|---|
| false | Default value. Single time picker. |
| true | Interval time picker. |
The default value is: false.
Negative Values
Specifies whether negative values are allowed in interval mode.
Attribute Values
| Value | Description |
|---|---|
| false | Default value. Negative values are not allowed. |
| true | Negative values are allowed. |
This attribute is available when interval is "true".
The default value is: false.
Data Format
Specifies the data format, which determines how the value is parsed when received (through a UISet) or sent.
Attribute Values
| Value | Description |
|---|---|
| extended | Default value. HH:mm:ss.SSSS Extended Format. |
| basic | HHmmssSSSS Basic Format. |
| timestamp | Unix Timestamp: Seconds since the Unix Epoch (January 1, 1970 00:00:00 GMT). |
This attribute is available when interval is "false".
The default value is: extended.
Locale
Specifies the locale to be used, or a list of locales.
If a list is provided, the runtime picks the best one available.
This attribute is available when interval is "false".
When interval is "false", this attribute defaults to the project's locale attribute.
Hour Cycle
Specifies the cycle of the hour.
Attribute Values
| Value | Description |
|---|---|
| auto | Default value. Use the default cycle for the locale. |
| h23 | (e.g. "0-23"). |
| h12 | (e.g. "0-11"). |
| h11 | (e.g. "1-12"). |
| h24 | (e.g. "1-24"). |
This attribute is available when interval is "false".
The default value is: auto.
Time
Step
Specifies the step of the time picker, referred to the smallest unit of time that can be selected.
E.g. if the smallest unit is minutes and step is set to 15, the time picker will allow to select only times that are multiple of 15 minutes.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <int> | Step of the picker. | 15 |
The default value is: 1.
Precision
Specifies the precision of the time picker, the smallest unit of time that can be selected
Attribute Values
| Value | Description |
|---|---|
| minute | Default value. Minute. |
| second | Second. |
| ms | Ms. |
This attribute is available when interval is "false".
When interval is "false", this attribute defaults to minute.
Unit
Specifies the unit of the value.
E.g.
Unit: hour, Max Precision: hour, Min Precision: second. 5:30 will be parsed as 5.5.
Unit: second, Max Precision: hour, Min Precision: second. 5:30 will be parsed as 330.
Attribute Values
| Value | Description |
|---|---|
| year | Year. |
| day | Day. |
| hour | Default value. Hour. |
| minute | Minute. |
| second | Second. |
| ms | Ms. |
This attribute is available when interval is "true".
When interval is "true", this attribute defaults to hour.
Min Precision
Specifies the minimum precision of the time picker, the greatest unit of time that can be selected
Attribute Values
| Value | Description |
|---|---|
| year | Year. |
| day | Day. |
| hour | Default value. Hour. |
| minute | Minute. |
| second | Second. |
| ms | Ms. |
This attribute is available when interval is "true".
When interval is "true", this attribute defaults to hour.
Max Precision
Specifies the maximum precision of the time picker, the smallest unit of time that can be selected.
Attribute Values
| Value | Description |
|---|---|
| year | Year. |
| day | Day. |
| hour | Hour. |
| minute | Default value. Minute. |
| second | Second. |
| ms | Ms. |
This attribute is available when interval is "true".
When interval is "true", this attribute defaults to minute.
Min Value
Specifies the minimum value of the time interval, in the unit specified by Unit.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <float> | Minimum value of the interval. | 5.5 |
This attribute is available when interval is "true".
Max Value
Specifies the maximum value of the time interval, in the unit specified by Unit.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <float> | Maximum value of the interval. | 5.5 |
This attribute is available when interval is "true".
Value Options
Specifies additional value options, which appear as buttons.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <JSON array> | Array of JSON options, each with value and label properties. | [{"value":"+15m","label":"In 15 min"}] |
Default behavior:
- When
intervalis "false", this attribute defaults to[{"value":"*", "label":"- -"},{"value":"now", "label":"$now;"}]. - When
intervalis "true", this attribute defaults to[{"value":"*", "label":"- -"}].
Panel
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".
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.
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.
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.
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.
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 |
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.
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.
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.
This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.