Time Display Component

Time

Function: a!timeDisplayField()

Displays a single time (hour, minute, second) but cannot take input.

When working with a date (year, month, day), use a date component. When working with date and time (year, month, day, hour, minute, second), use a date & time component. To display a time using a custom format, use a text component.

Parameters

Name Keyword Type Description
Label label Text Optional text to display as the field label.
Label Position labelPosition Text Optional text to determine where the label appears. Valid values include
  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.
Instructions instructions Text Optional text displayed below the field's value.
Help Tooltip helpTooltip Text Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".
Value value Integer The value to display in the paragraph field.
Visibility showWhen Boolean Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Notes

  • The time is shown in the current user's time zone. For example, 1:20 PM.
  • If you want to display a time with formatting other than the default, use the Text component.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Time with Only a Label

1
2
3
4

=a!timeDisplayField(
  label: "Daily Meeting Time",
  value: time(13, 20)
)

Displays the following:

Open in Github

On This Page

FEEDBACK