Search code examples
javascriptrhighchartsr-highcharter

Highcharter - add multiple text annotations


I have a stacked column plot where I need a text annotation below each column. I only found a way to add one annotation. Adding a second annotation yields the error All arguments must be named list. Sadly, I have know clue how to use the hc_annotations function.

Here is a little working example and code bits I tried:

hc <- highchart() %>% 
    hc_chart(type = "column") %>%
    hc_plotOptions(column = list(stacking = "normal")) %>%
    hc_title(text = "Plot with Annotations", useHTML = TRUE) %>%
    hc_yAxis(title = "") %>%
    hc_xAxis(title = "") %>%
    hc_xAxis(categories = c("A", "B", "C", "D", "E"))

hc <- hc %>%
    hc_add_series(name = "S1", data = c(5, 1, 2, 4, 5),
           dataLabels = list(format='{point.y:,.1f}', align = "center", enabled = TRUE))

hc <- hc %>%
    hc_add_series(name = "S2", data = c(-1, -4, 3, -2, -4),
           dataLabels = list(format='{point.y:,.1f}', align = "center", enabled = TRUE))


##try to add annotations

#1
hc <- hc %>%
    hc_annotations(list(xValue = 0, yValue = -2, title = list(text = '-6 pp'))) 
hc <- hc %>%
    hc_annotations(list(xValue = 1, yValue = -8, title = list(text = '-5 pp')))

#2 - basically the same as #1
hc <- hc %>%
    hc_annotations(list(xValue = 0, yValue = -2, title = list(text = '-6 pp'))) %>%
    hc_annotations(list(xValue = 1, yValue = -8, title = list(text = '-5 pp')))

#3
hc <- hc %>%
    hc_annotations(list(list(xValue = 0, yValue = -2, title = list(text = '-6 pp')),
                        list(xValue = 0, yValue = -8, title = list(text = '-5 pp')))
                   ) 

  hc

I just used here two annotations as showcase. In my final code in need one annotation below each column.


Solution

  • That is a known issue and it's solve with the next functions:

    • hc_add_annotation
    • hc_add_annotations

    Example of use:

    hc %>%
      hc_add_annotation(xValue = 0, yValue = -2, title = list(text = '-6 pp')) %>% 
      hc_add_annotation(xValue = 1, yValue = -4.5, title = list(text = '-5 pp'))
    
    hc %>% 
      hc_add_annotations(
        list(
          list(xValue = 0, yValue = -2, title = list(text = '-6 pp')),
          list(xValue = 1, yValue = -4.5, title = list(text = '-5 pp'))
          )
        )
    

    Or even better:

    df <- data_frame(
      xValue = c(0, 1),
      yValue = c(-2, -4.5),
      title = c("-6pp", "-5pp")
    )
    
    df <- df %>% 
      mutate(title = map(title, function(x) list(text = x)))
    
    df
    
    #> # A tibble: 2 x 3
    #>   xValue yValue      title
    #>    <dbl>  <dbl>     <list>
    #> 1      0   -2.0 <list [1]>
    #> 2      1   -4.5 <list [1]>
    
    hc %>% 
      hc_add_annotations(df)
    

    Reference: https://github.com/jbkunst/highcharter/issues/171