Create a waiter to then show, hide or update its content.
Create an object to show a waiting screen on either the entire application
or just a portion of the app by specifying the id. Then show,
then hide or meanwhile update the content of the waiter.
fadeoutSet or get the fade out
colorSet or get the background color
imageSet of get the background image
sessionSet or get the shiny session
htmlSet or get the html content
new()Waiter$new( id = NULL, html = NULL, color = NULL, logo = NULL, image = "", fadeout = FALSE, hide_on_render = !is.null(id), hide_on_error = !is.null(id), hide_on_silent_error = !is.null(id) )
idId, or vector of ids, of element on which to overlay the waiter, if NULL the waiter is
applied to the entire body.
htmlHTML content of waiter, generally a spinner, see spinners or a list of the latter.
colorBackground color of loading screen.
logoLogo to display. Deprecated.
imagePath to background image of loading screen.
fadeoutUse a fade out effect when the screen is removed. Can be a boolean, or a numeric indicating the number of milliseconds the effect should take.
hide_on_renderSet to TRUE to automatically hide the waiter
when the element in id is drawn. Note the latter will work with
shiny plots, tables, htmlwidgets, etc. but will not work with arbitrary
elements.
hide_on_error, hide_on_silent_errorWhether to hide the waiter when the underlying element throws an error. Silent error are thrown by req and validate.
Create a waiter.
\dontrun{Waiter$new()}
show()Waiter$show()
Show the waiter.
hide()Waiter$hide()
Hide the waiter.
update()Waiter$update(html = NULL)
htmlHTML content of waiter, generally a spinner, see spinners.
Update the waiter's html content.
print()Waiter$print()
print the waiter
clone()The objects of this class are cloneable with this method.
Waiter$clone(deep = FALSE)
deepWhether to make a deep clone.
## ------------------------------------------------ ## Method `Waiter$new` ## ------------------------------------------------ if (FALSE) Waiter$new()