R/Title.R

In xlcharts: Create Native 'Excel' Charts and Work with Microsoft 'Excel' Files

#' @title Title
#'
#' @description \url{https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.title.html}
#'
#' @param tx tx
#' @param layout layout
#' @param overlay overlay
#' @param spPr spPr
#' @param txPr txPr
#' @param extLst extLst
#' @param ... Additional arguments, i.e. kwargs.
#'
#' @return An openpyxl Python object.
#'
#' @examples
#' \dontrun{
#' Title()
#' }
#'
#' @export
Title <- function(tx = NULL, layout = NULL, overlay = NULL, spPr = NULL, txPr = NULL, extLst = NULL, ...) {

  py_obj <- openpyxl$chart$axis$Title(
    tx = tx,
    layout = layout,
    overlay = overlay,
    spPr = spPr,
    txPr = txPr,
    extLst = extLst
  )

  # as of openpyxl docs, additional arguments ("**kw")
  kwargs <- list(...)
  for(i in seq_along(kwargs)) {
    name <- names(kwargs)[i]
    py_obj[[name]] <- kwargs[[i]]
  }

  return(py_obj)
}