Add logo on export - Githubissues

@lindsayjorgenson putting this here because I don't have permissions to make a PR.

Here's the function

#' Logo
#' 
#' Add logo to exported charts.
#' 
#' @param hc a highcharter chart
#' @param path path to logo
#' @param top top margin of logo
#' @param left left margin of logo
#' @param width width of logo
#' @param height height of logo
#' 
#' @export
add_logo <- function(hc, path, top = 80L, left = 10L, width = 100L, height = 100L){
  if(missing(path))
    stop("path is required")

  hc$x$hc_opts$chart$events <- list(
    load = htmlwidgets::JS(
      sprintf("function() {
          if (!this.options.chart.forExport) return;
          this.renderer.image('%s', %s, %s, %s, %s).add();
        }",
        path,
        top,
        left,
        width,
        height
      )
    ),
    beforePrint = htmlwidgets::JS(
      sprintf("function() {
          let img = this.renderer.image('%s', %s, %s, %s, %s).add();
          img.addClass('image');
        }",
        path,
        top,
        left,
        width,
        height
      )
    ),
    afterPrint = htmlwidgets::JS("function(){
      $('.hc-image').hide();
    }")
  )

  hc
}

And here is an example of how to use it.

library(shiny)
library(naccho.viz)
library(highcharter)

ui <- fluidPage(
  highchartOutput("chart")
)

server <- function(input, output, session) {
  output$chart <- renderHighchart({
    highchart() |> 
      hc_xAxis(categories = month.abb) |> 
      hc_add_series(name = "Tokyo", data = sample(1:12)) |> 
      hc_exporting(
        enabled = TRUE, # always enabled
        filename = "custom-file-name"
      ) |>
      add_logo(
        "https://github.com/lindsayjorgenson.png",
        width = 10L,
        height = 10L
      )
  })
}

shinyApp(ui, server)

lindsayjorgenson / naccho.viz

Add logo on export #1