mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-10 07:28:01 -05:00
d4527cdc28
* Close #3626: use ragg::agg_png over Cairo::CairoPNG if available * Update documentation
100 lines
4.1 KiB
R
100 lines
4.1 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/render-plot.R
|
|
\name{renderPlot}
|
|
\alias{renderPlot}
|
|
\title{Plot Output}
|
|
\usage{
|
|
renderPlot(
|
|
expr,
|
|
width = "auto",
|
|
height = "auto",
|
|
res = 72,
|
|
...,
|
|
alt = NA,
|
|
env = parent.frame(),
|
|
quoted = FALSE,
|
|
execOnResize = FALSE,
|
|
outputArgs = list()
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{expr}{An expression that generates a plot.}
|
|
|
|
\item{width, height}{Height and width can be specified in three ways:
|
|
\itemize{
|
|
\item \code{"auto"}, the default, uses the size specified by \code{\link[=plotOutput]{plotOutput()}}
|
|
(i.e. the \code{offsetWidth}/`offsetHeight`` of the HTML element bound to
|
|
this plot.)
|
|
\item An integer, defining the width/height in pixels.
|
|
\item A function that returns the width/height in pixels (or \code{"auto"}).
|
|
The function is executed in a reactive context so that you can refer to
|
|
reactive values and expression to make the width/height reactive.
|
|
}
|
|
|
|
When rendering an inline plot, you must provide numeric values (in pixels)
|
|
to both \code{width} and \code{height}.}
|
|
|
|
\item{res}{Resolution of resulting plot, in pixels per inch. This value is
|
|
passed to \code{\link[=plotPNG]{plotPNG()}}. Note that this affects the resolution of PNG
|
|
rendering in R; it won't change the actual ppi of the browser.}
|
|
|
|
\item{...}{Arguments to be passed through to \code{\link[=plotPNG]{plotPNG()}}.
|
|
These can be used to set the width, height, background color, etc.}
|
|
|
|
\item{alt}{Alternate text for the HTML \verb{<img>} tag if it cannot be displayed
|
|
or viewed (i.e., the user uses a screen reader). In addition to a character
|
|
string, the value may be a reactive expression (or a function referencing
|
|
reactive values) that returns a character string. If the value is \code{NA} (the
|
|
default), then \code{ggplot2::get_alt_text()} is used to extract alt text from
|
|
ggplot objects; for other plots, \code{NA} results in alt text of "Plot object".
|
|
\code{NULL} or \code{""} is not recommended because those should be limited to
|
|
decorative images.}
|
|
|
|
\item{env}{The parent environment for the reactive expression. By default,
|
|
this is the calling environment, the same as when defining an ordinary
|
|
non-reactive expression. If \code{expr} is a quosure and \code{quoted} is \code{TRUE},
|
|
then \code{env} is ignored.}
|
|
|
|
\item{quoted}{If it is \code{TRUE}, then the \code{\link[=quote]{quote()}}ed value of \code{expr}
|
|
will be used when \code{expr} is evaluated. If \code{expr} is a quosure and you
|
|
would like to use its expression as a value for \code{expr}, then you must set
|
|
\code{quoted} to \code{TRUE}.}
|
|
|
|
\item{execOnResize}{If \code{FALSE} (the default), then when a plot is
|
|
resized, Shiny will \emph{replay} the plot drawing commands with
|
|
\code{\link[grDevices:recordplot]{grDevices::replayPlot()}} instead of re-executing \code{expr}.
|
|
This can result in faster plot redrawing, but there may be rare cases where
|
|
it is undesirable. If you encounter problems when resizing a plot, you can
|
|
have Shiny re-execute the code on resize by setting this to \code{TRUE}.}
|
|
|
|
\item{outputArgs}{A list of arguments to be passed through to the implicit
|
|
call to \code{\link[=plotOutput]{plotOutput()}} when \code{renderPlot} is used in an
|
|
interactive R Markdown document.}
|
|
}
|
|
\description{
|
|
Renders a reactive plot that is suitable for assigning to an \code{output}
|
|
slot.
|
|
}
|
|
\details{
|
|
The corresponding HTML output tag should be \code{div} or \code{img} and have
|
|
the CSS class name \code{shiny-plot-output}.
|
|
}
|
|
\section{Interactive plots}{
|
|
|
|
|
|
With ggplot2 graphics, the code in \code{renderPlot} should return a ggplot
|
|
object; if instead the code prints the ggplot2 object with something like
|
|
\code{print(p)}, then the coordinates for interactive graphics will not be
|
|
properly scaled to the data space.
|
|
|
|
See \code{\link[=plotOutput]{plotOutput()}} for more information about interactive plots.
|
|
}
|
|
|
|
\seealso{
|
|
For the corresponding client-side output function, and example
|
|
usage, see \code{\link[=plotOutput]{plotOutput()}}. For more details on how the plots are
|
|
generated, and how to control the output, see \code{\link[=plotPNG]{plotPNG()}}.
|
|
\code{\link[=renderCachedPlot]{renderCachedPlot()}} offers a way to cache generated plots to
|
|
expedite the rendering of identical plots.
|
|
}
|