waiterClass: Waiter R6 Class

Description Details Methods Examples

Description

Create a waiter to then show, hide or update its content.

Details

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.

Methods

Public methods


Method new()

Usage
Waiter$new(
  id = NULL,
  html = NULL,
  color = NULL,
  logo = NULL,
  hide_on_render = !is.null(id)
)
Arguments
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.

Details

Create a waiter.

Examples
\dontrun{Waiter$new()}

Method show()

Usage
Waiter$show()
Details

Show the waiter.


Method hide()

Usage
Waiter$hide()
Details

Hide the waiter.


Method update()

Usage
Waiter$update(html = NULL)
Arguments
html

HTML content of waiter, generally a spinner, see spinners.

Details

Update the waiter's html content.


Method print()

Usage
Waiter$print()
Details

print the waiter


Method clone()

The objects of this class are cloneable with this method.

Usage
Waiter$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

1
2
3
4
5
## ------------------------------------------------
## Method `Waiter$new`
## ------------------------------------------------

## Not run: Waiter$new()

waiter documentation built on July 12, 2020, 5:05 p.m.