[pivot tables] add show_data_as and compact/outline

NEWS.md

@@ -1,5 +1,7 @@
 # openxlsx2 (development version)
 
+* Add new params to `wb_add_pivot_table()`. It is now possible to set the `show_data_as` value and set a tabular table design. [833](https://github.com/JanMarvin/openxlsx2/pull/833)
+
 
 ***************************************************************************
 

R/class-workbook-wrappers.R

@@ -305,6 +305,9 @@ wb_add_data_table <- function(
 #' `fun` can be any of `AVERAGE`, `COUNT`, `COUNTA`, `MAX`, `MIN`,
 #' `PRODUCT`, `STDEV`, `STDEVP`, `SUM`, `VAR`, `VARP`.
 #'
+#' `show_data_as` can be any of `normal`, `difference`, `percent`, `percentDiff`,
+#' `runTotal`, `percentOfRow`, `percentOfCol`, `percentOfTotal`, `index`.
+#'
 #' The sheet will be empty unless it is opened in spreadsheet software.
 #'
 #' @param wb A Workbook object containing a #' worksheet.

R/helper-functions.R

@@ -758,6 +758,15 @@ create_pivot_table <- function(
   }
 
   pivotField <- NULL
+
+  compact <- ""
+  if (!is.null(params$compact))
+    compact <- params$compact
+
+  outline <- ""
+  if (!is.null(params$outline))
+    outline <- params$outline
+
   for (i in seq_along(x)) {
 
     dataField <- NULL
@@ -814,7 +823,10 @@ create_pivot_table <- function(
       else                  sort <- "ascending"
     }
 
-    attrs <- c(axis, dataField, showAll = "0", sortType = sort)
+    attrs <- c(
+      axis, dataField, showAll = "0", sortType = sort,
+      compact = as_xml_attr(compact), outline = as_xml_attr(outline)
+    )
 
     tmp <- xml_node_create(
       "pivotField",
@@ -879,6 +891,11 @@ create_pivot_table <- function(
   if (use_data) {
 
     dataField <- NULL
+
+    show_data_as <- rep("", length(data))
+    if (!is.null(params$show_data_as))
+      show_data_as <- params$show_data_as
+
     for (i in seq_along(data)) {
 
       if (missing(fun)) fun <- NULL
@@ -888,12 +905,13 @@ create_pivot_table <- function(
         xml_node_create(
           "dataField",
           xml_attributes = c(
-            name      = sprintf("%s of %s", ifelse(is.null(fun[i]), "Sum", fun[i]), data[i]),
-            fld       = sprintf("%s", data_pos[i] - 1L),
-            subtotal  = fun[i],
-            baseField = "0",
-            baseItem  = "0",
-            numFmtId  = numfmts[i]
+            name       = sprintf("%s of %s", ifelse(is.null(fun[i]), "Sum", fun[i]), data[i]),
+            fld        = sprintf("%s", data_pos[i] - 1L),
+            showDataAs = as_xml_attr(ifelse(is.null(show_data_as[i]), "", show_data_as[i])),
+            subtotal   = fun[i],
+            baseField  = "0",
+            baseItem   = "0",
+            numFmtId   = numfmts[i]
           )
         )
       )
@@ -986,10 +1004,6 @@ create_pivot_table <- function(
   if (!is.null(params$multipleFieldFilters))
     multipleFieldFilters <- params$multipleFieldFilters
 
-  outline <- "1"
-  if (!is.null(params$outline))
-    outline <- params$outline
-
   outlineData <- "1"
   if (!is.null(params$outlineData))
     outlineData <- params$outlineData