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.

89 lines
3.2 KiB

пре 7 година
% Generated by roxygen2: do not edit by hand
пре 5 година
% Please edit documentation in R/render-png.R
пре 7 година
\name{render_png}
\alias{render_png}
пре 6 година
\title{Return an image (in PNG format) of the javascript-rendered page.}
пре 7 година
\usage{
render_png(splash_obj = splash_local, url, base_url = NULL, 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)
пре 7 година
}
\arguments{
\item{splash_obj}{Object created by a call to \code{\link[=splash]{splash()}}}
пре 7 година
\item{url}{The URL to render (required)}
пре 7 година
\item{base_url}{The base url to render the page with.}
пре 7 година
пре 6 година
\item{width, height}{Resize the rendered image to the given width/height (in
pixels) keeping the aspect ratio. These are optional}
пре 7 година
пре 7 година
\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.}
пре 7 година
\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).}
пре 6 година
\item{render_all}{If \code{TRUE} extend the viewport to include the whole webpage
(possibly very tall) before rendering.}
пре 7 година
\item{proxy}{Proxy profile name or proxy URL.}
пре 7 година
пре 7 година
\item{js}{Javascript profile name.}
пре 7 година
пре 7 година
\item{js_src}{JavaScript code to be executed in page context.}
пре 7 година
пре 7 година
\item{filters}{Comma-separated list of request filter names.}
пре 7 година
пре 7 година
\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.}
пре 7 година
пре 7 година
\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.}
пре 7 година
пре 7 година
\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.}
пре 7 година
пре 7 година
\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".}
пре 7 година
пре 7 година
\item{images}{Whether to download images.}
пре 7 година
пре 7 година
\item{headers}{HTTP headers to set for the first outgoing request.}
пре 7 година
пре 7 година
\item{body}{Body of HTTP POST request to be sent if method is POST.}
пре 7 година
пре 7 година
\item{http_method}{HTTP method of outgoing Splash request.}
пре 7 година
пре 7 година
\item{save_args}{A list of argument names to put in cache.}
пре 7 година
пре 7 година
\item{load_args}{Parameter values to load from cache}
пре 7 година
}
пре 7 година
\value{
a \link{magick} image object
}
пре 7 година
\description{
пре 6 година
Return an image (in PNG format) of the javascript-rendered page.
пре 7 година
}
пре 7 година
\examples{
\dontrun{
render_png(url = "https://httpbin.org/")
}
}
пре 7 година
\references{
\href{http://splash.readthedocs.io/en/stable/index.html}{Splash docs}
}
пре 7 година
\seealso{
Other splash_renderers: \code{\link{execute_lua}},
пре 7 година
\code{\link{render_har}}, \code{\link{render_html}},
\code{\link{render_jpeg}}, \code{\link{render_json}}
пре 7 година
}
пре 6 година
\concept{splash_renderers}