Time Display Component

Function

a!timeDisplayField( label, instructions, value, labelPosition, helpTooltip, accessibilityText, showWhen )

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	Types	Description
Label	`label`	Text	Text to display as the field label.
Instructions	`instructions`	Text	Supplemental text about this field.
Display Value	`value`	Time	The time to display.
Label Position	`labelPosition`	Text	Determines where the label appears. Valid values: `"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.
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"`.
Accessibility Text	`accessibilityText`	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
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.

Usage considerations

Formatting

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

To experiment with examples, copy and paste the expression into an interface object.

Time with only a label

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

Displays the following:

screenshot of a time field with a label

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Compatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

Feedback

Was this page helpful?