Text formatting properties

Create a textProperties object that describes text formatting properties.

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

Value

a textProperties object

Details

Get a modified version of a textProperties with chprop.

See also

pot, alterFlexTable, shortcut_properties

Examples

textProperties( font.size = 12 )
#> {color:rgba(0,0,0,1.00);font-size:12;font-weight:normal;font-style:normal;underlined:FALSE;font-family:Helvetica;vertical.align:baseline;}
textProperties(color="red", font.weight = "bold",
  font.style = "italic", underlined = TRUE )
#> {color:rgba(255,0,0,1.00);font-size:10;font-weight:bold;font-style:italic;underlined:TRUE;font-family:Helvetica;vertical.align:baseline;}
textProperties( shading.color = "red" )
#> {color:rgba(0,0,0,1.00);font-size:10;font-weight:normal;font-style:normal;underlined:FALSE;font-family:Helvetica;background-color:rgba(255,0,0,1.00);vertical.align:baseline;}
print( textProperties (color="red", font.size = 12) )
#> {color:rgba(255,0,0,1.00);font-size:12;font-weight:normal;font-style:normal;underlined:FALSE;font-family:Helvetica;vertical.align:baseline;}

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

chprop( textProp, color = "red" )
#> {color:rgba(255,0,0,1.00);font-size:10;font-weight:normal;font-style:normal;underlined:FALSE;font-family:Helvetica;vertical.align:baseline;}
chprop( textProp, font.size = 12 )
#> {color:rgba(0,0,0,1.00);font-size:12;font-weight:normal;font-style:normal;underlined:FALSE;font-family:Helvetica;vertical.align:baseline;}
chprop( textProp, font.weight = "bold" )
#> {color:rgba(0,0,0,1.00);font-size:10;font-weight:bold;font-style:normal;underlined:FALSE;font-family:Helvetica;vertical.align:baseline;}
chprop( textProp, font.style = "italic" )
#> {color:rgba(0,0,0,1.00);font-size:10;font-weight:normal;font-style:italic;underlined:FALSE;font-family:Helvetica;vertical.align:baseline;}
chprop( textProp, underlined = TRUE )
#> {color:rgba(0,0,0,1.00);font-size:10;font-weight:normal;font-style:normal;underlined:TRUE;font-family:Helvetica;vertical.align:baseline;}
chprop( textProp, font.family = "Arial" )
#> {color:rgba(0,0,0,1.00);font-size:10;font-weight:normal;font-style:normal;underlined:FALSE;font-family:Arial;vertical.align:baseline;}
chprop( textProp, vertical.align = "superscript" )
#> {color:rgba(0,0,0,1.00);font-size:10;font-weight:normal;font-style:normal;underlined:FALSE;font-family:Helvetica;vertical.align:superscript;}
chprop( textProp, font.size = 12,
        font.weight = "bold", shading.color = "red" )
#> {color:rgba(0,0,0,1.00);font-size:12;font-weight:bold;font-style:normal;underlined:FALSE;font-family:Helvetica;background-color:rgba(255,0,0,1.00);vertical.align:baseline;}