loc.footer

Target the entire table footer.

Usage

Source

loc.footer()

With loc.footer() we can target the table’s footer, which contains both the footnotes and source notes sections. This is useful when 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. The ‘footer’ location encompasses content generated by both tab_footnote() and tab_source_note(). To target only one of these sections, use loc.footnotes() or loc.source_notes() instead.

Returns

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

Examples

Let’s use a subset of the gtcars dataset in a new table. Add a source note (with tab_source_note()) and style the entire footer section inside of tab_style() with locations=loc.footer().

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

(
    GT(gtcars[["mfr", "model", "msrp"]].head(5))
    .tab_source_note(source_note="From edmunds.com")
    .tab_style(
        style=style.text(color="blue", size="small", weight="bold"),
        locations=loc.footer()
    )
)
mfr model msrp
Ford GT 447000.0
Ferrari 458 Speciale 291744.0
Ferrari 458 Spider 263553.0
Ferrari 458 Italia 233509.0
Ferrari 488 GTB 245400.0
From edmunds.com