Paragraph formatting properties

Description

Create a parProperties object that describes paragraph formatting properties.

Usage

parProperties(text.align = "left", padding.bottom = 1, padding.top = 1,
  padding.left = 1, padding.right = 1, padding, list.style = "none",
  level = 1, border.bottom = borderNone(), border.left = borderNone(),
  border.top = borderNone(), border.right = borderNone(), shading.color)

## S3 method for class '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, ...)

## S3 method for class 'parProperties'
print(x, ...)

Arguments

Details

parProperties is used to control paragraph properties. It is used when adding plots or when adding content in a FlexTable.

Default values are:

• text.align "left"

• padding.bottom 1

• padding.top 1

• padding.left 1

• padding.right 1

• list.style 'none'

• level 1

Get a modified version of a parProperties with chprop.

Value

a parProperties object

See Also

alterFlexTable, addParagraph, shortcut_properties

Examples

# parProperties examples -------
parProperties( text.align = "center", padding = 5)

parProperties( text.align = "center", 
  padding.top = 5,
  padding.bottom = 0,
  padding.left = 2,
  padding.right = 0
)

parProperties( list.style = "ordered", level = 2)

parProperties( list.style = "unordered", level = 2)

# chprop usage example ------
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" )

Results

R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(ReporteRs)
Loading required package: ReporteRsjars
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/ReporteRs/parProperties.Rd_%03d_medium.png", width=480, height=480)
> ### Name: parProperties
> ### Title: Paragraph formatting properties
> ### Aliases: chprop.parProperties parProperties print.parProperties
> 
> ### ** Examples
> 
> # parProperties examples -------
> parProperties( text.align = "center", padding = 5)
{text-align: center ;padding-bottom: 5 ;padding-top: 5 ;padding-left: 5 ;padding-right: 5 ;list.style: none ;level: 1 ;}
border.bottom: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.top: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.left: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.right: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ; 
> 
> parProperties( text.align = "center", 
+   padding.top = 5,
+   padding.bottom = 0,
+   padding.left = 2,
+   padding.right = 0
+ )
{text-align: center ;padding-bottom: 0 ;padding-top: 5 ;padding-left: 2 ;padding-right: 0 ;list.style: none ;level: 1 ;}
border.bottom: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.top: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.left: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.right: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ; 
> 
> parProperties( list.style = "ordered", level = 2)
{text-align: left ;padding-bottom: 1 ;padding-top: 1 ;padding-left: 1 ;padding-right: 1 ;list.style: ordered ;level: 2 ;}
border.bottom: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.top: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.left: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.right: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ; 
> 
> parProperties( list.style = "unordered", level = 2)
{text-align: left ;padding-bottom: 1 ;padding-top: 1 ;padding-left: 1 ;padding-right: 1 ;list.style: unordered ;level: 2 ;}
border.bottom: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.top: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.left: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ;border.right: borderProperties{color:rgba(0,0,0,1.00);style:none;width:1;} ; 
> 
> # chprop usage example ------
> 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" )
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>