Files
shiny/man/updateDateInput.Rd
Yihui Xie 194d8a05f8 using the latest master of klutometis/roxygen (d823c3a088b20ea5e38a60d78d42ccbe9f1e1eec)
Rd text for arguments is no longer wrapped by default
2014-03-24 23:46:46 -05:00

64 lines
1.8 KiB
R

% Generated by roxygen2 (4.0.0): do not edit by hand
\name{updateDateInput}
\alias{updateDateInput}
\title{Change the value of a date input on the client}
\usage{
updateDateInput(session, inputId, label = NULL, value = NULL, min = NULL,
max = NULL)
}
\arguments{
\item{session}{The \code{session} object passed to function given to
\code{shinyServer}.}
\item{inputId}{The id of the input object.}
\item{label}{The label to set for the input object.}
\item{value}{The desired date value. Either a Date object, or a string in
\code{yyyy-mm-dd} format.}
\item{min}{The minimum allowed date. Either a Date object, or a string in
\code{yyyy-mm-dd} format.}
\item{max}{The maximum allowed date. Either a Date object, or a string in
\code{yyyy-mm-dd} format.}
}
\description{
Change the value of a date input on the client
}
\details{
The input updater functions send a message to the client, telling it to
change the settings of an input object. The messages are collected and sent
after all the observers (including outputs) have finished running.
The syntax of these functions is similar to the functions that created the
inputs in the first place. For example, \code{\link{numericInput}()} and
\code{updateNumericInput()} take a similar set of arguments.
Any arguments with NULL values will be ignored; they will not result in any
changes to the input object on the client.
}
\examples{
\dontrun{
shinyServer(function(input, output, session) {
observe({
# We'll use the input$controller variable multiple times, so save it as x
# for convenience.
x <- input$controller
updateDateInput(session, "inDate",
label = paste("Date label", x),
value = paste("2013-04-", x, sep=""),
min = paste("2013-04-", x-1, sep=""),
max = paste("2013-04-", x+1, sep="")
)
})
})
}
}
\seealso{
\code{\link{dateInput}}
}