fp_par function

Paragraph formatting properties

Create a fp_par object that describes paragraph formatting properties.

fp_par(
  text.align = "left",
  padding = 0,
  line_spacing = 1,
  border = fp_border(width = 0),
  padding.bottom,
  padding.top,
  padding.left,
  padding.right,
  border.bottom,
  border.left,
  border.top,
  border.right,
  shading.color = "transparent",
  keep_with_next = FALSE,
  tabs = NULL,
  word_style = "Normal"
)

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

## S3 method for class 'fp_par'
update(
  object,
  text.align,
  padding,
  border,
  padding.bottom,
  padding.top,
  padding.left,
  padding.right,
  border.bottom,
  border.left,
  border.top,
  border.right,
  shading.color,
  keep_with_next,
  word_style,
  ...
)

Arguments

• text.align: text alignment - a single character value, expected value is one of 'left', 'right', 'center', 'justify'.
• padding: paragraph paddings - 0 or positive integer value. Argument padding overwrites arguments padding.bottom, padding.top, padding.left, padding.right.
• line_spacing: line spacing, 1 is single line spacing, 2 is double line spacing.
• border: shortcut for all borders.
• padding.bottom, padding.top, padding.left, padding.right: paragraph paddings - 0 or positive integer value.
• border.bottom, border.left, border.top, border.right: fp_border for borders. overwrite other border properties.
• shading.color: shading color - a single character value specifying a valid color (e.g. "#000000" or "black").
• keep_with_next: a scalar logical. Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible.
• tabs: NULL (default) for no tabulation marks setting or an object returned by fp_tabs(). Note this can only have effect with Word or RTF outputs.
• word_style: Word paragraph style name
• x, object: fp_par object
• ...: further arguments - not used

Returns

a fp_par object

Examples

fp_par(text.align = "center", padding = 5)
obj <- fp_par(text.align = "center", padding = 1)
update(obj, padding.bottom = 5)

See Also

fpar

Other functions for defining formatting properties: fp_border(), fp_cell(), fp_tab(), fp_tabs(), fp_text()