openxlsx2 (version 1.29)

create_font: Create font format

Description

This function creates font styles for a cell in a spreadsheet. It allows customization of various font properties including bold, italic, color, size, underline, and more.

Usage

create_font(
  b = "",
  charset = "",
  color = wb_color(hex = "FF000000"),
  condense = "",
  extend = "",
  family = "2",
  i = "",
  name = "Aptos Narrow",
  outline = "",
  scheme = "",
  shadow = "",
  strike = "",
  sz = "11",
  u = "",
  vert_align = "",
  ...
)

Value

A formatted font object to be used in a spreadsheet.

Arguments

b

Logical, whether the font should be bold.

charset

Character, the character set to be used. The list of valid IDs can be found in the Details section of fmt_txt().

color

A wb_color(), the color of the font. Default is "FF000000".

condense

Logical, whether the font should be condensed.

extend

Logical, whether the font should be extended.

family

Character, the font family. Default is "2" (modern). "0" (auto), "1" (roman), "2" (swiss), "3" (modern), "4" (script), "5" (decorative). # 6-14 unused

i

Logical, whether the font should be italic.

name

Character, the name of the font. Default is "Aptos Narrow".

outline

Logical, whether the font should have an outline.

scheme

Character, the font scheme. Valid values are "minor", "major", "none", or "". Default is "". If set to "minor" or "major", the spreadsheet software will pick the font from the active theme, using name only as a fallback.

shadow

Logical, whether the font should have a shadow.

strike

Logical, whether the font should have a strikethrough.

sz

Character, the size of the font. Default is "11".

u

Character, the underline style. Valid values are "single", "double", "singleAccounting", "doubleAccounting", "none".

vert_align

Character, the vertical alignment of the font. Valid values are "baseline", "superscript", "subscript".

...

Additional arguments passed to other methods.

See Also

wb_add_font()

Other style creating functions: create_border(), create_cell_style(), create_colors_xml(), create_dxfs_style(), create_fill(), create_numfmt(), create_tablestyle()

Examples

# Create a font with bold and italic styles
font <- create_font(
  b = TRUE,
  i = TRUE,
  color = wb_color(hex = "FF00FF00"),
  name = "Arial",
  sz = "12"
)

# openxml has the alpha value leading
hex8 <- unlist(xml_attr(read_xml(font), "font", "color"))
hex8 <- paste0("#", substr(hex8, 3, 8), substr(hex8, 1, 2))

# # write test color
# col <- crayon::make_style(col2rgb(hex8, alpha = TRUE))
# cat(col("Test"))