add gradientFill option to `create_dxfs_style()

Author: JanMarvin

R/wb_styles.R

@@ -667,6 +667,7 @@ get_cell_styles <- function(wb, sheet, cell) {
 #' @param border_style "thin"
 #' @param bgFill Cell background fill color.
 #' @param fgColor Cell foreground fill color.
+#' @param gradientFill An xml string beginning with <gradientFill> ...
 #' @param text_bold bold
 #' @param text_strike strikeout
 #' @param text_italic italic
@@ -706,6 +707,7 @@ create_dxfs_style <- function(
     border_style   = getOption("openxlsx2.borderStyle", "thin"),
     bgFill         = NULL,
     fgColor        = NULL,
+    gradientFill   = NULL,
     text_bold      = NULL,
     text_strike    = NULL,
     text_italic    = NULL,
@@ -742,8 +744,14 @@ create_dxfs_style <- function(
     patternType <- "solid"
   }
 
-  if (!is.null(bgFill) && !all(bgFill == "")) {
-    fill <- create_fill(patternType = patternType, bgColor = bgFill, fgColor = fgColor)
+  if (!is.null(bgFill) && !all(bgFill == "") || !is.null(gradientFill)) {
+    if (is.null(gradientFill)) {
+      # gradientFill is an xml string
+      gradientFill <- ""
+    } else {
+      patternType  <- ""
+    }
+    fill <- create_fill(patternType = patternType, bgColor = bgFill, fgColor = fgColor, gradientFill = gradientFill)
   } else {
     fill <- NULL
   }

man/create_dxfs_style.Rd

@@ -767,3 +767,26 @@ test_that("un_list works", {
   expect_equal(pre_save, post_save)
 
 })
+
+test_that("conditional formatting with gradientFill works", {
+
+  gf <- read_xml(
+    "<gradientFill degree=\"45\">
+      <stop position=\"0\"><color rgb=\"FFFFC000\"/></stop>
+      <stop position=\"1\"><color rgb=\"FF00B0F0\"/></stop>
+   </gradientFill>",
+    pointer = FALSE)
+
+  gf_style <- create_dxfs_style(gradientFill = gf)
+
+  wb <- wb_workbook()$
+    add_worksheet()$
+    add_data(x = 1)$
+    add_conditional_formatting(cols = 1, rows = 1, rule = "==1", style = "gf_style")$
+    add_style(gf_style)
+
+  exp <- "<dxf><fill><gradientFill degree=\"45\"><stop position=\"0\"><color rgb=\"FFFFC000\"/></stop><stop position=\"1\"><color rgb=\"FF00B0F0\"/></stop></gradientFill></fill></dxf>"
+  got <- wb$styles_mgr$styles$dxfs
+  expect_equal(exp, got)
+
+})