Description Details Methods Examples
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.
new()
Waiter$new( id = NULL, html = NULL, color = NULL, logo = NULL, hide_on_render = !is.null(id), hide_on_error = !is.null(id), hide_on_silent_error = !is.null(id) )
id
Id, or vector of ids, of element on which to overlay the waiter, if NULL
the waiter is
applied to the entire body.
html
HTML content of waiter, generally a spinner, see spinners
or a list of the latter.
color
Background color of loading screen.
logo
Logo to display.
hide_on_render
Set 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_error
Whether 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)
html
HTML 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)
deep
Whether to make a deep clone.
1 2 3 4 5 | ## ------------------------------------------------
## Method `Waiter$new`
## ------------------------------------------------
## Not run: Waiter$new()
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.