Files
shiny/man/outputOptions.Rd
Joe Cheng dde266768c Restore HTML generating functions
These functions were temporarily ripped out of Shiny and moved
to the htmltools package. We've discovered that it's safe to
keep including them in shiny; as long as the functions in shiny
and the functions in htmltools are identical, the user won't
receive a conflict warning.
2014-05-31 08:06:03 -07:00

42 lines
1.2 KiB
R

% Generated by roxygen2 (4.0.1): do not edit by hand
\name{outputOptions}
\alias{outputOptions}
\title{Set options for an output object.}
\usage{
outputOptions(x, name, ...)
}
\arguments{
\item{x}{A shinyoutput object (typically \code{output}).}
\item{name}{The name of an output observer in the shinyoutput object.}
\item{...}{Options to set for the output observer.}
}
\description{
These are the available options for an output object:
\itemize{
\item suspendWhenHidden. When \code{TRUE} (the default), the output object
will be suspended (not execute) when it is hidden on the web page. When
\code{FALSE}, the output object will not suspend when hidden, and if it
was already hidden and suspended, then it will resume immediately.
\item priority. The priority level of the output object. Queued outputs
with higher priority values will execute before those with lower values.
}
}
\examples{
\dontrun{
# Get the list of options for all observers within output
outputOptions(output)
# Disable suspend for output$myplot
outputOptions(output, "myplot", suspendWhenHidden = FALSE)
# Change priority for output$myplot
outputOptions(output, "myplot", priority = 10)
# Get the list of options for output$myplot
outputOptions(output, "myplot")
}
}