border: Cell borders update

View source: R/borders.R

borderR Documentation

Cell borders update

Description

change borders of selected rows and columns of a flextable. This function is not to be used by end user (it requires careful settings to avoid overlapping borders) but only for programming purposes.

If you need to add borders, use instead other functions:

These set borders for the whole table : border_outer(), border_inner_h() and border_inner_v().

To add horizontal or vertical lines in the table at specific location, use:

  • hline(): set bottom borders (inner horizontal)

  • vline(): set right borders (inner vertical)

To add following horizontal or vertical lines at beginning or end of the table, use:

  • hline_top(): set the top border (outer horizontal)

  • hline_bottom(): set the bottom border (outer horizontal)

  • vline_left(): set the left border (outer vertical)

  • vline_right(): set the right border (outer vertical)

If you want to highlight specific cells with some borders, use surround().

Usage

border(
  x,
  i = NULL,
  j = NULL,
  border = NULL,
  border.top = NULL,
  border.bottom = NULL,
  border.left = NULL,
  border.right = NULL,
  part = "body"
)

Arguments

x

a flextable object

i

rows selection

j

columns selection

border

border (shortcut for top, bottom, left and right)

border.top

border top

border.bottom

border bottom

border.left

border left

border.right

border right

part

partname of the table (one of 'all', 'body', 'header', 'footer')

Note

pdf and pptx outputs do not support border() usage.

Examples

library(officer)
ftab <- flextable(head(mtcars))
ftab <- border(ftab, border.top = fp_border(color = "orange"))
ftab

flextable documentation built on Oct. 23, 2023, 1:07 a.m.