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 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.
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.
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! |
Value
Specifies the value of the field.
The format is specified by the Data Format
attribute.
"now" sets the current time.
"[+|-][h|m|s|ms]" sets a relative time, where 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 |
Auto Send
Specifies whether the value is automatically sent on change or is sent through a button with submit action.
The default
value is: auto
.
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. |
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.
The default
value is: false
.
Attribute Values
Value | Description |
---|---|
false | Default value. The field is not required. |
true | The field is required. |
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.
The default
value is: false
.
Attribute Values
Value | Description |
---|---|
false | Default value. Single time picker. |
true | Interval time picker. |
Data Format
Specifies the data format, which determines how the value is parsed when received (through a UISet) or sent.
The default
value is: extended
.
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). |
Locale
Specifies the locale to be used, or a list of locales.
If a list is provided, the runtime picks the best one available.
The default
value is: =project:locale
.
Hour Cycle
Specifies the cycle of the hour.
The default
value is: auto
.
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"). |
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.
The default
value is: 1
.
Attribute Values
Value | Description | Example |
---|---|---|
<int> | Step of the picker. | 15 |
Precision
Specifies the precision of the time picker, the smallest unit of time that can be selected
The default
value is: minute
.
Attribute Values
Value | Description |
---|---|
minute | Default value. Minute. |
second | Second. |
ms | Ms. |
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
.
The default
value is: hour
.
Attribute Values
Value | Description |
---|---|
year | Year. |
day | Day. |
hour | Default value. Hour. |
minute | Minute. |
second | Second. |
ms | Ms. |
Min Precision
Specifies the minimum precision of the time picker, the greatest unit of time that can be selected
The default
value is: hour
.
Attribute Values
Value | Description |
---|---|
year | Year. |
day | Day. |
hour | Default value. Hour. |
minute | Minute. |
second | Second. |
ms | Ms. |
Max Precision
Specifies the maximum precision of the time picker, the smallest unit of time that can be selected.
The default
value is: minute
.
Attribute Values
Value | Description |
---|---|
year | Year. |
day | Day. |
hour | Hour. |
minute | Default value. Minute. |
second | Second. |
ms | Ms. |
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 |
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 |
Value Options
Specifies additional value options, which appear as buttons.
The default
value is: [{"value":"*", "label":"- -"},{"value":"now", "label":"$now;"}]
.
This attribute is experimental
. It might not work properly and it might be modified or removed in a future release.
Attribute Values
Value | Description |
---|---|
<array> | Array of JSON options, each with value and label properties. |
Panel
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 |
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).
The default
value is: 14
.
Attribute Values
Value | Description | Example |
---|---|---|
<integer> | Font size in pixels. | |
<percentage>% | Relative font size in percentage. | 90% |
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.
The default
value is: normal
.
Attribute Values
Value | Description |
---|---|
normal | Default value. Normal. |
bold | Bold. |
bolder | Bolder. |
lighter | Lighter. |
Italic
Show the text in italics.
The default
value is: false
.
Attribute Values
Value | Description |
---|---|
false | Default value. Normal. |
true | Italics. |
Small Caps
Sets the font to small caps.
The default
value is: false
.
Attribute Values
Value | Description |
---|---|
false | Default value. Normal. |
true | Small caps. |
Decoration
Specifies the text decoration.
The default
value is: none
.
Attribute Values
Value | Description |
---|---|
none | Default value. No decoration. |
underline | Underline. |
overline | Overline. |
line-through | Line through. |
Line Height
Sets the line height of the text.
The default
value is: 1.0
.
Attribute Values
Value | Description |
---|---|
<float> | Specify the line height as a multiple of the font size. |
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
.
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
.
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
.
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.
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
.
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.
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
.
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. |