Location helper for targeting the column spanners

cells_column_spanners() is used to target the cells that contain the table column spanners. This is useful when applying a footnote with tab_footnote() or adding custom style with tab_style(). The function is expressly used in each of those functions' locations argument. The 'column_spanners' location is generated by one or more uses of the tab_spanner() function or the tab_spanner_delim() function.

Usage

cells_column_spanners(spanners = everything())

Arguments

spanners

Specification of spanner IDs

<spanner-targeting expression> // default: everything()

The spanners to which targeting operations are constrained. Can either be a series of spanner ID values provided in c() or a select helper function. Examples of select helper functions include starts_with(), ends_with(), contains(), matches(), one_of(), num_range(), and everything().

Value

A list object with the classes cells_column_spanners and location_cells.

Examples

Use the exibble dataset to create a gt table. We'll add a spanner column label over three columns (date, time, and datetime) with tab_spanner(). The spanner column label can be styled with tab_style() by using the cells_column_spanners() function in locations. In this example, we are making the text of the column spanner label appear as bold.

exibble |>
  dplyr::select(-fctr, -currency, -group) |>
  gt(rowname_col = "row") |>
  tab_spanner(
    label = "dates and times",
    columns = c(date, time, datetime),
    id = "dt"
  ) |>
  tab_style(
    style = cell_text(weight = "bold"),
    locations = cells_column_spanners(spanners = "dt")
  )

This image of a table was generated from the first code example in the `cells_column_spanners()` help file.

Function ID

8-13

Function Introduced

v0.2.0.5 (March 31, 2020)