ReporteRs (version 0.5.8)

chprop.cellProperties: Modify a cell formatting properties object

Description

Modify an object of class cellProperties.

Usage

# S3 method for cellProperties
chprop(object, border.bottom.color,
  border.bottom.style, border.bottom.width, border.left.color,
  border.left.style, border.left.width, border.top.color, border.top.style,
  border.top.width, border.right.color, border.right.style, border.right.width,
  vertical.align, padding.bottom, padding.top, padding.left, padding.right,
  background.color, padding, border.width, border.style, border.color, ...)

Arguments

object

cellProperties object to modify

...

further arguments - not used

border.bottom.color

border bottom color - a single character value specifying a valid color (e.g. "#000000" or "black").

border.bottom.style

border bottom style - a single character value, expected value is one of "none", "solid", "dotted", "dashed".

border.bottom.width

border bottom width - 0 or positive integer value

border.left.color

border left color - a single character value specifying a valid color (e.g. "#000000" or "black").

border.left.style

border left style - a single character value, expected value is one of "none", "solid", "dotted", "dashed".

border.left.width

border left width - 0 or positive integer value

border.top.color

border top color - a single character value specifying a valid color (e.g. "#000000" or "black").

border.top.style

border top style - a single character value, expected value is one of "none", "solid", "dotted", "dashed".

border.top.width

border top width - 0 or positive integer value

border.right.color

border right color - a single character value specifying a valid color (e.g. "#000000" or "black").

border.right.style

border right style - a single character value, expected value is one of "none", "solid", "dotted", "dashed".

border.right.width

border right width - 0 or positive integer value

vertical.align

cell content vertical alignment - a single character value , expected value is one of "center" or "top" or "bottom"

padding.bottom

cell bottom padding - 0 or positive integer value.

padding.top

cell top padding - 0 or positive integer value.

padding.left

cell left padding - 0 or positive integer value.

padding.right

cell right padding - 0 or positive integer value.

background.color

cell background color - a single character value specifying a valid color (e.g. "#000000" or "black").

padding

cell padding - 0 or positive integer value. Argument padding overwrites arguments padding.bottom, padding.top, padding.left, padding.right.

border.width

border width - 0 or positive integer value. Argument border.width overwrites arguments border.bottom.width, border.top.width , border.left.width, border.right.width.

border.style

border style - a single character value, expected value is one of "none" , "solid", "dotted", "dashed". Argument border.style overwrites arguments border.bottom.style, border.top.style, border.left.style , border.right.style.

border.color

border color - a single character value specifying a valid color (e.g. "#000000" or "black"). Argument border.color overwrites arguments border.bottom.color , border.top.color, border.left.color, border.right.color.

Value

a cellProperties object

See Also

cellProperties, parProperties, textProperties , chprop.parProperties, chprop.textProperties , FlexTable, tableProperties, addTable

Examples

# NOT RUN {
#START_TAG_TEST
cellProp = cellProperties()

cellProp01 = chprop( cellProp, border.bottom.color = "#8A949B" )
cellProp02 = chprop( cellProp, border.right.color = "#8A949B" )
cellProp03 = chprop( cellProp, border.left.color = "#8A949B" )
cellProp04 = chprop( cellProp, border.top.color = "#8A949B" )
cellProp05 = chprop( cellProp, border.color = "#8A949B" )

cellProp06 = chprop( cellProp, border.bottom.width = 2 )
cellProp07 = chprop( cellProp, border.left.width = 2 )
cellProp08 = chprop( cellProp, border.top.width = 2 )
cellProp09 = chprop( cellProp, border.right.width = 2 )
cellProp10 = chprop( cellProp, border.width = 2 )

cellProp11 = chprop( cellProp, padding.bottom = 5 )
cellProp12 = chprop( cellProp, padding.top = 5 )
cellProp13 = chprop( cellProp, padding.left = 5 )
cellProp14 = chprop( cellProp, padding.right = 5 )
cellProp15 = chprop( cellProp, padding = 5 )

cellProp16 = chprop( cellProp, border.bottom.style = "dotted" )
cellProp17 = chprop( cellProp, border.left.style = "dotted" )
cellProp18 = chprop( cellProp, border.top.style = "dotted" )
cellProp19 = chprop( cellProp, border.right.style = "dotted" )
cellProp20 = chprop( cellProp, border.style = "dotted" )

cellProp21 = chprop( cellProp, vertical.align = "middle" )
cellProp22 = chprop( cellProp, background.color = "#517281" )

cellProp23 = chprop( cellProp, background.color = "#517281"
  , border.color = "#F37257", border.width = 2  )
#STOP_TAG_TEST
# }