loc.header

Target the table header (title and subtitle).

Usage

Source

loc.header()

With loc.header(), we can target the table header which contains the title and the subtitle. This is useful for applying custom styling with the tab_style() method. That method has a locations= argument and this class should be used there to perform the targeting.

Returns

LocHeader

A LocHeader object, which is used for a locations= argument if specifying the title of the table.

Examples

Let’s use a subset of the gtcars dataset in a new table. We will style the entire table header (the ‘title’ and ‘subtitle’ parts. This can be done by using locations=loc.header() within tab_style().

from great_tables import GT, style, loc
from great_tables.data import gtcars

(
    GT(gtcars[["mfr", "model", "msrp"]].head(5))
    .tab_header(
        title="Select Cars from the gtcars Dataset",
        subtitle="Only the first five cars are displayed"
    )
    .tab_style(
        style=style.fill(color="lightblue"),
        locations=loc.header()
    )
    .fmt_currency(columns="msrp", decimals=0)
)

Select Cars from the gtcars Dataset
Only the first five cars are displayed
mfr	model	msrp
Ford	GT	$447,000
Ferrari	458 Speciale	$291,744
Ferrari	458 Spider	$263,553
Ferrari	458 Italia	$233,509
Ferrari	488 GTB	$245,400