Documentation
ProgressBar
Require: IP-Symcon >= 5.2
Creates a progress bar.
The progress bar is helpful to inform a user about a possibly longer process by using UpdateFormField.
It is possible to display either a progressive bar or an indefinite bar that shows a loading animation.
Parameters
Parameter | Description |
---|---|
caption (optional) | Visible caption of the progress bar |
current (optional) | (default: 0) The current value of the progress bar - If the bar is displayed progressively, it is unfilled if the current value corresponds to the minimum value of the progress bar, completely filled if the current value corresponds to the maximum value of the progress bar and otherwise accordingly proportionately filled. |
indeterminate (optional) | (default: false) If true, the progress bar is indeterminate and shows an animation, otherwise the bar is displayed progressively on the basis of current, minimum and maximum |
maximum (optional) | (default: 100) The maximum value of the progress bar |
minimum (optional) | (default: 0) The minimum value of the progress bar |
name (optional) | Name of the progress bar |
type | ProgressBar |
visible (optional) | (default: true) If true, the button is visible, otherwise it is invisible |
width (optional) | (default: 300px) Fixed width of the input field in pixels or % as a string, e.g. "40%" or "250px" (since IP-Symcon 5.3) |
Example
{ "type": "ProgressBar", "name": "IndeterminateProgress", "indeterminate": true, "caption": "loading..." }, { "type": "ProgressBar", "name": "DeterminateProgress", "minimum": 0, "maximum": 50, "current": 20, "caption": "20 / 50" }