Function: a!progressBarField()
Displays a completion percentage, such as receiving all the necessary approval tasks, completing a certain number of on-boarding processes, or completing a single process.
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
|
Instructions | instructions | Text | Optional text displayed beneath the component. |
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" . |
Percentage | percentage | Integer | Number between 0 and 100 to define how far the blue bar extends to show how much is completed. |
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
Examples
Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
Progress Bar with a Decimal Percentage
1
2
3
4
=a!progressBarField(
label: "Evaluations Completed",
percentage: (20 / 25) * 100
)
Displays the following:
Progress Bar with Percentage Details in the Instructions
1
2
3
4
5
6
7
8
9
=load(
local!readEmails: 143,
local!totalEmails: 150,
a!progressBarField(
label: "Emails Read",
instructions: local!readEmails & " of " & local!totalEmails & " read",
percentage: (local!readEmails / totalEmails) * 100
)
)
Displays the following:
On This Page