progress_image {switchboard} | R Documentation |
Display a custom 80 by 80 pixel image as a progress bar.
Description
The progress_image
widget displays an image as a progressBar.
Arguments
eavesdrop |
The variable to track with a progress bar. |
maximum |
The maximum value of |
size |
A number used to designate the size (magnification) of the
widget. The default is set to |
placeOnGrid |
A row by column coordinate (e.g., |
updates |
The number of times the widget is to be updated (e.g., when it be modified/changed). The default updates the widget 100 times. Increase number for smoother progress bar animation. |
delay |
Pause each update of the switchboard. Default has no delay,
values are in seconds (e.g., |
honest |
When |
closeAtMaximum |
Functions like |
fill |
The direction of how things are animated when displaying
progression. The default is |
file |
A *.png filename with a transparent background that designates an image to be used as a progress-bar. The total image size should be 80 by 80 pixels, but for best integration into switchboard layout, the actual image must be 75 by 75 pixels placed at the bottom left of the 80 by 80 image. This will leave a 5 pixel whitespace at both the top and right side of the image. |
Value
Nothing.
Usage
progress_image(eavesdrop, maximum = 100, size = 1, placeOnGrid = c(1, 1), updates = 100, delay = 0, honest = FALSE, closeAtMaximum = FALSE, fill = "horizontal", file = "")
See Also
Other progress bars:
progress_benchmark()
,
progress_ibis()
,
progress_oyster()
,
progress_percent()
,
progress_phyllotaxis()
,
progress_pikachu()
,
progress_ring_percent()
,
progress_ring()
Examples
## Not run:
for (i in 1:250) {
switchboard(delay = 0.01) %>%
progress_image(i, maximum = 250,
file = system.file("images", "topography.png", package = "switchboard"))
}
switchboard_close()
## End(Not run)