ReporteRs (version 0.7.1)

chprop.parProperties: Modify paragraph formatting properties

Description

Modify an object of class parProperties.

Usage

# S3 method for parProperties
chprop(object, text.align, padding.bottom, padding.top,
  padding.left, padding.right, padding, list.style, level, border.bottom,
  border.left, border.top, border.right, shading.color, ...)

Arguments

object

parProperties object to modify

text.align

text alignment - a single character value, expected value is one of 'left', 'right', 'center', 'justify'.

padding.bottom

paragraph bottom padding - 0 or positive integer value.

padding.top

paragraph top padding - 0 or positive integer value.

padding.left

paragraph left padding - 0 or positive integer value.

padding.right

paragraph right padding - 0 or positive integer value.

padding

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

list.style

list style - a single character value, expected value is one of 'none' (default), 'unordered', 'ordered', 'blockquote'.

level

list level if argument list is not 'none'.

border.bottom

borderProperties for bottom border. overwrite all border.bottom.* if specified.

border.left

borderProperties for left border. overwrite all border.left.* if specified.

border.top

borderProperties for top border. overwrite all border.top.* if specified.

border.right

borderProperties for right border. overwrite all border.right.* if specified.

shading.color

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

...

further arguments - not used

Value

a parProperties object

See Also

parProperties

Examples

# NOT RUN {
#START_TAG_TEST
parProp = parProperties()

parProp01 = chprop( parProp, text.align = "center" )
parProp02 = chprop( parProp, padding.bottom = 2 )
parProp03 = chprop( parProp, padding.top = 2 )
parProp04 = chprop( parProp, padding.left = 2 )
parProp05 = chprop( parProp, padding = 2 )

parProp06 = chprop( parProp, padding = 2, text.align = "center" )
#STOP_TAG_TEST
# }