Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update style vignette #618

Merged
merged 1 commit into from
May 19, 2023
Merged

update style vignette #618

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
96 changes: 47 additions & 49 deletions vignettes/openxlsx2_style_manual.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,23 @@ knitr::include_graphics("img/worksheet_styling.jpg")
set.seed(123)
mat <- matrix(rnorm(28 * 28, mean = 44444, sd = 555), ncol = 28)
colnames(mat) <- make.names(seq_len(ncol(mat)))
border_col <- wb_color(theme = "1")
border_col <- wb_color(theme = 1)
border_sty <- "thin"

# prepare workbook with data and formated first row
wb <- wb_workbook() %>%
wb_add_worksheet("test") %>%
wb_add_data("test", mat) %>%
wb_add_border("test", "A1:AB1",
wb_add_data(x = mat) %>%
wb_add_border(dims = "A1:AB1",
top_color = border_col, top_border = border_sty,
bottom_color = border_col, bottom_border = border_sty,
left_color = border_col, left_border = border_sty,
right_color = border_col, right_border = border_sty,
inner_hcolor = border_col, inner_hgrid = border_sty
) %>%
wb_add_fill("test", "A1:AB1", color = wb_color(hex = "FF334E6F")) %>%
wb_add_font("test", "A1:AB1", name = "Arial", bold = "1", color = wb_color(hex = "FFFFFFFF"), size = "20") %>%
wb_add_cell_style("test", "A1:AB1", horizontal = "center", textRotation = "45")
wb_add_fill(dims = "A1:AB1", color = wb_color(hex = "FF334E6F")) %>%
wb_add_font(dims = "A1:AB1", name = "Arial", bold = TRUE, color = wb_color(hex = "FFFFFFFF"), size = 20) %>%
wb_add_cell_style(dims = "A1:AB1", horizontal = "center", textRotation = 45)

# create various number formats
x <- c(
Expand All @@ -63,7 +63,7 @@ x <- c(
# apply the styles
for (i in seq_along(x)) {
cell <- sprintf("%s2:%s29", int2col(i), int2col(i))
wb <- wb_add_numfmt(wb, "test", cell, x[i])
wb <- wb %>% wb_add_numfmt(dims = cell, numfmt = x[i])
}

# wb$open()
Expand All @@ -72,17 +72,16 @@ for (i in seq_along(x)) {
### the long way: using bare metal functions
```{r}
# create workbook
wb <- wb_workbook()
wb <- wb_add_worksheet(wb, "test")
wb <- wb_workbook() %>% wb_add_worksheet("test")

# add some dummy data to the worksheet
set.seed(123)
mat <- matrix(rnorm(28 * 28, mean = 44444, sd = 555), ncol = 28)
colnames(mat) <- make.names(seq_len(ncol(mat)))
wb$add_data("test", mat, colNames = TRUE)
wb$add_data(x = mat, colNames = TRUE)

# create a border style and assign it to the workbook
black <- c(rgb = "FF000000")
black <- wb_color(hex = "FF000000")
new_border <- create_border(
bottom = "thin", bottom_color = black,
top = "thin", top_color = black,
Expand All @@ -97,14 +96,14 @@ new_fill <- create_fill(patternType = "solid", fgColor = wb_color(hex = "FF334E6
wb$styles_mgr$add(new_fill, "new_fill")

# create a font style and assign it to the workbook
new_font <- create_font(sz = "20", name = "Arial", b = "1", color = wb_color(hex = "FFFFFFFF"))
new_font <- create_font(sz = 20, name = "Arial", b = TRUE, color = wb_color(hex = "FFFFFFFF"))
wb$styles_mgr$add(new_font, "new_font")

# create a new cell style, that uses the fill, the font and the border style
new_cellxfs <- create_cell_style(
numFmtId = "0",
numFmtId = 0,
horizontal = "center",
textRotation = "45",
textRotation = 45,
fillId = wb$styles_mgr$get_fill_id("new_fill"),
fontId = wb$styles_mgr$get_font_id("new_font"),
borderId = wb$styles_mgr$get_border_id("new_border")
Expand All @@ -114,14 +113,16 @@ wb$styles_mgr$add(new_cellxfs, "new_styles")

# assign the new cell style to the header row of our data set
cell <- sprintf("A1:%s1", int2col(nrow(mat)))
wb_set_cell_style(wb, "test", cell, wb$styles_mgr$get_xf_id("new_styles"))
wb <- wb %>% wb_set_cell_style(
dims = cell,
style = wb$styles_mgr$get_xf_id("new_styles")
)

## style the cells with some builtin format codes (no new numFmt entry is needed)
# add builtin style ids
x <- c(
"0", "1", "2", "3", "4", "9", "10", "11", "12", "13", "14", "15", "16",
"17", "18", "19", "20", "21", "22", "37", "38", "39", "40", "45", "46",
"47", "48", "49"
1, 2, 3, 4, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,
37, 38, 39, 40, 45, 46, 47, 48, 49
)

# create styles
Expand All @@ -136,7 +137,7 @@ for (i in seq_along(x)) {
new_styles <- wb$styles_mgr$get_xf()
for (i in as.integer(new_styles$id[new_styles$name %in% paste0("new_style", seq_along(x))])) {
cell <- sprintf("%s2:%s29", int2col(i), int2col(i))
wb_set_cell_style(wb, "test", cell, i)
wb <- wb %>% wb_set_cell_style(dims = cell, style = i)
}

# assign a custom tabColor
Expand Down Expand Up @@ -227,14 +228,12 @@ options("openxlsx2.numFmt" = NULL)

## wb_set_col_widths
```{r}
sheet <- "mtcars"
wb <- wb_workbook()
wb <- wb_add_worksheet(wb, sheet)
wb$add_data(sheet, mtcars, rowNames = TRUE)
wb <- wb_workbook() %>%
wb_add_worksheet() %>%
wb_add_data(x = mtcars, rowNames = TRUE)

cols <- 1:12
wb <- wb_set_col_widths(wb, sheet, cols = cols, widths = "auto")
wb
wb <- wb %>% wb_set_col_widths(cols = cols, widths = "auto")
```

# Adding borders
Expand All @@ -246,15 +245,15 @@ wb <- wb_workbook()
wb$add_worksheet("S1", gridLines = FALSE)$add_data(x = mtcars)
wb$add_border(
dims = "A2:K33",
inner_hgrid = "thin", inner_hcolor = c(rgb = "FF808080"),
inner_vgrid = "thin", inner_vcolor = c(rgb = "FF808080")
inner_hgrid = "thin", inner_hcolor = wb_color(hex = "FF808080"),
inner_vgrid = "thin", inner_vcolor = wb_color(hex = "FF808080")
)
# only horizontal grid
wb$add_worksheet("S2", gridLines = FALSE)$add_data(x = mtcars)
wb$add_border(dims = "A2:K33", inner_hgrid = "thin", inner_hcolor = c(rgb = "FF808080"))
wb$add_border(dims = "A2:K33", inner_hgrid = "thin", inner_hcolor = wb_color(hex = "FF808080"))
# only vertical grid
wb$add_worksheet("S3", gridLines = FALSE)$add_data(x = mtcars)
wb$add_border(dims = "A2:K33", inner_vgrid = "thin", inner_vcolor = c(rgb = "FF808080"))
wb$add_border(dims = "A2:K33", inner_vgrid = "thin", inner_vcolor = wb_color(hex = "FF808080"))
# no inner grid
wb$add_worksheet("S4", gridLines = FALSE)$add_data(x = mtcars)
wb$add_border("S4", dims = "A2:K33")
Expand Down Expand Up @@ -283,15 +282,15 @@ wb <- wb_workbook() %>%
# add border for first row
wb_add_border(
dims = "B2:C2",
bottom_color = c(theme = "1"), bottom_border = "thin",
top_color = c(theme = "1"), top_border = "double",
left_border = "", right_border = ""
bottom_color = wb_color(theme = 1), bottom_border = "thin",
top_color = wb_color(theme = 1), top_border = "double",
left_border = NULL, right_border = NULL
) %>%
# add border for last row
wb_add_border(
dims = "B4:C4",
bottom_color = c(theme = "1"), bottom_border = "double",
top_border = "", left_border = "", right_border = ""
bottom_color = wb_color(theme = 1), bottom_border = "double",
top_border = NULL, left_border = NULL, right_border = NULL
)
```

Expand All @@ -301,13 +300,12 @@ wb <- wb_workbook() %>%
mat <- matrix(1:4, ncol = 2, nrow = 2)
colnames(mat) <- make.names(seq_len(ncol(mat)))

wb <- wb_workbook()
wb <- wb_add_worksheet(wb, "test")

wb$add_data("test", mat, colNames = TRUE, startCol = 2, startRow = 2)
wb <- wb_workbook() %>%
wb_add_worksheet("test") %>%
wb_add_data(x = mat, startCol = 2, startRow = 2)

# create a border style and assign it to the workbook
black <- c(rgb = "FF000000")
black <- wb_color(hex = "FF000000")
top_border <- create_border(
top = "double", top_color = black,
bottom = "thin", bottom_color = black
Expand All @@ -320,12 +318,12 @@ wb$styles_mgr$add(bottom_border, "bottom_border")

# create a new cell style, that uses the fill, the font and the border style
top_cellxfs <- create_cell_style(
numFmtId = "0",
numFmtId = 0,
horizontal = "center",
borderId = wb$styles_mgr$get_border_id("top_border")
)
bottom_cellxfs <- create_cell_style(
numFmtId = "0",
numFmtId = 0,
borderId = wb$styles_mgr$get_border_id("bottom_border")
)

Expand All @@ -335,12 +333,12 @@ wb$styles_mgr$add(bottom_cellxfs, "bottom_styles")

# assign the new cell style to the header row of our data set
cell <- "B2:C2"
wb_set_cell_style(wb, "test", cell, wb$styles_mgr$get_xf_id("top_styles"))
wb <- wb %>% wb_set_cell_style(dims = cell, style = wb$styles_mgr$get_xf_id("top_styles"))
cell <- "B4:C4"
wb_set_cell_style(wb, "test", cell, wb$styles_mgr$get_xf_id("bottom_styles"))
wb <- wb %>% wb_set_cell_style(dims = cell, style = wb$styles_mgr$get_xf_id("bottom_styles"))
```

### Use workbook colors and modify them
# Use workbook colors and modify them

The loop below will apply the tint attribute to the fill color

Expand All @@ -358,15 +356,15 @@ for (i in 0:9) {
col <- paste0(int2col(i + 1), which(tints %in% tnt))

if (tnt == 0) {
wb <- wb %>% wb_add_fill(dims = col, color = wb_color(theme = as.character(i)))
wb <- wb %>% wb_add_fill(dims = col, color = wb_color(theme = i))
} else {
wb <- wb %>% wb_add_fill(dims = col, color = wb_color(theme = as.character(i), tint = tnt))
wb <- wb %>% wb_add_fill(dims = col, color = wb_color(theme = i, tint = tnt))
}
}
}
```

### Copy cell styles
# Copy cell styles

It is possible to copy the styles of several cells at once. In the following example, the styles of some cells from a formatted workbook are applied to a previously empty cell range. Be careful though, `wb_get_cell_style()` returns only some styles, so you have to make sure that the copy-from and copy-to dimensions match in a meaningful way.

Expand All @@ -376,7 +374,7 @@ wb <- wb_load(system.file("extdata", "oxlsx2_sheet.xlsx", package = "openxlsx2")
# wb_open(wb)
```

### Style strings
# Style strings

Using `fmt_txt()` is possible to style strings indepentenly of the cell containing the string.

Expand All @@ -403,7 +401,7 @@ wb <- wb_workbook()$add_worksheet()$add_data(x = df, na.strings = na_red)
```


### Create custom table styles
# Create custom table styles

With `create_tablestyle()` it is possible to create your own table styles. This function uses `create_dxfs_style()` (just like your spreadsheet software does). Therefore, it is not quite as user-friendly. The following example shows how the function creates a red table style. The various dxfs styles must be created and assigned to the workbook (similar styles are used in conditional formatting). In `create_tablestyle()` these styles are assigned to the table style elements. Once the table style is created, it must also be assigned to the workbook. After that you can use it in the workbook like any other table style.

Expand Down