Set the top border of a table part

hline_top() draws a horizontal line at the very top of a table part. It does not accept a row selector i because it always targets the first row.

When the part above exists (e.g. header above body), the line is stored as the bottom border of that adjacent part so that it renders seamlessly.

Unlike hline(), which adds inner lines below arbitrary rows, hline_top() is meant for the outer top edge of a part.

Usage

hline_top(x, j = NULL, border = NULL, part = "body")

Arguments

x

a 'flextable' object, see flextable-package to learn how to create 'flextable' object.

j

column selector, see section Column selection with the j parameter in <Selectors in flextable>.

border

border properties defined by a call to officer::fp_border()

part

part selector, see section Part selection with the part parameter in <Selectors in flextable>. Value 'all' can be used.

See also

Other borders management: border_inner(), border_inner_h(), border_inner_v(), border_outer(), border_remove(), hline(), hline_bottom(), surround(), vline(), vline_left(), vline_right()

Examples

library(officer)
big_border <- fp_border(color = "orange", width = 3)

ft <- flextable(head(iris))
ft <- border_remove(x = ft)

# add a thick line on top of each part
ft <- hline_top(ft, part = "all", border = big_border)
ft
Sepal.Length
Sepal.Width
Petal.Length
Petal.Width
Species
5.1
3.5
1.4
0.2
setosa
4.9
3.0
1.4
0.2
setosa
4.7
3.2
1.3
0.2
setosa
4.6
3.1
1.5
0.2
setosa
5.0
3.6
1.4
0.2
setosa
5.4
3.9
1.7
0.4
setosa