R/hc_plot_ft.R

Defines functions hc_plot_ft

Documented in hc_plot_ft

#' Easy plot highcharter personal theme
#'
#' @param hc highchart object
#' @param title title to the plot
#' @param subtitle subtitle to the plot
#' @param source source of data
#' @param range logical, display range options?
#' @param navigator logical, display navigator zoom?
#' @import highcharter
#'
#' @return plot
#' @export
#'
hc_plot_ft <- function(
  hc,
  title,
  subtitle,
  source,
  range     = TRUE,
  navigator = TRUE
  )
  {

  # create plot object
  ftwo_plot <- hc %>%
    hc_title(text = title) %>%
    hc_subtitle(text = subtitle) %>%
    hc_credits(
      enabled = TRUE,
      text    = paste0("Source: ", source),
      style   = list(fontSize = "12px")
      ) %>%
    hc_xAxis(title = FALSE) %>%
    hc_yAxis(
      labels    = list(format = "{value}%"),
      title     = FALSE,
      plotLines = list(
        list(
          value = 0,
          color = "#1a1a1a",
          width = 2
          )
        )
      ) %>%
    hc_tooltip(shared = TRUE) %>%
    hc_add_theme(theme_fortietwo) %>%
    hc_navigator(enabled = navigator)

    if (range) {
      ftwo_plot <- ftwo_plot %>%
      hc_rangeSelector(
        selected          = 4,
        enabled           = TRUE,
        allButtonsEnabled = TRUE,
        inputEnabled      = FALSE,
        dropdown          = "always"
      )
    } else ftwo_plot

  ftwo_plot

  }
schoulten/macroview documentation built on Jan. 4, 2023, 3:54 a.m.