cellProperties: create a 'cellProperties' object.

In davidgohel/R2DOC: RDocument Tools

Description

Create a cellProperties object without using new("cellProperties", ...).

Usage

cellProperties( border.bottom.color = "black"
		, border.bottom.style = "solid", border.bottom.width = 1, border.left.color = "black"
		, border.left.style = "solid", border.left.width = 1, border.top.color = "black"
		, border.top.style = "solid", border.top.width = 1, border.right.color = "black"
		, border.right.style = "solid", border.right.width = 1, vertical.align = "middle"
		, padding.bottom = 2, padding.top = 2, padding.left = 3, padding.right = 3
		, padding, border.width, border.style, border.color ) 

Arguments

border.bottom.color	border bottom color.
border.bottom.style	border bottom style.
border.bottom.width	border bottom width.
border.top.color	border top color.
border.top.style	border top style.
border.top.width	border top width.
border.left.color	border left color.
border.left.style	border left style.
border.left.width	border left width.
border.right.color	border right color.
border.right.style	border right style.
border.right.width	border right width.
vertical.align	cell content vertical alignment. Expected value is one of c("top", "bottom", "middle").
padding.bottom	cell bottom padding.
padding.top	cell top padding.
padding.left	cell left padding.
padding.right	cell right padding.
padding	cell paddings. Expected value must be >=0 (no unit). It sets all paddings to the same value.
border.width	cell borders width. Expected value must be >=0 (no unit). It sets all borders widths to the same value.
border.style	cell borders style. See details for expected value. It sets all borders styles to the same value.
border.color	cell borders color. It sets all borders colors to the same value.

Details

Color arguments (border.*.color, border.color): character single value ; expected value is a valid color.
Border width arguments (border.*.width, border.width): integer single value representing border width in px unit, value must be >=0.
Border style arguments (border.*.style, border.style): character single value representing border style, expected value is one of c( "none", "hidden", "dotted", "dashed", "solid", "double", "inset", "outset" ).
Padding arguments (padding.*, padding): integer single value representing text padding of cell in px unit, value must be >=0.
Vertical align arguments (vertical.align): character single value representing text vertical alignment of cell, expected value is one of c("top", "bottom", "middle").

padding is a shortcut that provide its value to the 4 padding.* parameters.
border.width is a shortcut that provide its value to the 4 border.*.width parameters.
border.style is a shortcut that provide its value to the 4 border.*.style parameters.
border.color is a shortcut that provide its value to the 4 border.*.color parameters.

Value

an cellProperties object

See Also

tableProperties, tableProperties object
parProperties, parProperties object
textProperties, textProperties object
cellProperties object

Examples

cellProperties( border.color = "gray" )

davidgohel/R2DOC documentation built on May 14, 2019, 11:11 p.m.