textProperties

From ReporteRs v0.8.8 by David Gohel

Text formatting properties

Create a textProperties object that describes text formatting properties.

Usage

textProperties(color = "black", font.size = getOption("ReporteRs-fontsize"),
  font.weight = "normal", font.style = "normal", underlined = FALSE,
  font.family = getOption("ReporteRs-default-font"),
  vertical.align = "baseline", shading.color)
# S3 method for textProperties
print(x, ...)
# S3 method for textProperties
as.character(x, ...)
# S3 method for textProperties
chprop(object, color, font.size, font.weight,
  font.style, underlined, font.family, vertical.align, shading.color, ...)

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.
font.weight: single character value specifying font weight (expected value is normal or bold).
font.style: single character value specifying font style (expected value is normal or italic).
underlined: single logical value specifying if the font is underlined.
font.family: single character value specifying font name (it has to be an existing font in the OS).
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").
x: textProperties object to print
...: further arguments - not used
object: textProperties object to update

Details

Get a modified version of a textProperties with chprop.

Value

a textProperties object

Examples

# NOT RUN {
textProperties( font.size = 12 )
textProperties(color="red", font.weight = "bold",
  font.style = "italic", underlined = TRUE )
textProperties( shading.color = "red" )
print( textProperties (color="red", font.size = 12) )

# chprop usage example ------
textProp <- textProperties()

chprop( textProp, color = "red" )
chprop( textProp, font.size = 12 )
chprop( textProp, font.weight = "bold" )
chprop( textProp, font.style = "italic" )
chprop( textProp, underlined = TRUE )
chprop( textProp, font.family = "Arial" )
chprop( textProp, vertical.align = "superscript" )
chprop( textProp, font.size = 12,
        font.weight = "bold", shading.color = "red" )
# }

Documentation reproduced from package ReporteRs, version 0.8.8, License: GPL-3

Community examples

Looks like there are no examples yet.