mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
roxygenize
This commit is contained in:
@@ -4,12 +4,15 @@
|
||||
\alias{uiOutput}
|
||||
\title{Create an HTML output element}
|
||||
\usage{
|
||||
htmlOutput(outputId)
|
||||
htmlOutput(outputId, inline = FALSE)
|
||||
|
||||
uiOutput(outputId)
|
||||
uiOutput(outputId, inline = FALSE)
|
||||
}
|
||||
\arguments{
|
||||
\item{outputId}{output variable to read the value from}
|
||||
|
||||
\item{inline}{use an inline (\code{span()}) or block container (\code{div()})
|
||||
for the output}
|
||||
}
|
||||
\value{
|
||||
An HTML output element that can be included in a panel
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
\alias{imageOutput}
|
||||
\title{Create a image output element}
|
||||
\usage{
|
||||
imageOutput(outputId, width = "100\%", height = "400px")
|
||||
imageOutput(outputId, width = "100\%", height = "400px", inline = FALSE)
|
||||
}
|
||||
\arguments{
|
||||
\item{outputId}{output variable to read the image from}
|
||||
@@ -13,6 +13,9 @@ imageOutput(outputId, width = "100\%", height = "400px")
|
||||
string and have \code{"px"} appended.}
|
||||
|
||||
\item{height}{Image height}
|
||||
|
||||
\item{inline}{use an inline (\code{span()}) or block container (\code{div()})
|
||||
for the output}
|
||||
}
|
||||
\value{
|
||||
An image output element that can be included in a panel
|
||||
|
||||
@@ -7,12 +7,14 @@
|
||||
\usage{
|
||||
knit_print.shiny.appobj(x, ...)
|
||||
|
||||
knit_print.shiny.render.function(x, ...)
|
||||
knit_print.shiny.render.function(x, ..., inline = FALSE)
|
||||
}
|
||||
\arguments{
|
||||
\item{x}{Object to knit_print}
|
||||
|
||||
\item{...}{Additional knit_print arguments}
|
||||
|
||||
\item{inline}{Whether the object is printed inline.}
|
||||
}
|
||||
\description{
|
||||
These S3 methods are necessary to help Shiny applications and UI chunks embed
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
\usage{
|
||||
plotOutput(outputId, width = "100\%", height = "400px", clickId = NULL,
|
||||
hoverId = NULL, hoverDelay = 300, hoverDelayType = c("debounce",
|
||||
"throttle"))
|
||||
"throttle"), inline = FALSE)
|
||||
}
|
||||
\arguments{
|
||||
\item{outputId}{output variable to read the plot from}
|
||||
@@ -36,6 +36,9 @@ events. Use \code{"throttle"} to limit the number of hover events to one
|
||||
every \code{hoverDelay} milliseconds. Use \code{"debounce"} to suspend
|
||||
events while the cursor is moving, and wait until the cursor has been at
|
||||
rest for \code{hoverDelay} milliseconds before sending an event.}
|
||||
|
||||
\item{inline}{use an inline (\code{span()}) or block container (\code{div()})
|
||||
for the output}
|
||||
}
|
||||
\value{
|
||||
A plot output element that can be included in a panel
|
||||
|
||||
@@ -3,12 +3,15 @@
|
||||
\alias{textOutput}
|
||||
\title{Create a text output element}
|
||||
\usage{
|
||||
textOutput(outputId, container = div)
|
||||
textOutput(outputId, container = if (inline) span else div, inline = FALSE)
|
||||
}
|
||||
\arguments{
|
||||
\item{outputId}{output variable to read the value from}
|
||||
|
||||
\item{container}{a function to generate an HTML element to contain the text}
|
||||
|
||||
\item{inline}{use an inline (\code{span()}) or block container (\code{div()})
|
||||
for the output}
|
||||
}
|
||||
\value{
|
||||
A text output element that can be included in a panel
|
||||
@@ -19,7 +22,7 @@ text will be included within an HTML \code{div} tag by default.
|
||||
}
|
||||
\details{
|
||||
Text is HTML-escaped prior to rendering. This element is often used
|
||||
to display \link{renderText} output variables.
|
||||
to display \link{renderText} output variables.
|
||||
}
|
||||
\examples{
|
||||
h3(textOutput("caption"))
|
||||
|
||||
Reference in New Issue
Block a user