Set borders

These functions set borders between cells.

left_border(ht)
left_border(ht) <- value
set_left_border(ht, row, col, value = 0.4)
map_left_border(ht, row, col, fn)

right_border(ht)
right_border(ht) <- value
set_right_border(ht, row, col, value = 0.4)
map_right_border(ht, row, col, fn)

top_border(ht)
top_border(ht) <- value
set_top_border(ht, row, col, value = 0.4)
map_top_border(ht, row, col, fn)

bottom_border(ht)
bottom_border(ht) <- value
set_bottom_border(ht, row, col, value = 0.4)
map_bottom_border(ht, row, col, fn)

# S3 method for class 'huxtable'
left_border(ht) <- value

# S3 method for class 'huxtable'
right_border(ht) <- value

# S3 method for class 'huxtable'
top_border(ht) <- value

# S3 method for class 'huxtable'
bottom_border(ht) <- value

Arguments

ht

A huxtable.

value

A numeric thickness or a brdr() object.

row

A row specifier. See rowspecs for details.

col

An optional column specifier.

fn

A mapping function. See mapping-functions for details.

Details

Borders are always "collapsed": right_border(ht)[, 1] is the same as left_border(ht)[, 2], and setting one sets the other.

Setting left_border(ht) <- number sets the border thickness. You can set multiple properties at once by using brdr().

Currently in LaTeX, all non-zero border widths on a given line must be the same.

Limitations

• In HTML, you will need to set a width of at least 3 to get a double border.

• Only "solid" and "double" styles are currently implemented in LaTeX, and all non-zero horizontal border widths on a given line must be the same.

See also

set-multiple

Other border properties: border-colors, border-styles

Examples

bottom_border(jams)[1, ] <- 0.4
jams
#>                        Type         Price   Sugar content  
#>                      ──────────────────────────────────────
#>                        Strawberry    1.90          40.00%  
#>                        Raspberry     2.10          35.00%  
#>                        Plum          1.80          50.00%  
#> 
#> Column names: Type, Price, Sugar

bottom_border(jams)[1, ] <- brdr(0.4, "solid", "blue")
jams
#>                        Type         Price   Sugar content  
#>                      ──────────────────────────────────────
#>                        Strawberry    1.90          40.00%  
#>                        Raspberry     2.10          35.00%  
#>                        Plum          1.80          50.00%  
#> 
#> Column names: Type, Price, Sugar

set_bottom_border(jams, brdr(0.4, "solid", "green"))
#>                        Type         Price   Sugar content  
#>                      ──────────────────────────────────────
#>                        Strawberry    1.90          40.00%  
#>                      ──────────────────────────────────────
#>                        Raspberry     2.10          35.00%  
#>                      ──────────────────────────────────────
#>                        Plum          1.80          50.00%  
#>                      ──────────────────────────────────────
#> 
#> Column names: Type, Price, Sugar