Progress Bar
Component Palette Icon
Visually indicates the progress of some task. Can be used to display any value that has an upper and lower bound.
Properties
| Name | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Antialias | Draw with antialias on? Makes text smoother. | boolean | .antialias | Appearance |
| Background Color | The background color of the component. | Color | .background | Appearance |
| Border | The border surrounding this component. NOTE that the border is unaffected by rotation. | Border | .border | Common |
| Cursor | The mouse cursor to use when hovering over this component. | int | .cursorCode | Common |
| Data Quality | The data quality code for any tag bindings on this component. | int | .dataQuality | Data |
| Direction | Determines the direction of progress for this progress bar. | int | .direction | Appearance |
| Enabled | If disabled, a component cannot be used. | boolean | .componentEnabled | Common |
| Font | Font of text on this component. | Font | .font | Appearance |
| Foreground Color | The foreground color of the component. | Color | .foreground | Appearance |
| Horizontal? | If true, the progress bar will display horizontally, else it will display vertically. | boolean | .horizontal | Appearance |
| Indeterminate? | When true, the progressbar displays animation indicating that something is happening, but it will take an indeterminate amount of time | boolean | .indeterminate | Behavior |
| Maximum | The maximum value that this progress bar will reach. | int | .maximum | Data |
| Minimum | The minimum value that this progress bar will reach. | int | .minimum | Data |
| Mouseover Text | The text that is displayed in the tooltip which pops up on mouseover of this component. | String | .toolTipText | Common |
| Name | The name of this component. | String | .name | Common |
| Show Percentage? | If true, the progress bar will display its percentage. | boolean | .stringPainted | Appearance |
| Styles | Contains the component's styles. | Dataset | .styles | Appearance |
| Value | The current state of the Progress Bar. | int | .value | Data |
| Visible | If disabled, the component will be hidden. | boolean | .visible | Common |
Scripting
Scripting Functions
This component does not have scripting functions associated with it.
Extension Functions
This component does not have extension functions associated with it.
Event Handlers
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page
Customizers
Examples
Horizontal Blue Progress Bar
| Property Name | Value |
|---|---|
| Border | Titled Border |
| Value | 85 |
| Foreground Color | 0,0,255 |
| Horizontal? | True |
Wide Vertical Blue Progress Bar
| Property Name | Value |
|---|---|
| Border | Titled Border |
| Value | 85 |
| Foreground Color | 0,0,255 |
| Horizontal? | False |