Name of output file. Should end with .png, .pdf, or
.jpeg.
vwidth
Viewport width. This is the width of the browser "window".
vheight
Viewport height This is the height of the browser "window".
cliprect
Clipping rectangle. If cliprect and selector
are both unspecified, the clipping rectangle will contain the entire page.
This can be the string "viewport", in which case the clipping
rectangle matches the viewport size, or it can be a four-element numeric
vector specifying the top, left, width, and height. This option is not
compatible with selector.
selector
One or more CSS selectors specifying a DOM element to set the
clipping rectangle to. The screenshot will contain these DOM elements. For
a given selector, if it has more than one match, only the first one will be
used. This option is not compatible with cliprect.
expand
A numeric vector specifying how many pixels to expand the
clipping rectangle by. If one number, the rectangle will be expanded by
that many pixels on all sides. If four numbers, they specify the top,
right, bottom, and left, in that order.
delay
Time to wait before taking screenshot, in seconds. Sometimes a
longer delay is needed for all assets to display properly.
eval
An optional string with JavaScript code which will be evaluated
after opening the page and waiting for delay, but before calculating
the clipping region and taking the screenshot. See the Casper API
(http://docs.casperjs.org/en/latest/modules/casper.html) for more
information about what commands can be used to control the web page. NOTE:
This is experimental and likely to change!
See Also
appshot for taking screenshots of Shiny applications.
Examples
if (interactive()) {
# Whole web page
webshot("https://github.com/rstudio/shiny")
# Might need a longer delay for all assets to display
webshot("http://rstudio.github.io/leaflet", delay = 0.5)
# Clip to the viewport
webshot("http://rstudio.github.io/leaflet", "leaflet-viewport.png",
cliprect = "viewport")
# Manual clipping rectangle
webshot("http://rstudio.github.io/leaflet", "leaflet-clip.png",
cliprect = c(200, 5, 400, 300))
# Using CSS selectors to pick out regions
webshot("http://rstudio.github.io/leaflet", "leaflet-menu.png", selector = ".list-group")
webshot("http://reddit.com/", "reddit-top.png",
selector = c("input[type='text']", "#header-bottom-left"))
# Expand selection region
webshot("http://rstudio.github.io/leaflet", "leaflet-boxes.png",
selector = "#installation", expand = c(10, 50, 0, 50))
# If multiple matches for a given selector, it uses the first match
webshot("http://rstudio.github.io/leaflet", "leaflet-p.png", selector = "p")
webshot("https://github.com/rstudio/shiny/", "shiny-stats.png",
selector = "ul.numbers-summary")
# Send commands to eval
webshot("http://www.reddit.com/", "reddit-input.png",
selector = c("#search", "#login_login-main"),
eval = "casper.then(function() {
// Check the remember me box
this.click('#rem-login-main');
// Enter username and password
this.sendKeys('#login_login-main input[type="text"]', 'my_username');
this.sendKeys('#login_login-main input[type="password"]', 'password');
// Now click in the search box. This results in a box expanding below
this.click('#search input[type="text"]');
// Wait 500ms
this.wait(500);
});"
)
# Result can be piped to other commands like resize() and shrink()
webshot("http://www.google.com/", "google-small.png") %>%
resize("75%") %>%
shrink()
}
# See more examples in the package vignette
vignette("intro", package = "webshot")
providing 
.