| animate {animate} | R Documentation |
Extends the 'base' graphics functions to support frame-by-frame animation and keyframes animation.
connectionA handle for the WebSocket connection.
ready_stateThe ready state of the connection.
shinyTRUE or FALSE; whether the device is used with in a 'Shiny' app.
sessionA 'Shiny' session.
virtual_metaA list of device metadata.
virtual_sessionA virtual session simulated with 'V8'.
event_handlersA named list of user-defined functions for handling events.
new()Constructor of the device
animate$new(width, height, id = "SVG_1", launch.browser, ...)
widthAn integer; the width in pixels.
heightAn integer; the height in pixels.
idA character string; the id assigned to the device.
launch.browserA function to launch a viewer; two options are
rstudioapi::viewer and utils::browseURL. It defaults to the first
option if the user is using RStudio and to the second option otherwise.
The default applies to interactive session only.
...Additional arguments. Use virtual = TRUE to use the virtual
device, shiny = TRUE for shiny application; everything else will be
passed to the SVG element that hosts the visualisation.
\donttest{
library(animate)
device <- animate$new(400, 400) # Launch a WebSocket server
attach(device)
x <- 1:10
y <- 1:10
id <- new_id(x) # Give each point an ID: c("ID-1", "ID-2", ..., "ID-10")
plot(x, y, id = id)
new_y <- 10:1
plot(x, new_y, id = id, transition = TRUE) # Use transition
off()
detach(device)
}
off()Switch off the device; this function closes the WebSocket connection.
animate$off()
send()Send commands to device
animate$send(message)
messageThe message to send to the device.
set_max_stacksize()Set the maximum size of the stack
animate$set_max_stacksize(n)
nThe number of commands the plot stack can hold. Use -1 for unlimited number of commands.
svg()Initialise a SVG element
animate$svg(width = 800, height = 600, ...)
widthWidth of the canvas in pixels.
heightHeight of the canvas in pixels.
...Additional parameters. Some commonly used parameters are id
and root. id assigns an id to the SVG element for future reference;
root specifies the DOM element to insert the SVG element into.
bars()Add bars to a plot
animate$bars(x, y, w, h, ...)
xThe x coordinates of the bars.
yThe y coordinates of the bars.
wThe width of the bars.
hThe height of the bars.
...Additional graphical parameters.
objects()Add HTML objects to a plot
animate$objects(x, y, w, h, content, ...)
xThe x coordinates of the objects.
yThe y coordinates of the objects.
wThe width of the objects.
hThe height of the objects.
contentThe content of the objects; the HTML string.
...Additional graphical parameters.
plot()Generic X-Y plotting
animate$plot(x, y, type = "p", ...)
xThe x coordinates of the data.
yThe y coordinates of the data.
typeType of the plot; one of 'p' and 'l'.
...Additional graphical parameters.
points()Add points to a plot
animate$points(x, y, ...)
xThe x coordinates of the points.
yThe y coordinates of the points.
...Additional graphical parameters.
Options for the "pch" parameter: "circle", "plus", "diamond", "square", "star", "triangle", "wye", "triangle_down", "triangle_left", "triangle_right", "diamond_alt", "diamond_square", "pentagon", "hexagon", "hexagon_alt", "octagon", "octagon_alt", "cross".
The unit of the "cex" parameter is squared pixels, corresponding to how much pixel space the symbol would cover. The convention comes from the 'D3' library, and the choice is (believed) to make plots visually consistent across the different symbols.
lines()Add line segments / paths to a plot
animate$lines(x, y, ...)
xThe x coordinates of the line.
yThe y coordinates of the line.
...Additional graphical parameters.
abline()Add straight lines to a plot
animate$abline(a, b, h, v, ...)
aThe intercept.
bThe slope.
hThe y-value(s) for horizontal line(s).
vThe x-value(s) for vertical line(s).
...Additional graphical parameters.
axis()Add an axis to a plot
animate$axis(x, ...)
xThe x coordinates of the text.
...Additional graphical parameters.
yThe y coordinates of the text.
labelsThe text.
text()Add text to a plot
animate$text(x, y, labels, ...)
xThe x coordinates of the text.
yThe y coordinates of the text.
labelsThe text.
...Additional graphical parameters.
image()Add background image to a plot
animate$image(href, width, height, ...)
hrefThe link to the image.
widthThe width of the image.
heightTh height of the image.
...Additional graphical parameters.
event()Attach an interactive event to an element
animate$event(selector, event_type, callback)
selectorA character string; a CSS selector.
event_typeA character string; the event type. For example, "click", "mouseover", "mouseout". See more options at https://www.w3schools.com/jsref/dom_obj_event.asp.
callbackA function, to be called when the event is triggered. The function should take an argument to receive the data from the browser end.
chain()Chain a transition after another.
animate$chain(callback)
callbackA function, to be called when the event is triggered. The function should take an argument to receive the data from the browser end.
\donttest{
library(animate)
device <- animate$new(600, 600) # Launch a WebSocket server
attach(device)
par(xlim = c(0, 10), ylim = c(0, 10))
plot(1:10, 1:10, id = 1:10)
points(1:10, sample(10, 10), id = 1:10,
transition = list(
duration = 1000,
on = chain(function(message) {
print(message)
points(1:10, sample(10, 10), id = 1:10, bg = "green",
transition = list(duration = 2000))
})
))
par(xlim = NULL, ylim = NULL) # Reset `xlim` and `ylim` in `par`
off()
detach(device)
}
simple_event()Attach a captured event to an element
animate$simple_event(selector, event_type, method, param)
selectorA character string; a CSS selector.
event_typeA character string; the event type. For example, "click", "mouseover", "mouseout". See more options at https://www.w3schools.com/jsref/dom_obj_event.asp.
methodA character string; the name of a device function (e.g. "points").
paramA named list of arguments to be called with.
set()Set the active device to a SVG element
animate$set(device_id)
device_idA character vector; ID of the device.
par()Set the graphical parameters
animate$par(...)
...The graphical parameters
remove()Remove elements from the active SVG element
animate$remove(id = NULL, selector = "*")
idA character vector; the ID of the elements.
selectorA character vector; a CSS selector.
clear()Remove all elements from the active SVG element
animate$clear()
delete()Remove a SVG element
animate$delete(id = NULL)
idA character string; the ID of the SVG. If not provided, remove the active SVG element. #' @description #' Perform a group of graphical operations to a plot #' @param ... Any number of graphical operations. group = function(...) self$send(Message("fn_group", c(...))) ,
import()Import an animated plot
animate$import(setting)
settingA JSON file exported from previous runs.
export()Export an animated plot
animate$export(path = "./animate.json", handler = "browser")
pathA character string; the file path to export to.
handler'r' or 'browser'; the program to handle the export operation.
record()Record an animated plot as a MP4 video
animate$record()
This function will prompt you to select a screen / window / tab to record. Once started, the recording can be stopped by using the stop button at the notification box, or clicking anywhere on the page near the device. Always confirm that the screen recording notification box is gone. The captured video will be downloaded right after the recording stops.
This uses web browsers' Media Streams API to record the screen
and return the captured frames as a video. The entire process runs locally.
The source file that provides this functionality can be found at
system.file("addons/screen_record.js", package = "animate").
This function is disabled for 'Shiny' app and R Markdown document.
This function does not work in the RStudio viewer. Please use the "show in new window" button to launch the page with a web browser.
See browser compatibility at: https://developer.mozilla.org/en-US/docs/Web/API/MediaStream_Recording_API#browser_compatibility
See Media Streams API reference at: https://developer.mozilla.org/en-US/docs/Web/API/Media_Streams_API
observeAnimateEvent()Event handler
animate$observeAnimateEvent(input)
inputThe input object in the server function of a 'Shiny' app.
clone()The objects of this class are cloneable with this method.
animate$clone(deep = FALSE)
deepWhether to make a deep clone.
This function differs from the event function in that events
registered through simple_event do not require R at deployment to work.
## ------------------------------------------------
## Method `animate$new`
## ------------------------------------------------
library(animate)
device <- animate$new(400, 400) # Launch a WebSocket server
attach(device)
x <- 1:10
y <- 1:10
id <- new_id(x) # Give each point an ID: c("ID-1", "ID-2", ..., "ID-10")
plot(x, y, id = id)
new_y <- 10:1
plot(x, new_y, id = id, transition = TRUE) # Use transition
off()
detach(device)
## ------------------------------------------------
## Method `animate$chain`
## ------------------------------------------------
library(animate)
device <- animate$new(600, 600) # Launch a WebSocket server
attach(device)
par(xlim = c(0, 10), ylim = c(0, 10))
plot(1:10, 1:10, id = 1:10)
points(1:10, sample(10, 10), id = 1:10,
transition = list(
duration = 1000,
on = chain(function(message) {
print(message)
points(1:10, sample(10, 10), id = 1:10, bg = "green",
transition = list(duration = 2000))
})
))
par(xlim = NULL, ylim = NULL) # Reset `xlim` and `ylim` in `par`
off()
detach(device)