writexl (version 2.0.0)

xl_format: Combine cell-formatting groups into a single format

Description

`xl_format()` merges any number of [xl_format] objects (typically the single-group objects returned by [xl_font], [xl_fill], [xl_border], [xl_align], [xl_num_format] and [xl_protection]) into one combined format. The `+` operator does the same for two formats.

Merging is right-biased and works property-by-property: where two formats set the *same* property the later one wins, but properties set by only one side are all preserved. So partial groups accumulate rather than overwrite.

Usage

xl_format(..., quote_prefix = NA, hyperlink = NA)
# S3 method for xl_format
+(e1, e2)

Value

A combined [xl_format] object.

Arguments

...

[xl_format] objects (and/or `NULL`s, which are ignored). May also include the scalar flags `quote_prefix` and `hyperlink`.

quote_prefix

Logical; treat the cell contents as literal text (as if prefixed with a single quote in Excel).

hyperlink

Logical; apply the internal hyperlink style flag (advanced).

e1, e2

[xl_format] objects to combine.

See Also

[xl_font], [xl_fill], [xl_border], [xl_align], [xl_num_format], [xl_protection], [xl_color]

Other cell formatting: is_xl_format(), xl_color(), xl_format_groups

Examples

xl_format(xl_font(bold = TRUE), xl_border(bottom = "thin"),
          xl_num_format("#,##0.00"))

# equivalent, using +
xl_font(bold = TRUE) + xl_border(bottom = "thin") + xl_num_format("#,##0.00")