Create a officer::fp_text() object whose unspecified
arguments inherit from set_flextable_defaults() (font family, size, color).
Use fp_text_default() instead of officer::fp_text() when building
chunks with as_chunk(): only override the properties you need,
and the rest will match the table's default style.
See also set_flextable_defaults() to modify the inherited values.
Usage
fp_text_default(
color = flextable_global$defaults$font.color,
font.size = flextable_global$defaults$font.size,
bold = FALSE,
italic = FALSE,
underlined = FALSE,
strike = FALSE,
font.family = flextable_global$defaults$font.family,
cs.family = NULL,
eastasia.family = NULL,
hansi.family = NULL,
vertical.align = "baseline",
shading.color = "transparent"
)Arguments
- color
font color - a single character value specifying a valid color (e.g. "#000000" or "black").
- font.size
font size (in point) - 0 or positive integer value.
- bold
is bold
- italic
is italic
- underlined
is underlined
- strike
is strikethrough
- font.family
single character value. Specifies the font to be used to format characters in the Unicode range (U+0000-U+007F).
- cs.family
optional font to be used to format characters in a complex script Unicode range. For example, Arabic text might be displayed using the "Arial Unicode MS" font.
- eastasia.family
optional font to be used to format characters in an East Asian Unicode range. For example, Japanese text might be displayed using the "MS Mincho" font.
- hansi.family
optional. Specifies the font to be used to format characters in a Unicode range which does not fall into one of the other categories.
- vertical.align
single character value specifying font vertical alignments. Expected value is one of the following : default
'baseline'or'subscript'or'superscript'- shading.color
shading color - a single character value specifying a valid color (e.g. "#000000" or "black").
See also
as_chunk(), compose(), append_chunks(), prepend_chunks()
Other functions for defining formatting properties:
fp_border_default()
Examples
library(flextable)
set_flextable_defaults(
font.size = 11, font.color = "#303030",
padding = 3, table.layout = "autofit"
)
z <- flextable(head(cars))
z <- compose(
x = z,
i = ~ speed < 6,
j = "speed",
value = as_paragraph(
as_chunk("slow... ", props = fp_text_default(color = "red")),
as_chunk(speed, props = fp_text_default(italic = TRUE))
)
)
z
speed
dist
slow... 4.0
2
slow... 4.0
10
7
4
7
22
8
16
9
10
init_flextable_defaults()