Skip to contents

The gt_highlight_cols function takes an existing gt_tbl object and adds highlighting color to the cell background of a specific column(s).

Usage

gt_highlight_cols(
  gt_object,
  columns,
  fill = "#80bcd8",
  alpha = 1,
  font_weight = "normal"
)

Arguments

gt_object

An existing gt table object of class gt_tbl

columns

Specific columns to apply color to, accepts either tidyeval colum names or columns by position.

fill

A character string indicating the fill color. If nothing is provided, then "#80bcd8" (light blue) will be used as a default.

alpha

An optional alpha transparency value for the color as single value in the range of 0 (fully transparent) to 1 (fully opaque). If not provided the fill color will either be fully opaque or use alpha information from the color value if it is supplied in the #RRGGBBAA format.

font_weight

A string or number indicating the weight of the font. Can be a text-based keyword such as "normal", "bold", "lighter", "bolder", or, a numeric value between 1 and 1000, inclusive. Note that only variable fonts may support the numeric mapping of weight.

Value

An object of class gt_tbl.

Examples

library(gt)
basic_col <- head(mtcars) %>%
  gt() %>%
  gt_highlight_cols(cyl, fill = "red", alpha = 0.5)

Figures

Function ID

2-9