Tools to Work with the 'Splash' JavaScript Rendering Service in R
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

90 lines
3.3 KiB

6 years ago
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/render-jpg.R
6 years ago
\name{render_jpeg}
\alias{render_jpeg}
\title{Return a image (in JPEG format) of the javascript-rendered page.}
\usage{
render_jpeg(splash_obj = splash_local, url, base_url = NULL,
quality = 75, width, height, timeout = 30, resource_timeout,
wait = 0, render_all = TRUE, proxy, js, js_src, filters,
allowed_domains, allowed_content_types, forbidden_content_types,
viewport = "full", images, headers, body, http_method, save_args,
load_args)
6 years ago
}
\arguments{
\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
6 years ago
\item{url}{The URL to render (required)}
6 years ago
\item{base_url}{The base url to render the page with.}
6 years ago
\item{quality}{JPEG quality parameter in range from 0 to 100. Default is quality=75.}
\item{width}{Resize the rendered image to the given width/height (in
pixels) keeping the aspect ratio. These are optional}
6 years ago
\item{height}{Resize the rendered image to the given width/height (in
pixels) keeping the aspect ratio. These are optional}
6 years ago
6 years ago
\item{timeout}{A timeout (in seconds) for the render (defaults to 30). Without
reconfiguring the startup parameters of the Splash server (not this package)
the maximum allowed value for the timeout is 60 seconds.}
6 years ago
\item{resource_timeout}{A timeout (in seconds) for individual network requests.}
\item{wait}{Time (in seconds) to wait for updates after page is loaded (defaults to 0).}
\item{render_all}{If \code{TRUE} extend the viewport to include the whole webpage
(possibly very tall) before rendering.}
6 years ago
6 years ago
\item{proxy}{Proxy profile name or proxy URL.}
6 years ago
6 years ago
\item{js}{Javascript profile name.}
6 years ago
6 years ago
\item{js_src}{JavaScript code to be executed in page context.}
6 years ago
6 years ago
\item{filters}{Comma-separated list of request filter names.}
6 years ago
6 years ago
\item{allowed_domains}{Comma-separated list of allowed domain names. If present, Splash
won’t load anything neither from domains not in this list nor from subdomains of
domains not in this list.}
6 years ago
6 years ago
\item{allowed_content_types}{Comma-separated list of allowed content types. If present,
Splash will abort any request if the response’s content type doesn’t match any of
the content types in this list. Wildcards are supported.}
6 years ago
6 years ago
\item{forbidden_content_types}{Comma-separated list of forbidden content types. If
present, Splash will abort any request if the response’s content type matches
any of the content types in this list. Wildcards are supported.}
6 years ago
6 years ago
\item{viewport}{View width and height (in pixels) of the browser viewport to render the
web page. Format is “<width>x<height>”, e.g. 800x600. Default value is "full".}
6 years ago
6 years ago
\item{images}{Whether to download images.}
6 years ago
6 years ago
\item{headers}{HTTP headers to set for the first outgoing request.}
6 years ago
6 years ago
\item{body}{Body of HTTP POST request to be sent if method is POST.}
6 years ago
6 years ago
\item{http_method}{HTTP method of outgoing Splash request.}
6 years ago
6 years ago
\item{save_args}{A list of argument names to put in cache.}
6 years ago
6 years ago
\item{load_args}{Parameter values to load from cache}
6 years ago
}
6 years ago
\value{
a \link{magick} image object
}
6 years ago
\description{
Return a image (in JPEG format) of the javascript-rendered page.
}
6 years ago
\references{
\href{http://splash.readthedocs.io/en/stable/index.html}{Splash docs}
}
6 years ago
\seealso{
Other splash_renderers: \code{\link{execute_lua}},
\code{\link{render_har}}, \code{\link{render_html}},
\code{\link{render_json}}, \code{\link{render_png}}
6 years ago
}
5 years ago
\concept{splash_renderers}