R/timelines-shiny.R

In dreamRs/timelineschart: Timelines Chart Htmlwidget

#' Shiny bindings for timelines
#'
#' Output and render functions for using timelines within Shiny
#' applications and interactive Rmd documents.
#'
#' @param outputId output variable to read from
#' @param width,height Must be a valid CSS unit (like \code{'100\%'},
#'   \code{'400px'}, \code{'auto'}) or a number, which will be coerced to a
#'   string and have \code{'px'} appended.
#' @param expr An expression that generates a timelines
#' @param env The environment in which to evaluate \code{expr}.
#' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
#'   is useful if you want to save an expression in a variable.
#'
#' @name timelines-shiny
#'
#' @export
#'
#' @importFrom htmlwidgets shinyWidgetOutput
timelinesOutput <- function(outputId, width = '100%', height = '400px'){
  htmlwidgets::shinyWidgetOutput(outputId, 'timelines', width, height, package = 'timelineschart')
}

#' @rdname timelines-shiny
#' @export
#' @importFrom htmlwidgets shinyRenderWidget
renderTimelines <- function(expr, env = parent.frame(), quoted = FALSE) {
  if (!quoted) { expr <- substitute(expr) } # force quoted
  htmlwidgets::shinyRenderWidget(expr, timelinesOutput, env, quoted = TRUE)
}