From d211897adfc05b18b582d173e0ac7768ee58ac18 Mon Sep 17 00:00:00 2001 From: machow Date: Fri, 11 Oct 2024 20:48:39 +0000 Subject: [PATCH] deploy: cc9829c16807c3a7fa2b30b0730209e169695a43 --- blog/bring-your-own-df/index.html | 90 +- blog/design-philosophy/index.html | 240 +- blog/index.html | 24 +- blog/index.xml | 4332 ++++++++--------- blog/introduction-0.12.0/index.html | 400 +- blog/introduction-0.13.0/index.html | 720 +-- blog/introduction-0.2.0/index.html | 240 +- blog/introduction-0.3.0/index.html | 640 +-- blog/introduction-0.4.0/index.html | 400 +- blog/introduction_great_tables.html | 640 +-- blog/polars-styling/index.html | 562 +-- blog/superbowl-squares/index.html | 240 +- .../index.html | 160 +- examples/index.html | 560 +-- get-started/basic-column-labels.html | 242 +- get-started/basic-formatting.html | 406 +- get-started/basic-header.html | 240 +- get-started/basic-stub.html | 320 +- get-started/basic-styling.html | 964 ++-- get-started/colorizing-with-data.html | 400 +- get-started/column-selection.html | 322 +- get-started/index.html | 322 +- get-started/loc-selection.html | 882 ++-- get-started/nanoplots.html | 800 +-- get-started/row-selection.html | 482 +- get-started/table-theme-options.html | 720 +-- get-started/table-theme-premade.html | 1108 ++--- get-started/targeted-styles.html | 560 +-- reference/GT.as_raw_html.html | 4 +- reference/GT.cols_align.html | 82 +- reference/GT.cols_hide.html | 80 +- reference/GT.cols_label.html | 240 +- reference/GT.cols_move.html | 80 +- reference/GT.cols_move_to_end.html | 160 +- reference/GT.cols_move_to_start.html | 160 +- reference/GT.cols_width.html | 322 +- reference/GT.data_color.html | 244 +- reference/GT.fmt.html | 80 +- reference/GT.fmt_bytes.html | 90 +- reference/GT.fmt_currency.html | 94 +- reference/GT.fmt_date.html | 84 +- reference/GT.fmt_datetime.html | 84 +- reference/GT.fmt_image.html | 82 +- reference/GT.fmt_integer.html | 84 +- reference/GT.fmt_markdown.html | 80 +- reference/GT.fmt_nanoplot.html | 330 +- reference/GT.fmt_number.html | 88 +- reference/GT.fmt_percent.html | 90 +- reference/GT.fmt_roman.html | 82 +- reference/GT.fmt_scientific.html | 90 +- reference/GT.fmt_time.html | 84 +- reference/GT.fmt_units.html | 160 +- reference/GT.html | 402 +- reference/GT.opt_align_table_header.html | 82 +- reference/GT.opt_all_caps.html | 82 +- reference/GT.opt_horizontal_padding.html | 160 +- reference/GT.opt_row_striping.html | 80 +- reference/GT.opt_stylize.html | 162 +- reference/GT.opt_table_font.html | 166 +- reference/GT.opt_table_outline.html | 86 +- reference/GT.opt_vertical_padding.html | 160 +- reference/GT.save.html | 6 +- reference/GT.show.html | 160 +- reference/GT.sub_missing.html | 80 +- reference/GT.sub_zero.html | 80 +- reference/GT.tab_header.html | 160 +- reference/GT.tab_options.html | 472 +- reference/GT.tab_source_note.html | 80 +- reference/GT.tab_spanner.html | 162 +- reference/GT.tab_stub.html | 160 +- reference/GT.tab_stubhead.html | 160 +- reference/GT.tab_style.html | 160 +- reference/_styles-quartodoc.css | 2 +- reference/define_units.html | 80 +- reference/from_column.html | 160 +- reference/google_font.html | 160 +- reference/loc.body.html | 80 +- reference/loc.column_header.html | 80 +- reference/loc.column_labels.html | 82 +- reference/loc.footer.html | 80 +- reference/loc.header.html | 80 +- reference/loc.row_groups.html | 82 +- reference/loc.source_notes.html | 80 +- reference/loc.spanner_labels.html | 82 +- reference/loc.stub.html | 82 +- reference/loc.stubhead.html | 80 +- reference/loc.subtitle.html | 80 +- reference/loc.title.html | 80 +- reference/nanoplot_options.html | 36 +- reference/style.borders.html | 16 +- reference/style.text.html | 18 +- reference/system_fonts.html | 82 +- reference/vals.fmt_bytes.html | 10 +- reference/vals.fmt_currency.html | 14 +- reference/vals.fmt_date.html | 4 +- reference/vals.fmt_integer.html | 4 +- reference/vals.fmt_number.html | 8 +- reference/vals.fmt_percent.html | 10 +- reference/vals.fmt_roman.html | 2 +- reference/vals.fmt_scientific.html | 10 +- reference/vals.fmt_time.html | 4 +- search.json | 114 +- sitemap.xml | 250 +- 103 files changed, 12501 insertions(+), 12501 deletions(-) diff --git a/blog/bring-your-own-df/index.html b/blog/bring-your-own-df/index.html index f1fb0a300..68350fa5d 100644 --- a/blog/bring-your-own-df/index.html +++ b/blog/bring-your-own-df/index.html @@ -252,7 +252,7 @@

The

The challenge of removing hard dependencies

Removing hard dependencies on DataFrame libraries is worthwhile, but requires special handling for all DataFrame specific actions. To illustrate consider the Great Tables output below, which is produced from a Pandas DataFrame:

-
+
import pandas as pd
 import polars as pl
 from great_tables import GT
@@ -262,52 +262,52 @@ 

 GT(df_pandas)
-
+
@@ -345,7 +345,7 @@

Getting column names

The code below shows the different methods required to get column names as a list from Pandas and Polars.

-
+
df_pandas.columns.tolist()  # pandas
 df_polars.columns           # polars
@@ -353,7 +353,7 @@

Getting column names<

Notice that the two lines of code aren’t too different—Pandas just requires an extra .tolist() piece. We could create a special function, that returns a list of names, depending on the type of the input DataFrame.

-
+
def get_column_names(data) -> list[str]:
 
     # pandas specific ----
@@ -380,7 +380,7 @@ 
How we made Pa
 
Inverting dependency with databackend

 
Inverting dependency on DataFrame libraries means that we check whether something is a specific type of DataFrame, without using imports. This is done through the package databackend, which we copied into Great Tables.

 
It works by creating placeholder classes, which stand in for the DataFrames they’re detecting:

-

+

 
from great_tables._databackend import AbstractBackend
 
 
@@ -409,7 +409,7 @@ 
Inve
 
Separating concerns with singledispatch

 
While databackend removes dependencies, the use of singledispatch from the built-in functools module separates out the logic for handling Polars DataFrames from the logic for Pandas DataFrames. This makes it easier to think one DataFrame at a time, and also gets us better type hinting.

 
Here’s a basic example, showing the get_column_names() function re-written using singledispatch:

-

+

 
from functools import singledispatch
 
 
@@ -440,7 +440,7 @@ 
Se
 
  • The use of PdDataFrame is what signifies “run this for Pandas DataFrames”.
    • 
 
 
    With the get_column_names implementations defined, we can call it like a normal function:
    
-
    
+
    
 
    get_column_names(df_pandas)  # pandas version
 get_column_names(df_polars)  # polars version
    
 
    
diff --git a/blog/design-philosophy/index.html b/blog/design-philosophy/index.html
index e3f954b21..3a775ae04 100644
--- a/blog/design-philosophy/index.html
+++ b/blog/design-philosophy/index.html
@@ -238,54 +238,54 @@ 
    What is a table, re
 
  • the data is primarily text
    • 
 
 
    Let’s look at an example of a simple table with actual data to tie this theory to practice.
    
-
    
+
    
 
    
-
    
+
    @@ -451,7 +451,7 @@

    A
  • Table Footer: a place for additional information pertaining to the table content

    • Here’s a table that takes advantage of the different components available in Great Tables. It contains the names and addresses of people.

    -
    +
    Show the code 
    from great_tables import GT, md, system_fonts
@@ -475,52 +475,52 @@ 
    A
 )
    -
    +

    @@ -623,7 +623,7 @@

    Formatting

  • a compact integer value (fmt_integer()): 134K

    • The problem grows worse when values need to be conveyed as images or plots. If you’re a medical analyst, for example, you might need to effectively convey whether test results for a patient are improving or worsening over time. Reading such data as a sequence of numbers across a row can slow interpretation. But by using nanoplots, available as the fmt_nanoplot() formatting method, readers can spot trends right away. Here’s an example that provides test results over a series of days.

    -
    +
    Show the code 
    from great_tables import GT, md
@@ -651,52 +651,52 @@ 
    Formatting
    
 )
    -
    +
    diff --git a/blog/index.html b/blog/index.html index 5011e92d9..48c22f9d4 100644 --- a/blog/index.html +++ b/blog/index.html @@ -267,7 +267,7 @@

    Great Blogposts

     - + @@ -278,7 +278,7 @@

    Great Blogposts

    Rich Iannone and Michael Chow     - + @@ -289,7 +289,7 @@

    Great Blogposts

    Rich Iannone     - + @@ -300,7 +300,7 @@

    Great Blogposts

    Rich Iannone     - + @@ -311,7 +311,7 @@

    Great Blogposts

    Michael Chow     - + @@ -322,7 +322,7 @@

    Great Blogposts

    Michael Chow     - + @@ -333,7 +333,7 @@

    Great Blogposts

    Rich Iannone and Michael Chow     - + @@ -344,7 +344,7 @@

    Great Blogposts

    Rich Iannone     - + @@ -355,7 +355,7 @@

    Great Blogposts

    Rich Iannone     - + @@ -366,7 +366,7 @@

    Great Blogposts

    Michael Chow     - + @@ -377,7 +377,7 @@

    Great Blogposts

    Rich Iannone     - + @@ -388,7 +388,7 @@

    Great Blogposts

    Michael Chow     - + diff --git a/blog/index.xml b/blog/index.xml index cbcb2f62c..6a29b4aa8 100644 --- a/blog/index.xml +++ b/blog/index.xml @@ -32,7 +32,7 @@

    Starting things off with a big GT table

    The table we’ll make uses the nuclides dataset (available in the great_tables.data module). Through use of the tab_*() methods, quite a few table components (hence locations) will be added. We have hidden the code here because it is quite lengthy but you’re encouraged to check it out to glean some interesting GT tricks.

    -
    +
    Show the code 
    2)
 gt_tbl
    -
    +
    Oct 10, 2024
    Sep 30, 2024
    Jul 8, 2024
    May 16, 2024
    Apr 24, 2024
    Apr 4, 2024
    Mar 19, 2024
    Feb 16, 2024
    Feb 8, 2024
    Jan 24, 2024
    Jan 8, 2024
    Jan 4, 2024
    @@ -498,7 +498,7 @@ font-style: inherit;">2)
  • Make the values in the atomic_mass and half_life use a monospace font.
  • fill the background of isotopes with STABLE half lives to be PaleTurquoise.
    • -
    +
    gt_tbl = (
@@ -551,54 +551,54 @@ font-style: inherit;">"half_life").is_not_null())
 
 gt_tbl
    -
    +
    @@ -781,7 +781,7 @@ font-style: inherit;">"half_life").is_not_null())
  • Change the fill color (to ‘Linen’) and make the text bold for the entire stub
  • Highlight the rows where we have stable isotopes (the extent is both for the stub and the body cells)
    • -
    +
    gt_tbl = (
@@ -829,54 +829,54 @@ font-style: inherit;">"half_life").is_null())
 
 gt_tbl
    -
    +
    @@ -1053,7 +1053,7 @@ font-style: inherit;">"half_life").is_null())

    Using custom style rules with the new style.css()

    Aside from decking out the loc module with all manner of location methods, we’ve added a little something to the style module: style.css()! What’s it for? It lets you supply style declarations to its single rule= argument.

    As an example, I might want to indent some text in one or more table cells. You can’t really do that with the style.text() method since it doesn’t have an indent= argument. So, in Great Tables 0.13.0 you can manually indent the row label text for the ‘STABLE’ rows using a CSS style rule:

    -
    +
    gt_tbl = (
@@ -1078,54 +1078,54 @@ font-style: inherit;">"half_life").is_null())
 
 gt_tbl
    -
    +
    @@ -1300,7 +1300,7 @@ font-style: inherit;">"half_life").is_null())

    The combined location helpers: loc.column_header() and loc.footer()

    Look, I know we brought up the expression fine-grained before—right in the first paragraph—but sometimes you need just the opposite. There are lots of little locations in a GT table and some make for logical groupings. To that end, we have the concept of combined location helpers.

    Let’s set a grey background fill on the stubhead, column header, and footer:

    -
    +
    gt_tbl = (
@@ -1325,54 +1325,54 @@ font-style: inherit;">=[loc.stubhead(), loc.column_header(), loc.footer()
 
 gt_tbl
    -
    +
    @@ -1547,7 +1547,7 @@ font-style: inherit;">=[loc.stubhead(), loc.column_header(), loc.footer()

    Styling the title and the subtitle

    Although it really doesn’t appear to have separate locations, the table header (produced by way of tab_header()) can have two of them: the title and the subtitle (the latter is optional). These can be targeted via loc.title() and loc.subtitle(). Let’s focus in on the title location and set an aliceblue background fill on the title, along with some font and border adjustments.

    -
    +
    gt_tbl = (
@@ -1588,54 +1588,54 @@ font-style: inherit;">=loc.title()
 
 gt_tbl
    -
    +
    @@ -1806,7 +1806,7 @@ font-style: inherit;">=loc.title()

    Looks good. Notice that the title location is separate from the subtitle one, the background fill reveals the extent of its area.

    A subtitle is an optional part of the header. We do have one in our table example, so let’s style that as well. The style.css() method will be used to give the subtitle text some additional top and bottom padding, and, we’ll put in a fancy background involving a linear gradient.

    -
    +
    gt_tbl = (
@@ -1834,54 +1834,54 @@ font-style: inherit;">=loc.subtitle()
 
 gt_tbl
    -
    +
    @@ -2052,7 +2052,7 @@ font-style: inherit;">=loc.subtitle()

    None of what was done above could be done prior to v0.13.0. The style.css() method makes this all possible.

    The combined location helper for the title and the subtitle locations is loc.header(). As mentioned before, it can be used as a shorthand for locations=[loc.title(), loc_subtitle()] and it’s useful here where we want to change the font for the title and subtitle text.

    -
    +
    gt_tbl = (
@@ -2073,55 +2073,55 @@ font-style: inherit;">=loc.header()
 
 gt_tbl
    -
    +
    @@ -2295,7 +2295,7 @@ font-style: inherit;">=loc.header()

    How tab_style() fits in with tab_options()

    When it comes to styling, you can use tab_options() for some of the basics and use tab_style() for the more demanding styling tasks. And you could combine the usage of both in your table. Let’s set a default honeydew background fill on the body values:

    -
    +
    gt_tbl = gt_tbl.tab_options(table_background_color"HoneyDew")
 
 gt_tbl
    -
    +
    @@ -2560,7 +2560,7 @@ font-style: inherit;">"HoneyDew")
  • invoke google_font() within tab_style(styles=style.text(font=...)) to set the font within a location

    • Let’s start with this small table that uses the default set of fonts for the entire table.

    -
    +
    Show the code 
    "This dataset is included in Great Tables."
 gt_tbl
    -
    +
    @@ -2733,7 +2733,7 @@ font-style: inherit;">"This dataset is included in Great Tables."

    Now, with opt_table_font() + google_font(), we’ll change the table’s font to one from Google Fonts. I like Noto Serif so let’s use that here!

    -
    +
    from great_tables "Noto Serif"))
 )
    -
    +
    @@ -2869,7 +2869,7 @@ font-style: inherit;">"Noto Serif"))

    Looking good! And we don’t have to apply the font to the entire table. We might just wanted to use a Google Font in the table body. For that use case, tab_style() is the preferred method. Here’s an example that uses the IBM Plex Mono typeface.

    -
    +
    (
     gt_tbl
     .tab_style(
@@ -2888,53 +2888,53 @@ font-style: inherit;">=loc.body()
     )
 )
    -
    +
    @@ -3015,55 +3015,55 @@ font-style: inherit;">=loc.body()
  • using some combination of three row_striping_* arguments in tab_options()

    • Let’s use that example table with opt_row_striping().

    -
    +
    gt_tbl.opt_row_striping()
    -
    +
    @@ -3142,7 +3142,7 @@ font-style: inherit;">=loc.body()
  • row_striping_include_table_body: should striping include cells in the body?

    • With these new options, we can choose to stripe the entire row (stub cells + body cells) and use a darker color like "lightblue".

    -
    +
    (
     gt_tbl
     .tab_options(
@@ -3164,52 +3164,52 @@ font-style: inherit;">True,
     )
 )
    -
    +
    @@ -3334,7 +3334,7 @@ Tip
  • formatting for very small numbers in scientific notation.

    • Great Tables provides the necessary functionality for all three requirements. Here is a summary table that tabulates rate constants for mercaptan compounds undergoing reaction with OH, O3, and Cl:

    -
    +
    Show the Code 
    "humanist")
 )
    -
    +
    @@ -3667,7 +3667,7 @@ font-style: inherit;">"humanist")

    We added the nanoplots feature to Great Tables in v0.4.0 (check out the intro blog post for a quick explainer) so that tables can contain small, info-packed plots that fit reasonably well into a table context. They are interactive in that hovering over the data points provides additional plot information. This approach brings together the advantages of plots (elucidation of trends in data) and tables (access to numerical values representing the data points) in a single summary visualization.

    Version 0.10.0 of Great Tables adds the gibraltar dataset, which provides meteorological data (temeperature, humidity, wind speed, etc.) for the entire month of May 2024 at Gibraltar Airport Station.

    Nanoplots, as mentioned, are great for condensing a lot of information into a small area. Our example here with the gibraltar dataset takes all of the temperature and humidity data for the first 10 days of May 2023 and displays them in easy-to-explore nanoplots across two columns:

    -
    +
    Show the Code 
    "humidity"]
 )
    -
    +
    @@ -4605,7 +4605,7 @@ $14.8M

    The challenge of removing hard dependencies

    Removing hard dependencies on DataFrame libraries is worthwhile, but requires special handling for all DataFrame specific actions. To illustrate consider the Great Tables output below, which is produced from a Pandas DataFrame:

    -
    +
    import pandas = pl.from_pandas(df_pandas)
 
 GT(df_pandas)
    -
    +
    @@ -4726,7 +4726,7 @@ font-style: inherit;">= pl.from_pandas(df_pandas)

    Getting column names

    The code below shows the different methods required to get column names as a list from Pandas and Polars.

    -
    +
    df_pandas.columns.tolist()  # pandas
@@ -4738,7 +4738,7 @@ font-style: inherit;"># polars

    Notice that the two lines of code aren’t too different—Pandas just requires an extra .tolist() piece. We could create a special function, that returns a list of names, depending on the type of the input DataFrame.

    -
    +
    ")

    Inverting dependency with databackend

    Inverting dependency on DataFrame libraries means that we check whether something is a specific type of DataFrame, without using imports. This is done through the package databackend, which we copied into Great Tables.

    It works by creating placeholder classes, which stand in for the DataFrames they’re detecting:

    -
    +
    from great_tables._databackend "I'm a pandas DataFrame!!!")
    Separating concerns with singledispatch

    While databackend removes dependencies, the use of singledispatch from the built-in functools module separates out the logic for handling Polars DataFrames from the logic for Pandas DataFrames. This makes it easier to think one DataFrame at a time, and also gets us better type hinting.

    Here’s a basic example, showing the get_column_names() function re-written using singledispatch:

    -
    +
    from functools return data.columns
  • The use of PdDataFrame is what signifies “run this for Pandas DataFrames”.

    • With the get_column_names implementations defined, we can call it like a normal function:

    -
    +
    get_column_names(df_pandas)  # pandas version
@@ -5013,54 +5013,54 @@ Tables made with computers (left to right): (1) a DataFrame printed at the conso
 
  • the data is primarily text
    • 
 
 
    Let’s look at an example of a simple table with actual data to tie this theory to practice.
    
-
    
+
    
 
    
-
    
+
    @@ -5226,7 +5226,7 @@ A schematic with the complete set of table components that can be utilized in Table Footer: a place for additional information pertaining to the table content

    Here’s a table that takes advantage of the different components available in Great Tables. It contains the names and addresses of people.

    -
    +
    Show the code 
    "14px",
 )
    -
    +
    @@ -5480,7 +5480,7 @@ A table of named individuals redone, Great Tables style!
  • a compact integer value (fmt_integer()): 134K

    • The problem grows worse when values need to be conveyed as images or plots. If you’re a medical analyst, for example, you might need to effectively convey whether test results for a patient are improving or worsening over time. Reading such data as a sequence of numbers across a row can slow interpretation. But by using nanoplots, available as the fmt_nanoplot() formatting method, readers can spot trends right away. Here’s an example that provides test results over a series of days.

    -
    +
    Show the code 
    "Measurements from Day 3 through Day 9.")
 )
    -
    +
    @@ -5743,7 +5743,7 @@ font-style: inherit;">"Measurements from Day 3 through Day 9.")

    The recent v0.4.0 release of Great Tables contains nanoplots as a major new feature. So, in this post I’ll concentrate on showing you all the things you can do with nanoplots. What are nanoplots? Well, with nanoplots you can do this:

    -
    +
    Show the code 
    "Measurements from Day 3 through to Day 8.")
 )
    -
    +
    @@ -5962,7 +5962,7 @@ font-style: inherit;">"Measurements from Day 3 through to Day 8.")

    Nanoplots, small interactive plots in your table

    Nanoplots are small yet information-laden plots that fit nicely into table cells. They are interactive, allowing for more information to be shown on hovering (or through touch when that interaction is available). Nanoplots try to show individual data points with reasonably good visibility (space is limited, this is going in a table after all!) and the plot representations change depending on the data fed into them.

    We can generate nanoplots via the fmt_nanoplot() method. Let’s make two nanoplots of the two different available plot types: "line" and "bar":

    -
    +
    random_numbers_df = pl.DataFrame(
@@ -6025,52 +6025,52 @@ background-color: null;
 font-style: inherit;">"bar")
 )
    -
    +
    @@ -6117,7 +6117,7 @@ font-style: inherit;">"bar")

    Adding reference lines and highlighted areas

    It’s possible to add in a reference line and a reference area to individual plots. These may be useful to highlight a particular statistic (e.g., median or minimum value) or a bounded region of interest (e.g., the area between the first and third quartiles). Here is an example of how to use these options via the reference_line= and reference_area= arguments:

    -
    +
    (
     GT(random_numbers_df, rowname_col"median"])
 )
    -
    +
    @@ -6260,7 +6260,7 @@ font-style: inherit;">"median"])

    Simple bars

    We can also have single-value bar plots and line plots. These will run in the horizontal direction and such plots are meant for easy value comparisons (which works great in tables). To make this work, give fmt_nanoplot() a column of numeric values. The following example shows how fmt_nanoplot() can be used to create single-value bar and line plots.

    -
    +
    single_vals_df = pl.DataFrame(
@@ -6333,52 +6333,52 @@ background-color: null;
 font-style: inherit;">"line")
 )
    -
    +
    @@ -6430,7 +6430,7 @@ font-style: inherit;">"line")

    Customizing with nanoplot_options()

    We provide a lot of options for customizing your nanoplots. With the nanoplot_options() helper function, it’s possible to change the look and feel for a set of nanoplots. The options= argument of fmt_nanoplot() is where you’d need to invoke that helper function. Some possibilities for customization include determining which nanoplot elements are present, changing the sizes and colors of different elements, and a whole lot more! Here’s an example where both line- and bar-based nanoplots retain their basic compositional elements, but their appearance is quite different.

    -
    +
    from great_tables "blue",
     )
 )
    -
    +
    @@ -6647,7 +6647,7 @@ font-style: inherit;">"blue",

    Modifying the widths of columns

    Before v0.3.0, you could not alter the widths of individual columns. This meant that to great extent your content decided the width of individual columns. Even though browsers do an adequate job in sizing the widths of table columns, it doesn’t always result in a pleasing-to-look-at table. What if you want more space? Maybe you want consistently-sized columns? There’s many reasons to want to have a choice in the matter and the new cols_width() method now makes this possible.

    Here’s an example where the widths of all columns are set with our preferred length values (in px).

    -
    +
    from great_tables "50px"
     )
 )
    -
    +
    @@ -6822,7 +6822,7 @@ font-style: inherit;">"50px"

    Setting options across the entire table with tab_options()

    The new tab_options() method gives you the freedom to specify any of dozens of global style and layout options for the table. Want a font that’s used across all cells? Use the table_font_names= option. Do you need to make the text smaller, but only in the stub? Use stub_font_size= for that. The number of options is perhaps overwhelming at first but we think you’ll enjoy having them around nonetheless. It makes styling the table (and developing your own table themes) a relatively simple task.

    Here’s an example that creates a table with a few common components and then uses tab_options() to set up a collection of fonts for the table with the (also new) system_fonts() function:

    -
    +
    from great_tables ="industrial"))
    -
    +
    @@ -7028,59 +7028,59 @@ font-style: inherit;">"industrial"))

    Note that table_font_names= accepts a list of fonts that operate as fallbacks for users across different systems (i.e., they may not have the font you have). And the system_fonts() helper function in Great Tables makes this easy by providing you with themed, local font stacks that are meant to work across different computing platforms.

    Here’s another example where we set the width of the table to span across the entire page (or containing element).

    -
    +
    gt_tbl.tab_options(table_width="100%")
    -
    +
    @@ -7170,59 +7170,59 @@ font-style: inherit;">"100%")

    One more where the background color of the table is set to "lightcyan":

    -
    +
    gt_tbl.tab_options(table_background_color="lightcyan")
    -
    +
    @@ -7316,59 +7316,59 @@ font-style: inherit;">"lightcyan")

    Using the new opt_*() methods to do more complex tasks with table options

    While tab_options() is a great method for setting global table options, sometimes you want to set a number of them at once for a combined effect. For that type of operation, we have the opt_*() series of methods. A common thing you might do is align the content in the table header, we can make that an easy thing with opt_align_table_header():

    -
    +
    gt_tbl.opt_align_table_header(align="left")
    -
    +
    @@ -7459,55 +7459,55 @@ font-style: inherit;">"left")

    With that, you don’t have to hunt through the myriad options within tab_options() to find the two args you need to get the job done.

    The opt_all_caps() method transforms the text within the column labels, the stub, and in all row groups so that we get an all-capitalized (yet somewhat sized down) look that better differentiates the labels from the data. It’s rather easy to use, just do this:

    -
    +
    gt_tbl.opt_all_caps()
    -
    +
    @@ -7598,59 +7598,59 @@ font-style: inherit;">"left")

    This sets nine options you’d otherwise set in tab_options() all at once, making life generally easier.

    Here’s one last example, this time using opt_vertical_padding(). You’d use that if you’re dissatisfied with the level of top/bottom padding within cells of all locations (e.g., in the table body, in the column labels, etc.). You can either make a table taller or more ‘compressed’ with a single argument: scale=. Here’s an example where the amount of vertical padding is reduced, resulting in a table taking up less vertical space.

    -
    +
    gt_tbl.opt_vertical_padding(scale=0.5)
    -
    +
    @@ -7752,7 +7752,7 @@ font-style: inherit;">0.5)

    A new formatting method: fmt_image()

    Wouldn’t it be great to add graphics to your table? The fmt_image() method provides an easy way to add image files on disk into table body cells. The cells need to contain some reference to an image file. The path= and file_pattern= arguments give you some flexibility in defining exactly where the image files live.

    Here’s an example using the metro dataset that’s included within Great Tables.

    -
    +
    from great_tables.data "700px")
 )
    -
    +
    @@ -7964,7 +7964,7 @@ font-style: inherit;">"700px")
  • Away team digit: 7

    • Let’s say you choose the digits above, and write this as 4/7—meaning a final digit of 4 for home and 7 for away. You would mark yourself on this square:

    -
    +
    Code 
    df "Away")
 )
    -
    +
    @@ -8305,7 +8305,7 @@ font-style: inherit;">"Away")

    What squares are most likely to win?

    We looked back at games for the KC Chiefs (away), and games for the San Francisco 49ers (home), and calculated the proportion of the time each team ended with a specific digit. Putting this together for the two teams, here is the chance of winning on a given square:

    -
    +
    Code 
    '<span style="float: right;">Source data: [Lee Sharp
 )
    -
    +
    @@ -8836,7 +8836,7 @@ Appendix: analysis and code

    Code

    -
    +
    import polars '<span style="float: right;">Source data: [Lee Sharp
     )
 )
    -
    +
    @@ -9349,7 +9349,7 @@ font-style: inherit;">'<span style="float: right;">Source data: [Lee Sharp

    We enjoy working on Great Tables because we want everybody to easily make beautiful tables. Tables don’t have to be boring, they really could be captivating and insightful. With every release we get closer and closer to realizing our mission and, as such, we’re happy to announce the v0.2.0 release that’s now on PyPI.

    The really big feature that’s available with this release is the data_color() method. It gives you several options for colorizing data cells based on the underlying data. The method automatically scales color values according to the data in order to emphasize differences or reveal trends. The example below emphasizes large currency values with a "darkgreen" fill color.

    -
    +
    from great_tables "darkgreen"]
     )
 )
    -
    +
    @@ -9475,7 +9475,7 @@ font-style: inherit;">"darkgreen"]

    Note that we use columns= to specify which columns get the colorizing treatment (just currency here) and the palette= is given as a list of color values. From this we can see that the 65100.0 value polarizes the data coloring process; it is "darkgreen" while all other values are "lightblue" (with no interpolated colors in between). Also, isn’t it nice that the text adapts to the background color?

    The above example is suitable for emphasizing large values, but, maybe you consider the extreme value to be something that’s out of bounds? For that, we can use the domain= and na_value= arguments to gray-out the extreme values. We’ll also nicely format the currency column in this next example.

    -
    +
    (
     GT(exibble[[False
     )
 )
    -
    +
    @@ -9624,7 +9624,7 @@ font-style: inherit;">False

    Now the very large value is in "lightgray", making all other values easier to compare. We did setting domain=[0, 50] and specifying na_color="lightgray". This caused the out-of-bounds value of 65100 to have a light gray background. Notice that the values are also formatted as currencies, and this is thanks to fmt_currency() which never interferes with styling.

    Here’s a more inspirational example that uses a heavily-manipulated version of the countrypops dataset (thanks again, Polars!) along with a color treatment that’s mediated by data_color(). Here, the population values can be easily compared by the amount of "purple" within them.

    -
    +
    from great_tables.data 1.7e5])
 )
    -
    +
    @@ -9898,7 +9898,7 @@ font-style: inherit;">1.7e5])

    However, there are fewer options for styling tables for presentation. You could convert from polars to pandas, and use the built-in pandas DataFrame styler, but this has one major limitation: you can’t use polars expressions.

    As it turns out, polars expressions make styling tables very straightforward. The same polars code that you would use to select or filter combines with Great Tables to highlight, circle, or bolden text.

    In this post, I’ll show how Great Tables uses polars expressions to make delightful tables, like the one below.

    -
    +
    Code 
    max())
 )
    -
    +
    @@ -10275,7 +10275,7 @@ font-style: inherit;">max())

    Creating GT object

    First, we’ll import the necessary libraries, and do a tiny bit of data processing.

    -
    +
    import polars "Temp"

    The default polars output above is really helpful for data analysis! By passing it to the GT constructor, we can start getting it ready for presentation.

    -
    +
    gt_air = GT(pl_airquality)
 
 gt_air
    -
    +
    @@ -10471,7 +10471,7 @@ font-style: inherit;">= GT(pl_airquality)

    Set title and subtitle

    The simplest method in gt is GT.tab_header(), which lets you add a title and subtitle.

    -
    +
    (
     gt_air
 
@@ -10492,52 +10492,52 @@ font-style: inherit;">"Daily measurements in New York City (May 1-10, 1973)"    )
 )
    -
    +
    @@ -10619,7 +10619,7 @@ font-style: inherit;">"Daily measurements in New York City (May 1-10, 1973)"

    Set body styles

    The .tab_style() method sets styles—like fill color, or text properties—on different parts of the table. Let’s use it twice with a polars expression. First to highlight the row corresponding to the max Wind value, and then to bold that value.

    -
    +
    from great_tables "Wind", is_max_wind)
     )
 )
    -
    +
    @@ -10803,7 +10803,7 @@ font-style: inherit;">"Wind", is_max_wind)
  • More readable labels for columns themselves.

    • Use GT.tab_spanner() to set labels on groups of columns.

    -
    +
    time_cols = [=cs.exclude(time_cols)
 
 gt_with_spanners
    -
    +
    @@ -10972,7 +10972,7 @@ font-style: inherit;">=cs.exclude(time_cols)

    Notice that there are now labels for “Time” and “Measurement” sitting above the column names. This is useful for emphasizing columns that share something in common.

    Use GT.cols_labels() with html() to create human-friendly labels (e.g. convert things like cal_m_2 to cal/m2).

    -
    +
    from great_tables "Temp,<br>&deg;F")
     )
 )
    -
    +
    @@ -11135,7 +11135,7 @@ font-style: inherit;">"Temp,<br>&deg;F")

    Putting it all together

    Finally, we’ll combine everything from the sections above into a single block of code, and use a few more rows of data.

    -
    +
    Code 
    max())
 )
    -
    +
    @@ -11529,7 +11529,7 @@ font-style: inherit;">pip install great_tables

    A Basic Table

    Let’s get right to making a display table with Great Tables. The package has quite a few datasets and so we’ll start by making use of the very small, but useful, exibble dataset. After importing the GT class and that dataset, we’ll introduce that Pandas table to GT().

    -
    +
    from great_tables # Now, show the gt table
 gt_tbl
    -
    +
    @@ -11715,7 +11715,7 @@ font-style: inherit;"># Now, show the gt table

    More Complex Tables

    Let’s take things a bit further and create a table with the included gtcars dataset. Great Tables provides a large selection of methods and they let you refine the table display. They were designed so that you can easily create a really presentable and beautiful table visualization.

    For this next table, we’ll incorporate a Stub component and this provides a place for the row labels. Groupings of rows will be generated through categorical values in a particular column (we just have to cite the column name for that to work). We’ll add a table title and subtitle with tab_header(). The numerical values will be formatted with the fmt_integer() and fmt_currency() methods. Column labels will be enhanced via cols_label() and a source note will be included through use of the tab_source_note() method. Here is the table code, followed by the table itself.

    -
    +
    from great_tables "Source: the gtcars dataset within the Great Tables package.")
 )
    -
    +
    @@ -11993,7 +11993,7 @@ font-style: inherit;">"Source: the gtcars dataset within the Great Tables packag

    With the six different methods applied, the table looks highly presentable! The rendering you’re seeing here has been done through Quarto (this entire site has been generated with quartodoc). If you haven’t yet tried out Quarto, we highly recommend it!

    For this next example we’ll use the airquality dataset (also included in the package; it’s inside the data submodule). With this table, two spanners will be added with the tab_spanner() method. This method is meant to be easy to use, you only need to provide the text for the spanner label and the columns associated with the spanner. We also make it easy to move columns around. You can use cols_move_to_start() (example of that below) and there are also the cols_move_to_end() and cols_move() methods.

    -
    +
    from great_tables.data "Day"])
 )
    -
    +
    @@ -12280,7 +12280,7 @@ font-style: inherit;">"Day"])
  • fmt(): set a column format with a formatting function

    • We strive to make formatting a simple task but we also want to provide the user a lot of power through advanced options and we ensure that varied combinations of options works well. For example, most of the formatting methods have a locale= argument. We want as many users as possible to be able to format numbers, dates, and times in ways that are familiar to them and are adapted to their own regional specifications. Now let’s take a look at an example of this with a smaller version of the exibble dataset:

    -
    +
    exibble_smaller = exibble[["h_m_s_p")
 )
    -
    +
    @@ -12419,7 +12419,7 @@ font-style: inherit;">"h_m_s_p")

    Using Styles within a Table

    We can use the tab_style() method in combination with loc.body() and various style.*() functions to set styles on cells of data within the table body. For example, the table-making code below applies a yellow background color to the targeted cells.

    -
    +
    from great_tables 2])
     )
 )
    -
    +
    @@ -12572,7 +12572,7 @@ font-style: inherit;">2])

    Aside from style.fill() we can also use style.text() and style.borders() to focus the styling on cell text and borders. Here’s an example where we perform several types of styling on targeted cells (the key is to put the style.*() calls in a list).

    -
    +
    from great_tables "currency")
     )
 )
    -
    +
    @@ -12749,7 +12749,7 @@ font-style: inherit;">"currency")

    Column Selection with Polars (and How It Helps with Styling)

    Styles can also be specified using Polars expressions. For example, the code below uses the Temp column to set color to "lightyellow" or "lightblue".

    -
    +
    import polars "Temp")
     )
 )
    -
    +
    @@ -12922,7 +12922,7 @@ font-style: inherit;">"Temp")

    We can deftly mix and match Polars column selectors and expressions. This gives us great flexibility in selecting specific columns and rows. Here’s an example of doing that again with tab_style():

    -
    +
    import polars.selectors 70
     )
 )
    -
    +
    diff --git a/blog/introduction-0.12.0/index.html b/blog/introduction-0.12.0/index.html index 5f9a5cbc6..56fcee052 100644 --- a/blog/introduction-0.12.0/index.html +++ b/blog/introduction-0.12.0/index.html @@ -235,7 +235,7 @@

    Using fonts
  • invoke google_font() within tab_style(styles=style.text(font=...)) to set the font within a location

    • Let’s start with this small table that uses the default set of fonts for the entire table.

    -
    +
    Show the code 
    from great_tables import GT, exibble, style, loc
@@ -255,52 +255,52 @@ 
    Using fonts
 gt_tbl
    -
    +

    @@ -372,7 +372,7 @@

    Using fonts

    Now, with opt_table_font() + google_font(), we’ll change the table’s font to one from Google Fonts. I like Noto Serif so let’s use that here!

    -
    +
    from great_tables import GT, exibble, style, loc, google_font
 
 (
@@ -380,53 +380,53 @@ 
    Using fonts
     .opt_table_font(font=google_font(name="Noto Serif"))
 )
    -
    +

    @@ -498,7 +498,7 @@

    Using fonts

    Looking good! And we don’t have to apply the font to the entire table. We might just wanted to use a Google Font in the table body. For that use case, tab_style() is the preferred method. Here’s an example that uses the IBM Plex Mono typeface.

    -
    +
    (
     gt_tbl
     .tab_style(
@@ -507,53 +507,53 @@ 
    Using fonts
     )
 )
    -
    +

    @@ -634,55 +634,55 @@

    Striping rows
  • using some combination of three row_striping_* arguments in tab_options()

    • Let’s use that example table with opt_row_striping().

    -
    +
    gt_tbl.opt_row_striping()
    -
    +

    @@ -761,7 +761,7 @@

    Striping rows
  • row_striping_include_table_body: should striping include cells in the body?

    • With these new options, we can choose to stripe the entire row (stub cells + body cells) and use a darker color like "lightblue".

    -
    +
    (
     gt_tbl
     .tab_options(
@@ -771,52 +771,52 @@ 
    Striping rows
     )
 )
    -
    +

    diff --git a/blog/introduction-0.13.0/index.html b/blog/introduction-0.13.0/index.html index 242861fd2..0f5f256ac 100644 --- a/blog/introduction-0.13.0/index.html +++ b/blog/introduction-0.13.0/index.html @@ -238,7 +238,7 @@

    Great Tables v0.13.0: Applying styles to all tabl

    Starting things off with a big GT table

    The table we’ll make uses the nuclides dataset (available in the great_tables.data module). Through use of the tab_*() methods, quite a few table components (hence locations) will be added. We have hidden the code here because it is quite lengthy but you’re encouraged to check it out to glean some interesting GT tricks.

    -
    +
    Show the code 
    from great_tables import GT, md, style, loc, google_font
@@ -292,53 +292,53 @@ 
    St
 gt_tbl
    -
    +

    @@ -524,7 +524,7 @@

    Styling the body

  • Make the values in the atomic_mass and half_life use a monospace font.
  • fill the background of isotopes with STABLE half lives to be PaleTurquoise.
    • -
    +
    gt_tbl = (
     gt_tbl
     .tab_style(
@@ -539,54 +539,54 @@ 
    Styling the body
    
 
 gt_tbl
    -
    +
    @@ -769,7 +769,7 @@

    Don’t forget the st
  • Change the fill color (to ‘Linen’) and make the text bold for the entire stub
  • Highlight the rows where we have stable isotopes (the extent is both for the stub and the body cells)
    • -
    +
    gt_tbl = (
     gt_tbl
     .tab_style(
@@ -787,54 +787,54 @@ 
    Don’t forget the st
 
 gt_tbl
    -
    +

    @@ -1011,7 +1011,7 @@

    Don’t forget the st

    Using custom style rules with the new style.css()

    Aside from decking out the loc module with all manner of location methods, we’ve added a little something to the style module: style.css()! What’s it for? It lets you supply style declarations to its single rule= argument.

    As an example, I might want to indent some text in one or more table cells. You can’t really do that with the style.text() method since it doesn’t have an indent= argument. So, in Great Tables 0.13.0 you can manually indent the row label text for the ‘STABLE’ rows using a CSS style rule:

    -
    +
    gt_tbl = (
     gt_tbl
     .tab_style(
@@ -1022,54 +1022,54 @@ 
    
 gt_tbl
    -
    +
    @@ -1244,7 +1244,7 @@

    The combined location helpers: loc.column_header() and loc.footer()

    Look, I know we brought up the expression fine-grained before—right in the first paragraph—but sometimes you need just the opposite. There are lots of little locations in a GT table and some make for logical groupings. To that end, we have the concept of combined location helpers.

    Let’s set a grey background fill on the stubhead, column header, and footer:

    -
    +
    gt_tbl = (
     gt_tbl
     .tab_style(
@@ -1255,54 +1255,54 @@ 
    
 gt_tbl
    -
    +
    @@ -1477,7 +1477,7 @@

    Styling the title and the subtitle

    Although it really doesn’t appear to have separate locations, the table header (produced by way of tab_header()) can have two of them: the title and the subtitle (the latter is optional). These can be targeted via loc.title() and loc.subtitle(). Let’s focus in on the title location and set an aliceblue background fill on the title, along with some font and border adjustments.

    -
    +
    gt_tbl = (
     gt_tbl
     .tab_style(
@@ -1492,54 +1492,54 @@ 
    Styling
 
 gt_tbl
    -
    +
    @@ -1710,7 +1710,7 @@

    Styling

    Looks good. Notice that the title location is separate from the subtitle one, the background fill reveals the extent of its area.

    A subtitle is an optional part of the header. We do have one in our table example, so let’s style that as well. The style.css() method will be used to give the subtitle text some additional top and bottom padding, and, we’ll put in a fancy background involving a linear gradient.

    -
    +
    gt_tbl = (
     gt_tbl
     .tab_style(
@@ -1724,54 +1724,54 @@ 
    Styling
 
 gt_tbl
    -
    +

    @@ -1942,7 +1942,7 @@

    Styling

    None of what was done above could be done prior to v0.13.0. The style.css() method makes this all possible.

    The combined location helper for the title and the subtitle locations is loc.header(). As mentioned before, it can be used as a shorthand for locations=[loc.title(), loc_subtitle()] and it’s useful here where we want to change the font for the title and subtitle text.

    -
    +
    gt_tbl = (
     gt_tbl
     .tab_style(
@@ -1953,55 +1953,55 @@ 
    Styling
 
 gt_tbl
    -
    +

    @@ -2175,60 +2175,60 @@

    Styling

    How tab_style() fits in with tab_options()

    When it comes to styling, you can use tab_options() for some of the basics and use tab_style() for the more demanding styling tasks. And you could combine the usage of both in your table. Let’s set a default honeydew background fill on the body values:

    -
    +
    gt_tbl = gt_tbl.tab_options(table_background_color="HoneyDew")
 
 gt_tbl
    -
    +

    diff --git a/blog/introduction-0.2.0/index.html b/blog/introduction-0.2.0/index.html index 2faccc3c1..24dea6c89 100644 --- a/blog/introduction-0.2.0/index.html +++ b/blog/introduction-0.2.0/index.html @@ -215,7 +215,7 @@

    Great Tables v0.2.0: Easy Data Coloring

    We enjoy working on Great Tables because we want everybody to easily make beautiful tables. Tables don’t have to be boring, they really could be captivating and insightful. With every release we get closer and closer to realizing our mission and, as such, we’re happy to announce the v0.2.0 release that’s now on PyPI.

    The really big feature that’s available with this release is the data_color() method. It gives you several options for colorizing data cells based on the underlying data. The method automatically scales color values according to the data in order to emphasize differences or reveal trends. The example below emphasizes large currency values with a "darkgreen" fill color.

    -
    +
    from great_tables import GT, exibble
 
 (
@@ -226,52 +226,52 @@ 
    Great Tables v0.2.0: Easy Data Coloring
    
     )
 )
    -
    +
    @@ -315,7 +315,7 @@

    Great Tables v0.2.0: Easy Data Coloring

    Note that we use columns= to specify which columns get the colorizing treatment (just currency here) and the palette= is given as a list of color values. From this we can see that the 65100.0 value polarizes the data coloring process; it is "darkgreen" while all other values are "lightblue" (with no interpolated colors in between). Also, isn’t it nice that the text adapts to the background color?

    The above example is suitable for emphasizing large values, but, maybe you consider the extreme value to be something that’s out of bounds? For that, we can use the domain= and na_value= arguments to gray-out the extreme values. We’ll also nicely format the currency column in this next example.

    -
    +
    (
     GT(exibble[["currency", "date", "row"]].head(4), rowname_col="row")
     .data_color(
@@ -331,52 +331,52 @@ 
    Great Tables v0.2.0: Easy Data Coloring
    
     )
 )
    -
    +
    @@ -420,7 +420,7 @@

    Great Tables v0.2.0: Easy Data Coloring

    Now the very large value is in "lightgray", making all other values easier to compare. We did setting domain=[0, 50] and specifying na_color="lightgray". This caused the out-of-bounds value of 65100 to have a light gray background. Notice that the values are also formatted as currencies, and this is thanks to fmt_currency() which never interferes with styling.

    Here’s a more inspirational example that uses a heavily-manipulated version of the countrypops dataset (thanks again, Polars!) along with a color treatment that’s mediated by data_color(). Here, the population values can be easily compared by the amount of "purple" within them.

    -
    +
    from great_tables.data import countrypops
 import polars as pl
 import polars.selectors as cs
@@ -446,52 +446,52 @@ 
    Great Tables v0.2.0: Easy Data Coloring
    
     .data_color(palette=["white", "purple"], domain=[0, 1.7e5])
 )
    -
    +
    diff --git a/blog/introduction-0.3.0/index.html b/blog/introduction-0.3.0/index.html index 385e9e685..556744d1c 100644 --- a/blog/introduction-0.3.0/index.html +++ b/blog/introduction-0.3.0/index.html @@ -228,7 +228,7 @@

    Great Tables v0.3.0: So Many Style Options!

    Modifying the widths of columns

    Before v0.3.0, you could not alter the widths of individual columns. This meant that to great extent your content decided the width of individual columns. Even though browsers do an adequate job in sizing the widths of table columns, it doesn’t always result in a pleasing-to-look-at table. What if you want more space? Maybe you want consistently-sized columns? There’s many reasons to want to have a choice in the matter and the new cols_width() method now makes this possible.

    Here’s an example where the widths of all columns are set with our preferred length values (in px).

    -
    +
    from great_tables import GT, exibble
 
 exibble_mini = exibble[["num", "char", "date", "datetime", "row"]].head(5)
@@ -245,52 +245,52 @@ 
    Modifying
     )
 )
    -
    +
    @@ -363,7 +363,7 @@

    Modifying

    Setting options across the entire table with tab_options()

    The new tab_options() method gives you the freedom to specify any of dozens of global style and layout options for the table. Want a font that’s used across all cells? Use the table_font_names= option. Do you need to make the text smaller, but only in the stub? Use stub_font_size= for that. The number of options is perhaps overwhelming at first but we think you’ll enjoy having them around nonetheless. It makes styling the table (and developing your own table themes) a relatively simple task.

    Here’s an example that creates a table with a few common components and then uses tab_options() to set up a collection of fonts for the table with the (also new) system_fonts() function:

    -
    +
    from great_tables import md, system_fonts
 
 gt_tbl = (
@@ -383,52 +383,52 @@ 
    
 gt_tbl.tab_options(table_font_names=system_fonts(name="industrial"))
    -
    +
    @@ -519,55 +519,55 @@

    system_fonts() helper function in Great Tables makes this easy by providing you with themed, local font stacks that are meant to work across different computing platforms.

    Here’s another example where we set the width of the table to span across the entire page (or containing element).

    -
    +
    gt_tbl.tab_options(table_width="100%")
    -
    +

    @@ -657,55 +657,55 @@

    :

    -
    +
    gt_tbl.tab_options(table_background_color="lightcyan")
    -
    +

    @@ -799,55 +799,55 @@

    Using the new opt_*() methods to do more complex tasks with table options

    While tab_options() is a great method for setting global table options, sometimes you want to set a number of them at once for a combined effect. For that type of operation, we have the opt_*() series of methods. A common thing you might do is align the content in the table header, we can make that an easy thing with opt_align_table_header():

    -
    +
    gt_tbl.opt_align_table_header(align="left")
    -
    +
    @@ -938,55 +938,55 @@

    tab_options() to find the two args you need to get the job done.

    The opt_all_caps() method transforms the text within the column labels, the stub, and in all row groups so that we get an all-capitalized (yet somewhat sized down) look that better differentiates the labels from the data. It’s rather easy to use, just do this:

    -
    +
    gt_tbl.opt_all_caps()
    -
    +

    @@ -1077,55 +1077,55 @@

    tab_options() all at once, making life generally easier.

    Here’s one last example, this time using opt_vertical_padding(). You’d use that if you’re dissatisfied with the level of top/bottom padding within cells of all locations (e.g., in the table body, in the column labels, etc.). You can either make a table taller or more ‘compressed’ with a single argument: scale=. Here’s an example where the amount of vertical padding is reduced, resulting in a table taking up less vertical space.

    -
    +
    gt_tbl.opt_vertical_padding(scale=0.5)
    -
    +

    @@ -1227,7 +1227,7 @@

    A new formatting method: fmt_image()

    Wouldn’t it be great to add graphics to your table? The fmt_image() method provides an easy way to add image files on disk into table body cells. The cells need to contain some reference to an image file. The path= and file_pattern= arguments give you some flexibility in defining exactly where the image files live.

    Here’s an example using the metro dataset that’s included within Great Tables.

    -
    +
    from great_tables.data import metro
 from importlib_resources import files
 
@@ -1246,52 +1246,52 @@ 
    A new fo
     .tab_options(table_width="700px")
 )
    -
    +
    diff --git a/blog/introduction-0.4.0/index.html b/blog/introduction-0.4.0/index.html index fa43c5483..546d754c7 100644 --- a/blog/introduction-0.4.0/index.html +++ b/blog/introduction-0.4.0/index.html @@ -224,7 +224,7 @@

    Great Tables v0.4.0: Nanoplots and More

    The recent v0.4.0 release of Great Tables contains nanoplots as a major new feature. So, in this post I’ll concentrate on showing you all the things you can do with nanoplots. What are nanoplots? Well, with nanoplots you can do this:

    -
    +
    Show the code 
    from great_tables import GT, md
@@ -251,52 +251,52 @@ 
    Great Tables v0.4.0: Nanoplots and More
    
 )
    -
    +
    @@ -375,7 +375,7 @@

    Great Tables v0.4.0: Nanoplots and More

    Nanoplots, small interactive plots in your table

    Nanoplots are small yet information-laden plots that fit nicely into table cells. They are interactive, allowing for more information to be shown on hovering (or through touch when that interaction is available). Nanoplots try to show individual data points with reasonably good visibility (space is limited, this is going in a table after all!) and the plot representations change depending on the data fed into them.

    We can generate nanoplots via the fmt_nanoplot() method. Let’s make two nanoplots of the two different available plot types: "line" and "bar":

    -
    +
    random_numbers_df = pl.DataFrame(
     {
         "i": range(1, 5),
@@ -394,52 +394,52 @@ 
        .fmt_nanoplot(columns="bars", plot_type="bar")
 )
    -
    +
    @@ -486,7 +486,7 @@

    Adding reference lines and highlighted areas

    It’s possible to add in a reference line and a reference area to individual plots. These may be useful to highlight a particular statistic (e.g., median or minimum value) or a bounded region of interest (e.g., the area between the first and third quartiles). Here is an example of how to use these options via the reference_line= and reference_area= arguments:

    -
    +
    (
     GT(random_numbers_df, rowname_col="i")
     .fmt_nanoplot(
@@ -501,52 +501,52 @@ 
            reference_area=["max", "median"])
 )
    -
    +
    @@ -593,7 +593,7 @@

    Simple bars

    We can also have single-value bar plots and line plots. These will run in the horizontal direction and such plots are meant for easy value comparisons (which works great in tables). To make this work, give fmt_nanoplot() a column of numeric values. The following example shows how fmt_nanoplot() can be used to create single-value bar and line plots.

    -
    +
    single_vals_df = pl.DataFrame(
     {
         "i": range(1, 6),
@@ -608,52 +608,52 @@ 
    Simple bars
    
     .fmt_nanoplot(columns="lines", plot_type="line")
 )
    -
    +
    @@ -705,7 +705,7 @@

    Simple bars

    Customizing with nanoplot_options()

    We provide a lot of options for customizing your nanoplots. With the nanoplot_options() helper function, it’s possible to change the look and feel for a set of nanoplots. The options= argument of fmt_nanoplot() is where you’d need to invoke that helper function. Some possibilities for customization include determining which nanoplot elements are present, changing the sizes and colors of different elements, and a whole lot more! Here’s an example where both line- and bar-based nanoplots retain their basic compositional elements, but their appearance is quite different.

    -
    +
    from great_tables import nanoplot_options
 
 (
@@ -736,52 +736,52 @@ 
    Customiz
     )
 )
    -
    +
    diff --git a/blog/introduction_great_tables.html b/blog/introduction_great_tables.html index 81bdda6b4..e052759fb 100644 --- a/blog/introduction_great_tables.html +++ b/blog/introduction_great_tables.html @@ -238,7 +238,7 @@

    Introducing Great Tables

    A Basic Table

    Let’s get right to making a display table with Great Tables. The package has quite a few datasets and so we’ll start by making use of the very small, but useful, exibble dataset. After importing the GT class and that dataset, we’ll introduce that Pandas table to GT().

    -
    +
    from great_tables import GT, exibble
 
 # Create a display table with the `exibble` dataset
@@ -247,52 +247,52 @@ 
    A Basic Table
    
 # Now, show the gt table
 gt_tbl
    -
    +
    @@ -414,7 +414,7 @@

    A Basic Table

    More Complex Tables

    Let’s take things a bit further and create a table with the included gtcars dataset. Great Tables provides a large selection of methods and they let you refine the table display. They were designed so that you can easily create a really presentable and beautiful table visualization.

    For this next table, we’ll incorporate a Stub component and this provides a place for the row labels. Groupings of rows will be generated through categorical values in a particular column (we just have to cite the column name for that to work). We’ll add a table title and subtitle with tab_header(). The numerical values will be formatted with the fmt_integer() and fmt_currency() methods. Column labels will be enhanced via cols_label() and a source note will be included through use of the tab_source_note() method. Here is the table code, followed by the table itself.

    -
    +
    from great_tables import GT, md, html
 from great_tables.data import gtcars
 
@@ -433,52 +433,52 @@ 
    More Complex Tables    .tab_source_note(source_note="Source: the gtcars dataset within the Great Tables package.")
 )
    -
    +
    @@ -606,7 +606,7 @@

    More Complex Tables

    With the six different methods applied, the table looks highly presentable! The rendering you’re seeing here has been done through Quarto (this entire site has been generated with quartodoc). If you haven’t yet tried out Quarto, we highly recommend it!

    For this next example we’ll use the airquality dataset (also included in the package; it’s inside the data submodule). With this table, two spanners will be added with the tab_spanner() method. This method is meant to be easy to use, you only need to provide the text for the spanner label and the columns associated with the spanner. We also make it easy to move columns around. You can use cols_move_to_start() (example of that below) and there are also the cols_move_to_end() and cols_move() methods.

    -
    +
    from great_tables.data import airquality
 
 airquality_mini = airquality.head(10).assign(Year=1973)
@@ -628,52 +628,52 @@ 
    More Complex Tables    .cols_move_to_start(columns=["Year", "Month", "Day"])
 )
    -
    +

    @@ -823,7 +823,7 @@

    Formatting Table Ce
  • fmt(): set a column format with a formatting function

    • We strive to make formatting a simple task but we also want to provide the user a lot of power through advanced options and we ensure that varied combinations of options works well. For example, most of the formatting methods have a locale= argument. We want as many users as possible to be able to format numbers, dates, and times in ways that are familiar to them and are adapted to their own regional specifications. Now let’s take a look at an example of this with a smaller version of the exibble dataset:

    -
    +
    exibble_smaller = exibble[["date", "time"]].head(4)
 
 (
@@ -833,52 +833,52 @@ 
    Formatting Table Ce
     .fmt_time(columns="time", time_style="h_m_s_p")
 )
    -
    +

    @@ -920,7 +920,7 @@

    Formatting Table Ce

    Using Styles within a Table

    We can use the tab_style() method in combination with loc.body() and various style.*() functions to set styles on cells of data within the table body. For example, the table-making code below applies a yellow background color to the targeted cells.

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import airquality
 
@@ -934,52 +934,52 @@ 
    Using Styles w
     )
 )
    -
    +

    @@ -1045,7 +1045,7 @@

    Using Styles w

    Aside from style.fill() we can also use style.text() and style.borders() to focus the styling on cell text and borders. Here’s an example where we perform several types of styling on targeted cells (the key is to put the style.*() calls in a list).

    -
    +
    from great_tables import GT, style, exibble
 
 (
@@ -1068,52 +1068,52 @@ 
    Using Styles w
     )
 )
    -
    +

    @@ -1170,7 +1170,7 @@

    Using Styles w

    Column Selection with Polars (and How It Helps with Styling)

    Styles can also be specified using Polars expressions. For example, the code below uses the Temp column to set color to "lightyellow" or "lightblue".

    -
    +
    import polars as pl
 
 from great_tables import GT, from_column, style, loc
@@ -1194,52 +1194,52 @@ 
        )
 )
    -
    +

    @@ -1305,7 +1305,7 @@

    +
    import polars.selectors as cs
 
 (
@@ -1319,52 +1319,52 @@ 
        )
 )
    -
    +

    diff --git a/blog/polars-styling/index.html b/blog/polars-styling/index.html index b982a6703..47a5db841 100644 --- a/blog/polars-styling/index.html +++ b/blog/polars-styling/index.html @@ -228,7 +228,7 @@

    Great Tables: The Polars DataFrame Styler of Your Dreams

    However, there are fewer options for styling tables for presentation. You could convert from polars to pandas, and use the built-in pandas DataFrame styler, but this has one major limitation: you can’t use polars expressions.

    As it turns out, polars expressions make styling tables very straightforward. The same polars code that you would use to select or filter combines with Great Tables to highlight, circle, or bolden text.

    In this post, I’ll show how Great Tables uses polars expressions to make delightful tables, like the one below.

    -
    +
    Code 
    import polars as pl
@@ -283,52 +283,52 @@ 
    Great Tables: The Polars DataFrame Styler of Your Dreams
    
 )
    -
    +
    @@ -477,7 +477,7 @@

    Th

    Creating GT object

    First, we’ll import the necessary libraries, and do a tiny bit of data processing.

    -
    +
    import polars as pl
 import polars.selectors as cs
 
@@ -503,57 +503,57 @@ 
    Creating GT object

    The default polars output above is really helpful for data analysis! By passing it to the GT constructor, we can start getting it ready for presentation.

    -
    +
    gt_air = GT(pl_airquality)
 
 gt_air
    -
    +

    @@ -629,7 +629,7 @@

    Creating GT object

    Set title and subtitle

    The simplest method in gt is GT.tab_header(), which lets you add a title and subtitle.

    -
    +
    (
     gt_air
 
@@ -640,52 +640,52 @@ 
    Set title and subti
     )
 )
    -
    +
    @@ -767,7 +767,7 @@

    Set title and subti

    Set body styles

    The .tab_style() method sets styles—like fill color, or text properties—on different parts of the table. Let’s use it twice with a polars expression. First to highlight the row corresponding to the max Wind value, and then to bold that value.

    -
    +
    from great_tables import style, loc
 
 is_max_wind = pl.col("Wind") == pl.col("Wind").max()
@@ -789,52 +789,52 @@ 
    Set body styles
    
     )
 )
    -
    +

    @@ -921,7 +921,7 @@

    Set column spannersMore readable labels for columns themselves.

    Use GT.tab_spanner() to set labels on groups of columns.

    -
    +
    time_cols = ["Year", "Month", "Day"]
 
 gt_with_spanners = (
@@ -940,52 +940,52 @@ 
    Set column spanners
 gt_with_spanners
    -
    +

    @@ -1066,7 +1066,7 @@

    Set column spanners

    Notice that there are now labels for “Time” and “Measurement” sitting above the column names. This is useful for emphasizing columns that share something in common.

    Use GT.cols_labels() with html() to create human-friendly labels (e.g. convert things like cal_m_2 to cal/m2).

    -
    +
    from great_tables import html
 
 (
@@ -1079,52 +1079,52 @@ 
    Set column spanners    )
 )
    -
    +

    @@ -1209,7 +1209,7 @@

    Set column spanners

    Putting it all together

    Finally, we’ll combine everything from the sections above into a single block of code, and use a few more rows of data.

    -
    +
    Code 
    import polars as pl
@@ -1264,52 +1264,52 @@ 
    Putting it all tog
 )
    -
    +
    diff --git a/blog/superbowl-squares/index.html b/blog/superbowl-squares/index.html index cce47fac5..bcc91aa87 100644 --- a/blog/superbowl-squares/index.html +++ b/blog/superbowl-squares/index.html @@ -238,7 +238,7 @@

    What is Super B
  • Away team digit: 7

    • Let’s say you choose the digits above, and write this as 4/7—meaning a final digit of 4 for home and 7 for away. You would mark yourself on this square:

    -
    +
    Code 
    df = (
@@ -262,52 +262,52 @@ 
    What is Super B
 )
    -
    +

    @@ -485,7 +485,7 @@

    Why analyze squares?

    What squares are most likely to win?

    We looked back at games for the KC Chiefs (away), and games for the San Francisco 49ers (home), and calculated the proportion of the time each team ended with a specific digit. Putting this together for the two teams, here is the chance of winning on a given square:

    -
    +
    Code 
    import polars as pl
@@ -558,52 +558,52 @@ 
    What s
 )
    -
    +
    @@ -818,7 +818,7 @@

    Method

    Code

    -
    +
    import polars as pl
 import polars.selectors as cs
 from great_tables import GT, md
@@ -888,52 +888,52 @@ 
    Code
    
     )
 )
    -
    +
    diff --git a/blog/tables-for-scientific-publishing/index.html b/blog/tables-for-scientific-publishing/index.html index e7129c9c3..2fac4a972 100644 --- a/blog/tables-for-scientific-publishing/index.html +++ b/blog/tables-for-scientific-publishing/index.html @@ -253,7 +253,7 @@

    Unit and scie
  • formatting for very small numbers in scientific notation.

    • Great Tables provides the necessary functionality for all three requirements. Here is a summary table that tabulates rate constants for mercaptan compounds undergoing reaction with OH, O3, and Cl:

    -
    +
    Show the Code 
    from great_tables import GT
@@ -299,52 +299,52 @@ 
    Unit and scie
 )
    -
    +

    @@ -466,7 +466,7 @@

    Nanoplots

    We added the nanoplots feature to Great Tables in v0.4.0 (check out the intro blog post for a quick explainer) so that tables can contain small, info-packed plots that fit reasonably well into a table context. They are interactive in that hovering over the data points provides additional plot information. This approach brings together the advantages of plots (elucidation of trends in data) and tables (access to numerical values representing the data points) in a single summary visualization.

    Version 0.10.0 of Great Tables adds the gibraltar dataset, which provides meteorological data (temeperature, humidity, wind speed, etc.) for the entire month of May 2024 at Gibraltar Airport Station.

    Nanoplots, as mentioned, are great for condensing a lot of information into a small area. Our example here with the gibraltar dataset takes all of the temperature and humidity data for the first 10 days of May 2023 and displays them in easy-to-explore nanoplots across two columns:

    -
    +
    Show the Code 
    from great_tables import GT, nanoplot_options
@@ -523,52 +523,52 @@ 
    Nanoplots
    
 )
    -
    +
    diff --git a/examples/index.html b/examples/index.html index 2794cdb56..012ad5df9 100644 --- a/examples/index.html +++ b/examples/index.html @@ -205,7 +205,7 @@

    Examples

    -
    +
    Show the Code 
    import polars as pl
@@ -233,52 +233,52 @@ 
    Examples
    
 )
    -
    +
    @@ -358,7 +358,7 @@

    Examples

    -
    +
    Show the Code 
    from great_tables import GT, html
@@ -390,52 +390,52 @@ 
    Examples
    
 )
    -
    +
    @@ -567,7 +567,7 @@

    Examples

    -
    +
    Show the Code 
    from great_tables import GT
@@ -608,52 +608,52 @@ 
    Examples
    
 )
    -
    +
    @@ -800,7 +800,7 @@

    Examples

    -
    +
    Show the Code 
    from great_tables import GT, html
@@ -841,52 +841,52 @@ 
    Examples
    
 )
    -
    +
    @@ -977,7 +977,7 @@

    Examples

    -
    +
    Show the Code 
    from great_tables import GT, html
@@ -1008,52 +1008,52 @@ 
    Examples
    
 )
    -
    +
    @@ -1468,54 +1468,54 @@

    Examples

    View source ⬀     Blog post (R code) ⬀

    -
    +
    -
    +
    @@ -2025,7 +2025,7 @@

    Examples

    View source ⬀     Notebook ⬀

    -
    +
    Show the Code 
    import polars as pl
@@ -2082,52 +2082,52 @@ 
    Examples
    
 coffee_table
    -
    +
    diff --git a/get-started/basic-column-labels.html b/get-started/basic-column-labels.html index 0bc50205f..d63e72dd5 100644 --- a/get-started/basic-column-labels.html +++ b/get-started/basic-column-labels.html @@ -381,7 +381,7 @@

    Column Labels

  • Month, Day: the numeric month and day of month for the record

    • We know that all measurements took place in 1973, so a year column will be added to the dataset before it is passed to the GT() class.

    -
    +
    from great_tables import GT, html
 from great_tables.data import airquality
 
@@ -513,7 +513,7 @@ 
    Column Labels
    
 
    
 
    Adding Column Spanners
    
 
    Let’s organize the time information under a Time spanner label, and put the other columns under a Measurement spanner label. We can do this with the tab_spanner() method.
    
-
    
+
    
 
    gt_airquality = (
     GT(airquality_mini)
     .tab_header(
@@ -532,52 +532,52 @@ 
    Adding Column Spann
 
 gt_airquality
    
 
    
-
    
+
    @@ -716,7 +716,7 @@

    Moving and R
  • customize the column labels so that they are more descriptive (using cols_label())

    • Let’s do both of these things in the next example:

    -
    +
    (
     gt_airquality
     .cols_move_to_start(columns=["Year", "Month", "Day"])
@@ -728,52 +728,52 @@ 
    Moving and R
     )
 )
    -
    +

    @@ -910,58 +910,58 @@

    Moving and R

    Targeting Columns for columns=

    In the above examples, we selected columns to span or move using a list of column names (as strings). However, Great Tables supports a wide range of ways to select columns.

    For example, you can use a lambda function:

    -
    +
    (
     GT(airquality_mini)
     .cols_move_to_start(columns=lambda colname: colname.endswith("R"))
 )
    -
    +
    diff --git a/get-started/basic-formatting.html b/get-started/basic-formatting.html index ddd926e57..c240f91ab 100644 --- a/get-started/basic-formatting.html +++ b/get-started/basic-formatting.html @@ -370,7 +370,7 @@

    Formatting Values

    The values within the table body, specifically those within the body cells, can be formatted with a large selection of fmt_*() methods like fmt_number(), fmt_integer(), fmt_scientific(), and more. Let’s use a portion of the exibble dataset and introduce some formatting to the cell values. First, we’ll generate the basic GT object and take a look at the table without any cell formatting applied.

    -
    +
    from great_tables import GT
 from great_tables.data import exibble
 from great_tables import vals
@@ -379,52 +379,52 @@ 
    Formatting Values
    
 
 gt_ex
    -
    +
    @@ -478,57 +478,57 @@

    Formatting Values

    The num column contains both small and much larger numbers. We can use the fmt_number() method to obtain formatted values have a fixed level of decimal precision and grouping separators. At the same time, we’ll format the numeric values in currency column to get monetary values.

    -
    +
    gt_ex = gt_ex.fmt_number(columns="num", decimals=2).fmt_currency(columns="currency")
 
 gt_ex
    -
    +
    @@ -582,7 +582,7 @@

    Formatting Values

    Dates and times can be formatted as well. As long as they are in ISO 8601 form, the fmt_date() and fmt_time() methods can be used to format such values. These methods have corresponding date_style= and time_style= arguments that accept a number of keywords that act as preset formatting styles.

    -
    +
    gt_ex = (
     gt_ex.fmt_date(columns="date", date_style="m_day_year")
     .fmt_time(columns="time", time_style="h_m_p")
@@ -590,52 +590,52 @@ 
    Formatting Values
    
 
 gt_ex
    -
    +
    @@ -689,57 +689,57 @@

    Formatting Values

    It’s possible to format cells that have already been formatted. Using a formatting method again on previously formatted cells will always work within the ‘last-formatted-wins’ rule.

    -
    +
    gt_ex = gt_ex.fmt_date(columns="date", date_style="wday_day_month_year")
 
 gt_ex
    -
    +
    @@ -793,57 +793,57 @@

    Formatting Values

    Within the selected columns= we can choose to target specific cells with the rows= argument. The latter argument allows us to pass in a list of row indices.

    -
    +
    gt_ex = gt_ex.fmt_currency(columns="currency", rows=[2, 3, 4], currency="GBP")
 
 gt_ex
    -
    +
    @@ -908,7 +908,7 @@

    , "fr", "de-AT", etc.) will result in numeric formatting specific to the chosen locale

    Here are a number of examples that use vals.fmt_number().

    -
    +
    fmt_number_1 = vals.fmt_number([1.64, 3.26, 3000.63, 236742.37])
 fmt_number_2 = vals.fmt_number([1.64, 3.26, 3000.63, 236742.37], compact=True)
 fmt_number_3 = vals.fmt_number([1.64, 3.26, 3000.63, 236742.37], decimals=3)
@@ -925,7 +925,7 @@ 
    vals.fmt_scientific().
    
-
    
+
    
 
    fmt_sci_1 = vals.fmt_scientific([0.00064, 7.353, 863454.63])
 fmt_sci_2 = vals.fmt_scientific([1.64, 3.26, 3000.63], decimals=3)
 fmt_sci_3 = vals.fmt_scientific([1.64, 3.26, 3000.63], exp_style="E")
@@ -940,7 +940,7 @@ 
    vals.fmt_date() and vals.fmt_time().
    
-
    
+
    
 
    fmt_date_1 = vals.fmt_date(
     ["2015-03-15", "2017-08-18", "2020-04-12"], date_style="wday_month_day_year"
 )
diff --git a/get-started/basic-header.html b/get-started/basic-header.html
index 7830e01c6..95d185a3d 100644
--- a/get-started/basic-header.html
+++ b/get-started/basic-header.html
@@ -364,7 +364,7 @@ 
    Header and Footer
    
 
 
 
    The way that we add components like the Table Header and source notes in the Table Footer is to use the tab_*() family of methods. A Table Header is easy to add so let’s see how the previous table looks with a title and a subtitle. We can add this component using the tab_header() method:
    
-
    
+
    
 
    from great_tables import GT, md, html
 from great_tables.data import islands
 
@@ -380,52 +380,52 @@ 
    Header and Footer
    
     )
 )
    
 
    
-
    
+

    @@ -493,7 +493,7 @@

    Header and Footer

    The Header table component provides an opportunity to describe the data that’s presented. Using subtitle= allows us to insert a subtitle, which is an optional part of the Header. We may also style the title= and subtitle= using Markdown! We do this by wrapping the values passed to title= or subtitle= with the md() helper function (we may also use html() in a similar fashion). Here is an example with the table data truncated for brevity:

    -
    +
    # Make a display table with the `islands_tbl` table;
 # put a heading just above the column labels
 gt_tbl = (
@@ -506,52 +506,52 @@ 
    Header and Footer
    
 
 gt_tbl
    -
    +
    @@ -587,7 +587,7 @@

    Header and Footer

    A source note can be added to the table’s Footer through use of the tab_source_note() method. It works in the same way as tab_header() (it also allows for Markdown inputs) except it can be called multiple times—each invocation results in the addition of a source note.

    -
    +
    # Display the `islands_tbl` data with a heading and two source notes
 (
     gt_tbl
@@ -599,52 +599,52 @@ 
    Header and Footer
    
     )
 )
    -
    +
    diff --git a/get-started/basic-stub.html b/get-started/basic-stub.html index 3e2ca43bd..d45646d70 100644 --- a/get-started/basic-stub.html +++ b/get-started/basic-stub.html @@ -375,7 +375,7 @@

    Stub (Row Labels)

    Row names

    An easy way to generate a Stub part is by specifying a stub column in the GT() class with the rowname_col= argument. This will signal to Great Tables that the named column should be used as the stub, using the contents of that column to make row labels. Let’s add a stub with our islands dataset by using rowname_col= in the call to GT():

    -
    +
    from great_tables import GT, md, html
 from great_tables.data import islands
 
@@ -383,52 +383,52 @@ 
    Row names
    
 
 GT(islands_mini).tab_stub(rowname_col="name")
    -
    +
    @@ -490,59 +490,59 @@

    Row names

    Notice that the landmass names are now placed to the left? That’s the Stub. Notably, there is a prominent border to the right of it but there’s no label above the Stub. We can change this and apply what’s known as a stubhead label through use of the tab_stubhead() method:

    -
    +
    (
     GT(islands_mini)
     .tab_stub(rowname_col="name")
     .tab_stubhead(label="landmass")
 )
    -
    +
    @@ -608,7 +608,7 @@

    Row names

    Row groups

    Let’s incorporate row groups into the display table. This divides rows into groups, creating row groups, and results in a display of a row group labels right above the each group. This can be easily done with a table containing row labels and the key is to use the groupname_col= argument of the GT() class. Here we will create three row groups (with row group labels "continent", "country", and "subregion") to have a grouping of rows.

    -
    +
    island_groups = islands.head(10).assign(group = ["subregion"] * 2 + ["country"] * 2 + ["continent"] * 6)
 
 (
@@ -617,52 +617,52 @@ 
    Row groups
    
     .tab_stubhead(label="landmass")
 )
    -
    +
    @@ -736,55 +736,55 @@

    Row groups

    GT convenience arguments

    Rather than using the GT.tab_stub() method, the GT(rowname_col=..., groupname_col=...) arguments provide a quick way to specify row names and groups.

    -
    +
    GT(island_groups, rowname_col="name", groupname_col="group")
    -
    +
    diff --git a/get-started/basic-styling.html b/get-started/basic-styling.html index 6542a9df8..ee34c0f70 100644 --- a/get-started/basic-styling.html +++ b/get-started/basic-styling.html @@ -388,7 +388,7 @@

    Styling the Table Body

    Great Tables can add styles—like color, text properties, and borders—on many different parts of the displayed table. The following set of examples shows how to set styles on the body of table, where the data cells are located.

    For the examples on this page, we’ll use the included airquality dataset to set up GT objects for both Pandas and Polars DataFrames.

    -
    +
    import polars as pl
 
 from great_tables import GT, from_column, style, loc
@@ -402,58 +402,58 @@ 
    Styling the Table Body
    
 
    
 
    Style basics
    
 
    We use the tab_style() method in combination with loc.body() to set styles on cells of data in the table body. For example, the table-making code below applies a yellow background color to specific cells.
    
-
    
+
    
 
    gt_air.tab_style(
     style=style.fill(color="yellow"),
     locations=loc.body(columns="Temp", rows=[1, 2])
 )
    
 
    
-
    
+
    @@ -527,58 +527,58 @@

    Style basics

    Customizing Borders

    Let’s use style.borders() to place borders around targeted cells. In this next example, the table has a red dashed border above two rows.

    -
    +
    gt_air.tab_style(
     style=style.borders(sides="top", color="red", style="dashed", weight="3px"),
     locations=loc.body(rows=[1, 2])
 )
    -
    +
    @@ -647,58 +647,58 @@

    Customizing Borders

    Customizing Text

    We can style text with by using the style.text() function. This gives us many customization possibilities for any text we target. For example, the Solar_R column below has green, bolded text in a custom font.

    -
    +
    gt_air.tab_style(
     style=style.text(color="green", font="Times New Roman", weight="bold"),
     locations=loc.body(columns="Solar_R")
 )
    -
    +
    @@ -768,7 +768,7 @@

    Customizing Text

    Column-based Styles

    In addition to setting styles to specific values (e.g., a "yellow" background fill), you can also use parameter values from table columns to specify styles. The way to do this is to use the from_column() helper function to access those values.

    -
    +
    df = pl.DataFrame({"x": [1, 2], "background": ["lightyellow", "lightblue"]})
 
 (
@@ -779,52 +779,52 @@ 
    Column-based Styles    )
 )
    -
    +
    @@ -858,7 +858,7 @@

    Column-based Styles

    Combining Styling with cols_hide()

    One common approach is to specify a style from a column, and then hide that column in the final output. For example, we can add a background column to our airquality data:

    -
    +
    color_map = {
     True: "lightyellow",
     False: "lightblue"
@@ -943,7 +943,7 @@ 
    Combining

    Notice that the dataset now has a background column set to either "lightyellow" or "lightblue", depending on whether Temp is above 70.

    We can then use this background column to set the fill color of certain body cells, and then hide the background column since we don’t need that in our finalized display table:

    -
    +
    (
     GT(with_color)
     .tab_style(
@@ -953,52 +953,52 @@ 
    Combining
     .cols_hide(columns="background")
 )
    -
    +
    @@ -1072,7 +1072,7 @@

    Combining

    Using Polars expressions

    Styles can also be specified using Polars expressions. For example, the code below uses the Temp column to set color to "lightyellow" or "lightblue".

    -
    +
    # A Polars expression defines color based on `Temp`
 temp_color = (
     pl.when(pl.col("Temp") > 70)
@@ -1085,52 +1085,52 @@ 
    Using Pol
     locations=loc.body("Temp")
 )
    -
    +

    @@ -1200,7 +1200,7 @@

    Using Pol

    Using functions

    You can also use a function, that takes the DataFrame and returns a Series with a style value for each row.

    This is shown below on a pandas DataFrame.

    -
    +
    def map_color(df):
     return (df["Temp"] > 70).map(
         {True: "lightyellow", False: "lightblue"}
@@ -1212,52 +1212,52 @@ 
    Using functions
    
     locations=loc.body("Temp")
 )
    -
    +

    @@ -1329,7 +1329,7 @@

    Specifying col

    Using polars selectors

    If you are using Polars, you can use column selectors and expressions for selecting specific columns and rows:

    -
    +
    import polars.selectors as cs
 
 gt_pl_air.tab_style(
@@ -1340,52 +1340,52 @@ 
    Using polars select
     )
 )
    -
    +

    @@ -1455,7 +1455,7 @@

    Using polars select

    Using a function

    For tools like pandas, you can use a function (or lambda) to select rows. The function should take a DataFrame, and output a boolean Series.

    -
    +
    gt_air.tab_style(
     style=style.fill(color="yellow"),
     locations=loc.body(
@@ -1464,52 +1464,52 @@ 
    Using a function
    
     )
 )
    -
    +

    @@ -1579,58 +1579,58 @@

    Using a function

    Multiple styles and locations

    We can use a list within style= to apply multiple styles at once. For example, the code below sets fill and border styles on the same set of body cells.

    -
    +
    gt_air.tab_style(
     style=[style.fill(color="yellow"), style.borders(sides="all")],
     locations=loc.body(columns="Temp", rows=[1, 2]),
 )
    -
    +
    @@ -1696,7 +1696,7 @@

    Multiple sty

    Note that you can also pass a list to locations=!

    -
    +
    gt_air.tab_style(
     style=style.fill(color="yellow"),
     locations=[
@@ -1705,52 +1705,52 @@ 
    Multiple sty
     ]
 )
    -
    +

    @@ -1816,7 +1816,7 @@

    Multiple sty

    You can also combine Polars selectors with a row filtering expression, in order to select a combination of columns and rows.

    -
    +
    import polars.selectors as cs
 
 gt_pl_air.tab_style(
@@ -1827,52 +1827,52 @@ 
    Multiple sty
     )
 )
    -
    +

    diff --git a/get-started/colorizing-with-data.html b/get-started/colorizing-with-data.html index 978076e0b..7d5578655 100644 --- a/get-started/colorizing-with-data.html +++ b/get-started/colorizing-with-data.html @@ -374,7 +374,7 @@

    Colorizing with Data

    You sometimes come across heat maps in data visualization, and they’re used to represent data values with color gradients. This technique is great for identifying patterns, trends, outliers, and missing data when there’s lots of data. Tables can have this sort of treatment as well! Typically, formatted numeric values are shown along with some color treatment coinciding with the underlying data values.

    We can make this possible in Great Tables by using the data_color() method. Let’s start with a simple example, using a Polars DataFrame with three columns of values. We can introduce that data to GT() and use data_color() without any arguments.

    -
    +
    from great_tables import GT
 import polars as pl
 
@@ -388,52 +388,52 @@ 
    Colorizing with Data
    
 
 GT(simple_df).data_color()
    -
    +
    @@ -484,55 +484,55 @@

    Colorizing with Data

    Setting palette colors

    While this first example illustrated some basic things, the common thing to do in practices to provide a list of colors to the palette= argument. Let’s choose two colors "green" and "red" and place them in that order.

    -
    +
    GT(simple_df).data_color(palette=["blue", "red"])
    -
    +
    @@ -584,55 +584,55 @@

    Setting palette col

    Coloring missing values with na_color

    There is a lone "None" value in the float column, and it has a gray background. Thoughout the Great Tables package, missing values are treated in different ways and, in this case, it’s given a default color value. We can change that with the na_color= argument. Let’s try it now:

    -
    +
    GT(simple_df).data_color(palette=["blue", "red"], na_color="#FFE4C4")
    -
    +

    @@ -684,7 +684,7 @@

    Colo

    Using domain= to color values across columns

    The previous usages of the data_color() method were such that the color ranges encompassed the boundaries of the data values. That can be changed with the domain= argument, which expects a list of two values (a lower and an upper value). Let’s use the range [0, 10] on the first two columns, integer and float, and not the third (since a numerical domain is incompatible with string-based values). Here’s the table code for that:

    -
    +
    (
     GT(simple_df)
     .data_color(
@@ -695,52 +695,52 @@ 
        )
 )
    -
    +

    @@ -793,7 +793,7 @@

    Bringing it all together

    For a more advanced treatment of data colorization in the table, let’s take the sza dataset (available in the great_tables.data submodule) and vigorously reshape it with Polars so that solar zenith angles are arranged as rows by month, and the half-hourly clock times are the columns (from early morning to solar noon).

    Once the pivot()ing is done, we can introduce that that table to the GT() class, placing the names of the months in the table stub. We will use data_color() with a domain that runs from 90 to 0 (here, 90° is sunrise, and 0° is represents the sun angle that’s directly overhead). There are months where the sun rises later in the morning, before the sunrise times we’ll see missing values in the dataset, and na_color="white" will handle those cases. Okay, that’s the plan, and now here’s the code:

    -
    +
    from great_tables import html
 from great_tables.data import sza
 import polars.selectors as cs
@@ -819,52 +819,52 @@ 
    Bringing it all t
     )
 )
    -
    +
    diff --git a/get-started/column-selection.html b/get-started/column-selection.html index 95faa5c0f..59bdbe1e3 100644 --- a/get-started/column-selection.html +++ b/get-started/column-selection.html @@ -380,7 +380,7 @@

    Column Selection

  • a Polars selector.
  • a function that takes a string and returns True or False.
    • -
    +
    from great_tables import GT
 from great_tables.data import exibble
 
@@ -389,52 +389,52 @@ 
    Column Selection
    
 
 gt_ex
    -
    +
    @@ -489,55 +489,55 @@

    Column Selection

    Using integers

    We can use a list of strings or integers to select columns by name or position, respectively.

    -
    +
    gt_ex.cols_move_to_start(columns=["date", 1, -1])
    -
    +
    @@ -600,7 +600,7 @@

    Using integers

    Using Polars selectors

    When using a Polars DataFrame, you can select columns using Polars selectors. The example below uses Polars selectors to move all columns that start with "c" or "f" to the start of the table.

    -
    +
    import polars as pl
 import polars.selectors as cs
 
@@ -608,52 +608,52 @@ 
    Using Polar
 
 GT(pl_df).cols_move_to_start(columns=cs.starts_with("c") | cs.starts_with("f"))
    -
    +
    @@ -706,7 +706,7 @@

    Using Polar

    In general, selection should match the behaviors of the Polars DataFrame.select() method.

    -
    +
    pl_df.select(cs.starts_with("c") | cs.starts_with("f")).columns
    ['char', 'fctr']
    @@ -717,55 +717,55 @@

    Using Polar

    Using functions

    A function can be used to select columns. It should take a column name as a string and return True or False.

    -
    +
    gt_ex.cols_move_to_start(columns=lambda x: "c" in x)
    -
    +

    diff --git a/get-started/index.html b/get-started/index.html index 6be3a72e2..15c8ef0e1 100644 --- a/get-started/index.html +++ b/get-started/index.html @@ -382,66 +382,66 @@

    Let’s Install

    A Basic Table using Great Tables

    Let’s use a subset of the islands dataset available within great_tables.data:

    -
    +
    from great_tables import GT, md, html
 from great_tables.data import islands
 
 islands_mini = islands.head(10)

    The islands data is a simple Pandas DataFrame with 2 columns and that’ll serve as a great start. Speaking of which, the main entry point into the Great Tables API is the GT class. Let’s use that to make a presentable table:

    -
    +
    # Create a display table showing ten of the largest islands in the world
 gt_tbl = GT(islands_mini)
 
 # Show the output table
 gt_tbl
    -
    +
    @@ -507,7 +507,7 @@

    A Basic T

    Polars DataFrame support

    GT accepts both Pandas and Polars DataFrames. You can pass a Polars DataFrame to GT, or use its DataFrame.style property.

    -
    +
    import polars as pl
 
 df_polars = pl.from_pandas(islands_mini)
@@ -518,52 +518,52 @@ 
    Polars# Approach 2: Polars style property ----
 df_polars.style
    -
    +

    @@ -641,7 +641,7 @@

    Polars

    Some Beautiful Examples

    In the following pages we’ll use Great Tables to turn DataFrames into beautiful tables, like the ones below.

    -
    +
    Show the Code 
    from great_tables import GT, md, html
@@ -665,52 +665,52 @@ 
    Some Beautiful Exa
 )
    -
    +

    @@ -788,7 +788,7 @@

    Some Beautiful Exa -
    +
    Show the Code 
    from great_tables import GT, html
@@ -816,52 +816,52 @@ 
    Some Beautiful Exa
 gt_airquality
    -
    +

    diff --git a/get-started/loc-selection.html b/get-started/loc-selection.html index 450669eac..bc4231fa4 100644 --- a/get-started/loc-selection.html +++ b/get-started/loc-selection.html @@ -379,54 +379,54 @@

    Location selection

    Great Tables uses the loc module to specify locations for styling in tab_style(). Some location specifiers also allow selecting specific columns and rows of data.

    For example, you might style a particular row name, group, column, or spanner label.

    The table below shows the different location specifiers, along with the types of column or row selection they allow.

    -
    +
    -
    +
    @@ -507,7 +507,7 @@

    Location selection

    Setting up data

    The examples below will use this small dataset to show selecting different locations, as well as specific rows and columns within a location (where supported).

    -
    +
    import polars as pl
 import polars.selectors as cs
 
@@ -532,7 +532,7 @@ 
    Setting up data
    
 
    Simple locations
    
 
    Simple locations don’t take any arguments.
    
 
    For example, styling the title uses loc.title().
    
-
    
+
    
 
    (
     GT(pl_exibble)
     .tab_header("A title", "A subtitle")
@@ -542,52 +542,52 @@ 
    Simple locations
    
     )
 )
    
 
    
-
    
+
    @@ -635,7 +635,7 @@

    Simple locations

    Composite locations

    Composite locations target multiple simple locations.

    For example, loc.header() includes both loc.title() and loc.subtitle().

    -
    +
    (
     GT(pl_exibble)
     .tab_header("A title", "A subtitle")
@@ -645,52 +645,52 @@ 
    Composite locations    )
 )
    -
    +
    @@ -737,7 +737,7 @@

    Composite locations

    Body columns and rows

    Use loc.body() to style specific cells in the table body.

    -
    +
    (
     GT(pl_exibble).tab_style(
         style.fill("yellow"),
@@ -748,52 +748,52 @@ 
    Body columns and row
     )
 )
    -
    +
    @@ -836,7 +836,7 @@

    Body columns and row

    Column labels

    Locations like loc.spanner_labels() and loc.column_labels() can select specific column and spanner labels.

    You can use name strings, index position, or polars selectors.

    -
    +
    GT(pl_exibble).tab_style(
     style.fill("yellow"),
     loc.column_labels(
@@ -844,52 +844,52 @@ 
    Column labels
    
     ),
 )
    -
    +
    @@ -936,7 +936,7 @@

    Row and group namesby index
  • by polars expression
    • -
    +
    gt = GT(pl_exibble).tab_stub(
     rowname_col="char",
     groupname_col="group",
@@ -944,52 +944,52 @@ 
    Row and group names
 gt.tab_style(style.fill("yellow"), loc.stub())
    -
    +

    @@ -1028,55 +1028,55 @@

    Row and group names -
    +
    gt.tab_style(style.fill("yellow"), loc.stub("banana"))
    -
    +

    @@ -1115,55 +1115,55 @@

    Row and group names -
    +
    gt.tab_style(style.fill("yellow"), loc.stub(["apricot", 2]))
    -
    +

    @@ -1206,58 +1206,58 @@

    Row and group namesGroups by name and position

    Note that for specifying row groups, the group corresponding to the group name or row number in the original data is used.

    For example, the code below styles the group corresponding to the row at index 1 (i.e. the second row) in the data.

    -
    +
    gt.tab_style(
     style.fill("yellow"),
     loc.row_groups(1),
 )
    -
    +
    @@ -1298,58 +1298,58 @@

    Groups by name

    Since the second row (starting with “banana”) is in “grp_a”, that is the group that gets styled.

    This means you can use a polars expression to select groups:

    -
    +
    gt.tab_style(
     style.fill("yellow"),
     loc.row_groups(pl.col("group") == "grp_b"),
 )
    -
    +

    @@ -1389,58 +1389,58 @@

    Groups by name

    You can also specify group names using a string (or list of strings).

    -
    +
    gt.tab_style(
     style.fill("yellow"),
     loc.row_groups("grp_b"),
 )
    -
    +

    diff --git a/get-started/nanoplots.html b/get-started/nanoplots.html index d4b61102d..d533b00a2 100644 --- a/get-started/nanoplots.html +++ b/get-started/nanoplots.html @@ -398,7 +398,7 @@

    Nanoplots

    A simple line-based nanoplot

    Let’s make some simple plots with a Polars DataFrame. Here we are using lists to define data values for each cell in the numbers column. The fmt_nanoplot() method understands that these are input values for a line plot (the default type of nanoplot).

    -
    +
    from great_tables import GT
 import polars as pl
 
@@ -416,52 +416,52 @@ 
    A simple line
 
 GT(random_numbers_df).fmt_nanoplot(columns="numbers")
    -
    +
    @@ -524,55 +524,55 @@

    A simple line

    The reference line and the reference area

    You can insert two additional things which may be useful: a reference line and a reference area. You can define them either through literal values or via keywords (these are: "mean", "median", "min", "max", "q1", "q3", "first", or "last"). Here’s a reference line that corresponds to the mean data value of each nanoplot:

    -
    +
    GT(random_numbers_df).fmt_nanoplot(columns="numbers", reference_line="mean")
    -
    +

    @@ -610,55 +610,55 @@

    This example uses a reference area that bounds the minimum value to the median value:

    -
    +
    GT(random_numbers_df).fmt_nanoplot(columns="numbers", reference_area=["min", "median"])
    -
    +

    @@ -700,55 +700,55 @@

    Using autoscale= to have a common y-axis scale across plots

    There are lots of options. Like, if you want to ensure that the scale is shared across all of the nanoplots (so you can better get a sense of overall magnitude), you can set autoscale= to True:

    -
    +
    GT(random_numbers_df).fmt_nanoplot(columns="numbers", autoscale=True)
    -
    +

    @@ -790,7 +790,7 @@

    Using the nanoplot_options() helper function

    There are many options for customization. You can radically change the look of a collection of nanoplots with the nanoplot_options() helper function. With that function, you invoke it in the options= argument of fmt_nanoplot(). You can modify the sizes and colors of different elements, decide which elements are even present, and much more! Here’s an example where a line-based nanoplot retains all of its elements, but the overall appearance is greatly altered.

    -
    +
    from great_tables import nanoplot_options
 
 (
@@ -811,52 +811,52 @@ 
        )
 )
    -
    +
    @@ -898,55 +898,55 @@

    Making nanoplots with bars using plot_type="bar"

    We don’t just support line plots in fmt_nanoplot(), we also have the option to show bar plots. The only thing you need to change is the value of plot_type= argument to "bar":

    -
    +
    GT(random_numbers_df).fmt_nanoplot(columns="numbers", plot_type="bar")
    -
    +
    @@ -985,7 +985,7 @@

    still allows us to supply a reference line and a reference area with reference_line= and reference_area=. The autoscale= option works here as well. We also have a set of options just for bar plots available inside nanoplot_options(). Here’s an example where we use all of the aforementioned customization possibilities:

    -
    +
    (
     GT(random_numbers_df)
     .fmt_nanoplot(
@@ -1008,52 +1008,52 @@ 
        )
 )
    -
    +

    @@ -1094,7 +1094,7 @@

    Horizontal bar and line plots

    Single-value bar plots, running in the horizontal direction, can be made by simply invoking fmt_nanoplot() on a column of numeric values. These plots are meant for comparison across rows so the method automatically scales the horizontal bars to facilitate this type of display. Here’s a simple example that uses plot_type="bar" on the numbers column that contains a single numeric value in every cell.

    -
    +
    single_vals_df = pl.DataFrame(
     {
         "example": ["Row " + str(x) for x in range(1, 5)],
@@ -1104,52 +1104,52 @@ 
    Horizontal b
 
 GT(single_vals_df).fmt_nanoplot(columns="numbers", plot_type="bar")
    -
    +
    @@ -1187,55 +1187,55 @@

    Horizontal b

    This, interestingly enough, works with the "line" type of nanoplot. The result is akin to a lollipop plot:

    -
    +
    GT(single_vals_df).fmt_nanoplot(columns="numbers")
    -
    +

    @@ -1277,7 +1277,7 @@

    Horizontal b

    Line plots with paired x and y values

    Aside from a single stream of y values, we can plot pairs of x and y values. This works only for the "line" type of plot. We can set up a column of Polars struct values in a DataFrame to have this input data prepared for fmt_nanoplot(). Notice that the dictionary values in the enclosed list must have the "x" and "y" keys. Further to this, the list lengths for each of "x" and "y" must match (i.e., to make valid pairs of x and y).

    -
    +
    weather_2 = pl.DataFrame(
     {
         "station": ["Station " + str(x) for x in range(1, 4)],
@@ -1312,52 +1312,52 @@ 
    Line
     )
 )
    -
    +

    diff --git a/get-started/row-selection.html b/get-started/row-selection.html index c29459003..0b1b9da9c 100644 --- a/get-started/row-selection.html +++ b/get-started/row-selection.html @@ -381,7 +381,7 @@

    Row Selection

  • a function that takes a DataFrame and returns a boolean Series.

    • The following sections will use a subset of the exibble data, to demonstrate these options.

    -
    +
    from great_tables import GT, exibble, loc, style
 
 lil_exibble = exibble[["num", "char", "currency"]].head(3)
@@ -390,55 +390,55 @@ 
    Row Selection
    
 
    
 
    Using integers
    
 
    Use a single integer, or a list of integers, to select rows by position.
    
-
    
+
    
 
    gt_ex.fmt_currency("currency", rows=0, decimals=1)
    
 
    
-
    
+
    @@ -477,55 +477,55 @@

    Using integers

    Notice that a dollar sign ($) was only added to the first row (index 0 in python).

    Indexing works the same as selecting items from a python list. This negative integers select relative to the final row.

    -
    +
    gt_ex.fmt_currency("currency", rows=[0, -1], decimals=1)
    -
    +
    @@ -567,59 +567,59 @@

    Using integers

    Using polars expressions

    The rows= argument accepts polars expressions, which return a boolean Series, indicating which rows to operate on.

    For example, the code below only formats the num column, but only when currency is less than 40.

    -
    +
    import polars as pl
 
 gt_polars = GT(pl.from_pandas(lil_exibble))
 
 gt_polars.fmt_integer("num", rows=pl.col("currency") < 40)
    -
    +
    @@ -657,7 +657,7 @@

    Using polars expr

    Here’s a more realistic example, which highlights the row with the highest value for currency.

    -
    +
    import polars.selectors as cs
 
 gt_polars.tab_style(
@@ -668,52 +668,52 @@ 
    Using polars expr
     )
 )
    -
    +

    @@ -755,55 +755,55 @@

    Using polars expr

    Using a function

    Since libraries like pandas don’t have lazy expressions, the rows= argument also accepts a function for selecting rows. The function should take a DataFrame and return a boolean series.

    Here’s the same example as the previous polars section, but with pandas data, and a lamba for selecting rows.

    -
    +
    gt_ex.fmt_integer("num", rows=lambda D: D["currency"] < 40)
    -
    +
    @@ -841,7 +841,7 @@

    Using a function

    Here’s the styling example from the previous polars section.

    -
    +
    import polars.selectors as cs
 
 gt_ex.tab_style(
@@ -852,52 +852,52 @@ 
    Using a function
    
     )
 )
    -
    +
    diff --git a/get-started/table-theme-options.html b/get-started/table-theme-options.html index 1880fcc8f..3fdc0063e 100644 --- a/get-started/table-theme-options.html +++ b/get-started/table-theme-options.html @@ -384,7 +384,7 @@

    Table Theme Options

    This page covers how to style and theme your table using GT.tab_options(), which is meant to quickly set a broad range of styles.

    We’ll use the basic GT object below for most examples, since it marks some of the table parts.

    -
    +
    from great_tables import GT, exibble
 
 gt_ex = (
@@ -396,52 +396,52 @@ 
    Table Theme Options
    
 
 gt_ex
    -
    +
    @@ -540,7 +540,7 @@

    Table Theme Options

    Table option parts

    As the graph above showed, tables are made of many parts—such as the heading, column labels, and stub. .tab_options() organizes options based on table part.

    The code below illustrates the table parts .tab_options() can target, by setting the background color for various parts.

    -
    +
    (
     gt_ex
     .tab_options(
@@ -554,52 +554,52 @@ 
    Table option parts
    
     )
 )
    -
    +
    @@ -733,59 +733,59 @@

    Findin

    Styling borders

    Many table parts support customizing border colors and style. This is shown below for column labels.

    -
    +
    gt_ex.tab_options(
     column_labels_border_top_color="blue",
     column_labels_border_top_style="solid",
     column_labels_border_top_width="5px"
 )
    -
    +

    @@ -883,57 +883,57 @@

    Styling borders

    Styling background color

    -
    +
    gt_ex.tab_options(
     heading_background_color="purple"
 )
    -
    +
    @@ -1033,59 +1033,59 @@

    Styling backgroun

    Styling body cells

    The table body can style the lines between individual cells. Use the hline and vline option types to specify cell line color, style, and width.

    For example, the code below changes horizontal lines (hline) between cells to be red, dashed lines.

    -
    +
    gt_ex.tab_options(
     table_body_hlines_color="red",
     table_body_hlines_style="dashed",
     table_body_hlines_width="4px",
 )
    -
    +
    @@ -1181,58 +1181,58 @@

    Styling body cells

    In order to define the vertical lines between cells, set vline styles. For example, the code below makes both horizontal and vertical lines between cells solid.

    -
    +
    gt_ex.tab_options(
     table_body_hlines_style="solid",
     table_body_vlines_style="solid",
 )
    -
    +
    @@ -1331,7 +1331,7 @@

    Styling body cells

    Set options across table parts

    Some options starting with table_ apply to all parts of the table. For example, fonts and background color apply everywhere.

    -
    +
    gt_ex.tab_options(
     table_background_color="green",
     table_font_color="darkblue",
@@ -1339,52 +1339,52 @@ 
    Set options
     table_font_names="Times New Roman"
 )
    -
    +
    @@ -1480,58 +1480,58 @@

    Set options

    Options set across the whole table, can be overriden by styling a specific part.

    -
    +
    gt_ex.tab_options(
     table_background_color="orange",
     heading_background_color="pink"
 )
    -
    +

    @@ -1631,7 +1631,7 @@

    Set options

    A basic theme

    Based on the sections above, we can design an overall theme for a table.

    This requires setting a decent number of options, but makes a big difference when presenting a table! Below is a table with a simple, blue theme. (The code is hidden by default, but can be expanded to see all the options set).

    -
    +
    Code 
    from great_tables import GT, exibble
@@ -1678,52 +1678,52 @@ 
    A basic theme
    
 )
    -
    +
    diff --git a/get-started/table-theme-premade.html b/get-started/table-theme-premade.html index 6dc99d3b4..de38933f9 100644 --- a/get-started/table-theme-premade.html +++ b/get-started/table-theme-premade.html @@ -383,7 +383,7 @@

    Premade Themes

  • The remaining GT.opt_*() methods: shortcuts for common uses of GT.tab_options().

    • We’ll use the basic GT object below for most examples, since it marks some of the table parts.

    -
    +
    from great_tables import GT, exibble, md
 
 lil_exibble = exibble.head(5)[["num", "char", "row", "group"]]
@@ -403,52 +403,52 @@ 
    Premade Themes
    
 
 gt_ex
    -
    +
    @@ -518,55 +518,55 @@

    opt_styli

    Below are the first two premade styles. The first uses color="blue", and the second uses color="red".

    -
    +
    gt_ex.opt_stylize(style=1, color="blue")
    -
    +

    @@ -633,55 +633,55 @@

    opt_styli
    -
    +
    gt_ex.opt_stylize(style=2, color="red")
    -
    +

    @@ -760,52 +760,52 @@

    opt_styli
    1
    -
    +

    @@ -913,52 +913,52 @@

    opt_styli
    2
    -
    +

    @@ -1066,52 +1066,52 @@

    opt_styli
    3
    -
    +

    @@ -1219,52 +1219,52 @@

    opt_styli
    4
    -
    +

    @@ -1372,52 +1372,52 @@

    opt_styli
    5
    -
    +

    @@ -1525,52 +1525,52 @@

    opt_styli
    6
    -
    +

    @@ -1681,55 +1681,55 @@

    opt_*()This section shows the different GT.opt_*() methods available. They serve as convenience methods for common GT.tab_options() tasks.

    Align table header

    -
    +
    gt_ex.opt_align_table_header(align="left")
    -
    +

    @@ -1797,55 +1797,55 @@

    Align table header

    Make text ALL CAPS

    -
    +
    gt_ex.opt_all_caps()
    -
    +
    @@ -1913,55 +1913,55 @@

    Make text ALL CAPS

    Reduce or expand padding

    -
    +
    gt_ex.opt_vertical_padding(scale=0.3)
    -
    +
    @@ -2026,55 +2026,55 @@

    Reduce or expand -
    +
    gt_ex.opt_horizontal_padding(scale=3)
    -
    +

    @@ -2142,55 +2142,55 @@

    Reduce or expand

    Set table outline

    -
    +
    gt_ex.opt_table_outline()
    -
    +

    diff --git a/get-started/targeted-styles.html b/get-started/targeted-styles.html index 394f36413..d1ddc4246 100644 --- a/get-started/targeted-styles.html +++ b/get-started/targeted-styles.html @@ -392,7 +392,7 @@

    Styling the whole table

    Kitchen sink

    Below is a big example that shows all possible loc specifiers being used.

    -
    +
    from great_tables import GT, exibble, loc, style
 
 # https://colorbrewer2.org/#type=qualitative&scheme=Paired&n=12
@@ -443,52 +443,52 @@ 
    Kitchen sink
    
     .tab_style(style.fill(next(c)), loc.stubhead())
 )
    -
    +
    @@ -555,55 +555,55 @@

    Kitchen sink

    Body

    -
    +
    gt.tab_style(style.fill("yellow"), loc.body())
    -
    +
    @@ -670,7 +670,7 @@

    Body

    Column labels

    -
    +
    (
     gt
     .tab_style(style.fill("yellow"), loc.column_header())
@@ -678,52 +678,52 @@ 
    Column labels
    
     .tab_style(style.fill("red"), loc.spanner_labels(ids=["spanner"]))
 )
    -
    +
    @@ -790,59 +790,59 @@

    Column labels

    @@ -909,7 +909,7 @@

    Header

    @@ -1032,7 +1032,7 @@

    Footer

    Stub

    -
    +
    (
     gt.tab_style(style.fill("yellow"), loc.stub())
     .tab_style(style.fill("blue"), loc.row_groups())
@@ -1042,52 +1042,52 @@ 
    Stub
    
     )
 )
    -
    +
    @@ -1154,55 +1154,55 @@

    Stub

    Stubhead

    -
    +
    gt.tab_style(style.fill("yellow"), loc.stubhead())
    -
    +
    diff --git a/reference/GT.as_raw_html.html b/reference/GT.as_raw_html.html index 22013affb..a6ac9e341 100644 --- a/reference/GT.as_raw_html.html +++ b/reference/GT.as_raw_html.html @@ -228,12 +228,12 @@

    Re

    Examples:

    Let’s use the row column of exibble dataset to create a table. With the as_raw_html() method, we’re able to output the HTML content.

    -
    +
    from great_tables import GT, exibble
 
 GT(exibble[["row"]]).as_raw_html()
    -
    '<div id="zkgrpdffwg" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">\n<style>\n#zkgrpdffwg table {\n          font-family: -apple-system, BlinkMacSystemFont, \'Segoe UI\', Roboto, Oxygen, Ubuntu, Cantarell, \'Helvetica Neue\', \'Fira Sans\', \'Droid Sans\', Arial, sans-serif;\n          -webkit-font-smoothing: antialiased;\n          -moz-osx-font-smoothing: grayscale;\n        }\n\n#zkgrpdffwg thead, tbody, tfoot, tr, td, th { border-style: none; }\n tr { background-color: transparent; }\n#zkgrpdffwg p { margin: 0; padding: 0; }\n #zkgrpdffwg .gt_table { display: table; border-collapse: collapse; line-height: normal; margin-left: auto; margin-right: auto; color: #333333; font-size: 16px; font-weight: normal; font-style: normal; background-color: #FFFFFF; width: auto; border-top-style: solid; border-top-width: 2px; border-top-color: #A8A8A8; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #A8A8A8; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3; }\n #zkgrpdffwg .gt_caption { padding-top: 4px; padding-bottom: 4px; }\n #zkgrpdffwg .gt_title { color: #333333; font-size: 125%; font-weight: initial; padding-top: 4px; padding-bottom: 4px; padding-left: 5px; padding-right: 5px; border-bottom-color: #FFFFFF; border-bottom-width: 0; }\n #zkgrpdffwg .gt_subtitle { color: #333333; font-size: 85%; font-weight: initial; padding-top: 3px; padding-bottom: 5px; padding-left: 5px; padding-right: 5px; border-top-color: #FFFFFF; border-top-width: 0; }\n #zkgrpdffwg .gt_heading { background-color: #FFFFFF; text-align: center; border-bottom-color: #FFFFFF; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; }\n #zkgrpdffwg .gt_bottom_border { border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; }\n #zkgrpdffwg .gt_col_headings { border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; }\n #zkgrpdffwg .gt_col_heading { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: normal; text-transform: inherit; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: bottom; padding-top: 5px; padding-bottom: 5px; padding-left: 5px; padding-right: 5px; overflow-x: hidden; }\n #zkgrpdffwg .gt_column_spanner_outer { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: normal; text-transform: inherit; padding-top: 0; padding-bottom: 0; padding-left: 4px; padding-right: 4px; }\n #zkgrpdffwg .gt_column_spanner_outer:first-child { padding-left: 0; }\n #zkgrpdffwg .gt_column_spanner_outer:last-child { padding-right: 0; }\n #zkgrpdffwg .gt_column_spanner { border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; vertical-align: bottom; padding-top: 5px; padding-bottom: 5px; overflow-x: hidden; display: inline-block; width: 100%; }\n #zkgrpdffwg .gt_spanner_row { border-bottom-style: hidden; }\n #zkgrpdffwg .gt_group_heading { padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; text-align: left; }\n #zkgrpdffwg .gt_empty_group_heading { padding: 0.5px; color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; vertical-align: middle; }\n #zkgrpdffwg .gt_from_md> :first-child { margin-top: 0; }\n #zkgrpdffwg .gt_from_md> :last-child { margin-bottom: 0; }\n #zkgrpdffwg .gt_row { padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; margin: 10px; border-top-style: solid; border-top-width: 1px; border-top-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; overflow-x: hidden; }\n #zkgrpdffwg .gt_stub { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-right-style: solid; border-right-width: 2px; border-right-color: #D3D3D3; padding-left: 5px; padding-right: 5px; }\n #zkgrpdffwg .gt_stub_row_group { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-right-style: solid; border-right-width: 2px; border-right-color: #D3D3D3; padding-left: 5px; padding-right: 5px; vertical-align: top; }\n #zkgrpdffwg .gt_row_group_first td { border-top-width: 2px; }\n #zkgrpdffwg .gt_row_group_first th { border-top-width: 2px; }\n #zkgrpdffwg .gt_striped { background-color: rgba(128,128,128,0.05); }\n #zkgrpdffwg .gt_table_body { border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; }\n #zkgrpdffwg .gt_sourcenotes { color: #333333; background-color: #FFFFFF; border-bottom-style: none; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; }\n #zkgrpdffwg .gt_sourcenote { font-size: 90%; padding-top: 4px; padding-bottom: 4px; padding-left: 5px; padding-right: 5px; text-align: left; }\n #zkgrpdffwg .gt_left { text-align: left; }\n #zkgrpdffwg .gt_center { text-align: center; }\n #zkgrpdffwg .gt_right { text-align: right; font-variant-numeric: tabular-nums; }\n #zkgrpdffwg .gt_font_normal { font-weight: normal; }\n #zkgrpdffwg .gt_font_bold { font-weight: bold; }\n #zkgrpdffwg .gt_font_italic { font-style: italic; }\n #zkgrpdffwg .gt_super { font-size: 65%; }\n #zkgrpdffwg .gt_footnote_marks { font-size: 75%; vertical-align: 0.4em; position: initial; }\n #zkgrpdffwg .gt_asterisk { font-size: 100%; vertical-align: 0; }\n \n</style>\n<table class="gt_table" data-quarto-disable-processing="false" data-quarto-bootstrap="false">\n<thead>\n\n<tr class="gt_col_headings">\n  <th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="row">row</th>\n</tr>\n</thead>\n<tbody class="gt_table_body">\n  <tr>\n    <td class="gt_row gt_left">row_1</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_2</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_3</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_4</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_5</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_6</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_7</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_8</td>\n  </tr>\n</tbody>\n\n\n</table>\n\n</div>\n        '
    +
    '<div id="vngpmdgrpi" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">\n<style>\n#vngpmdgrpi table {\n          font-family: -apple-system, BlinkMacSystemFont, \'Segoe UI\', Roboto, Oxygen, Ubuntu, Cantarell, \'Helvetica Neue\', \'Fira Sans\', \'Droid Sans\', Arial, sans-serif;\n          -webkit-font-smoothing: antialiased;\n          -moz-osx-font-smoothing: grayscale;\n        }\n\n#vngpmdgrpi thead, tbody, tfoot, tr, td, th { border-style: none; }\n tr { background-color: transparent; }\n#vngpmdgrpi p { margin: 0; padding: 0; }\n #vngpmdgrpi .gt_table { display: table; border-collapse: collapse; line-height: normal; margin-left: auto; margin-right: auto; color: #333333; font-size: 16px; font-weight: normal; font-style: normal; background-color: #FFFFFF; width: auto; border-top-style: solid; border-top-width: 2px; border-top-color: #A8A8A8; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #A8A8A8; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3; }\n #vngpmdgrpi .gt_caption { padding-top: 4px; padding-bottom: 4px; }\n #vngpmdgrpi .gt_title { color: #333333; font-size: 125%; font-weight: initial; padding-top: 4px; padding-bottom: 4px; padding-left: 5px; padding-right: 5px; border-bottom-color: #FFFFFF; border-bottom-width: 0; }\n #vngpmdgrpi .gt_subtitle { color: #333333; font-size: 85%; font-weight: initial; padding-top: 3px; padding-bottom: 5px; padding-left: 5px; padding-right: 5px; border-top-color: #FFFFFF; border-top-width: 0; }\n #vngpmdgrpi .gt_heading { background-color: #FFFFFF; text-align: center; border-bottom-color: #FFFFFF; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; }\n #vngpmdgrpi .gt_bottom_border { border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; }\n #vngpmdgrpi .gt_col_headings { border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; }\n #vngpmdgrpi .gt_col_heading { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: normal; text-transform: inherit; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: bottom; padding-top: 5px; padding-bottom: 5px; padding-left: 5px; padding-right: 5px; overflow-x: hidden; }\n #vngpmdgrpi .gt_column_spanner_outer { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: normal; text-transform: inherit; padding-top: 0; padding-bottom: 0; padding-left: 4px; padding-right: 4px; }\n #vngpmdgrpi .gt_column_spanner_outer:first-child { padding-left: 0; }\n #vngpmdgrpi .gt_column_spanner_outer:last-child { padding-right: 0; }\n #vngpmdgrpi .gt_column_spanner { border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; vertical-align: bottom; padding-top: 5px; padding-bottom: 5px; overflow-x: hidden; display: inline-block; width: 100%; }\n #vngpmdgrpi .gt_spanner_row { border-bottom-style: hidden; }\n #vngpmdgrpi .gt_group_heading { padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; text-align: left; }\n #vngpmdgrpi .gt_empty_group_heading { padding: 0.5px; color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; vertical-align: middle; }\n #vngpmdgrpi .gt_from_md> :first-child { margin-top: 0; }\n #vngpmdgrpi .gt_from_md> :last-child { margin-bottom: 0; }\n #vngpmdgrpi .gt_row { padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; margin: 10px; border-top-style: solid; border-top-width: 1px; border-top-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; overflow-x: hidden; }\n #vngpmdgrpi .gt_stub { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-right-style: solid; border-right-width: 2px; border-right-color: #D3D3D3; padding-left: 5px; padding-right: 5px; }\n #vngpmdgrpi .gt_stub_row_group { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-right-style: solid; border-right-width: 2px; border-right-color: #D3D3D3; padding-left: 5px; padding-right: 5px; vertical-align: top; }\n #vngpmdgrpi .gt_row_group_first td { border-top-width: 2px; }\n #vngpmdgrpi .gt_row_group_first th { border-top-width: 2px; }\n #vngpmdgrpi .gt_striped { background-color: rgba(128,128,128,0.05); }\n #vngpmdgrpi .gt_table_body { border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; }\n #vngpmdgrpi .gt_sourcenotes { color: #333333; background-color: #FFFFFF; border-bottom-style: none; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; }\n #vngpmdgrpi .gt_sourcenote { font-size: 90%; padding-top: 4px; padding-bottom: 4px; padding-left: 5px; padding-right: 5px; text-align: left; }\n #vngpmdgrpi .gt_left { text-align: left; }\n #vngpmdgrpi .gt_center { text-align: center; }\n #vngpmdgrpi .gt_right { text-align: right; font-variant-numeric: tabular-nums; }\n #vngpmdgrpi .gt_font_normal { font-weight: normal; }\n #vngpmdgrpi .gt_font_bold { font-weight: bold; }\n #vngpmdgrpi .gt_font_italic { font-style: italic; }\n #vngpmdgrpi .gt_super { font-size: 65%; }\n #vngpmdgrpi .gt_footnote_marks { font-size: 75%; vertical-align: 0.4em; position: initial; }\n #vngpmdgrpi .gt_asterisk { font-size: 100%; vertical-align: 0; }\n \n</style>\n<table class="gt_table" data-quarto-disable-processing="false" data-quarto-bootstrap="false">\n<thead>\n\n<tr class="gt_col_headings">\n  <th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="row">row</th>\n</tr>\n</thead>\n<tbody class="gt_table_body">\n  <tr>\n    <td class="gt_row gt_left">row_1</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_2</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_3</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_4</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_5</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_6</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_7</td>\n  </tr>\n  <tr>\n    <td class="gt_row gt_left">row_8</td>\n  </tr>\n</tbody>\n\n\n</table>\n\n</div>\n        '
    diff --git a/reference/GT.cols_align.html b/reference/GT.cols_align.html index 17819ede5..79023573c 100644 --- a/reference/GT.cols_align.html +++ b/reference/GT.cols_align.html @@ -215,7 +215,7 @@

    align : str = 'left'
    -

    The alignment to apply. Must be one of \"left\", \"center\", or \"right\".

    +

    The alignment to apply. Must be one of "left", "center", or "right".

    columns : SelectExpr = None
    @@ -235,7 +235,7 @@

    Re

    Examples

    Let’s use the countrypops to create a small table. We can change the alignment of the population column with cols_align(). In this example, the column label and body cells of population will be aligned to the left.

    -
    +
    from great_tables import GT
 from great_tables.data import countrypops
 
@@ -248,52 +248,52 @@ 
    
     .cols_align(align="left", columns="population")
 )
    -
    +

    diff --git a/reference/GT.cols_hide.html b/reference/GT.cols_hide.html index 4f4c872e8..757c98deb 100644 --- a/reference/GT.cols_hide.html +++ b/reference/GT.cols_hide.html @@ -232,7 +232,7 @@

    Re

    Examples

    For this example, we’ll use a portion of the countrypops dataset to create a simple table. Let’s hide the year column with the cols_hide() method.

    -
    +
    from great_tables import GT
 from great_tables.data import countrypops
 
@@ -242,52 +242,52 @@ 
    
 
 GT(countrypops_mini).cols_hide(columns="year")
    -
    +

    diff --git a/reference/GT.cols_label.html b/reference/GT.cols_label.html index 26ba9da06..49846a15b 100644 --- a/reference/GT.cols_label.html +++ b/reference/GT.cols_label.html @@ -246,7 +246,7 @@

    Notes<

    Examples

    The example below relabels columns from the countrypops data to start with uppercase.

    -
    +
    from great_tables import GT
 from great_tables.data import countrypops
 
@@ -263,52 +263,52 @@ 
    
     )
 )
    -
    +

    @@ -357,7 +357,7 @@

    Note that we supplied the name of the column as the key, and the new label as the value.

    We can also use Markdown formatting for the column labels. In this example, we’ll use md("*Population*") to make the label italicized.

    -
    +
    from great_tables import GT, md
 from great_tables.data import countrypops
 
@@ -370,52 +370,52 @@ 
    
     )
 )
    -
    +

    @@ -463,7 +463,7 @@

    We can also use unit notation to format the column labels. In this example, we’ll use {cm^3 molecules^-1 s^-1} for part of the label for the OH_k298 column.

    -
    +
    from great_tables import GT
 from great_tables.data import reactions
 import polars as pl
@@ -484,52 +484,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/GT.cols_move.html b/reference/GT.cols_move.html index cf58f7a6c..385fea9fb 100644 --- a/reference/GT.cols_move.html +++ b/reference/GT.cols_move.html @@ -236,7 +236,7 @@

    Re

    Examples

    Let’s use the countrypops dataset to create a table. We’ll choose to position the population column after the country_name column by using the cols_move() method.

    -
    +
    from great_tables import GT
 from great_tables.data import countrypops
 
@@ -252,52 +252,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/GT.cols_move_to_end.html b/reference/GT.cols_move_to_end.html index 20a97a241..689f73f10 100644 --- a/reference/GT.cols_move_to_end.html +++ b/reference/GT.cols_move_to_end.html @@ -231,7 +231,7 @@

    Re

    Examples

    For this example, we’ll use a portion of the countrypops dataset to create a simple table. Let’s move the year column, which is the middle column, to the end of the column series with the cols_move_to_end() method.

    -
    +
    from great_tables import GT
 from great_tables.data import countrypops
 
@@ -241,52 +241,52 @@ 
    
 
 GT(countrypops_mini).cols_move_to_end(columns="year")
    -
    +

    @@ -334,55 +334,55 @@

    We can also move multiple columns at a time. With the same countrypops-based table (countrypops_mini), let’s move both the year and country_name columns to the end of the column series.

    -
    +
    GT(countrypops_mini).cols_move_to_end(columns=["year", "country_name"])
    -
    +

    diff --git a/reference/GT.cols_move_to_start.html b/reference/GT.cols_move_to_start.html index 57b50c968..bb991d9c7 100644 --- a/reference/GT.cols_move_to_start.html +++ b/reference/GT.cols_move_to_start.html @@ -232,7 +232,7 @@

    Re

    Examples

    For this example, we’ll use a portion of the countrypops dataset to create a simple table. Let’s move the year column, which is the middle column, to the start of the column series with the cols_move_to_start() method.

    -
    +
    from great_tables import GT
 from great_tables.data import countrypops
 
@@ -242,52 +242,52 @@ 
    
 
 GT(countrypops_mini).cols_move_to_start(columns="year")
    -
    +

    @@ -335,55 +335,55 @@

    We can also move multiple columns at a time. With the same countrypops-based table (countrypops_mini), let’s move both the year and population columns to the start of the column series.

    -
    +
    GT(countrypops_mini).cols_move_to_start(columns=["year", "population"])
    -
    +

    diff --git a/reference/GT.cols_width.html b/reference/GT.cols_width.html index 96c7b37e0..e9e867a5b 100644 --- a/reference/GT.cols_width.html +++ b/reference/GT.cols_width.html @@ -215,7 +215,7 @@

    cases : dict[str, str] | None = None
    -

    A dictionary where the keys are column names and the values are the widths. Widths can be specified in pixels (e.g., \"50px\") or as percentages (e.g., \"20%\").

    +

    A dictionary where the keys are column names and the values are the widths. Widths can be specified in pixels (e.g., "50px") or as percentages (e.g., "20%").

    ****kwargs** : str = {}
    @@ -235,7 +235,7 @@

    Re

    Examples

    Let’s use select columns from the exibble dataset to create a new table. We can specify the widths of columns with cols_width(). This is done by specifying the exact widths for table columns in a dictionary. In this example, we’ll set the width of the num column to "150px", the char column to "100px", the date column to "300px". All other columns won’t be affected (their widths will be automatically set by their content).

    -
    +
    from great_tables import GT, exibble
 
 exibble_mini = exibble[["num", "char", "date", "datetime", "row"]].head(5)
@@ -251,52 +251,52 @@ 
    
     )
 )
    -
    +

    @@ -364,7 +364,7 @@

    We can also specify the widths of columns as percentages. In this example, we’ll set the width of the num column to "20%", the char column to "10%", and the date column to "30%". Note that the percentages are relative and don’t need to sum to 100%.

    -
    +
    (
     GT(exibble_mini)
     .cols_width(
@@ -376,52 +376,52 @@ 
    
     )
 )
    -
    +

    @@ -489,7 +489,7 @@

    We can also mix and match pixel and percentage widths. In this example, we’ll set the width of the num column to "150px", the char column to "10%", and the date column to "30%".

    -
    +
    (
     GT(exibble_mini)
     .cols_width(
@@ -501,52 +501,52 @@ 
    
     )
 )
    -
    +

    @@ -614,7 +614,7 @@

    If we set the width of all columns, the table will be forced to use the specified widths (i.e., a column width less than the content width will be honored). In this next example, we’ll set widths for all columns. This is a good way to ensure that the widths you specify are fully respected (and not overridden by automatic width calculations).

    -
    +
    (
     GT(exibble_mini)
     .cols_width(
@@ -628,52 +628,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/GT.data_color.html b/reference/GT.data_color.html index 41ad0037c..ae072e90f 100644 --- a/reference/GT.data_color.html +++ b/reference/GT.data_color.html @@ -240,7 +240,7 @@

    palette : str | list[str] | None = None
    -

    The color palette to use. This should be a list of colors (e.g., [\"#FF0000\", \"#00FF00\", \"#0000FF\"]). A ColorBrewer palette could also be used, just supply the name (reference available in the Color palette access from ColorBrewer section). If None, then a default palette will be used.

    +

    The color palette to use. This should be a list of colors (e.g., ["#FF0000", "#00FF00", "#0000FF"]). A ColorBrewer palette could also be used, just supply the name (reference available in the Color palette access from ColorBrewer section). If None, then a default palette will be used.

    domain : list[str] | list[int] | list[float] | None = None
    @@ -248,7 +248,7 @@

    na_color : str | None = None
    -

    The color to use for missing values. If None, then the default color (\"#808080\") will be used.

    +

    The color to use for missing values. If None, then the default color ("#808080") will be used.

    alpha : int | float | None = None
    @@ -539,58 +539,58 @@

    Examples

    The data_color() method can be used without any supplied arguments to colorize a table. Let’s do this with the exibble dataset:

    -
    +
    from great_tables import GT
 from great_tables.data import exibble
 
 GT(exibble).data_color()
    -
    +

    @@ -708,58 +708,58 @@

    What’s happened is that data_color() applies background colors to all cells of every column with the palette of eight colors. Numeric columns will use ‘numeric’ methodology for color scaling whereas string-based columns will use the ‘factor’ methodology. The text color undergoes an automatic modification that maximizes contrast (since autocolor_text=True by default).

    We can target specific colors and apply color to just those columns. Let’s do that and also supply palette= values of "red" and "green".

    -
    +
    GT(exibble).data_color(
     columns=["num", "currency"],
     palette=["red", "green"]
 )
    -
    +

    @@ -877,7 +877,7 @@

    With those options in place we see that only the numeric columns num and currency received color treatments. Moreover, the palette colors were mapped to the lower and upper limits of the data in each column; interpolated colors were used for the values in between the numeric limits of the two columns.

    We can manually set the limits of the data with the domain= argument (which is preferable in most cases). Let’s colorize just the currency column and set domain=[0, 50]. Any values that are either missing or lie outside of the domain will be colorized with the na_color= color (so we’ll set that to "lightgray").

    -
    +
    GT(exibble).data_color(
     columns="currency",
     palette=["red", "green"],
@@ -885,52 +885,52 @@ 
    
     na_color="lightgray"
 )
    -
    +

    diff --git a/reference/GT.fmt.html b/reference/GT.fmt.html index 1de0765bc..0e268f60d 100644 --- a/reference/GT.fmt.html +++ b/reference/GT.fmt.html @@ -244,7 +244,7 @@

    Re

    Examples

    Let’s use the exibble dataset to create a table. With the fmt() method, we’ll add a prefix ^ and a suffix $ to the row and group columns.

    -
    +
    from great_tables import GT, exibble
 
 (
@@ -252,52 +252,52 @@ 
    
     .fmt(lambda x: f"^{x}$", columns=["row", "group"])
 )
    -
    +

    diff --git a/reference/GT.fmt_bytes.html b/reference/GT.fmt_bytes.html index 8e56c1ca6..ce983d0de 100644 --- a/reference/GT.fmt_bytes.html +++ b/reference/GT.fmt_bytes.html @@ -247,11 +247,11 @@

    standard : str = 'decimal'
    -

    The form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., \"kB\" and \"MB\"), and (2) binary units (powers of 1024; e.g., \"KiB\" and \"MiB\"). The default is to use decimal units with the \"decimal\" option. The alternative is to use binary units with the \"binary\" option.

    +

    The form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., "kB" and "MB"), and (2) binary units (powers of 1024; e.g., "KiB" and "MiB"). The default is to use decimal units with the "decimal" option. The alternative is to use binary units with the "binary" option.

    decimals : int = 1
    -

    This corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.

    +

    This corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in "2". With 4 decimal places, the formatted value becomes "2.3400". The trailing zeros can be removed with drop_trailing_zeros=True.

    drop_trailing_zeros : bool = True
    @@ -271,11 +271,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -287,7 +287,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    @@ -308,7 +308,7 @@

    Examples

    Let’s use a single column from the exibble dataset and create a new table. We’ll format the num column to display as byte sizes in the decimal standard through use of the fmt_bytes() method.

    -
    +
    from great_tables import GT, exibble
 
 (
@@ -316,52 +316,52 @@ 
    
     .fmt_bytes(columns="num", standard="decimal")
 )
    -
    +

    diff --git a/reference/GT.fmt_currency.html b/reference/GT.fmt_currency.html index 83a80cf6b..84d863a03 100644 --- a/reference/GT.fmt_currency.html +++ b/reference/GT.fmt_currency.html @@ -251,15 +251,15 @@

    currency : str | None = None
    -

    The currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., \"USD\" for U.S. Dollars, \"EUR\" for the Euro currency).

    +

    The currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., "USD" for U.S. Dollars, "EUR" for the Euro currency).

    use_subunits : bool = True
    -

    An option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce \"$273.81\". Removing the subunits (with use_subunits = False) will give us \"$273\".

    +

    An option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce "$273.81". Removing the subunits (with use_subunits = False) will give us "$273".

    decimals : int | None = None
    -

    The decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is \"USD\" it would result in \"$2\". With 4 decimal places, the formatted value becomes \"$2.3400\".

    +

    The decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is "USD" it would result in "$2". With 4 decimal places, the formatted value becomes "$2.3400".

    drop_trailing_dec_mark : bool = True
    @@ -279,11 +279,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -291,7 +291,7 @@

    placement : str = 'left'
    -

    The placement of the currency symbol. This can be either be \"left\" (as in \"$450\") or \"right\" (which yields \"450$\").

    +

    The placement of the currency symbol. This can be either be "left" (as in "$450") or "right" (which yields "450$").

    incl_space : bool = False
    @@ -299,7 +299,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    @@ -320,7 +320,7 @@

    Examples

    Let’s use the exibble dataset to create a table. With the fmt_currency() method, we’ll format the currency column to display monetary values.

    -
    +
    from great_tables import GT, exibble
 
 (
@@ -332,52 +332,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/GT.fmt_date.html b/reference/GT.fmt_date.html index 7d648f5bc..b76015b03 100644 --- a/reference/GT.fmt_date.html +++ b/reference/GT.fmt_date.html @@ -233,7 +233,7 @@

    date_style : DateStyle = 'iso'
    -

    The date style to use. By default this is the short name \"iso\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().

    +

    The date style to use. By default this is the short name "iso" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().

    pattern : str = '{x}'
    @@ -241,7 +241,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    @@ -362,7 +362,7 @@

    Examples

    Let’s use the exibble dataset to create a simple, two-column table (keeping only the date and time columns). With the fmt_date() method, we’ll format the date column to display dates formatted with the "month_day_year" date style.

    -
    +
    from great_tables import GT, exibble
 
 exibble_mini = exibble[["date", "time"]]
@@ -372,52 +372,52 @@ 
    
     .fmt_date(columns="date", date_style="month_day_year")
 )
    -
    +

    diff --git a/reference/GT.fmt_datetime.html b/reference/GT.fmt_datetime.html index 804944c6a..9ff36deb4 100644 --- a/reference/GT.fmt_datetime.html +++ b/reference/GT.fmt_datetime.html @@ -233,11 +233,11 @@

    date_style : DateStyle = 'iso'
    -

    The date style to use. By default this is the short name \"iso\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().

    +

    The date style to use. By default this is the short name "iso" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().

    time_style : TimeStyle = 'iso'
    -

    The time style to use. By default this is the short name \"iso\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().

    +

    The time style to use. By default this is the short name "iso" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().

    @@ -397,7 +397,7 @@

    Re

    Examples

    Let’s use the exibble dataset to create a simple, two-column table (keeping only the date and time columns). With the fmt_datetime() method, we’ll format the date column to display dates formatted with the "month_day_year" date style and the time column to display times formatted with the "h_m_s_p" time style.

    -
    +
    from great_tables import GT, exibble
 
 exibble_mini = exibble[["date", "time"]]
@@ -411,52 +411,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/GT.fmt_image.html b/reference/GT.fmt_image.html index 72f398f8e..635d79901 100644 --- a/reference/GT.fmt_image.html +++ b/reference/GT.fmt_image.html @@ -249,7 +249,7 @@

    file_pattern : str = '{}'
    -

    The pattern to use for mapping input values in the body cells to the names of the graphics files. The string supplied should use \"{}\" in the pattern to map filename fragments to input strings.

    +

    The pattern to use for mapping input values in the body cells to the names of the graphics files. The string supplied should use "{}" in the pattern to map filename fragments to input strings.

    encode : bool = True
    @@ -269,7 +269,7 @@

    Re

    Examples

    Using a small portion of metro dataset, let’s create a new table. We will only include a few columns and rows from that table. The lines column has comma-separated listings of numbers corresponding to lines served at each station. We have a directory of SVG graphics for all of these lines in the package (the path for the image directory can be accessed via files("great_tables") / "data/metro_images", using the importlib_resources package). The filenames roughly corresponds to the data in the lines column. The fmt_image() method can be used with these inputs since the path= and file_pattern= arguments allow us to compose complete and valid file locations. What you get from this are sequences of images in the table cells, taken from the referenced graphics files on disk.

    -
    +
    from great_tables import GT
 from great_tables.data import metro
 from importlib_resources import files
@@ -288,52 +288,52 @@ 
    
     .fmt_integer(columns="passengers")
 )
    -
    +

    diff --git a/reference/GT.fmt_integer.html b/reference/GT.fmt_integer.html index 3fc264efb..d3b13c2bb 100644 --- a/reference/GT.fmt_integer.html +++ b/reference/GT.fmt_integer.html @@ -260,7 +260,7 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -268,7 +268,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    @@ -289,7 +289,7 @@

    Examples

    For this example, we’ll use the exibble dataset as the input table. With the fmt_integer() method, we’ll format the num column as integer values having no digit separators (with the use_seps=False option).

    -
    +
    from great_tables import GT, exibble
 
 (
@@ -297,52 +297,52 @@ 
    
     .fmt_integer(columns="num", use_seps=False)
 )
    -
    +

    diff --git a/reference/GT.fmt_markdown.html b/reference/GT.fmt_markdown.html index c269e1aae..d73dc3231 100644 --- a/reference/GT.fmt_markdown.html +++ b/reference/GT.fmt_markdown.html @@ -236,7 +236,7 @@

    Re

    Examples:

    Let’s first create a DataFrame containing some text that is Markdown-formatted and then introduce that to GT(). We’ll then transform the md column with the fmt_markdown() method.

    -
    +
    import pandas as pd
 from great_tables import GT
 from great_tables.data import towny
@@ -260,52 +260,52 @@ 
    
 
 (GT(df).fmt_markdown("md"))
    -
    +

    diff --git a/reference/GT.fmt_nanoplot.html b/reference/GT.fmt_nanoplot.html index 50dae0bd8..c00503575 100644 --- a/reference/GT.fmt_nanoplot.html +++ b/reference/GT.fmt_nanoplot.html @@ -250,15 +250,15 @@

    plot_type : PlotType = 'line'
    -

    Nanoplots can either take the form of a line plot (using \"line\") or a bar plot (with \"bar\"). A line plot, by default, contains layers for a data line, data points, and a data area. With a bar plot, the always visible layer is that of the data bars.

    +

    Nanoplots can either take the form of a line plot (using "line") or a bar plot (with "bar"). A line plot, by default, contains layers for a data line, data points, and a data area. With a bar plot, the always visible layer is that of the data bars.

    plot_height : str = '2em'
    -

    The height of the nanoplots. The default here is a sensible value of \"2em\".

    +

    The height of the nanoplots. The default here is a sensible value of "2em".

    missing_vals : MissingVals = 'marker'
    -

    If missing values are encountered within the input data, there are three strategies available for their handling: (1) \"gap\" will show data gaps at the sites of missing data, where data lines will have discontinuities and bar plots will have missing bars; (2) \"marker\" will behave like \"gap\" but show prominent visual marks at the missing data locations; (3) \"zero\" will replace missing values with zero values; and (4) \"remove\" will remove any incoming missing values.

    +

    If missing values are encountered within the input data, there are three strategies available for their handling: (1) "gap" will show data gaps at the sites of missing data, where data lines will have discontinuities and bar plots will have missing bars; (2) "marker" will behave like "gap" but show prominent visual marks at the missing data locations; (3) "zero" will replace missing values with zero values; and (4) "remove" will remove any incoming missing values.

    autoscale : bool = False
    @@ -266,11 +266,11 @@

    reference_line : str | int | float | None = None
    -

    A reference line requires a single input to define the line. It could be a numeric value, applied to all nanoplots generated. Or, the input can be one of the following for generating the line from the underlying data: (1) \"mean\", (2) \"median\", (3) \"min\", (4) \"max\", (5) \"q1\", (6) \"q3\", (7) \"first\", or (8) \"last\".

    +

    A reference line requires a single input to define the line. It could be a numeric value, applied to all nanoplots generated. Or, the input can be one of the following for generating the line from the underlying data: (1) "mean", (2) "median", (3) "min", (4) "max", (5) "q1", (6) "q3", (7) "first", or (8) "last".

    reference_area : list[Any] | None = None
    -

    A reference area requires a list of two values for defining bottom and top boundaries (in the y direction) for a rectangular area. The types of values supplied are the same as those expected for reference_line=, which is either a numeric value or one of the following keywords for the generation of the value: (1) \"mean\", (2) \"median\", (3) \"min\", (4) \"max\", (5) \"q1\", (6) \"q3\", (7) \"first\", or (8) \"last\". Input can either be a vector or list with two elements.

    +

    A reference area requires a list of two values for defining bottom and top boundaries (in the y direction) for a rectangular area. The types of values supplied are the same as those expected for reference_line=, which is either a numeric value or one of the following keywords for the generation of the value: (1) "mean", (2) "median", (3) "min", (4) "max", (5) "q1", (6) "q3", (7) "first", or (8) "last". Input can either be a vector or list with two elements.

    expand_x : list[int] | list[float] | list[int | float] | None = None
    @@ -303,7 +303,7 @@

    De

    Examples

    Let’s create a nanoplot from a Polars DataFrame containing multiple numbers per cell. The numbers are represented here as strings, where spaces separate the values, and the same values are present in two columns: lines and bars. We will use the fmt_nanoplot() method twice to create a line plot and a bar plot from the data in their respective columns.

    -
    +
    from great_tables import GT
 import polars as pl
 
@@ -325,52 +325,52 @@ 
    
     .fmt_nanoplot(columns="bars", plot_type="bar")
 )
    -
    +

    @@ -413,7 +413,7 @@

    We can always represent the input DataFrame in a different way (with list columns) and fmt_nanoplot() will still work. While the input data is the same as in the previous example, we’ll take the opportunity here to add a reference line and a reference area to the line plot and also to the bar plot.

    -
    +
    random_numbers_df = pl.DataFrame(
     {
         "i": range(1, 5),
@@ -440,52 +440,52 @@ 
    
         reference_area=["max", "median"])
 )
    -
    +

    @@ -528,7 +528,7 @@

    Here’s an example to adjust some of the options using nanoplot_options().

    -
    +
    from great_tables import nanoplot_options
 
 (
@@ -568,52 +568,52 @@ 
    
     )
 )
    -
    +

    @@ -656,7 +656,7 @@

    Single-value bar plots and line plots can be made with fmt_nanoplot(). These run in the horizontal direction, which is ideal for tabular presentation. The key thing here is that fmt_nanoplot() expects a column of numeric values. These plots are meant for comparison across rows so the method automatically scales the horizontal bars to facilitate this type of display. The following example shows how fmt_nanoplot() can be used to create single-value bar and line plots.

    -
    +
    single_vals_df = pl.DataFrame(
     {
         "i": range(1, 6),
@@ -670,52 +670,52 @@ 
    
     .fmt_nanoplot(columns="lines", plot_type="line")
 )
    -
    +

    diff --git a/reference/GT.fmt_number.html b/reference/GT.fmt_number.html index 8b626b861..e9c2726a6 100644 --- a/reference/GT.fmt_number.html +++ b/reference/GT.fmt_number.html @@ -249,7 +249,7 @@

    decimals : int = 2
    -

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the fmt_integer() method should be considered.

    +

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in "2". With 4 decimal places, the formatted value becomes "2.3400". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the fmt_integer() method should be considered.

    n_sigfig : int | None = None
    @@ -281,11 +281,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -293,7 +293,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    @@ -314,7 +314,7 @@

    Examples

    Let’s use the exibble dataset to create a table. With the fmt_number() method, we’ll format the num column to have three decimal places (with decimals=3) and omit the use of digit separators (with use_seps=False).

    -
    +
    from great_tables import GT, exibble
 
 (
@@ -322,52 +322,52 @@ 
    
     .fmt_number(columns="num", decimals=3, use_seps=False)
 )
    -
    +

    diff --git a/reference/GT.fmt_percent.html b/reference/GT.fmt_percent.html index 8f01ce609..3db314d12 100644 --- a/reference/GT.fmt_percent.html +++ b/reference/GT.fmt_percent.html @@ -249,7 +249,7 @@

    decimals : int = 2
    -

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.

    +

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in "2". With 4 decimal places, the formatted value becomes "2.3400". The trailing zeros can be removed with drop_trailing_zeros=True.

    drop_trailing_zeros : bool = False
    @@ -273,11 +273,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -285,7 +285,7 @@

    placement : str = 'right'
    -

    This option governs the placement of the percent sign. This can be either be \"right\" (the default) or \"left\".

    +

    This option governs the placement of the percent sign. This can be either be "right" (the default) or "left".

    incl_space : bool = False
    @@ -293,7 +293,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    @@ -314,7 +314,7 @@

    Examples

    Let’s use the towny dataset as the input table. With the fmt_percent() method, we’ll format the pop_change_2016_2021_pct column to to display values as percentages (to two decimal places).

    -
    +
    from great_tables import GT
 from great_tables.data import towny
 
@@ -325,52 +325,52 @@ 
    
 
 (GT(towny_mini).fmt_percent("pop_change_2016_2021_pct", decimals=2))
    -
    +

    diff --git a/reference/GT.fmt_roman.html b/reference/GT.fmt_roman.html index 46cfdd371..2859412dc 100644 --- a/reference/GT.fmt_roman.html +++ b/reference/GT.fmt_roman.html @@ -224,7 +224,7 @@

    case : str = 'upper'
    -

    Should Roman numerals should be rendered as uppercase (\"upper\") or lowercase (\"lower\") letters? By default, this is set to \"upper\".

    +

    Should Roman numerals should be rendered as uppercase ("upper") or lowercase ("lower") letters? By default, this is set to "upper".

    pattern : str = '{x}'
    @@ -244,7 +244,7 @@

    Re

    Examples

    Let’s first create a DataFrame containing small numeric values and then introduce that to GT(). We’ll then format the roman column to appear as Roman numerals with the fmt_roman() method.

    -
    +
    import pandas as pd
 from great_tables import GT
 
@@ -255,52 +255,52 @@ 
    
     .fmt_roman(columns="roman")
 )
    -
    +

    diff --git a/reference/GT.fmt_scientific.html b/reference/GT.fmt_scientific.html index 7eca7115b..94a586320 100644 --- a/reference/GT.fmt_scientific.html +++ b/reference/GT.fmt_scientific.html @@ -248,7 +248,7 @@

    decimals : int = 2
    -

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.

    +

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in "2". With 4 decimal places, the formatted value becomes "2.3400". The trailing zeros can be removed with drop_trailing_zeros=True.

    n_sigfig : int | None = None
    @@ -268,7 +268,7 @@

    exp_style : str = 'x10n'
    -

    Style of formatting to use for the scientific notation formatting. By default this is \"x10n\" but other options include using a single letter (e.g., \"e\", \"E\", etc.), a letter followed by a \"1\" to signal a minimum digit width of one, or \"low-ten\" for using a stylized \"10\" marker.

    +

    Style of formatting to use for the scientific notation formatting. By default this is "x10n" but other options include using a single letter (e.g., "e", "E", etc.), a letter followed by a "1" to signal a minimum digit width of one, or "low-ten" for using a stylized "10" marker.

    pattern : str = '{x}'
    @@ -276,11 +276,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign_m : bool = False
    @@ -292,7 +292,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    @@ -313,7 +313,7 @@

    Examples

    For this example, we’ll use the exibble dataset as the input table. With the fmt_scientific() method, we’ll format the num column to contain values in scientific formatting.

    -
    +
    from great_tables import GT, exibble
 
 (
@@ -321,52 +321,52 @@ 
    
     .fmt_scientific(columns="num")
 )
    -
    +

    diff --git a/reference/GT.fmt_time.html b/reference/GT.fmt_time.html index 8ecc34eab..ba0341573 100644 --- a/reference/GT.fmt_time.html +++ b/reference/GT.fmt_time.html @@ -233,7 +233,7 @@

    time_style : TimeStyle = 'iso'
    -

    The time style to use. By default this is the short name \"iso\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().

    +

    The time style to use. By default this is the short name "iso" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().

    pattern : str = '{x}'
    @@ -241,7 +241,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    @@ -308,7 +308,7 @@

    Examples

    Let’s use the exibble dataset to create a simple, two-column table (keeping only the date and time columns). With the fmt_time() method, we’ll format the time column to display times formatted with the "h_m_s_p" time style.

    -
    +
    from great_tables import GT, exibble
 
 exibble_mini = exibble[["date", "time"]]
@@ -318,52 +318,52 @@ 
    
     .fmt_time(columns="time", time_style="h_m_s_p")
 )
    -
    +

    diff --git a/reference/GT.fmt_units.html b/reference/GT.fmt_units.html index ae2d4b2b7..f8e51c607 100644 --- a/reference/GT.fmt_units.html +++ b/reference/GT.fmt_units.html @@ -258,7 +258,7 @@

    Re

    Examples

    Let’s use the illness dataset and create a new table. The units column happens to contain string values in units notation (e.g., "x10^9 / L"). Using the fmt_units() method here will improve the formatting of those measurement units.

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import illness
 
@@ -284,52 +284,52 @@ 
    
     .opt_vertical_padding(scale=0.5)
 )
    -
    +

    @@ -878,7 +878,7 @@

    The constants dataset contains values for hundreds of fundamental physical constants. We’ll take a subset of values that have some molar basis and generate a new display table from that. Like the illness dataset, this one has a units column so, again, the fmt_units() method will be used to format those units. Here, the preference for typesetting measurement units is to have positive and negative exponents (e.g., not "<unit_1> / <unit_2>" but rather "<unit_1> <unit_2>^-1").

    -
    +
    from great_tables.data import constants
 import polars as pl
 import polars.selectors as cs
@@ -903,52 +903,52 @@ 
    
     .tab_options(column_labels_hidden=True)
 )
    -
    +

    diff --git a/reference/GT.html b/reference/GT.html index 21fadd438..e3633a661 100644 --- a/reference/GT.html +++ b/reference/GT.html @@ -245,7 +245,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be set as the default locale for all functions that take a locale argument. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be set as the default locale for all functions that take a locale argument. Examples include "en" for English (United States) and "fr" for French (France).

    @@ -261,57 +261,57 @@

    Re

    Examples

    Let’s use the exibble dataset for the next few examples, we’ll learn how to make simple output tables with the GT() class. The most basic thing to do is to just use GT() with the dataset as the input.

    -
    +
    from great_tables import GT, exibble
 
 GT(exibble)
    -
    +

    @@ -428,57 +428,57 @@

    This dataset has the row and group columns. The former contains unique values that are ideal for labeling rows, and this often happens in what is called the ‘stub’ (a reserved area that serves to label rows). With the GT() class, we can immediately place the contents of the row column into the stub column. To do this, we use the rowname_col= argument with the appropriate column name.

    -
    +
    from great_tables import GT, exibble
 
 GT(exibble, rowname_col="row")
    -
    +

    @@ -596,57 +596,57 @@

    This sets up a table with a stub, the row labels are placed within the stub column, and a vertical dividing line has been placed on the right-hand side.

    The group column contains categorical values that are ideal for grouping rows. We can use the groupname_col= argument to place these values into row groups.

    -
    +
    from great_tables import GT, exibble
 
 GT(exibble, rowname_col="row", groupname_col="group")
    -
    +

    @@ -760,57 +760,57 @@

    By default, values in the body of a table (and their column labels) are automatically aligned. The alignment is governed by the types of values in a column. If you’d like to disable this form of auto-alignment, the auto_align=False option can be taken.

    -
    +
    from great_tables import GT, exibble
 
 GT(exibble, rowname_col="row", auto_align=False)
    -
    +

    @@ -928,7 +928,7 @@

    What you’ll get from that is center-alignment of all table body values and all column labels. Note that row labels in the the stub are still left-aligned; and auto_align= has no effect on alignment within the table stub.

    However which way you generate the initial table object, you can modify it with a huge variety of methods to further customize the presentation. Formatting body cells is commonly done with the family of formatting methods (e.g., fmt_number(), fmt_date(), etc.). The package supports formatting with internationalization (‘i18n’ features) and so locale-aware methods all come with a locale= argument. To avoid having to use that argument repeatedly, the GT() class has its own locale= argument. Setting a locale in that will make it available globally. Here’s an example of how that works in practice when setting locale = "fr" in GT() prior to using formatting methods:

    -
    +
    from great_tables import GT, exibble
 
 (
@@ -938,52 +938,52 @@ 
    
     .fmt_date(columns="date", date_style="day_month_year")
 )
    -
    +

    diff --git a/reference/GT.opt_align_table_header.html b/reference/GT.opt_align_table_header.html index 77e202202..c56589b93 100644 --- a/reference/GT.opt_align_table_header.html +++ b/reference/GT.opt_align_table_header.html @@ -215,7 +215,7 @@

    align : str = 'center'
    -

    The alignment of the title and subtitle elements in the table header. Options are \"center\" (the default), \"left\", or \"right\".

    +

    The alignment of the title and subtitle elements in the table header. Options are "center" (the default), "left", or "right".

    @@ -231,7 +231,7 @@

    Re

    Examples

    Using select columns from the exibble dataset, let’s create a table with a number of components added. Following that, we’ll align the header contents (consisting of the title and the subtitle) to the left with the opt_align_table_header() method.

    -
    +
    from great_tables import GT, exibble, md
 
 (
@@ -250,52 +250,52 @@ 
    
   .opt_align_table_header(align="left")
 )
    -
    +

    diff --git a/reference/GT.opt_all_caps.html b/reference/GT.opt_all_caps.html index 9bbbf2087..876f1d0c8 100644 --- a/reference/GT.opt_all_caps.html +++ b/reference/GT.opt_all_caps.html @@ -223,7 +223,7 @@

    locations : str | list[str] = ['column_labels', 'stub', 'row_group']
    -

    Which locations should undergo this text transformation? By default it includes all of the \"column_labels\", the \"stub\", and the \"row_group\" locations. However, we could just choose one or two of those.

    +

    Which locations should undergo this text transformation? By default it includes all of the "column_labels", the "stub", and the "row_group" locations. However, we could just choose one or two of those.

    @@ -239,7 +239,7 @@

    Re

    Examples

    Using select columns from the exibble dataset, let’s create a table with a number of components added. Following that, we’ll ensure that all text in the column labels, the stub, and in all row groups is transformed to all caps using the opt_all_caps() method.

    -
    +
    from great_tables import GT, exibble, md
 
 (
@@ -258,52 +258,52 @@ 
    
   .opt_all_caps()
 )
    -
    +

    diff --git a/reference/GT.opt_horizontal_padding.html b/reference/GT.opt_horizontal_padding.html index c6c2b9602..11c88aca7 100644 --- a/reference/GT.opt_horizontal_padding.html +++ b/reference/GT.opt_horizontal_padding.html @@ -231,7 +231,7 @@

    Re

    Examples

    Using select columns from the exibble dataset, let’s create a table with a number of components added. Following that, we’ll scale the horizontal padding of the table by a factor of 3 using the opt_horizontal_padding() method.

    -
    +
    from great_tables import GT, exibble, md
 
 gt_tbl = (
@@ -251,52 +251,52 @@ 
    
 
 gt_tbl.opt_horizontal_padding(scale=3)
    -
    +

    @@ -387,55 +387,55 @@

    The overall effect of scaling the horizontal padding is that the table will appear wider or and there will added buffer space between the table elements. The overall look of the table will be more spacious and neigboring pieces of text will be less cramped.

    Let’s go the other way and scale the horizontal padding of the table by a factor of 0.5 using the opt_horizontal_padding() method.

    -
    +
    gt_tbl.opt_horizontal_padding(scale=0.5)
    -
    +

    diff --git a/reference/GT.opt_row_striping.html b/reference/GT.opt_row_striping.html index 4416d355c..5c6ab07b0 100644 --- a/reference/GT.opt_row_striping.html +++ b/reference/GT.opt_row_striping.html @@ -231,7 +231,7 @@

    Re

    Examples

    Using only a few columns from the exibble dataset, let’s create a table with a number of components added. Following that, we’ll add row striping to every second row with the opt_row_striping() method.

    -
    +
    from great_tables import GT, exibble, md
 
 (
@@ -250,52 +250,52 @@ 
    
     .opt_row_striping()
 )
    -
    +

    diff --git a/reference/GT.opt_stylize.html b/reference/GT.opt_stylize.html index 786437edf..20b747d26 100644 --- a/reference/GT.opt_stylize.html +++ b/reference/GT.opt_stylize.html @@ -219,7 +219,7 @@

    color : str = 'blue'
    -

    The color scheme of the table. The default value is \"blue\". The valid values are \"blue\", \"cyan\", \"pink\", \"green\", \"red\", and \"gray\".

    +

    The color scheme of the table. The default value is "blue". The valid values are "blue", "cyan", "pink", "green", "red", and "gray".

    add_row_striping : bool = True
    @@ -239,7 +239,7 @@

    Re

    Examples

    Using select columns from the exibble dataset, let’s create a table with a number of components added. Following that, we’ll apply a predefined style to the table using the opt_stylize() method.

    -
    +
    from great_tables import GT, exibble, md
 
 gt_tbl = (
@@ -260,52 +260,52 @@ 
    
 
 gt_tbl
    -
    +

    @@ -396,55 +396,55 @@

    The table has been stylized with the default style and color. The default style is 1 and the default color is "blue". The resulting table style is a combination of color and border settings that are applied to the table.

    We can modify the overall style and choose a different color theme by providing different values to the style= and color= arguments.

    -
    +
    gt_tbl.opt_stylize(style=2, color="green")
    -
    +

    diff --git a/reference/GT.opt_table_font.html b/reference/GT.opt_table_font.html index a8e335501..e6b0c6ab1 100644 --- a/reference/GT.opt_table_font.html +++ b/reference/GT.opt_table_font.html @@ -223,7 +223,7 @@

    font : str | list[str] | dict[str, str] | GoogleFont | None = None
    -

    One or more font names available on the user's system. This can be provided as a string or a list of strings. Alternatively, you can specify font names using the google_font() helper function. The default value is None since you could instead opt to use stack to define a list of fonts.

    +

    One or more font names available on the user’s system. This can be provided as a string or a list of strings. Alternatively, you can specify font names using the google_font() helper function. The default value is None since you could instead opt to use stack to define a list of fonts.

    stack : FontStackName | None = None
    @@ -231,11 +231,11 @@

    style : str | None = None
    -

    An option to modify the text style. Can be one of either \"normal\", \"italic\", or \"oblique\".

    +

    An option to modify the text style. Can be one of either "normal", "italic", or "oblique".

    weight : str | int | float | None = None
    -

    Option to set 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. Please note that typefaces have varying support for the numeric mapping of weight.

    +

    Option to set 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. Please note that typefaces have varying support for the numeric mapping of weight.

    add : bool = True
    @@ -276,7 +276,7 @@

    Examples

    Let’s use a subset of the sp500 dataset to create a small table. With opt_table_font() we can add some preferred font choices for modifying the text of the entire table. Here we’ll use the "Superclarendon" and "Georgia" fonts (the second font serves as a fallback).

    -
    +
    import polars as pl
 from great_tables import GT
 from great_tables.data import sp500
@@ -289,52 +289,52 @@ 
    
     .opt_table_font(font=["Superclarendon", "Georgia"])
 )
    -
    +

    @@ -430,7 +430,7 @@

    In practice, both of these fonts are not likely to be available on all systems. The opt_table_font() method safeguards against this by prepending the fonts in the font= list to the existing font stack. This way, if both fonts are not available, the table will fall back to using the list of default table fonts. This behavior is controlled by the add= argument, which is True by default.

    With the sza dataset we’ll create a two-column, eleven-row table. Within opt_table_font(), the stack= argument will be supplied with the “rounded-sans” font stack. This sets up a family of fonts with rounded, curved letterforms that should be locally available in different computing environments.

    -
    +
    from great_tables.data import sza
 
 sza_mini = (
@@ -446,52 +446,52 @@ 
    
     .opt_all_caps()
 )
    -
    +

    diff --git a/reference/GT.opt_table_outline.html b/reference/GT.opt_table_outline.html index ee68e1dd8..db80e597e 100644 --- a/reference/GT.opt_table_outline.html +++ b/reference/GT.opt_table_outline.html @@ -215,15 +215,15 @@

    style : str = 'solid'
    -

    The style of the table outline. The default value is \"solid\". The valid values are \"solid\", \"dashed\", \"dotted\", and \"none\".

    +

    The style of the table outline. The default value is "solid". The valid values are "solid", "dashed", "dotted", and "none".

    width : str = '3px'
    -

    The width of the table outline. The default value is \"3px\". The value must be in pixels and it must be an integer value.

    +

    The width of the table outline. The default value is "3px". The value must be in pixels and it must be an integer value.

    color : str = '#D3D3D3'
    -

    The color of the table outline, where the default is \"#D3D3D3\". The value must either a hexadecimal color code or a color name.

    +

    The color of the table outline, where the default is "#D3D3D3". The value must either a hexadecimal color code or a color name.

    @@ -239,7 +239,7 @@

    Re

    Examples

    Using select columns from the exibble dataset, let’s create a table with a number of components added. Following that, we’ll put an outline around the entire table using the opt_table_outline() method.

    -
    +
    from great_tables import GT, exibble, md
 
 (
@@ -258,52 +258,52 @@ 
    
   .opt_table_outline()
 )
    -
    +

    diff --git a/reference/GT.opt_vertical_padding.html b/reference/GT.opt_vertical_padding.html index 242698679..3e3f9cc4b 100644 --- a/reference/GT.opt_vertical_padding.html +++ b/reference/GT.opt_vertical_padding.html @@ -231,7 +231,7 @@

    Re

    Examples

    Using select columns from the exibble dataset, let’s create a table with a number of components added. Following that, we’ll scale the vertical padding of the table by a factor of 3 using the opt_vertical_padding() method.

    -
    +
    from great_tables import GT, exibble, md
 
 gt_tbl = (
@@ -251,52 +251,52 @@ 
    
 
 gt_tbl.opt_vertical_padding(scale=3)
    -
    +

    @@ -387,55 +387,55 @@

    Now that’s a tall table! The overall effect of scaling the vertical padding is that the table will appear taller and there will be more buffer space between the table elements. A value of 3 is pretty extreme and is likely to be too much in most cases, so, feel free to experiment with different values when looking to increase the vertical padding.

    Let’s go the other way (using a value less than 1) and try to condense the content vertically with a scale factor of 0.5. This will reduce the top and bottom padding globally and make the table appear more compact.

    -
    +
    gt_tbl.opt_vertical_padding(scale=0.5)
    -
    +

    diff --git a/reference/GT.save.html b/reference/GT.save.html index de014fa1a..74970014c 100644 --- a/reference/GT.save.html +++ b/reference/GT.save.html @@ -228,11 +228,11 @@

    web_driver : WebDrivers | webdriver.Remote = 'chrome'
    -

    The webdriver to use when taking the screenshot. Either a driver name, or webdriver instance. By default, uses Google Chrome. Supports \"firefox\" (Mozilla Firefox), \"safari\" (Apple Safari), and \"edge\" (Microsoft Edge). Specified browser must be installed. Note that if a webdriver instance is passed, options that require setting up a webdriver, like debug_port, will not be used.

    +

    The webdriver to use when taking the screenshot. Either a driver name, or webdriver instance. By default, uses Google Chrome. Supports "firefox" (Mozilla Firefox), "safari" (Apple Safari), and "edge" (Microsoft Edge). Specified browser must be installed. Note that if a webdriver instance is passed, options that require setting up a webdriver, like debug_port, will not be used.

    window_size : tuple[int, int] = (6000, 6000)
    -

    The size of the browser window to use when laying out the table. This shouldn't be necessary to capture a table, but may affect the tables appearance.

    +

    The size of the browser window to use when laying out the table. This shouldn’t be necessary to capture a table, but may affect the tables appearance.

    debug_port : None | int = None
    @@ -244,7 +244,7 @@

    **_debug_dump** : DebugDumpOptions | None = None
    -

    Whether the saved image should be a big browser window, with key elements outlined. This is helpful for debugging this function's resizing, cropping heuristics. This is an internal parameter and subject to change.

    +

    Whether the saved image should be a big browser window, with key elements outlined. This is helpful for debugging this function’s resizing, cropping heuristics. This is an internal parameter and subject to change.

    diff --git a/reference/GT.show.html b/reference/GT.show.html index 25f2deca2..c64d0848d 100644 --- a/reference/GT.show.html +++ b/reference/GT.show.html @@ -214,65 +214,65 @@

    target : Literal['auto', 'notebook', 'browser'] = 'auto'
    -

    Where to show the table. If "auto", infer whether the table can be displayed inline (e.g. in a notebook), or whether a browser is needed (e.g. in a console).

    +

    Where to show the table. If “auto”, infer whether the table can be displayed inline (e.g. in a notebook), or whether a browser is needed (e.g. in a console).

    Examples

    The example below when in the Great Tables documentation, should appear on the page.

    -
    +
    from great_tables import GT, exibble
 
 GT(exibble.head(2)).show()
 GT(exibble.tail(2)).show()
    -
    +

    @@ -322,52 +322,52 @@

    -
    +

    diff --git a/reference/GT.sub_missing.html b/reference/GT.sub_missing.html index 661418a9d..ecca7749b 100644 --- a/reference/GT.sub_missing.html +++ b/reference/GT.sub_missing.html @@ -239,7 +239,7 @@

    Re

    Examples

    Using a subset of the exibble dataset, let’s create a new table. The missing values in two selections of columns will be given different variations of replacement text (across two separate calls of sub_missing()).

    -
    +
    from great_tables import GT, md, html, exibble
 import polars as pl
 import polars.selectors as cs
@@ -258,52 +258,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/GT.sub_zero.html b/reference/GT.sub_zero.html index bed7e4e27..2d1285a4c 100644 --- a/reference/GT.sub_zero.html +++ b/reference/GT.sub_zero.html @@ -239,7 +239,7 @@

    Re

    Examples

    Let’s generate a simple table that contains an assortment of values that could potentially undergo some substitution via the sub_zero() method (i.e., there are two 0 values). The ordering of the fmt_scientific() and sub_zero() calls in the example below doesn’t affect the final result since any sub_*() method won’t interfere with the formatting of the table.

    -
    +
    from great_tables import GT
 import polars as pl
 
@@ -252,52 +252,52 @@ 
    
 
 GT(single_vals_df).fmt_scientific(columns="numbers").sub_zero()
    -
    +

    diff --git a/reference/GT.tab_header.html b/reference/GT.tab_header.html index 6a31d50c2..9d0567d1d 100644 --- a/reference/GT.tab_header.html +++ b/reference/GT.tab_header.html @@ -239,7 +239,7 @@

    Re

    Examples

    Let’s use a small portion of the gtcars dataset to create a table. A header part can be added to the table with the tab_header() method. We’ll add a title and the optional subtitle as well. With the md() helper function, we can make sure the Markdown formatting is interpreted and transformed.

    -
    +
    from great_tables import GT, md
 from great_tables.data import gtcars
 
@@ -253,52 +253,52 @@ 
    
     )
 )
    -
    +

    @@ -352,7 +352,7 @@

    We can alternatively use the html() helper function to retain HTML elements in the text.

    -
    +
    from great_tables import GT, md, html
 from great_tables.data import gtcars
 
@@ -366,52 +366,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/GT.tab_options.html b/reference/GT.tab_options.html index 8207d6ed4..963dab050 100644 --- a/reference/GT.tab_options.html +++ b/reference/GT.tab_options.html @@ -339,11 +339,11 @@

    container_width : str | None = None
    -

    The width of the table's container. Can be specified as a single-length character with units of pixels or as a percentage. If provided as a scalar numeric value, it is assumed that the value is given in units of pixels.

    +

    The width of the table’s container. Can be specified as a single-length character with units of pixels or as a percentage. If provided as a scalar numeric value, it is assumed that the value is given in units of pixels.

    container_height : str | None = None
    -

    The height of the table's container.

    +

    The height of the table’s container.

    container_overflow_x : str | None = None
    @@ -359,7 +359,7 @@

    table_layout : str | None = None
    -

    The value for the table-layout CSS style in the HTML output context. By default, this is \"fixed\" but another valid option is \"auto\".

    +

    The value for the table-layout CSS style in the HTML output context. By default, this is "fixed" but another valid option is "auto".

    table_margin_left : str | None = None
    @@ -379,7 +379,7 @@

    table_font_names : str | list[str] | None = None
    -

    The names of the fonts used for the table. This should be provided as a list of font names. If the first font isn't available, then the next font is tried (and so on).

    +

    The names of the fonts used for the table. This should be provided as a list of font names. If the first font isn’t available, then the next font is tried (and so on).

    table_font_size : str | None = None
    @@ -387,11 +387,11 @@

    table_font_weight : str | int | float | None = None
    -

    The font weight of the table. 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.

    +

    The font weight of the table. 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.

    table_font_style : str | None = None
    -

    The font style for the table. Can be one of either \"normal\", \"italic\", or \"oblique\".

    +

    The font style for the table. Can be one of either "normal", "italic", or "oblique".

    table_font_color : str | None = None
    @@ -403,51 +403,51 @@

    table_border_top_style : str | None = None
    -

    The style of the table's absolute top border. Can be one of either \"solid\", \"dotted\", \"dashed\", \"double\", \"groove\", \"ridge\", \"inset\", or \"outset\".

    +

    The style of the table’s absolute top border. Can be one of either "solid", "dotted", "dashed", "double", "groove", "ridge", "inset", or "outset".

    table_border_top_width : str | None = None
    -

    The width of the table's absolute top border. Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.

    +

    The width of the table’s absolute top border. Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.

    table_border_top_color : str | None = None
    -

    The color of the table's absolute top border. A color name or a hexadecimal color code should be provided.

    +

    The color of the table’s absolute top border. A color name or a hexadecimal color code should be provided.

    table_border_bottom_style : str | None = None
    -

    The style of the table's absolute bottom border.

    +

    The style of the table’s absolute bottom border.

    table_border_bottom_width : str | None = None
    -

    The width of the table's absolute bottom border.

    +

    The width of the table’s absolute bottom border.

    table_border_bottom_color : str | None = None
    -

    The color of the table's absolute bottom border.

    +

    The color of the table’s absolute bottom border.

    table_border_left_style : str | None = None
    -

    The style of the table's absolute left border.

    +

    The style of the table’s absolute left border.

    table_border_left_width : str | None = None
    -

    The width of the table's absolute left border.

    +

    The width of the table’s absolute left border.

    table_border_left_color : str | None = None
    -

    The color of the table's absolute left border.

    +

    The color of the table’s absolute left border.

    table_border_right_style : str | None = None
    -

    The style of the table's absolute right border.

    +

    The style of the table’s absolute right border.

    table_border_right_width : str | None = None
    -

    The width of the table's absolute right border.

    +

    The width of the table’s absolute right border.

    table_border_right_color : str | None = None
    -

    The color of the table's absolute right border.

    +

    The color of the table’s absolute right border.

    heading_background_color : str | None = None
    @@ -455,7 +455,7 @@

    heading_align : str | None = None
    -

    Controls the horizontal alignment of the heading title and subtitle. We can either use \"center\", \"left\", or \"right\".

    +

    Controls the horizontal alignment of the heading title and subtitle. We can either use "center", "left", or "right".

    heading_title_font_size : str | None = None
    @@ -483,15 +483,15 @@

    heading_border_bottom_style : str | None = None
    -

    The style of the header's bottom border.

    +

    The style of the header’s bottom border.

    heading_border_bottom_width : str | None = None
    -

    The width of the header's bottom border. If the width of this border is larger, then it will be the visible border.

    +

    The width of the header’s bottom border. If the width of this border is larger, then it will be the visible border.

    heading_border_bottom_color : str | None = None
    -

    The color of the header's bottom border.

    +

    The color of the header’s bottom border.

    heading_border_lr_style : str | None = None
    @@ -515,11 +515,11 @@

    column_labels_font_weight : str | int | float | None = None
    -

    The font weight of the table's column labels.

    +

    The font weight of the table’s column labels.

    column_labels_text_transform : str | None = None
    -

    The text transformation for the column labels. Either of the \"uppercase\", \"lowercase\", or \"capitalize\" keywords can be used.

    +

    The text transformation for the column labels. Either of the "uppercase", "lowercase", or "capitalize" keywords can be used.

    column_labels_padding : str | None = None
    @@ -531,15 +531,15 @@

    column_labels_vlines_style : str | None = None
    -

    The style of all vertical lines ('vlines') of the column_labels.

    +

    The style of all vertical lines (‘vlines’) of the column_labels.

    column_labels_vlines_width : str | None = None
    -

    The width of all vertical lines ('vlines') of the column_labels.

    +

    The width of all vertical lines (‘vlines’) of the column_labels.

    column_labels_vlines_color : str | None = None
    -

    The color of all vertical lines ('vlines') of the column_labels.

    +

    The color of all vertical lines (‘vlines’) of the column_labels.

    column_labels_border_top_style : str | None = None
    @@ -579,7 +579,7 @@

    column_labels_hidden : bool | None = None
    -

    An option to hide the column labels. If providing True then the entire column_labels location won't be seen and the table header (if present) will collapse downward.

    +

    An option to hide the column labels. If providing True then the entire column_labels location won’t be seen and the table header (if present) will collapse downward.

    row_group_background_color : str | None = None
    @@ -651,27 +651,27 @@

    table_body_hlines_style : str | None = None
    -

    The style of all horizontal lines ('hlines') in the table_body.

    +

    The style of all horizontal lines (‘hlines’) in the table_body.

    table_body_hlines_width : str | None = None
    -

    The width of all horizontal lines ('hlines') in the table_body.

    +

    The width of all horizontal lines (‘hlines’) in the table_body.

    table_body_hlines_color : str | None = None
    -

    The color of all horizontal lines ('hlines') in the table_body.

    +

    The color of all horizontal lines (‘hlines’) in the table_body.

    table_body_vlines_style : str | None = None
    -

    The style of all vertical lines ('vlines') in the table_body.

    +

    The style of all vertical lines (‘vlines’) in the table_body.

    table_body_vlines_width : str | None = None
    -

    The width of all vertical lines ('vlines') in the table_body.

    +

    The width of all vertical lines (‘vlines’) in the table_body.

    table_body_vlines_color : str | None = None
    -

    The color of all vertical lines ('vlines') in the table_body.

    +

    The color of all vertical lines (‘vlines’) in the table_body.

    table_body_border_top_style : str | None = None
    @@ -775,11 +775,11 @@

    source_notes_multiline : bool | None = None
    -

    An option to either put source notes in separate lines (the default, or True) or render them as a continuous line of text with source_notes_sep providing the separator (by default \" \") between notes.

    +

    An option to either put source notes in separate lines (the default, or True) or render them as a continuous line of text with source_notes_sep providing the separator (by default " ") between notes.

    source_notes_sep : str | None = None
    -

    The separating characters between adjacent source notes when rendered as a continuous line of text (when source_notes_multiline is False). The default value is a single space character (\" \").

    +

    The separating characters between adjacent source notes when rendered as a continuous line of text (when source_notes_multiline is False). The default value is a single space character (" ").

    source_notes_border_bottom_style : str | None = None
    @@ -831,7 +831,7 @@

    Re

    Examples

    Using select columns from the exibble dataset, let’s create a new table with a number of table components added. We can use this object going forward to demonstrate some of the features available in the tab_options() method.

    -
    +
    from great_tables import GT, exibble, md
 
 gt_tbl = (
@@ -851,52 +851,52 @@ 
    
 
 gt_tbl
    -
    +

    @@ -986,55 +986,55 @@

    We can modify the table width to be set as "100%“. In effect, this spans the table to entirely fill the content width area. This is done with the table_width option.

    -
    +
    gt_tbl.tab_options(table_width="100%")
    -
    +

    @@ -1124,55 +1124,55 @@

    With the table_background_color option, we can modify the table’s background color. Here, we want that to be "lightcyan".

    -
    +
    gt_tbl.tab_options(table_background_color="lightcyan")
    -
    +

    @@ -1262,55 +1262,55 @@

    The data rows of a table typically take up the most physical space but we have some control over the extent of that. With the data_row_padding option, it’s possible to modify the top and bottom padding of data rows. We’ll do just that in the following example, reducing the padding to a value of "3px".

    -
    +
    gt_tbl.tab_options(data_row_padding="3px")
    -
    +

    @@ -1400,55 +1400,55 @@

    The size of the title and the subtitle text in the header of the table can be altered with the heading_title_font_size and heading_subtitle_font_size options. Here, we’ll use the "small" and "x-small" keyword values.

    -
    +
    gt_tbl.tab_options(heading_title_font_size="small", heading_subtitle_font_size="x-small")
    -
    +

    diff --git a/reference/GT.tab_source_note.html b/reference/GT.tab_source_note.html index c81ea4dc5..c59601c39 100644 --- a/reference/GT.tab_source_note.html +++ b/reference/GT.tab_source_note.html @@ -231,7 +231,7 @@

    Re

    Examples

    With three columns from the gtcars dataset, let’s create a new table. We can use the tab_source_note() method to add a source note to the table footer. Here we are citing the data source but this method can be used for any text you’d prefer to display in the footer component of the table.

    -
    +
    from great_tables import GT
 from great_tables.data import gtcars
 
@@ -242,52 +242,52 @@ 
    
     .tab_source_note(source_note="From edmunds.com")
 )
    -
    +

    diff --git a/reference/GT.tab_spanner.html b/reference/GT.tab_spanner.html index ed984da80..7dc506edc 100644 --- a/reference/GT.tab_spanner.html +++ b/reference/GT.tab_spanner.html @@ -241,7 +241,7 @@

    id : str | None = None
    -

    The ID for the spanner. When accessing a spanner through the spanners argument of tab_spanner() the id value is used as the reference (and not the label). If an id is not explicitly provided here, it will be taken from the label value. It is advisable to set an explicit id value if you plan to access this cell in a later call and the label text is complicated (e.g., contains markup, is lengthy, or both). Finally, when providing an id value you must ensure that it is unique across all ID values set for spanner labels (the method will throw an error if id isn't unique).

    +

    The ID for the spanner. When accessing a spanner through the spanners argument of tab_spanner() the id value is used as the reference (and not the label). If an id is not explicitly provided here, it will be taken from the label value. It is advisable to set an explicit id value if you plan to access this cell in a later call and the label text is complicated (e.g., contains markup, is lengthy, or both). Finally, when providing an id value you must ensure that it is unique across all ID values set for spanner labels (the method will throw an error if id isn’t unique).

    gather : bool = True
    @@ -265,7 +265,7 @@

    Re

    Examples

    Let’s create a table using a small portion of the gtcars dataset. Over several columns (hp, hp_rpm, trq, trq_rpm, mpg_c, mpg_h) we’ll use tab_spanner() to add a spanner with the label "performance". This effectively groups together several columns related to car performance under a unifying label.

    -
    +
    from great_tables import GT
 from great_tables.data import gtcars
 
@@ -280,52 +280,52 @@ 
    
     )
 )
    -
    +

    @@ -447,7 +447,7 @@

    We can also use Markdown formatting for the spanner label. In this example, we’ll use gt.md("*Performance*") to make the label italicized.

    -
    +
    from great_tables import GT, md
 from great_tables.data import gtcars
 
@@ -462,52 +462,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/GT.tab_stub.html b/reference/GT.tab_stub.html index 3843d9e86..d884c07aa 100644 --- a/reference/GT.tab_stub.html +++ b/reference/GT.tab_stub.html @@ -224,57 +224,57 @@

    Examples

    By default, all data is together in the body of the table.

    -
    +
    from great_tables import GT, exibble
 
 GT(exibble)
    -
    +
    @@ -391,55 +391,55 @@

    The table stub separates row names with a vertical line, and puts group names on their own line.

    -
    +
    GT(exibble).tab_stub(rowname_col="row", groupname_col="group")
    -
    +

    diff --git a/reference/GT.tab_stubhead.html b/reference/GT.tab_stubhead.html index 6a8b5d373..53b95a688 100644 --- a/reference/GT.tab_stubhead.html +++ b/reference/GT.tab_stubhead.html @@ -231,7 +231,7 @@

    Re

    Examples

    Using a small subset of the gtcars dataset, we can create a table with row labels. Since we have row labels in the stub (via use of rowname_col="model" in the GT() call) we have a stubhead, so, let’s add a stubhead label ("car") with the tab_stubhead() method to describe what’s in the stub.

    -
    +
    from great_tables import GT
 from great_tables.data import gtcars
 
@@ -242,52 +242,52 @@ 
    
     .tab_stubhead(label="car")
 )
    -
    +

    @@ -341,7 +341,7 @@

    We can also use Markdown formatting for the stubhead label. In this example, we’ll use md("*Car*") to make the label italicized.

    -
    +
    from great_tables import GT, md
 from great_tables.data import gtcars
 
@@ -350,52 +350,52 @@ 
    
     .tab_stubhead(label=md("*Car*"))
 )
    -
    +

    diff --git a/reference/GT.tab_style.html b/reference/GT.tab_style.html index f3f2cec8c..be9745163 100644 --- a/reference/GT.tab_style.html +++ b/reference/GT.tab_style.html @@ -243,7 +243,7 @@

    Re

    Examples

    Let’s use a small subset of the exibble dataset to demonstrate how to use tab_style() to target specific cells and apply styles to them. We’ll start by creating the exibble_sm table (a subset of the exibble table) and then use tab_style() to apply a light cyan background color to the cells in the num column for the first two rows of the table. We’ll then apply a larger font size to the cells in the fctr column for the last four rows of the table.

    -
    +
    from great_tables import GT, style, loc, exibble
 
 exibble_sm = exibble[["num", "fctr", "row", "group"]]
@@ -260,52 +260,52 @@ 
    
     )
 )
    -
    +

    @@ -374,7 +374,7 @@

    Let’s use exibble once again to create a simple, two-column output table (keeping only the num and currency columns). With the tab_style() method (called thrice), we’ll add style to the values already formatted by fmt_number() and fmt_currency(). In the style argument of the first two tab_style() call, we can define multiple types of styling with the style.fill() and style.text() classes (enclosing these in a list). The cells to be targeted for styling require the use of loc.body(), which is used here with different columns being targeted. For the final tab_style() call, we demonstrate the use of style.borders() class as the style argument, which is employed in conjunction with loc.body() to locate the row to be styled.

    -
    +
    from great_tables import GT, style, loc, exibble
 
 (
@@ -401,52 +401,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/_styles-quartodoc.css b/reference/_styles-quartodoc.css index fd3d1c013..7da330fe6 100644 --- a/reference/_styles-quartodoc.css +++ b/reference/_styles-quartodoc.css @@ -1,5 +1,5 @@ /* -This file generated automatically by quartodoc version 0.8.0. +This file generated automatically by quartodoc version 0.8.1. Modifications may be overwritten by quartodoc build. If you want to customize styles, create a new .css file to avoid losing changes. */ diff --git a/reference/define_units.html b/reference/define_units.html index bfc77d8a7..7a5eeb7ed 100644 --- a/reference/define_units.html +++ b/reference/define_units.html @@ -230,54 +230,54 @@

    Re

    Specification of units notation

    The following table demonstrates the various ways in which units can be specified in the units_notation string and how the input is processed by the define_units() function. The concluding step for display of the units in HTML is to use the to_html() method.

    -
    +
    -
    +

    diff --git a/reference/from_column.html b/reference/from_column.html index d6e3eb067..c661aae9b 100644 --- a/reference/from_column.html +++ b/reference/from_column.html @@ -209,7 +209,7 @@

    from_column

    Specify that a style value should be fetched from a column in the data.

    Examples

    -
    +
    import pandas as pd
 from great_tables import GT, exibble, from_column, loc, style
 
@@ -223,52 +223,52 @@ 
    
     )
 )
    -
    +
    @@ -298,7 +298,7 @@

    If you are using polars, you can just pass polars expressions in directly:

    -
    +
    import polars as pl
 from great_tables import GT, exibble, from_column, loc, style
 
@@ -312,52 +312,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/google_font.html b/reference/google_font.html index aa1f3cb6e..3eb6b6468 100644 --- a/reference/google_font.html +++ b/reference/google_font.html @@ -235,7 +235,7 @@

    Re

    Examples

    Let’s use the exibble dataset to create a table of two columns and eight rows. We’ll replace missing values with em dashes using sub_missing(). For text in the time column, we will use the font called "IBM Plex Mono" which is available from Google Fonts. This is defined inside the google_font() call, itself within the style.text() method that’s applied to the style= parameter of tab_style().

    -
    +
    from great_tables import GT, exibble, style, loc, google_font
 
 (
@@ -247,53 +247,53 @@ 
    
     )
 )
    -
    +

    @@ -347,7 +347,7 @@

    We can use a subset of the sp500 dataset to create a small table. With fmt_currency(), we can display values as monetary values. Then, we’ll set a larger font size for the table and opt to use the "Merriweather" font by calling google_font() within opt_table_font(). In cases where that font may not materialize, we include two font fallbacks: "Cochin" and the catchall "Serif" group.

    -
    +
    from great_tables import GT, google_font
 from great_tables.data import sp500
 
@@ -358,53 +358,53 @@ 
    
     .opt_table_font(font=[google_font(name="Merriweather"), "Cochin", "Serif"])
 )
    -
    +

    diff --git a/reference/loc.body.html b/reference/loc.body.html index add56eef4..4b29ef554 100644 --- a/reference/loc.body.html +++ b/reference/loc.body.html @@ -235,7 +235,7 @@

    Re

    Examples

    Let’s use a subset of the gtcars dataset in a new table. We will style all of the body cells by using locations=loc.body() within tab_style().

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -257,52 +257,52 @@ 
    
     .fmt_currency(columns="msrp", decimals=0)
 )
    -
    +

    diff --git a/reference/loc.column_header.html b/reference/loc.column_header.html index f39433b26..8df658ed1 100644 --- a/reference/loc.column_header.html +++ b/reference/loc.column_header.html @@ -221,7 +221,7 @@

    Re

    Examples

    Let’s use a subset of the gtcars dataset in a new table. We create spanner labels through use of the tab_spanner() method; this gives us a column header with a mix of column labels and spanner labels. We will style the entire column header at once by using locations=loc.column_header() within tab_style().

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -246,52 +246,52 @@ 
    
     .fmt_currency(columns="msrp", decimals=0)
 )
    -
    +

    diff --git a/reference/loc.column_labels.html b/reference/loc.column_labels.html index 1e4138ff0..5979e3b6f 100644 --- a/reference/loc.column_labels.html +++ b/reference/loc.column_labels.html @@ -224,14 +224,14 @@

    Re
    : LocColumnLabels
    -

    A LocColumnLabels object, which is used for a locations= argument if specifying the table's column labels.

    +

    A LocColumnLabels object, which is used for a locations= argument if specifying the table’s column labels.

    Examples

    Let’s use a subset of the gtcars dataset in a new table. We will style all three of the column labels by using locations=loc.column_labels() within tab_style(). Note that no specification of columns= is needed here because we want to target all columns.

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -243,52 +243,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/loc.footer.html b/reference/loc.footer.html index 62df8cfc8..94eca3755 100644 --- a/reference/loc.footer.html +++ b/reference/loc.footer.html @@ -221,7 +221,7 @@

    Re

    Examples

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

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -234,52 +234,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/loc.header.html b/reference/loc.header.html index 19598f605..9beabc707 100644 --- a/reference/loc.header.html +++ b/reference/loc.header.html @@ -221,7 +221,7 @@

    Re

    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
 
@@ -238,52 +238,52 @@ 
    
     .fmt_currency(columns="msrp", decimals=0)
 )
    -
    +

    diff --git a/reference/loc.row_groups.html b/reference/loc.row_groups.html index fc8618954..90589d800 100644 --- a/reference/loc.row_groups.html +++ b/reference/loc.row_groups.html @@ -224,14 +224,14 @@

    Re
    : LocRowGroups
    -

    A LocRowGroups object, which is used for a locations= argument if specifying the table's row groups.

    +

    A LocRowGroups object, which is used for a locations= argument if specifying the table’s row groups.

    Examples

    Let’s use a subset of the gtcars dataset in a new table. We will style all of the cells comprising the row group labels by using locations=loc.row_groups() within tab_style().

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -253,52 +253,52 @@ 
    
     .fmt_currency(columns="msrp", decimals=0)
 )
    -
    +

    diff --git a/reference/loc.source_notes.html b/reference/loc.source_notes.html index 42b9a6729..dc896c005 100644 --- a/reference/loc.source_notes.html +++ b/reference/loc.source_notes.html @@ -221,7 +221,7 @@

    Re

    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 source notes section inside tab_style() with locations=loc.source_notes().

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -234,52 +234,52 @@ 
    
     )
 )
    -
    +

    diff --git a/reference/loc.spanner_labels.html b/reference/loc.spanner_labels.html index c08862022..1670163f8 100644 --- a/reference/loc.spanner_labels.html +++ b/reference/loc.spanner_labels.html @@ -224,14 +224,14 @@

    Re
    : LocSpannerLabels
    -

    A LocSpannerLabels object, which is used for a locations= argument if specifying the table's spanner labels.

    +

    A LocSpannerLabels object, which is used for a locations= argument if specifying the table’s spanner labels.

    Examples

    Let’s use a subset of the gtcars dataset in a new table. We create two spanner labels through two separate calls of the tab_spanner() method. In each of those, the text supplied to label= argument is used as the ID value (though they have to be explicitly set via the id= argument). We will style only the spanner label having the text "performance" by using locations=loc.spanner_labels(ids=["performance"]) within tab_style().

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -253,52 +253,52 @@ 
    
     .fmt_currency(columns="msrp", decimals=0)
 )
    -
    +

    diff --git a/reference/loc.stub.html b/reference/loc.stub.html index 709fc7916..69b9b4006 100644 --- a/reference/loc.stub.html +++ b/reference/loc.stub.html @@ -224,14 +224,14 @@

    Re
    : LocStub
    -

    A LocStub object, which is used for a locations= argument if specifying the table's stub.

    +

    A LocStub object, which is used for a locations= argument if specifying the table’s stub.

    Examples

    Let’s use a subset of the gtcars dataset in a new table. We will style the entire table stub (the row labels) by using locations=loc.stub() within tab_style().

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -253,52 +253,52 @@ 
    
     .fmt_currency(columns="msrp", decimals=0)
 )
    -
    +

    diff --git a/reference/loc.stubhead.html b/reference/loc.stubhead.html index 7c8b325fc..3e4724b5e 100644 --- a/reference/loc.stubhead.html +++ b/reference/loc.stubhead.html @@ -221,7 +221,7 @@

    Re

    Examples

    Let’s use a subset of the gtcars dataset in a new table. This table contains a stub (produced by setting rowname_col="model" in the initial GT() call). The stubhead is given a label by way of the tab_stubhead() method and this label can be styled by using locations=loc.stubhead() within tab_style().

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -240,52 +240,52 @@ 
    
     .fmt_currency(columns="msrp", decimals=0)
 )
    -
    +

    diff --git a/reference/loc.subtitle.html b/reference/loc.subtitle.html index bd2b14d18..bd4ac6c0a 100644 --- a/reference/loc.subtitle.html +++ b/reference/loc.subtitle.html @@ -221,7 +221,7 @@

    Re

    Examples

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

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -238,52 +238,52 @@ 
    
     .fmt_currency(columns="msrp", decimals=0)
 )
    -
    +

    diff --git a/reference/loc.title.html b/reference/loc.title.html index 5ff012ddf..2f176daaa 100644 --- a/reference/loc.title.html +++ b/reference/loc.title.html @@ -221,7 +221,7 @@

    Re

    Examples

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

    -
    +
    from great_tables import GT, style, loc
 from great_tables.data import gtcars
 
@@ -238,52 +238,52 @@ 
    
     .fmt_currency(columns="msrp", decimals=0)
 )
    -
    +

    diff --git a/reference/nanoplot_options.html b/reference/nanoplot_options.html index 8eb1fb4e3..9348548d0 100644 --- a/reference/nanoplot_options.html +++ b/reference/nanoplot_options.html @@ -235,71 +235,71 @@

    data_point_stroke_color : str | list[str] | None = None
    -

    The default stroke color of the data points is \"#FFFFFF\" (\"white\"). This works well when there is a visible data line combined with data points with a darker fill color. The stroke color can be modified with data_point_stroke_color= for all data points by supplying a single color value. With a list of colors, each data point's stroke color can be changed (ensure that the list length matches the number of data points).

    +

    The default stroke color of the data points is "#FFFFFF" ("white"). This works well when there is a visible data line combined with data points with a darker fill color. The stroke color can be modified with data_point_stroke_color= for all data points by supplying a single color value. With a list of colors, each data point’s stroke color can be changed (ensure that the list length matches the number of data points).

    data_point_stroke_width : int | list[int] | None = None
    -

    The width of the outside stroke for the data points can be modified with the data_point_stroke_width= option. By default, a value of 4 (as in '4px') is used.

    +

    The width of the outside stroke for the data points can be modified with the data_point_stroke_width= option. By default, a value of 4 (as in ‘4px’) is used.

    data_point_fill_color : str | list[str] | None = None
    -

    By default, all data points have a fill color of \"#FF0000\" (\"red\"). This can be changed for all data points by providing a different color to data_point_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data points; the fill color values will be applied in order of left to right.

    +

    By default, all data points have a fill color of "#FF0000" ("red"). This can be changed for all data points by providing a different color to data_point_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data points; the fill color values will be applied in order of left to right.

    data_line_type : str | None = None
    -

    This can accept either \"curved\" or \"straight\". Curved lines are recommended when the nanoplot has less than 30 points and data points are evenly spaced. In most other cases, straight lines might present better.

    +

    This can accept either "curved" or "straight". Curved lines are recommended when the nanoplot has less than 30 points and data points are evenly spaced. In most other cases, straight lines might present better.

    data_line_stroke_color : str | None = None
    -

    The color of the data line can be modified from its default \"#4682B4\" (\"steelblue\") color by supplying a color to the data_line_stroke_color= option.

    +

    The color of the data line can be modified from its default "#4682B4" ("steelblue") color by supplying a color to the data_line_stroke_color= option.

    data_line_stroke_width : int | None = None
    -

    The width of the connecting data line can be modified with data_line_stroke_width=. By default, a value of 4 (as in '4px') is used.

    +

    The width of the connecting data line can be modified with data_line_stroke_width=. By default, a value of 4 (as in ‘4px’) is used.

    data_area_fill_color : str | None = None
    -

    The fill color for the area that bounds the data points in line plot. The default is \"#FF0000\" (\"red\") but can be changed by providing a color value to data_area_fill_color=.

    +

    The fill color for the area that bounds the data points in line plot. The default is "#FF0000" ("red") but can be changed by providing a color value to data_area_fill_color=.

    data_bar_stroke_color : str | list[str] | None = None
    -

    The color of the stroke used for the data bars can be modified from its default \"#3290CC\" color by supplying a color to data_bar_stroke_color=.

    +

    The color of the stroke used for the data bars can be modified from its default "#3290CC" color by supplying a color to data_bar_stroke_color=.

    data_bar_stroke_width : int | list[int] | None = None
    -

    The width of the stroke used for the data bars can be modified with the data_bar_stroke_width= option. By default, a value of 4 (as in '4px') is used.

    +

    The width of the stroke used for the data bars can be modified with the data_bar_stroke_width= option. By default, a value of 4 (as in ‘4px’) is used.

    data_bar_fill_color : str | list[str] | None = None
    -

    By default, all data bars have a fill color of \"#3FB5FF\". This can be changed for all data bars by providing a different color to data_bar_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data bars; the fill color values will be applied in order of left to right.

    +

    By default, all data bars have a fill color of "#3FB5FF". This can be changed for all data bars by providing a different color to data_bar_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data bars; the fill color values will be applied in order of left to right.

    data_bar_negative_stroke_color : str | None = None
    -

    The color of the stroke used for the data bars that have negative values. The default color is \"#CC3243\" but this can be changed by supplying a color value to the data_bar_negative_stroke_color= option.

    +

    The color of the stroke used for the data bars that have negative values. The default color is "#CC3243" but this can be changed by supplying a color value to the data_bar_negative_stroke_color= option.

    data_bar_negative_stroke_width : int | None = None
    -

    The width of the stroke used for negative value data bars. This has the same default as data_bar_stroke_width= with a value of 4 (as in '4px'). This can be changed by giving a numeric value to the data_bar_negative_stroke_width= option.

    +

    The width of the stroke used for negative value data bars. This has the same default as data_bar_stroke_width= with a value of 4 (as in ‘4px’). This can be changed by giving a numeric value to the data_bar_negative_stroke_width= option.

    data_bar_negative_fill_color : str | None = None
    -

    By default, all negative data bars have a fill color of \"#D75A68\". This can however be changed by providing a color value to data_bar_negative_fill_color=.

    +

    By default, all negative data bars have a fill color of "#D75A68". This can however be changed by providing a color value to data_bar_negative_fill_color=.

    reference_line_color : str | None = None
    -

    The reference line will have a color of \"#75A8B0\" if it is set to appear. This color can be changed by providing a single color value to reference_line_color=.

    +

    The reference line will have a color of "#75A8B0" if it is set to appear. This color can be changed by providing a single color value to reference_line_color=.

    reference_area_fill_color : str | None = None
    -

    If a reference area has been defined and is visible it has by default a fill color of \"#A6E6F2\". This can be modified by declaring a color value in the reference_area_fill_color= option.

    +

    If a reference area has been defined and is visible it has by default a fill color of "#A6E6F2". This can be modified by declaring a color value in the reference_area_fill_color= option.

    vertical_guide_stroke_color : str | None = None
    -

    Vertical guides appear when hovering in the vicinity of data points. Their default color is \"#911EB4\" (a strong magenta color) and a fill opacity value of 0.4 is automatically applied to this. However, the base color can be changed with the vertical_guide_stroke_color= option.

    +

    Vertical guides appear when hovering in the vicinity of data points. Their default color is "#911EB4" (a strong magenta color) and a fill opacity value of 0.4 is automatically applied to this. However, the base color can be changed with the vertical_guide_stroke_color= option.

    vertical_guide_stroke_width : int | None = None
    -

    The vertical guide's stroke width, by default, is relatively large at 12 (this is '12px'). This is modifiable by setting a different value with vertical_guide_stroke_width=.

    +

    The vertical guide’s stroke width, by default, is relatively large at 12 (this is ‘12px’). This is modifiable by setting a different value with vertical_guide_stroke_width=.

    show_data_points : bool | None = None
    @@ -347,7 +347,7 @@

    currency : str | None = None
    -

    If the values are to be displayed as currency values, supply either: (1) a 3-letter currency code (e.g., \"USD\" for U.S. Dollars, \"EUR\" for the Euro currency), or (2) a common currency name (e.g., \"dollar\", \"pound\", \"yen\", etc.).

    +

    If the values are to be displayed as currency values, supply either: (1) a 3-letter currency code (e.g., "USD" for U.S. Dollars, "EUR" for the Euro currency), or (2) a common currency name (e.g., "dollar", "pound", "yen", etc.).

    diff --git a/reference/style.borders.html b/reference/style.borders.html index 8bc18883a..85ced08b4 100644 --- a/reference/style.borders.html +++ b/reference/style.borders.html @@ -202,19 +202,19 @@

    sides : Literal['all', 'top', 'bottom', 'left', 'right'] | list[Literal['all', 'top', 'bottom', 'left', 'right']] | ColumnExpr = 'all'
    -

    The border sides to be modified. Options include \"left\", \"right\", \"top\", and \"bottom\". For all borders surrounding the selected cells, we can use the \"all\" option.

    +

    The border sides to be modified. Options include "left", "right", "top", and "bottom". For all borders surrounding the selected cells, we can use the "all" option.

    color : str | ColumnExpr = '#000000'
    -

    The border color can be defined with any valid CSS color value, such as a hex code, a named color, or an RGB value. The default color value is \"#000000\" (black).

    +

    The border color can be defined with any valid CSS color value, such as a hex code, a named color, or an RGB value. The default color value is "#000000" (black).

    style : str | ColumnExpr = 'solid'
    -

    The border style can be one of either \"solid\" (the default), \"dashed\", \"dotted\", \"hidden\", or \"double\".

    +

    The border style can be one of either "solid" (the default), "dashed", "dotted", "hidden", or "double".

    weight : str | ColumnExpr = '1px'
    -

    The default value for weight is \"1px\" and higher values will become more visually prominent.

    +

    The default value for weight is "1px" and higher values will become more visually prominent.

    @@ -243,19 +243,19 @@

    Attributes

     - + - + - + - +
    colorstr(object='') -> strstr(object=’’) -> str
    sidesstr(object='') -> strstr(object=’’) -> str
    stylestr(object='') -> strstr(object=’’) -> str
    weightstr(object='') -> strstr(object=’’) -> str
    diff --git a/reference/style.text.html b/reference/style.text.html index 57e2ad08f..da76d89b8 100644 --- a/reference/style.text.html +++ b/reference/style.text.html @@ -221,39 +221,39 @@

    size : str | ColumnExpr | None = None
    -

    The size of the font. Can be provided as a number that is assumed to represent px values (or could be wrapped in the px() helper function). We can also use one of the following absolute size keywords: \"xx-small\", \"x-small\", \"small\", \"medium\", \"large\", \"x-large\", or \"xx-large\".

    +

    The size of the font. Can be provided as a number that is assumed to represent px values (or could be wrapped in the px() helper function). We can also use one of the following absolute size keywords: "xx-small", "x-small", "small", "medium", "large", "x-large", or "xx-large".

    align : Literal['center', 'left', 'right', 'justify'] | ColumnExpr | None = None
    -

    The text in a cell can be horizontally aligned though one of the following options: \"center\", \"left\", \"right\", or \"justify\".

    +

    The text in a cell can be horizontally aligned though one of the following options: "center", "left", "right", or "justify".

    v_align : Literal['middle', 'top', 'bottom'] | ColumnExpr | None = None
    -

    The vertical alignment of the text in the cell can be modified through the options \"middle\", \"top\", or \"bottom\".

    +

    The vertical alignment of the text in the cell can be modified through the options "middle", "top", or "bottom".

    style : Literal['normal', 'italic', 'oblique'] | ColumnExpr | None = None
    -

    Can be one of either \"normal\", \"italic\", or \"oblique\".

    +

    Can be one of either "normal", "italic", or "oblique".

    weight : Literal['normal', 'bold', 'bolder', 'lighter'] | ColumnExpr | None = None
    -

    The weight of the font can be modified thorough a text-based option 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.

    +

    The weight of the font can be modified thorough a text-based option 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.

    stretch : Literal['normal', 'condensed', 'ultra-condensed', 'extra-condensed', 'semi-condensed', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'] | ColumnExpr | None = None
    -

    Allows for text to either be condensed or expanded. We can use one of the following text-based keywords to describe the degree of condensation/expansion: \"ultra-condensed\", \"extra-condensed\", \"condensed\", \"semi-condensed\", \"normal\", \"semi-expanded\", \"expanded\", \"extra-expanded\", or \"ultra-expanded\". Alternatively, we can supply percentage values from 0% to 200%, inclusive. Negative percentage values are not allowed.

    +

    Allows for text to either be condensed or expanded. We can use one of the following text-based keywords to describe the degree of condensation/expansion: "ultra-condensed", "extra-condensed", "condensed", "semi-condensed", "normal", "semi-expanded", "expanded", "extra-expanded", or "ultra-expanded". Alternatively, we can supply percentage values from 0% to 200%, inclusive. Negative percentage values are not allowed.

    decorate : Literal['overline', 'line-through', 'underline', 'underline overline'] | ColumnExpr | None = None
    -

    Allows for text decoration effect to be applied. Here, we can use \"overline\", \"line-through\", or \"underline\".

    +

    Allows for text decoration effect to be applied. Here, we can use "overline", "line-through", or "underline".

    transform : Literal['uppercase', 'lowercase', 'capitalize'] | ColumnExpr | None = None
    -

    Allows for the transformation of text. Options are \"uppercase\", \"lowercase\", or \"capitalize\".

    +

    Allows for the transformation of text. Options are "uppercase", "lowercase", or "capitalize".

    whitespace : Literal['normal', 'nowrap', 'pre', 'pre-wrap', 'pre-line', 'break-spaces'] | ColumnExpr | None = None
    -

    A white-space preservation option. By default, runs of white-space will be collapsed into single spaces but several options exist to govern how white-space is collapsed and how lines might wrap at soft-wrap opportunities. The options are \"normal\", \"nowrap\", \"pre\", \"pre-wrap\", \"pre-line\", and \"break-spaces\".

    +

    A white-space preservation option. By default, runs of white-space will be collapsed into single spaces but several options exist to govern how white-space is collapsed and how lines might wrap at soft-wrap opportunities. The options are "normal", "nowrap", "pre", "pre-wrap", "pre-line", and "break-spaces".

    diff --git a/reference/system_fonts.html b/reference/system_fonts.html index f702aeea9..fdb327a8f 100644 --- a/reference/system_fonts.html +++ b/reference/system_fonts.html @@ -233,7 +233,7 @@

    name : FontStackName = 'system-ui'
    -

    The name of a font stack. Must be drawn from the set of \"system-ui\" (the default), \"transitional\", \"old-style\", \"humanist\", \"geometric-humanist\", \"classical-humanist\", \"neo-grotesque\", \"monospace-slab-serif\", \"monospace-code\", \"industrial\", \"rounded-sans\", \"slab-serif\", \"antique\", \"didone\", and \"handwritten\".

    +

    The name of a font stack. Must be drawn from the set of "system-ui" (the default), "transitional", "old-style", "humanist", "geometric-humanist", "classical-humanist", "neo-grotesque", "monospace-slab-serif", "monospace-code", "industrial", "rounded-sans", "slab-serif", "antique", "didone", and "handwritten".

    @@ -327,7 +327,7 @@

    Handwritten (

    Examples

    Using select columns from the exibble dataset, let’s create a table with a number of components added. Following that, we’ll set a font for the entire table using the tab_options() method with the table_font_names parameter. Instead of passing a list of font names, we’ll use the system_fonts() helper function to get a font stack. In this case, we’ll use the "industrial" font stack.

    -
    +
    from great_tables import GT, exibble, md, system_fonts
 
 (
@@ -347,52 +347,52 @@ 
    
   .tab_options(table_font_names=system_fonts("industrial"))
 )
    -
    +
    diff --git a/reference/vals.fmt_bytes.html b/reference/vals.fmt_bytes.html index a433785ec..8ee642452 100644 --- a/reference/vals.fmt_bytes.html +++ b/reference/vals.fmt_bytes.html @@ -224,11 +224,11 @@

    standard : str = 'decimal'
    -

    The form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., \"kB\" and \"MB\"), and (2) binary units (powers of 1024; e.g., \"KiB\" and \"MiB\"). The default is to use decimal units with the \"decimal\" option. The alternative is to use binary units with the \"binary\" option.

    +

    The form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., "kB" and "MB"), and (2) binary units (powers of 1024; e.g., "KiB" and "MiB"). The default is to use decimal units with the "decimal" option. The alternative is to use binary units with the "binary" option.

    decimals : int = 1
    -

    This corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.

    +

    This corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in "2". With 4 decimal places, the formatted value becomes "2.3400". The trailing zeros can be removed with drop_trailing_zeros=True.

    drop_trailing_zeros : bool = True
    @@ -248,11 +248,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -264,7 +264,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    diff --git a/reference/vals.fmt_currency.html b/reference/vals.fmt_currency.html index bcba569a8..5fa8f1a63 100644 --- a/reference/vals.fmt_currency.html +++ b/reference/vals.fmt_currency.html @@ -228,15 +228,15 @@

    currency : str | None = None
    -

    The currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., \"USD\" for U.S. Dollars, \"EUR\" for the Euro currency).

    +

    The currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., "USD" for U.S. Dollars, "EUR" for the Euro currency).

    use_subunits : bool = True
    -

    An option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce \"$273.81\". Removing the subunits (with use_subunits = False) will give us \"$273\".

    +

    An option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce "$273.81". Removing the subunits (with use_subunits = False) will give us "$273".

    decimals : int | None = None
    -

    The decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is \"USD\" it would result in \"$2\". With 4 decimal places, the formatted value becomes \"$2.3400\".

    +

    The decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is "USD" it would result in "$2". With 4 decimal places, the formatted value becomes "$2.3400".

    drop_trailing_dec_mark : bool = True
    @@ -256,11 +256,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -268,7 +268,7 @@

    placement : str = 'left'
    -

    The placement of the currency symbol. This can be either be \"left\" (as in \"$450\") or \"right\" (which yields \"450$\").

    +

    The placement of the currency symbol. This can be either be "left" (as in "$450") or "right" (which yields "450$").

    incl_space : bool = False
    @@ -276,7 +276,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    diff --git a/reference/vals.fmt_date.html b/reference/vals.fmt_date.html index a1cd35925..1ba6473e2 100644 --- a/reference/vals.fmt_date.html +++ b/reference/vals.fmt_date.html @@ -205,7 +205,7 @@

    date_style : DateStyle = 'iso'
    -

    The date style to use. By default this is the short name \"iso\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().

    +

    The date style to use. By default this is the short name "iso" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().

    pattern : str = '{x}'
    @@ -213,7 +213,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    diff --git a/reference/vals.fmt_integer.html b/reference/vals.fmt_integer.html index b5b7069c8..e1c20a479 100644 --- a/reference/vals.fmt_integer.html +++ b/reference/vals.fmt_integer.html @@ -237,7 +237,7 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -245,7 +245,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    diff --git a/reference/vals.fmt_number.html b/reference/vals.fmt_number.html index 0fa5d7f1d..668be9f9d 100644 --- a/reference/vals.fmt_number.html +++ b/reference/vals.fmt_number.html @@ -226,7 +226,7 @@

    decimals : int = 2
    -

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the val_fmt_integer() function should be considered.

    +

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in "2". With 4 decimal places, the formatted value becomes "2.3400". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the val_fmt_integer() function should be considered.

    n_sigfig : int | None = None
    @@ -258,11 +258,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -270,7 +270,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    diff --git a/reference/vals.fmt_percent.html b/reference/vals.fmt_percent.html index 62847668f..bc46c8bc4 100644 --- a/reference/vals.fmt_percent.html +++ b/reference/vals.fmt_percent.html @@ -226,7 +226,7 @@

    decimals : int = 2
    -

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.

    +

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in "2". With 4 decimal places, the formatted value becomes "2.3400". The trailing zeros can be removed with drop_trailing_zeros=True.

    drop_trailing_zeros : bool = False
    @@ -250,11 +250,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign : bool = False
    @@ -262,7 +262,7 @@

    placement : str = 'right'
    -

    This option governs the placement of the percent sign. This can be either be \"right\" (the default) or \"left\".

    +

    This option governs the placement of the percent sign. This can be either be "right" (the default) or "left".

    incl_space : bool = False
    @@ -270,7 +270,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    diff --git a/reference/vals.fmt_roman.html b/reference/vals.fmt_roman.html index 1f471a73c..f9210a260 100644 --- a/reference/vals.fmt_roman.html +++ b/reference/vals.fmt_roman.html @@ -204,7 +204,7 @@

    case : str = 'upper'
    -

    Should Roman numerals should be rendered as uppercase (\"upper\") or lowercase (\"lower\") letters? By default, this is set to \"upper\".

    +

    Should Roman numerals should be rendered as uppercase ("upper") or lowercase ("lower") letters? By default, this is set to "upper".

    pattern : str = '{x}'
    diff --git a/reference/vals.fmt_scientific.html b/reference/vals.fmt_scientific.html index afb801d67..4f9f6e769 100644 --- a/reference/vals.fmt_scientific.html +++ b/reference/vals.fmt_scientific.html @@ -225,7 +225,7 @@

    decimals : int = 2
    -

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.

    +

    The decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in "2". With 4 decimal places, the formatted value becomes "2.3400". The trailing zeros can be removed with drop_trailing_zeros=True.

    n_sigfig : int | None = None
    @@ -245,7 +245,7 @@

    exp_style : str = 'x10n'
    -

    Style of formatting to use for the scientific notation formatting. By default this is \"x10n\" but other options include using a single letter (e.g., \"e\", \"E\", etc.), a letter followed by a \"1\" to signal a minimum digit width of one, or \"low-ten\" for using a stylized \"10\" marker.

    +

    Style of formatting to use for the scientific notation formatting. By default this is "x10n" but other options include using a single letter (e.g., "e", "E", etc.), a letter followed by a "1" to signal a minimum digit width of one, or "low-ten" for using a stylized "10" marker.

    pattern : str = '{x}'
    @@ -253,11 +253,11 @@

    sep_mark : str = ','
    -

    The string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to use as a separator between groups of digits. For example, using sep_mark="," with a value of 1000 would result in a formatted value of "1,000". This argument is ignored if a locale is supplied (i.e., is not None).

    dec_mark : str = '.'
    -

    The string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).

    +

    The string to be used as the decimal mark. For example, using dec_mark="," with the value 0.152 would result in a formatted value of "0,152"). This argument is ignored if a locale is supplied (i.e., is not None).

    force_sign_m : bool = False
    @@ -269,7 +269,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    diff --git a/reference/vals.fmt_time.html b/reference/vals.fmt_time.html index 64b5daf77..77f9be954 100644 --- a/reference/vals.fmt_time.html +++ b/reference/vals.fmt_time.html @@ -205,7 +205,7 @@

    time_style : TimeStyle = 'iso'
    -

    The time style to use. By default this is the short name \"iso\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().

    +

    The time style to use. By default this is the short name "iso" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().

    pattern : str = '{x}'
    @@ -213,7 +213,7 @@

    locale : str | None = None
    -

    An optional locale identifier that can be used for formatting values according the locale's rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).

    +

    An optional locale identifier that can be used for formatting values according the locale’s rules. Examples include "en" for English (United States) and "fr" for French (France).

    diff --git a/search.json b/search.json index fbf182d7b..c44734322 100644 --- a/search.json +++ b/search.json @@ -579,7 +579,7 @@ "href": "reference/GT.as_raw_html.html#examples", "title": "GT.as_raw_html", "section": "Examples:", - "text": "Examples:\nLet’s use the row column of exibble dataset to create a table. With the as_raw_html() method, we’re able to output the HTML content.\n\nfrom great_tables import GT, exibble\n\nGT(exibble[[\"row\"]]).as_raw_html()\n\n'<div id=\"zkgrpdffwg\" style=\"padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;\">\\n<style>\\n#zkgrpdffwg table {\\n font-family: -apple-system, BlinkMacSystemFont, \\'Segoe UI\\', Roboto, Oxygen, Ubuntu, Cantarell, \\'Helvetica Neue\\', \\'Fira Sans\\', \\'Droid Sans\\', Arial, sans-serif;\\n -webkit-font-smoothing: antialiased;\\n -moz-osx-font-smoothing: grayscale;\\n }\\n\\n#zkgrpdffwg thead, tbody, tfoot, tr, td, th { border-style: none; }\\n tr { background-color: transparent; }\\n#zkgrpdffwg p { margin: 0; padding: 0; }\\n #zkgrpdffwg .gt_table { display: table; border-collapse: collapse; line-height: normal; margin-left: auto; margin-right: auto; color: #333333; font-size: 16px; font-weight: normal; font-style: normal; background-color: #FFFFFF; width: auto; border-top-style: solid; border-top-width: 2px; border-top-color: #A8A8A8; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #A8A8A8; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3; }\\n #zkgrpdffwg .gt_caption { padding-top: 4px; padding-bottom: 4px; }\\n #zkgrpdffwg .gt_title { color: #333333; font-size: 125%; font-weight: initial; padding-top: 4px; padding-bottom: 4px; padding-left: 5px; padding-right: 5px; border-bottom-color: #FFFFFF; border-bottom-width: 0; }\\n #zkgrpdffwg .gt_subtitle { color: #333333; font-size: 85%; font-weight: initial; padding-top: 3px; padding-bottom: 5px; padding-left: 5px; padding-right: 5px; border-top-color: #FFFFFF; border-top-width: 0; }\\n #zkgrpdffwg .gt_heading { background-color: #FFFFFF; text-align: center; border-bottom-color: #FFFFFF; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; }\\n #zkgrpdffwg .gt_bottom_border { border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; }\\n #zkgrpdffwg .gt_col_headings { border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; }\\n #zkgrpdffwg .gt_col_heading { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: normal; text-transform: inherit; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: bottom; padding-top: 5px; padding-bottom: 5px; padding-left: 5px; padding-right: 5px; overflow-x: hidden; }\\n #zkgrpdffwg .gt_column_spanner_outer { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: normal; text-transform: inherit; padding-top: 0; padding-bottom: 0; padding-left: 4px; padding-right: 4px; }\\n #zkgrpdffwg .gt_column_spanner_outer:first-child { padding-left: 0; }\\n #zkgrpdffwg .gt_column_spanner_outer:last-child { padding-right: 0; }\\n #zkgrpdffwg .gt_column_spanner { border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; vertical-align: bottom; padding-top: 5px; padding-bottom: 5px; overflow-x: hidden; display: inline-block; width: 100%; }\\n #zkgrpdffwg .gt_spanner_row { border-bottom-style: hidden; }\\n #zkgrpdffwg .gt_group_heading { padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; text-align: left; }\\n #zkgrpdffwg .gt_empty_group_heading { padding: 0.5px; color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; vertical-align: middle; }\\n #zkgrpdffwg .gt_from_md> :first-child { margin-top: 0; }\\n #zkgrpdffwg .gt_from_md> :last-child { margin-bottom: 0; }\\n #zkgrpdffwg .gt_row { padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; margin: 10px; border-top-style: solid; border-top-width: 1px; border-top-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; overflow-x: hidden; }\\n #zkgrpdffwg .gt_stub { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-right-style: solid; border-right-width: 2px; border-right-color: #D3D3D3; padding-left: 5px; padding-right: 5px; }\\n #zkgrpdffwg .gt_stub_row_group { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-right-style: solid; border-right-width: 2px; border-right-color: #D3D3D3; padding-left: 5px; padding-right: 5px; vertical-align: top; }\\n #zkgrpdffwg .gt_row_group_first td { border-top-width: 2px; }\\n #zkgrpdffwg .gt_row_group_first th { border-top-width: 2px; }\\n #zkgrpdffwg .gt_striped { background-color: rgba(128,128,128,0.05); }\\n #zkgrpdffwg .gt_table_body { border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; }\\n #zkgrpdffwg .gt_sourcenotes { color: #333333; background-color: #FFFFFF; border-bottom-style: none; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; }\\n #zkgrpdffwg .gt_sourcenote { font-size: 90%; padding-top: 4px; padding-bottom: 4px; padding-left: 5px; padding-right: 5px; text-align: left; }\\n #zkgrpdffwg .gt_left { text-align: left; }\\n #zkgrpdffwg .gt_center { text-align: center; }\\n #zkgrpdffwg .gt_right { text-align: right; font-variant-numeric: tabular-nums; }\\n #zkgrpdffwg .gt_font_normal { font-weight: normal; }\\n #zkgrpdffwg .gt_font_bold { font-weight: bold; }\\n #zkgrpdffwg .gt_font_italic { font-style: italic; }\\n #zkgrpdffwg .gt_super { font-size: 65%; }\\n #zkgrpdffwg .gt_footnote_marks { font-size: 75%; vertical-align: 0.4em; position: initial; }\\n #zkgrpdffwg .gt_asterisk { font-size: 100%; vertical-align: 0; }\\n \\n</style>\\n<table class=\"gt_table\" data-quarto-disable-processing=\"false\" data-quarto-bootstrap=\"false\">\\n<thead>\\n\\n<tr class=\"gt_col_headings\">\\n <th class=\"gt_col_heading gt_columns_bottom_border gt_left\" rowspan=\"1\" colspan=\"1\" scope=\"col\" id=\"row\">row</th>\\n</tr>\\n</thead>\\n<tbody class=\"gt_table_body\">\\n <tr>\\n <td class=\"gt_row gt_left\">row_1</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_2</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_3</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_4</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_5</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_6</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_7</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_8</td>\\n </tr>\\n</tbody>\\n\\n\\n</table>\\n\\n</div>\\n '" + "text": "Examples:\nLet’s use the row column of exibble dataset to create a table. With the as_raw_html() method, we’re able to output the HTML content.\n\nfrom great_tables import GT, exibble\n\nGT(exibble[[\"row\"]]).as_raw_html()\n\n'<div id=\"vngpmdgrpi\" style=\"padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;\">\\n<style>\\n#vngpmdgrpi table {\\n font-family: -apple-system, BlinkMacSystemFont, \\'Segoe UI\\', Roboto, Oxygen, Ubuntu, Cantarell, \\'Helvetica Neue\\', \\'Fira Sans\\', \\'Droid Sans\\', Arial, sans-serif;\\n -webkit-font-smoothing: antialiased;\\n -moz-osx-font-smoothing: grayscale;\\n }\\n\\n#vngpmdgrpi thead, tbody, tfoot, tr, td, th { border-style: none; }\\n tr { background-color: transparent; }\\n#vngpmdgrpi p { margin: 0; padding: 0; }\\n #vngpmdgrpi .gt_table { display: table; border-collapse: collapse; line-height: normal; margin-left: auto; margin-right: auto; color: #333333; font-size: 16px; font-weight: normal; font-style: normal; background-color: #FFFFFF; width: auto; border-top-style: solid; border-top-width: 2px; border-top-color: #A8A8A8; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #A8A8A8; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3; }\\n #vngpmdgrpi .gt_caption { padding-top: 4px; padding-bottom: 4px; }\\n #vngpmdgrpi .gt_title { color: #333333; font-size: 125%; font-weight: initial; padding-top: 4px; padding-bottom: 4px; padding-left: 5px; padding-right: 5px; border-bottom-color: #FFFFFF; border-bottom-width: 0; }\\n #vngpmdgrpi .gt_subtitle { color: #333333; font-size: 85%; font-weight: initial; padding-top: 3px; padding-bottom: 5px; padding-left: 5px; padding-right: 5px; border-top-color: #FFFFFF; border-top-width: 0; }\\n #vngpmdgrpi .gt_heading { background-color: #FFFFFF; text-align: center; border-bottom-color: #FFFFFF; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; }\\n #vngpmdgrpi .gt_bottom_border { border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; }\\n #vngpmdgrpi .gt_col_headings { border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; }\\n #vngpmdgrpi .gt_col_heading { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: normal; text-transform: inherit; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: bottom; padding-top: 5px; padding-bottom: 5px; padding-left: 5px; padding-right: 5px; overflow-x: hidden; }\\n #vngpmdgrpi .gt_column_spanner_outer { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: normal; text-transform: inherit; padding-top: 0; padding-bottom: 0; padding-left: 4px; padding-right: 4px; }\\n #vngpmdgrpi .gt_column_spanner_outer:first-child { padding-left: 0; }\\n #vngpmdgrpi .gt_column_spanner_outer:last-child { padding-right: 0; }\\n #vngpmdgrpi .gt_column_spanner { border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; vertical-align: bottom; padding-top: 5px; padding-bottom: 5px; overflow-x: hidden; display: inline-block; width: 100%; }\\n #vngpmdgrpi .gt_spanner_row { border-bottom-style: hidden; }\\n #vngpmdgrpi .gt_group_heading { padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; text-align: left; }\\n #vngpmdgrpi .gt_empty_group_heading { padding: 0.5px; color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; vertical-align: middle; }\\n #vngpmdgrpi .gt_from_md> :first-child { margin-top: 0; }\\n #vngpmdgrpi .gt_from_md> :last-child { margin-bottom: 0; }\\n #vngpmdgrpi .gt_row { padding-top: 8px; padding-bottom: 8px; padding-left: 5px; padding-right: 5px; margin: 10px; border-top-style: solid; border-top-width: 1px; border-top-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3; vertical-align: middle; overflow-x: hidden; }\\n #vngpmdgrpi .gt_stub { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-right-style: solid; border-right-width: 2px; border-right-color: #D3D3D3; padding-left: 5px; padding-right: 5px; }\\n #vngpmdgrpi .gt_stub_row_group { color: #333333; background-color: #FFFFFF; font-size: 100%; font-weight: initial; text-transform: inherit; border-right-style: solid; border-right-width: 2px; border-right-color: #D3D3D3; padding-left: 5px; padding-right: 5px; vertical-align: top; }\\n #vngpmdgrpi .gt_row_group_first td { border-top-width: 2px; }\\n #vngpmdgrpi .gt_row_group_first th { border-top-width: 2px; }\\n #vngpmdgrpi .gt_striped { background-color: rgba(128,128,128,0.05); }\\n #vngpmdgrpi .gt_table_body { border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; }\\n #vngpmdgrpi .gt_sourcenotes { color: #333333; background-color: #FFFFFF; border-bottom-style: none; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; }\\n #vngpmdgrpi .gt_sourcenote { font-size: 90%; padding-top: 4px; padding-bottom: 4px; padding-left: 5px; padding-right: 5px; text-align: left; }\\n #vngpmdgrpi .gt_left { text-align: left; }\\n #vngpmdgrpi .gt_center { text-align: center; }\\n #vngpmdgrpi .gt_right { text-align: right; font-variant-numeric: tabular-nums; }\\n #vngpmdgrpi .gt_font_normal { font-weight: normal; }\\n #vngpmdgrpi .gt_font_bold { font-weight: bold; }\\n #vngpmdgrpi .gt_font_italic { font-style: italic; }\\n #vngpmdgrpi .gt_super { font-size: 65%; }\\n #vngpmdgrpi .gt_footnote_marks { font-size: 75%; vertical-align: 0.4em; position: initial; }\\n #vngpmdgrpi .gt_asterisk { font-size: 100%; vertical-align: 0; }\\n \\n</style>\\n<table class=\"gt_table\" data-quarto-disable-processing=\"false\" data-quarto-bootstrap=\"false\">\\n<thead>\\n\\n<tr class=\"gt_col_headings\">\\n <th class=\"gt_col_heading gt_columns_bottom_border gt_left\" rowspan=\"1\" colspan=\"1\" scope=\"col\" id=\"row\">row</th>\\n</tr>\\n</thead>\\n<tbody class=\"gt_table_body\">\\n <tr>\\n <td class=\"gt_row gt_left\">row_1</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_2</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_3</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_4</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_5</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_6</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_7</td>\\n </tr>\\n <tr>\\n <td class=\"gt_row gt_left\">row_8</td>\\n </tr>\\n</tbody>\\n\\n\\n</table>\\n\\n</div>\\n '" }, { "objectID": "reference/loc.column_labels.html", @@ -600,7 +600,7 @@ "href": "reference/loc.column_labels.html#returns", "title": "loc.column_labels", "section": "Returns", - "text": "Returns\n\n : LocColumnLabels\n\nA LocColumnLabels object, which is used for a locations= argument if specifying the table's column labels." + "text": "Returns\n\n : LocColumnLabels\n\nA LocColumnLabels object, which is used for a locations= argument if specifying the table’s column labels." }, { "objectID": "reference/loc.column_labels.html#examples", @@ -621,7 +621,7 @@ "href": "reference/GT.opt_table_outline.html#parameters", "title": "GT.opt_table_outline", "section": "Parameters", - "text": "Parameters\n\nstyle : str = 'solid'\n\nThe style of the table outline. The default value is \\\"solid\\\". The valid values are \\\"solid\\\", \\\"dashed\\\", \\\"dotted\\\", and \\\"none\\\".\n\nwidth : str = '3px'\n\nThe width of the table outline. The default value is \\\"3px\\\". The value must be in pixels and it must be an integer value.\n\ncolor : str = '#D3D3D3'\n\nThe color of the table outline, where the default is \\\"#D3D3D3\\\". The value must either a hexadecimal color code or a color name." + "text": "Parameters\n\nstyle : str = 'solid'\n\nThe style of the table outline. The default value is \"solid\". The valid values are \"solid\", \"dashed\", \"dotted\", and \"none\".\n\nwidth : str = '3px'\n\nThe width of the table outline. The default value is \"3px\". The value must be in pixels and it must be an integer value.\n\ncolor : str = '#D3D3D3'\n\nThe color of the table outline, where the default is \"#D3D3D3\". The value must either a hexadecimal color code or a color name." }, { "objectID": "reference/GT.opt_table_outline.html#returns", @@ -649,7 +649,7 @@ "href": "reference/GT.tab_spanner.html#parameters", "title": "GT.tab_spanner", "section": "Parameters", - "text": "Parameters\n\nlabel : str | Text\n\nThe text to use for the spanner label. We can optionally use the md() and html() helper functions to style the text as Markdown or to retain HTML elements in the text. Alternatively, units notation can be used (see define_units() for details).\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nspanners : str | list[str] | None = None\n\nThe spanners that should be spanned over, should they already be defined. One or more spanner ID values (in quotes) can be supplied here. This argument works in tandem with the columns argument.\n\nlevel : int | None = None\n\nAn explicit level to which the spanner should be placed. If not provided, Great Tables will choose the level based on the inputs provided within columns and spanners, placing the spanner label where it will fit. The first spanner level (right above the column labels) is 0.\n\nid : str | None = None\n\nThe ID for the spanner. When accessing a spanner through the spanners argument of tab_spanner() the id value is used as the reference (and not the label). If an id is not explicitly provided here, it will be taken from the label value. It is advisable to set an explicit id value if you plan to access this cell in a later call and the label text is complicated (e.g., contains markup, is lengthy, or both). Finally, when providing an id value you must ensure that it is unique across all ID values set for spanner labels (the method will throw an error if id isn't unique).\n\ngather : bool = True\n\nAn option to move the specified columns such that they are unified under the spanner. Ordering of the moved-into-place columns will be preserved in all cases. By default, this is set to True.\n\nreplace : bool = False\n\nShould new spanners be allowed to partially or fully replace existing spanners? (This is a possibility if setting spanners at an already populated level.) By default, this is set to False and an error will occur if some replacement is attempted." + "text": "Parameters\n\nlabel : str | Text\n\nThe text to use for the spanner label. We can optionally use the md() and html() helper functions to style the text as Markdown or to retain HTML elements in the text. Alternatively, units notation can be used (see define_units() for details).\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nspanners : str | list[str] | None = None\n\nThe spanners that should be spanned over, should they already be defined. One or more spanner ID values (in quotes) can be supplied here. This argument works in tandem with the columns argument.\n\nlevel : int | None = None\n\nAn explicit level to which the spanner should be placed. If not provided, Great Tables will choose the level based on the inputs provided within columns and spanners, placing the spanner label where it will fit. The first spanner level (right above the column labels) is 0.\n\nid : str | None = None\n\nThe ID for the spanner. When accessing a spanner through the spanners argument of tab_spanner() the id value is used as the reference (and not the label). If an id is not explicitly provided here, it will be taken from the label value. It is advisable to set an explicit id value if you plan to access this cell in a later call and the label text is complicated (e.g., contains markup, is lengthy, or both). Finally, when providing an id value you must ensure that it is unique across all ID values set for spanner labels (the method will throw an error if id isn’t unique).\n\ngather : bool = True\n\nAn option to move the specified columns such that they are unified under the spanner. Ordering of the moved-into-place columns will be preserved in all cases. By default, this is set to True.\n\nreplace : bool = False\n\nShould new spanners be allowed to partially or fully replace existing spanners? (This is a possibility if setting spanners at an already populated level.) By default, this is set to False and an error will occur if some replacement is attempted." }, { "objectID": "reference/GT.tab_spanner.html#returns", @@ -698,7 +698,7 @@ "href": "reference/GT.fmt_date.html#parameters", "title": "GT.fmt_date", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndate_style : DateStyle = 'iso'\n\nThe date style to use. By default this is the short name \\\"iso\\\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndate_style : DateStyle = 'iso'\n\nThe date style to use. By default this is the short name \"iso\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/GT.fmt_date.html#formatting-with-the-date_style-argument", @@ -810,14 +810,14 @@ "href": "reference/vals.fmt_integer.html", "title": "vals.fmt_integer", "section": "", - "text": "vals.fmt_integer(\n x\n use_seps=True\n scale_by=1\n compact=False\n pattern='{x}'\n sep_mark=','\n force_sign=False\n locale=None\n)\nFormat values as integers.\nWith numeric values in a list, we can perform number-based formatting so that the input values are always rendered as integer values. The following major options are available:\nWe can have fine control over integer formatting with the following options:\n\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\nscaling: we can choose to scale targeted values by a multiplier value\nlarge-number suffixing: larger figures (thousands, millions, etc.) can be autoscaled and decorated with the appropriate suffixes\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in number formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1K, and 1230000 becomes 1M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." + "text": "vals.fmt_integer(\n x\n use_seps=True\n scale_by=1\n compact=False\n pattern='{x}'\n sep_mark=','\n force_sign=False\n locale=None\n)\nFormat values as integers.\nWith numeric values in a list, we can perform number-based formatting so that the input values are always rendered as integer values. The following major options are available:\nWe can have fine control over integer formatting with the following options:\n\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\nscaling: we can choose to scale targeted values by a multiplier value\nlarge-number suffixing: larger figures (thousands, millions, etc.) can be autoscaled and decorated with the appropriate suffixes\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in number formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1K, and 1230000 becomes 1M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." }, { "objectID": "reference/vals.fmt_integer.html#parameters", "href": "reference/vals.fmt_integer.html#parameters", "title": "vals.fmt_integer", "section": "", - "text": "x : X\n\nA list of values to be formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1K, and 1230000 becomes 1M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "x : X\n\nA list of values to be formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1K, and 1230000 becomes 1M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/vals.fmt_integer.html#returns", @@ -908,7 +908,7 @@ "href": "reference/GT.fmt_percent.html#parameters", "title": "GT.fmt_percent", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_values : bool = True\n\nShould the values be scaled through multiplication by 100? By default this scaling is performed since the expectation is that incoming values are usually proportional. Setting to False signifies that the values are already scaled and require only the percent sign when formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'right'\n\nThis option governs the placement of the percent sign. This can be either be \\\"right\\\" (the default) or \\\"left\\\".\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the percent sign. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_values : bool = True\n\nShould the values be scaled through multiplication by 100? By default this scaling is performed since the expectation is that incoming values are usually proportional. Setting to False signifies that the values are already scaled and require only the percent sign when formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'right'\n\nThis option governs the placement of the percent sign. This can be either be \"right\" (the default) or \"left\".\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the percent sign. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/GT.fmt_percent.html#returns", @@ -1076,7 +1076,7 @@ "href": "reference/GT.fmt_datetime.html#parameters", "title": "GT.fmt_datetime", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndate_style : DateStyle = 'iso'\n\nThe date style to use. By default this is the short name \\\"iso\\\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().\n\ntime_style : TimeStyle = 'iso'\n\nThe time style to use. By default this is the short name \\\"iso\\\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style()." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndate_style : DateStyle = 'iso'\n\nThe date style to use. By default this is the short name \"iso\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().\n\ntime_style : TimeStyle = 'iso'\n\nThe time style to use. By default this is the short name \"iso\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style()." }, { "objectID": "reference/GT.fmt_datetime.html#formatting-with-the-date_style-and-time_style-arguments", @@ -1104,14 +1104,14 @@ "href": "reference/vals.fmt_time.html", "title": "vals.fmt_time", "section": "", - "text": "vals.fmt_time(x, time_style='iso', pattern='{x}', locale=None)\nFormat values as times.\nFormat input values to time values using one of 5 preset time styles. Input can be in the form of time values, or strings in the ISO 8601 forms of HH:MM:SS or YYYY-MM-DD HH:MM:SS.\n\n\n\nx : X\n\nA list of values to be formatted.\n\ntime_style : TimeStyle = 'iso'\n\nThe time style to use. By default this is the short name \\\"iso\\\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France).\n\n\n\n\n\nWe need to supply a preset time style to the time_style argument. The time styles are numerous and can handle localization to any supported locale. The following table provides a listing of all time styles and their output values (corresponding to an input time of 14:35:00).\n\n\n\n\nTime Style\nOutput\nNotes\n\n\n\n\n1\n\"iso\"\n\"14:35:00\"\nISO 8601, 24h\n\n\n2\n\"iso-short\"\n\"14:35\"\nISO 8601, 24h\n\n\n3\n\"h_m_s_p\"\n\"2:35:00 PM\"\n12h\n\n\n4\n\"h_m_p\"\n\"2:35 PM\"\n12h\n\n\n5\n\"h_p\"\n\"2 PM\"\n12h\n\n\n\nWe can use the info_time_style() function within the console to view a similar table of time styles with example output.\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." + "text": "vals.fmt_time(x, time_style='iso', pattern='{x}', locale=None)\nFormat values as times.\nFormat input values to time values using one of 5 preset time styles. Input can be in the form of time values, or strings in the ISO 8601 forms of HH:MM:SS or YYYY-MM-DD HH:MM:SS.\n\n\n\nx : X\n\nA list of values to be formatted.\n\ntime_style : TimeStyle = 'iso'\n\nThe time style to use. By default this is the short name \"iso\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).\n\n\n\n\n\nWe need to supply a preset time style to the time_style argument. The time styles are numerous and can handle localization to any supported locale. The following table provides a listing of all time styles and their output values (corresponding to an input time of 14:35:00).\n\n\n\n\nTime Style\nOutput\nNotes\n\n\n\n\n1\n\"iso\"\n\"14:35:00\"\nISO 8601, 24h\n\n\n2\n\"iso-short\"\n\"14:35\"\nISO 8601, 24h\n\n\n3\n\"h_m_s_p\"\n\"2:35:00 PM\"\n12h\n\n\n4\n\"h_m_p\"\n\"2:35 PM\"\n12h\n\n\n5\n\"h_p\"\n\"2 PM\"\n12h\n\n\n\nWe can use the info_time_style() function within the console to view a similar table of time styles with example output.\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." }, { "objectID": "reference/vals.fmt_time.html#parameters", "href": "reference/vals.fmt_time.html#parameters", "title": "vals.fmt_time", "section": "", - "text": "x : X\n\nA list of values to be formatted.\n\ntime_style : TimeStyle = 'iso'\n\nThe time style to use. By default this is the short name \\\"iso\\\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "x : X\n\nA list of values to be formatted.\n\ntime_style : TimeStyle = 'iso'\n\nThe time style to use. By default this is the short name \"iso\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/vals.fmt_time.html#formatting-with-the-time_style-argument", @@ -1174,7 +1174,7 @@ "href": "reference/loc.stub.html#returns", "title": "loc.stub", "section": "Returns", - "text": "Returns\n\n : LocStub\n\nA LocStub object, which is used for a locations= argument if specifying the table's stub." + "text": "Returns\n\n : LocStub\n\nA LocStub object, which is used for a locations= argument if specifying the table’s stub." }, { "objectID": "reference/loc.stub.html#examples", @@ -1321,7 +1321,7 @@ "href": "reference/GT.fmt_integer.html#parameters", "title": "GT.fmt_integer", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1K, and 1230000 becomes 1M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1K, and 1230000 becomes 1M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/GT.fmt_integer.html#returns", @@ -1384,14 +1384,14 @@ "href": "reference/vals.fmt_percent.html", "title": "vals.fmt_percent", "section": "", - "text": "vals.fmt_percent(\n x\n decimals=2\n drop_trailing_zeros=False\n drop_trailing_dec_mark=True\n scale_values=True\n use_seps=True\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign=False\n placement='right'\n incl_space=False\n locale=None\n)\nFormat values as a percentage.\nWith numeric values in a list, we can perform percentage-based formatting. It is assumed the input numeric values are proportional values and, in this case, the values will be automatically multiplied by 100 before decorating with a percent sign (the other case is accommodated though setting scale_values to False). For more control over percentage formatting, we can use the following options:\n\npercent sign placement: the percent sign can be placed after or before the values and a space can be inserted between the symbol and the value.\ndecimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\nvalue scaling toggle: choose to disable automatic value scaling in the situation that values are already scaled coming in (and just require the percent symbol)\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in number formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_values : bool = True\n\nShould the values be scaled through multiplication by 100? By default this scaling is performed since the expectation is that incoming values are usually proportional. Setting to False signifies that the values are already scaled and require only the percent sign when formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'right'\n\nThis option governs the placement of the percent sign. This can be either be \\\"right\\\" (the default) or \\\"left\\\".\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the percent sign. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." + "text": "vals.fmt_percent(\n x\n decimals=2\n drop_trailing_zeros=False\n drop_trailing_dec_mark=True\n scale_values=True\n use_seps=True\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign=False\n placement='right'\n incl_space=False\n locale=None\n)\nFormat values as a percentage.\nWith numeric values in a list, we can perform percentage-based formatting. It is assumed the input numeric values are proportional values and, in this case, the values will be automatically multiplied by 100 before decorating with a percent sign (the other case is accommodated though setting scale_values to False). For more control over percentage formatting, we can use the following options:\n\npercent sign placement: the percent sign can be placed after or before the values and a space can be inserted between the symbol and the value.\ndecimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\nvalue scaling toggle: choose to disable automatic value scaling in the situation that values are already scaled coming in (and just require the percent symbol)\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in number formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_values : bool = True\n\nShould the values be scaled through multiplication by 100? By default this scaling is performed since the expectation is that incoming values are usually proportional. Setting to False signifies that the values are already scaled and require only the percent sign when formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'right'\n\nThis option governs the placement of the percent sign. This can be either be \"right\" (the default) or \"left\".\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the percent sign. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." }, { "objectID": "reference/vals.fmt_percent.html#parameters", "href": "reference/vals.fmt_percent.html#parameters", "title": "vals.fmt_percent", "section": "", - "text": "x : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_values : bool = True\n\nShould the values be scaled through multiplication by 100? By default this scaling is performed since the expectation is that incoming values are usually proportional. Setting to False signifies that the values are already scaled and require only the percent sign when formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'right'\n\nThis option governs the placement of the percent sign. This can be either be \\\"right\\\" (the default) or \\\"left\\\".\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the percent sign. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "x : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_values : bool = True\n\nShould the values be scaled through multiplication by 100? By default this scaling is performed since the expectation is that incoming values are usually proportional. Setting to False signifies that the values are already scaled and require only the percent sign when formatted.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'right'\n\nThis option governs the placement of the percent sign. This can be either be \"right\" (the default) or \"left\".\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the percent sign. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/vals.fmt_percent.html#returns", @@ -1447,14 +1447,14 @@ "href": "reference/vals.fmt_scientific.html", "title": "vals.fmt_scientific", "section": "", - "text": "vals.fmt_scientific(\n x\n decimals=2\n n_sigfig=None\n drop_trailing_zeros=False\n drop_trailing_dec_mark=True\n scale_by=1\n exp_style='x10n'\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign_m=False\n force_sign_n=False\n locale=None\n)\nFormat values to scientific notation.\nWith numeric values in a list, we can perform formatting so that the input values are rendered in scientific notation, where extremely large or very small numbers can be expressed in a more practical fashion. Here, numbers are written in the form of a mantissa (m) and an exponent (n) with the construction m x 10^n or mEn. The mantissa component is a number between 1 and 10. For instance, 2.5 x 10^9 can be used to represent the value 2,500,000,000 in scientific notation. In a similar way, 0.00000012 can be expressed as 1.2 x 10^-7. Due to its ability to describe numbers more succinctly and its ease of calculation, scientific notation is widely employed in scientific and technical domains.\nWe have fine control over the formatting task, with the following options:\n\ndecimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol\nscaling: we can choose to scale targeted values by a multiplier value\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\nexp_style : str = 'x10n'\n\nStyle of formatting to use for the scientific notation formatting. By default this is \\\"x10n\\\" but other options include using a single letter (e.g., \\\"e\\\", \\\"E\\\", etc.), a letter followed by a \\\"1\\\" to signal a minimum digit width of one, or \\\"low-ten\\\" for using a stylized \\\"10\\\" marker.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign_m : bool = False\n\nShould the plus sign be shown for positive values of the mantissa (first component)? This would effectively show a sign for all values except zero on the first numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nforce_sign_n : bool = False\n\nShould the plus sign be shown for positive values of the exponent (second component)? This would effectively show a sign for all values except zero on the second numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." + "text": "vals.fmt_scientific(\n x\n decimals=2\n n_sigfig=None\n drop_trailing_zeros=False\n drop_trailing_dec_mark=True\n scale_by=1\n exp_style='x10n'\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign_m=False\n force_sign_n=False\n locale=None\n)\nFormat values to scientific notation.\nWith numeric values in a list, we can perform formatting so that the input values are rendered in scientific notation, where extremely large or very small numbers can be expressed in a more practical fashion. Here, numbers are written in the form of a mantissa (m) and an exponent (n) with the construction m x 10^n or mEn. The mantissa component is a number between 1 and 10. For instance, 2.5 x 10^9 can be used to represent the value 2,500,000,000 in scientific notation. In a similar way, 0.00000012 can be expressed as 1.2 x 10^-7. Due to its ability to describe numbers more succinctly and its ease of calculation, scientific notation is widely employed in scientific and technical domains.\nWe have fine control over the formatting task, with the following options:\n\ndecimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol\nscaling: we can choose to scale targeted values by a multiplier value\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\nexp_style : str = 'x10n'\n\nStyle of formatting to use for the scientific notation formatting. By default this is \"x10n\" but other options include using a single letter (e.g., \"e\", \"E\", etc.), a letter followed by a \"1\" to signal a minimum digit width of one, or \"low-ten\" for using a stylized \"10\" marker.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign_m : bool = False\n\nShould the plus sign be shown for positive values of the mantissa (first component)? This would effectively show a sign for all values except zero on the first numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nforce_sign_n : bool = False\n\nShould the plus sign be shown for positive values of the exponent (second component)? This would effectively show a sign for all values except zero on the second numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." }, { "objectID": "reference/vals.fmt_scientific.html#parameters", "href": "reference/vals.fmt_scientific.html#parameters", "title": "vals.fmt_scientific", "section": "", - "text": "x : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\nexp_style : str = 'x10n'\n\nStyle of formatting to use for the scientific notation formatting. By default this is \\\"x10n\\\" but other options include using a single letter (e.g., \\\"e\\\", \\\"E\\\", etc.), a letter followed by a \\\"1\\\" to signal a minimum digit width of one, or \\\"low-ten\\\" for using a stylized \\\"10\\\" marker.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign_m : bool = False\n\nShould the plus sign be shown for positive values of the mantissa (first component)? This would effectively show a sign for all values except zero on the first numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nforce_sign_n : bool = False\n\nShould the plus sign be shown for positive values of the exponent (second component)? This would effectively show a sign for all values except zero on the second numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "x : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\nexp_style : str = 'x10n'\n\nStyle of formatting to use for the scientific notation formatting. By default this is \"x10n\" but other options include using a single letter (e.g., \"e\", \"E\", etc.), a letter followed by a \"1\" to signal a minimum digit width of one, or \"low-ten\" for using a stylized \"10\" marker.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign_m : bool = False\n\nShould the plus sign be shown for positive values of the mantissa (first component)? This would effectively show a sign for all values except zero on the first numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nforce_sign_n : bool = False\n\nShould the plus sign be shown for positive values of the exponent (second component)? This would effectively show a sign for all values except zero on the second numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/vals.fmt_scientific.html#returns", @@ -1468,14 +1468,14 @@ "href": "reference/nanoplot_options.html", "title": "nanoplot_options", "section": "", - "text": "nanoplot_options(\n data_point_radius=None\n data_point_stroke_color=None\n data_point_stroke_width=None\n data_point_fill_color=None\n data_line_type=None\n data_line_stroke_color=None\n data_line_stroke_width=None\n data_area_fill_color=None\n data_bar_stroke_color=None\n data_bar_stroke_width=None\n data_bar_fill_color=None\n data_bar_negative_stroke_color=None\n data_bar_negative_stroke_width=None\n data_bar_negative_fill_color=None\n reference_line_color=None\n reference_area_fill_color=None\n vertical_guide_stroke_color=None\n vertical_guide_stroke_width=None\n show_data_points=None\n show_data_line=None\n show_data_area=None\n show_reference_line=None\n show_reference_area=None\n show_vertical_guides=None\n show_y_axis_guide=None\n interactive_data_values=None\n y_val_fmt_fn=None\n y_axis_fmt_fn=None\n y_ref_line_fmt_fn=None\n currency=None\n)\nHelper for setting the options for a nanoplot.\nWhen using cols_nanoplot(), the defaults for the generated nanoplots can be modified with nanoplot_options() within the options= argument.\n\n\n\ndata_point_radius : int | list[int] | None = None\n\nThe data_point_radius= option lets you set the radius for each of the data points. By default this is set to 10. Individual radius values can be set by using a list of numeric values; however, the list provided must match the number of data points.\n\ndata_point_stroke_color : str | list[str] | None = None\n\nThe default stroke color of the data points is \\\"#FFFFFF\\\" (\\\"white\\\"). This works well when there is a visible data line combined with data points with a darker fill color. The stroke color can be modified with data_point_stroke_color= for all data points by supplying a single color value. With a list of colors, each data point's stroke color can be changed (ensure that the list length matches the number of data points).\n\ndata_point_stroke_width : int | list[int] | None = None\n\nThe width of the outside stroke for the data points can be modified with the data_point_stroke_width= option. By default, a value of 4 (as in '4px') is used.\n\ndata_point_fill_color : str | list[str] | None = None\n\nBy default, all data points have a fill color of \\\"#FF0000\\\" (\\\"red\\\"). This can be changed for all data points by providing a different color to data_point_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data points; the fill color values will be applied in order of left to right.\n\ndata_line_type : str | None = None\n\nThis can accept either \\\"curved\\\" or \\\"straight\\\". Curved lines are recommended when the nanoplot has less than 30 points and data points are evenly spaced. In most other cases, straight lines might present better.\n\ndata_line_stroke_color : str | None = None\n\nThe color of the data line can be modified from its default \\\"#4682B4\\\" (\\\"steelblue\\\") color by supplying a color to the data_line_stroke_color= option.\n\ndata_line_stroke_width : int | None = None\n\nThe width of the connecting data line can be modified with data_line_stroke_width=. By default, a value of 4 (as in '4px') is used.\n\ndata_area_fill_color : str | None = None\n\nThe fill color for the area that bounds the data points in line plot. The default is \\\"#FF0000\\\" (\\\"red\\\") but can be changed by providing a color value to data_area_fill_color=.\n\ndata_bar_stroke_color : str | list[str] | None = None\n\nThe color of the stroke used for the data bars can be modified from its default \\\"#3290CC\\\" color by supplying a color to data_bar_stroke_color=.\n\ndata_bar_stroke_width : int | list[int] | None = None\n\nThe width of the stroke used for the data bars can be modified with the data_bar_stroke_width= option. By default, a value of 4 (as in '4px') is used.\n\ndata_bar_fill_color : str | list[str] | None = None\n\nBy default, all data bars have a fill color of \\\"#3FB5FF\\\". This can be changed for all data bars by providing a different color to data_bar_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data bars; the fill color values will be applied in order of left to right.\n\ndata_bar_negative_stroke_color : str | None = None\n\nThe color of the stroke used for the data bars that have negative values. The default color is \\\"#CC3243\\\" but this can be changed by supplying a color value to the data_bar_negative_stroke_color= option.\n\ndata_bar_negative_stroke_width : int | None = None\n\nThe width of the stroke used for negative value data bars. This has the same default as data_bar_stroke_width= with a value of 4 (as in '4px'). This can be changed by giving a numeric value to the data_bar_negative_stroke_width= option.\n\ndata_bar_negative_fill_color : str | None = None\n\nBy default, all negative data bars have a fill color of \\\"#D75A68\\\". This can however be changed by providing a color value to data_bar_negative_fill_color=.\n\nreference_line_color : str | None = None\n\nThe reference line will have a color of \\\"#75A8B0\\\" if it is set to appear. This color can be changed by providing a single color value to reference_line_color=.\n\nreference_area_fill_color : str | None = None\n\nIf a reference area has been defined and is visible it has by default a fill color of \\\"#A6E6F2\\\". This can be modified by declaring a color value in the reference_area_fill_color= option.\n\nvertical_guide_stroke_color : str | None = None\n\nVertical guides appear when hovering in the vicinity of data points. Their default color is \\\"#911EB4\\\" (a strong magenta color) and a fill opacity value of 0.4 is automatically applied to this. However, the base color can be changed with the vertical_guide_stroke_color= option.\n\nvertical_guide_stroke_width : int | None = None\n\nThe vertical guide's stroke width, by default, is relatively large at 12 (this is '12px'). This is modifiable by setting a different value with vertical_guide_stroke_width=.\n\nshow_data_points : bool | None = None\n\nBy default, all data points in a nanoplot are shown but this layer can be hidden by setting show_data_points= to False.\n\nshow_data_line : bool | None = None\n\nThe data line connects data points together and it is shown by default. This data line layer can be hidden by setting show_data_line= to False.\n\nshow_data_area : bool | None = None\n\nThe data area layer is adjacent to the data points and the data line. It is shown by default but can be hidden with show_data_area=False.\n\nshow_reference_line : bool | None = None\n\nThe layer with a horizontal reference line appears underneath that of the data points and the data line. Like vertical guides, hovering over a reference will show its value. The reference line (if available) is shown by default but can be hidden by setting show_reference_line= to False.\n\nshow_reference_area : bool | None = None\n\nThe reference area appears at the very bottom of the layer stack, if it is available (i.e., defined in cols_nanoplot()). It will be shown in the default case but can be hidden by using show_reference_area=False.\n\nshow_vertical_guides : bool | None = None\n\nVertical guides appear when hovering over data points. This hidden layer is active by default but can be deactivated by using show_vertical_guides=False.\n\nshow_y_axis_guide : bool | None = None\n\nThe y-axis guide will appear when hovering over the far left side of a nanoplot. This hidden layer is active by default but can be deactivated by using show_y_axis_guide=False.\n\ninteractive_data_values : bool | None = None\n\nBy default, numeric data values will be shown only when the user interacts with certain regions of a nanoplot. This is because the values may be numerous (i.e., clutter the display when all are visible) and it can be argued that the values themselves are secondary to the presentation. However, for some types of plots (like horizontal bar plots), a persistent display of values alongside the plot marks may be desirable. By setting interactive_data_values=False we can opt for always displaying the data values alongside the plot components.\n\ny_val_fmt_fn : Callable[…, str] | None = None\n\nIf providing a function to y_val_fmt_fn=, customized formatting of the y values associated with the data points/bars is possible.\n\ny_axis_fmt_fn : Callable[…, str] | None = None\n\nA function supplied to y_axis_fmt_fn= will result in customized formatting of the y-axis label values.\n\ny_ref_line_fmt_fn : Callable[…, str] | None = None\n\nProviding a function for y_ref_line_fmt_fn= yields customized formatting of the reference line (if present).\n\ncurrency : str | None = None\n\nIf the values are to be displayed as currency values, supply either: (1) a 3-letter currency code (e.g., \\\"USD\\\" for U.S. Dollars, \\\"EUR\\\" for the Euro currency), or (2) a common currency name (e.g., \\\"dollar\\\", \\\"pound\\\", \\\"yen\\\", etc.).\n\n\n\n\n\nSee fmt_nanoplot()." + "text": "nanoplot_options(\n data_point_radius=None\n data_point_stroke_color=None\n data_point_stroke_width=None\n data_point_fill_color=None\n data_line_type=None\n data_line_stroke_color=None\n data_line_stroke_width=None\n data_area_fill_color=None\n data_bar_stroke_color=None\n data_bar_stroke_width=None\n data_bar_fill_color=None\n data_bar_negative_stroke_color=None\n data_bar_negative_stroke_width=None\n data_bar_negative_fill_color=None\n reference_line_color=None\n reference_area_fill_color=None\n vertical_guide_stroke_color=None\n vertical_guide_stroke_width=None\n show_data_points=None\n show_data_line=None\n show_data_area=None\n show_reference_line=None\n show_reference_area=None\n show_vertical_guides=None\n show_y_axis_guide=None\n interactive_data_values=None\n y_val_fmt_fn=None\n y_axis_fmt_fn=None\n y_ref_line_fmt_fn=None\n currency=None\n)\nHelper for setting the options for a nanoplot.\nWhen using cols_nanoplot(), the defaults for the generated nanoplots can be modified with nanoplot_options() within the options= argument.\n\n\n\ndata_point_radius : int | list[int] | None = None\n\nThe data_point_radius= option lets you set the radius for each of the data points. By default this is set to 10. Individual radius values can be set by using a list of numeric values; however, the list provided must match the number of data points.\n\ndata_point_stroke_color : str | list[str] | None = None\n\nThe default stroke color of the data points is \"#FFFFFF\" (\"white\"). This works well when there is a visible data line combined with data points with a darker fill color. The stroke color can be modified with data_point_stroke_color= for all data points by supplying a single color value. With a list of colors, each data point’s stroke color can be changed (ensure that the list length matches the number of data points).\n\ndata_point_stroke_width : int | list[int] | None = None\n\nThe width of the outside stroke for the data points can be modified with the data_point_stroke_width= option. By default, a value of 4 (as in ‘4px’) is used.\n\ndata_point_fill_color : str | list[str] | None = None\n\nBy default, all data points have a fill color of \"#FF0000\" (\"red\"). This can be changed for all data points by providing a different color to data_point_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data points; the fill color values will be applied in order of left to right.\n\ndata_line_type : str | None = None\n\nThis can accept either \"curved\" or \"straight\". Curved lines are recommended when the nanoplot has less than 30 points and data points are evenly spaced. In most other cases, straight lines might present better.\n\ndata_line_stroke_color : str | None = None\n\nThe color of the data line can be modified from its default \"#4682B4\" (\"steelblue\") color by supplying a color to the data_line_stroke_color= option.\n\ndata_line_stroke_width : int | None = None\n\nThe width of the connecting data line can be modified with data_line_stroke_width=. By default, a value of 4 (as in ‘4px’) is used.\n\ndata_area_fill_color : str | None = None\n\nThe fill color for the area that bounds the data points in line plot. The default is \"#FF0000\" (\"red\") but can be changed by providing a color value to data_area_fill_color=.\n\ndata_bar_stroke_color : str | list[str] | None = None\n\nThe color of the stroke used for the data bars can be modified from its default \"#3290CC\" color by supplying a color to data_bar_stroke_color=.\n\ndata_bar_stroke_width : int | list[int] | None = None\n\nThe width of the stroke used for the data bars can be modified with the data_bar_stroke_width= option. By default, a value of 4 (as in ‘4px’) is used.\n\ndata_bar_fill_color : str | list[str] | None = None\n\nBy default, all data bars have a fill color of \"#3FB5FF\". This can be changed for all data bars by providing a different color to data_bar_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data bars; the fill color values will be applied in order of left to right.\n\ndata_bar_negative_stroke_color : str | None = None\n\nThe color of the stroke used for the data bars that have negative values. The default color is \"#CC3243\" but this can be changed by supplying a color value to the data_bar_negative_stroke_color= option.\n\ndata_bar_negative_stroke_width : int | None = None\n\nThe width of the stroke used for negative value data bars. This has the same default as data_bar_stroke_width= with a value of 4 (as in ‘4px’). This can be changed by giving a numeric value to the data_bar_negative_stroke_width= option.\n\ndata_bar_negative_fill_color : str | None = None\n\nBy default, all negative data bars have a fill color of \"#D75A68\". This can however be changed by providing a color value to data_bar_negative_fill_color=.\n\nreference_line_color : str | None = None\n\nThe reference line will have a color of \"#75A8B0\" if it is set to appear. This color can be changed by providing a single color value to reference_line_color=.\n\nreference_area_fill_color : str | None = None\n\nIf a reference area has been defined and is visible it has by default a fill color of \"#A6E6F2\". This can be modified by declaring a color value in the reference_area_fill_color= option.\n\nvertical_guide_stroke_color : str | None = None\n\nVertical guides appear when hovering in the vicinity of data points. Their default color is \"#911EB4\" (a strong magenta color) and a fill opacity value of 0.4 is automatically applied to this. However, the base color can be changed with the vertical_guide_stroke_color= option.\n\nvertical_guide_stroke_width : int | None = None\n\nThe vertical guide’s stroke width, by default, is relatively large at 12 (this is ‘12px’). This is modifiable by setting a different value with vertical_guide_stroke_width=.\n\nshow_data_points : bool | None = None\n\nBy default, all data points in a nanoplot are shown but this layer can be hidden by setting show_data_points= to False.\n\nshow_data_line : bool | None = None\n\nThe data line connects data points together and it is shown by default. This data line layer can be hidden by setting show_data_line= to False.\n\nshow_data_area : bool | None = None\n\nThe data area layer is adjacent to the data points and the data line. It is shown by default but can be hidden with show_data_area=False.\n\nshow_reference_line : bool | None = None\n\nThe layer with a horizontal reference line appears underneath that of the data points and the data line. Like vertical guides, hovering over a reference will show its value. The reference line (if available) is shown by default but can be hidden by setting show_reference_line= to False.\n\nshow_reference_area : bool | None = None\n\nThe reference area appears at the very bottom of the layer stack, if it is available (i.e., defined in cols_nanoplot()). It will be shown in the default case but can be hidden by using show_reference_area=False.\n\nshow_vertical_guides : bool | None = None\n\nVertical guides appear when hovering over data points. This hidden layer is active by default but can be deactivated by using show_vertical_guides=False.\n\nshow_y_axis_guide : bool | None = None\n\nThe y-axis guide will appear when hovering over the far left side of a nanoplot. This hidden layer is active by default but can be deactivated by using show_y_axis_guide=False.\n\ninteractive_data_values : bool | None = None\n\nBy default, numeric data values will be shown only when the user interacts with certain regions of a nanoplot. This is because the values may be numerous (i.e., clutter the display when all are visible) and it can be argued that the values themselves are secondary to the presentation. However, for some types of plots (like horizontal bar plots), a persistent display of values alongside the plot marks may be desirable. By setting interactive_data_values=False we can opt for always displaying the data values alongside the plot components.\n\ny_val_fmt_fn : Callable[…, str] | None = None\n\nIf providing a function to y_val_fmt_fn=, customized formatting of the y values associated with the data points/bars is possible.\n\ny_axis_fmt_fn : Callable[…, str] | None = None\n\nA function supplied to y_axis_fmt_fn= will result in customized formatting of the y-axis label values.\n\ny_ref_line_fmt_fn : Callable[…, str] | None = None\n\nProviding a function for y_ref_line_fmt_fn= yields customized formatting of the reference line (if present).\n\ncurrency : str | None = None\n\nIf the values are to be displayed as currency values, supply either: (1) a 3-letter currency code (e.g., \"USD\" for U.S. Dollars, \"EUR\" for the Euro currency), or (2) a common currency name (e.g., \"dollar\", \"pound\", \"yen\", etc.).\n\n\n\n\n\nSee fmt_nanoplot()." }, { "objectID": "reference/nanoplot_options.html#parameters", "href": "reference/nanoplot_options.html#parameters", "title": "nanoplot_options", "section": "", - "text": "data_point_radius : int | list[int] | None = None\n\nThe data_point_radius= option lets you set the radius for each of the data points. By default this is set to 10. Individual radius values can be set by using a list of numeric values; however, the list provided must match the number of data points.\n\ndata_point_stroke_color : str | list[str] | None = None\n\nThe default stroke color of the data points is \\\"#FFFFFF\\\" (\\\"white\\\"). This works well when there is a visible data line combined with data points with a darker fill color. The stroke color can be modified with data_point_stroke_color= for all data points by supplying a single color value. With a list of colors, each data point's stroke color can be changed (ensure that the list length matches the number of data points).\n\ndata_point_stroke_width : int | list[int] | None = None\n\nThe width of the outside stroke for the data points can be modified with the data_point_stroke_width= option. By default, a value of 4 (as in '4px') is used.\n\ndata_point_fill_color : str | list[str] | None = None\n\nBy default, all data points have a fill color of \\\"#FF0000\\\" (\\\"red\\\"). This can be changed for all data points by providing a different color to data_point_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data points; the fill color values will be applied in order of left to right.\n\ndata_line_type : str | None = None\n\nThis can accept either \\\"curved\\\" or \\\"straight\\\". Curved lines are recommended when the nanoplot has less than 30 points and data points are evenly spaced. In most other cases, straight lines might present better.\n\ndata_line_stroke_color : str | None = None\n\nThe color of the data line can be modified from its default \\\"#4682B4\\\" (\\\"steelblue\\\") color by supplying a color to the data_line_stroke_color= option.\n\ndata_line_stroke_width : int | None = None\n\nThe width of the connecting data line can be modified with data_line_stroke_width=. By default, a value of 4 (as in '4px') is used.\n\ndata_area_fill_color : str | None = None\n\nThe fill color for the area that bounds the data points in line plot. The default is \\\"#FF0000\\\" (\\\"red\\\") but can be changed by providing a color value to data_area_fill_color=.\n\ndata_bar_stroke_color : str | list[str] | None = None\n\nThe color of the stroke used for the data bars can be modified from its default \\\"#3290CC\\\" color by supplying a color to data_bar_stroke_color=.\n\ndata_bar_stroke_width : int | list[int] | None = None\n\nThe width of the stroke used for the data bars can be modified with the data_bar_stroke_width= option. By default, a value of 4 (as in '4px') is used.\n\ndata_bar_fill_color : str | list[str] | None = None\n\nBy default, all data bars have a fill color of \\\"#3FB5FF\\\". This can be changed for all data bars by providing a different color to data_bar_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data bars; the fill color values will be applied in order of left to right.\n\ndata_bar_negative_stroke_color : str | None = None\n\nThe color of the stroke used for the data bars that have negative values. The default color is \\\"#CC3243\\\" but this can be changed by supplying a color value to the data_bar_negative_stroke_color= option.\n\ndata_bar_negative_stroke_width : int | None = None\n\nThe width of the stroke used for negative value data bars. This has the same default as data_bar_stroke_width= with a value of 4 (as in '4px'). This can be changed by giving a numeric value to the data_bar_negative_stroke_width= option.\n\ndata_bar_negative_fill_color : str | None = None\n\nBy default, all negative data bars have a fill color of \\\"#D75A68\\\". This can however be changed by providing a color value to data_bar_negative_fill_color=.\n\nreference_line_color : str | None = None\n\nThe reference line will have a color of \\\"#75A8B0\\\" if it is set to appear. This color can be changed by providing a single color value to reference_line_color=.\n\nreference_area_fill_color : str | None = None\n\nIf a reference area has been defined and is visible it has by default a fill color of \\\"#A6E6F2\\\". This can be modified by declaring a color value in the reference_area_fill_color= option.\n\nvertical_guide_stroke_color : str | None = None\n\nVertical guides appear when hovering in the vicinity of data points. Their default color is \\\"#911EB4\\\" (a strong magenta color) and a fill opacity value of 0.4 is automatically applied to this. However, the base color can be changed with the vertical_guide_stroke_color= option.\n\nvertical_guide_stroke_width : int | None = None\n\nThe vertical guide's stroke width, by default, is relatively large at 12 (this is '12px'). This is modifiable by setting a different value with vertical_guide_stroke_width=.\n\nshow_data_points : bool | None = None\n\nBy default, all data points in a nanoplot are shown but this layer can be hidden by setting show_data_points= to False.\n\nshow_data_line : bool | None = None\n\nThe data line connects data points together and it is shown by default. This data line layer can be hidden by setting show_data_line= to False.\n\nshow_data_area : bool | None = None\n\nThe data area layer is adjacent to the data points and the data line. It is shown by default but can be hidden with show_data_area=False.\n\nshow_reference_line : bool | None = None\n\nThe layer with a horizontal reference line appears underneath that of the data points and the data line. Like vertical guides, hovering over a reference will show its value. The reference line (if available) is shown by default but can be hidden by setting show_reference_line= to False.\n\nshow_reference_area : bool | None = None\n\nThe reference area appears at the very bottom of the layer stack, if it is available (i.e., defined in cols_nanoplot()). It will be shown in the default case but can be hidden by using show_reference_area=False.\n\nshow_vertical_guides : bool | None = None\n\nVertical guides appear when hovering over data points. This hidden layer is active by default but can be deactivated by using show_vertical_guides=False.\n\nshow_y_axis_guide : bool | None = None\n\nThe y-axis guide will appear when hovering over the far left side of a nanoplot. This hidden layer is active by default but can be deactivated by using show_y_axis_guide=False.\n\ninteractive_data_values : bool | None = None\n\nBy default, numeric data values will be shown only when the user interacts with certain regions of a nanoplot. This is because the values may be numerous (i.e., clutter the display when all are visible) and it can be argued that the values themselves are secondary to the presentation. However, for some types of plots (like horizontal bar plots), a persistent display of values alongside the plot marks may be desirable. By setting interactive_data_values=False we can opt for always displaying the data values alongside the plot components.\n\ny_val_fmt_fn : Callable[…, str] | None = None\n\nIf providing a function to y_val_fmt_fn=, customized formatting of the y values associated with the data points/bars is possible.\n\ny_axis_fmt_fn : Callable[…, str] | None = None\n\nA function supplied to y_axis_fmt_fn= will result in customized formatting of the y-axis label values.\n\ny_ref_line_fmt_fn : Callable[…, str] | None = None\n\nProviding a function for y_ref_line_fmt_fn= yields customized formatting of the reference line (if present).\n\ncurrency : str | None = None\n\nIf the values are to be displayed as currency values, supply either: (1) a 3-letter currency code (e.g., \\\"USD\\\" for U.S. Dollars, \\\"EUR\\\" for the Euro currency), or (2) a common currency name (e.g., \\\"dollar\\\", \\\"pound\\\", \\\"yen\\\", etc.)." + "text": "data_point_radius : int | list[int] | None = None\n\nThe data_point_radius= option lets you set the radius for each of the data points. By default this is set to 10. Individual radius values can be set by using a list of numeric values; however, the list provided must match the number of data points.\n\ndata_point_stroke_color : str | list[str] | None = None\n\nThe default stroke color of the data points is \"#FFFFFF\" (\"white\"). This works well when there is a visible data line combined with data points with a darker fill color. The stroke color can be modified with data_point_stroke_color= for all data points by supplying a single color value. With a list of colors, each data point’s stroke color can be changed (ensure that the list length matches the number of data points).\n\ndata_point_stroke_width : int | list[int] | None = None\n\nThe width of the outside stroke for the data points can be modified with the data_point_stroke_width= option. By default, a value of 4 (as in ‘4px’) is used.\n\ndata_point_fill_color : str | list[str] | None = None\n\nBy default, all data points have a fill color of \"#FF0000\" (\"red\"). This can be changed for all data points by providing a different color to data_point_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data points; the fill color values will be applied in order of left to right.\n\ndata_line_type : str | None = None\n\nThis can accept either \"curved\" or \"straight\". Curved lines are recommended when the nanoplot has less than 30 points and data points are evenly spaced. In most other cases, straight lines might present better.\n\ndata_line_stroke_color : str | None = None\n\nThe color of the data line can be modified from its default \"#4682B4\" (\"steelblue\") color by supplying a color to the data_line_stroke_color= option.\n\ndata_line_stroke_width : int | None = None\n\nThe width of the connecting data line can be modified with data_line_stroke_width=. By default, a value of 4 (as in ‘4px’) is used.\n\ndata_area_fill_color : str | None = None\n\nThe fill color for the area that bounds the data points in line plot. The default is \"#FF0000\" (\"red\") but can be changed by providing a color value to data_area_fill_color=.\n\ndata_bar_stroke_color : str | list[str] | None = None\n\nThe color of the stroke used for the data bars can be modified from its default \"#3290CC\" color by supplying a color to data_bar_stroke_color=.\n\ndata_bar_stroke_width : int | list[int] | None = None\n\nThe width of the stroke used for the data bars can be modified with the data_bar_stroke_width= option. By default, a value of 4 (as in ‘4px’) is used.\n\ndata_bar_fill_color : str | list[str] | None = None\n\nBy default, all data bars have a fill color of \"#3FB5FF\". This can be changed for all data bars by providing a different color to data_bar_fill_color=. And, a list of different colors can be supplied so long as the length is equal to the number of data bars; the fill color values will be applied in order of left to right.\n\ndata_bar_negative_stroke_color : str | None = None\n\nThe color of the stroke used for the data bars that have negative values. The default color is \"#CC3243\" but this can be changed by supplying a color value to the data_bar_negative_stroke_color= option.\n\ndata_bar_negative_stroke_width : int | None = None\n\nThe width of the stroke used for negative value data bars. This has the same default as data_bar_stroke_width= with a value of 4 (as in ‘4px’). This can be changed by giving a numeric value to the data_bar_negative_stroke_width= option.\n\ndata_bar_negative_fill_color : str | None = None\n\nBy default, all negative data bars have a fill color of \"#D75A68\". This can however be changed by providing a color value to data_bar_negative_fill_color=.\n\nreference_line_color : str | None = None\n\nThe reference line will have a color of \"#75A8B0\" if it is set to appear. This color can be changed by providing a single color value to reference_line_color=.\n\nreference_area_fill_color : str | None = None\n\nIf a reference area has been defined and is visible it has by default a fill color of \"#A6E6F2\". This can be modified by declaring a color value in the reference_area_fill_color= option.\n\nvertical_guide_stroke_color : str | None = None\n\nVertical guides appear when hovering in the vicinity of data points. Their default color is \"#911EB4\" (a strong magenta color) and a fill opacity value of 0.4 is automatically applied to this. However, the base color can be changed with the vertical_guide_stroke_color= option.\n\nvertical_guide_stroke_width : int | None = None\n\nThe vertical guide’s stroke width, by default, is relatively large at 12 (this is ‘12px’). This is modifiable by setting a different value with vertical_guide_stroke_width=.\n\nshow_data_points : bool | None = None\n\nBy default, all data points in a nanoplot are shown but this layer can be hidden by setting show_data_points= to False.\n\nshow_data_line : bool | None = None\n\nThe data line connects data points together and it is shown by default. This data line layer can be hidden by setting show_data_line= to False.\n\nshow_data_area : bool | None = None\n\nThe data area layer is adjacent to the data points and the data line. It is shown by default but can be hidden with show_data_area=False.\n\nshow_reference_line : bool | None = None\n\nThe layer with a horizontal reference line appears underneath that of the data points and the data line. Like vertical guides, hovering over a reference will show its value. The reference line (if available) is shown by default but can be hidden by setting show_reference_line= to False.\n\nshow_reference_area : bool | None = None\n\nThe reference area appears at the very bottom of the layer stack, if it is available (i.e., defined in cols_nanoplot()). It will be shown in the default case but can be hidden by using show_reference_area=False.\n\nshow_vertical_guides : bool | None = None\n\nVertical guides appear when hovering over data points. This hidden layer is active by default but can be deactivated by using show_vertical_guides=False.\n\nshow_y_axis_guide : bool | None = None\n\nThe y-axis guide will appear when hovering over the far left side of a nanoplot. This hidden layer is active by default but can be deactivated by using show_y_axis_guide=False.\n\ninteractive_data_values : bool | None = None\n\nBy default, numeric data values will be shown only when the user interacts with certain regions of a nanoplot. This is because the values may be numerous (i.e., clutter the display when all are visible) and it can be argued that the values themselves are secondary to the presentation. However, for some types of plots (like horizontal bar plots), a persistent display of values alongside the plot marks may be desirable. By setting interactive_data_values=False we can opt for always displaying the data values alongside the plot components.\n\ny_val_fmt_fn : Callable[…, str] | None = None\n\nIf providing a function to y_val_fmt_fn=, customized formatting of the y values associated with the data points/bars is possible.\n\ny_axis_fmt_fn : Callable[…, str] | None = None\n\nA function supplied to y_axis_fmt_fn= will result in customized formatting of the y-axis label values.\n\ny_ref_line_fmt_fn : Callable[…, str] | None = None\n\nProviding a function for y_ref_line_fmt_fn= yields customized formatting of the reference line (if present).\n\ncurrency : str | None = None\n\nIf the values are to be displayed as currency values, supply either: (1) a 3-letter currency code (e.g., \"USD\" for U.S. Dollars, \"EUR\" for the Euro currency), or (2) a common currency name (e.g., \"dollar\", \"pound\", \"yen\", etc.)." }, { "objectID": "reference/nanoplot_options.html#examples", @@ -1566,7 +1566,7 @@ "href": "reference/GT.show.html#parameters", "title": "GT.show", "section": "Parameters", - "text": "Parameters\n\ntarget : Literal['auto', 'notebook', 'browser'] = 'auto'\n\nWhere to show the table. If \"auto\", infer whether the table can be displayed inline (e.g. in a notebook), or whether a browser is needed (e.g. in a console)." + "text": "Parameters\n\ntarget : Literal['auto', 'notebook', 'browser'] = 'auto'\n\nWhere to show the table. If “auto”, infer whether the table can be displayed inline (e.g. in a notebook), or whether a browser is needed (e.g. in a console)." }, { "objectID": "reference/GT.show.html#examples", @@ -1608,14 +1608,14 @@ "href": "reference/GT.save.html", "title": "GT.save", "section": "", - "text": "GT.save(\n self\n file\n selector='table'\n scale=1.0\n expand=5\n web_driver='chrome'\n window_size=(6000, 6000)\n debug_port=None\n encoding='utf-8'\n _debug_dump=None\n)\nProduce a high-resolution image file or PDF of the table.\nThe output file is created by taking a screenshot of the table using a headless browser.\n\n\n\nfile : Path | str\n\nThe name of the file to save the image to. Accepts names ending with .png, .bmp, and other image extensions. Also accepts the extension .pdf.\n\nselector : str = 'table'\n\n(NOT IMPLEMENTED) The HTML element name used to select table. Defaults to the whole table.\n\nscale : float = 1.0\n\nThe scaling factor that will be used when generating the image. Lower values decrease resolution. A scale of 2 is equivalent to doubling the width of the table in pixels. Note that higher resolution results in larger file sizes.\n\nexpand : int = 5\n\n(NOT IMPLEMENTED) The number of pixels to expand the screenshot by. This can be increased to capture more of the surrounding area, or decreased to capture less.\n\nweb_driver : WebDrivers | webdriver.Remote = 'chrome'\n\nThe webdriver to use when taking the screenshot. Either a driver name, or webdriver instance. By default, uses Google Chrome. Supports \\\"firefox\\\" (Mozilla Firefox), \\\"safari\\\" (Apple Safari), and \\\"edge\\\" (Microsoft Edge). Specified browser must be installed. Note that if a webdriver instance is passed, options that require setting up a webdriver, like debug_port, will not be used.\n\nwindow_size : tuple[int, int] = (6000, 6000)\n\nThe size of the browser window to use when laying out the table. This shouldn't be necessary to capture a table, but may affect the tables appearance.\n\ndebug_port : None | int = None\n\nPort number to use for debugging. By default no debugging port is opened.\n\nencoding : str = 'utf-8'\n\nThe encoding used when writing temporary files.\n\n**_debug_dump** : DebugDumpOptions | None = None\n\nWhether the saved image should be a big browser window, with key elements outlined. This is helpful for debugging this function's resizing, cropping heuristics. This is an internal parameter and subject to change.\n\n\n\n\n\n\n : None\n\nThis function does not return anything; it simply saves the image to the specified file path.\n\n\n\n\n\nWe create the output file based on the HTML version of the table.\nThis process is facilitated by two libraries:\n\nselenium, which is used to control the Chrome browser and take a screenshot of the table.\nPIL, which is used to crop the screenshot to only include the table element of the page.\n\nBoth of these packages needs to be installed before attempting to save any table as an image file. The selenium package also requires the Chrome browser to be installed on the system.\nA pip-based reinstallation of Great Tables through the following command will install these required packages:\npip install great_tables[extra]" + "text": "GT.save(\n self\n file\n selector='table'\n scale=1.0\n expand=5\n web_driver='chrome'\n window_size=(6000, 6000)\n debug_port=None\n encoding='utf-8'\n _debug_dump=None\n)\nProduce a high-resolution image file or PDF of the table.\nThe output file is created by taking a screenshot of the table using a headless browser.\n\n\n\nfile : Path | str\n\nThe name of the file to save the image to. Accepts names ending with .png, .bmp, and other image extensions. Also accepts the extension .pdf.\n\nselector : str = 'table'\n\n(NOT IMPLEMENTED) The HTML element name used to select table. Defaults to the whole table.\n\nscale : float = 1.0\n\nThe scaling factor that will be used when generating the image. Lower values decrease resolution. A scale of 2 is equivalent to doubling the width of the table in pixels. Note that higher resolution results in larger file sizes.\n\nexpand : int = 5\n\n(NOT IMPLEMENTED) The number of pixels to expand the screenshot by. This can be increased to capture more of the surrounding area, or decreased to capture less.\n\nweb_driver : WebDrivers | webdriver.Remote = 'chrome'\n\nThe webdriver to use when taking the screenshot. Either a driver name, or webdriver instance. By default, uses Google Chrome. Supports \"firefox\" (Mozilla Firefox), \"safari\" (Apple Safari), and \"edge\" (Microsoft Edge). Specified browser must be installed. Note that if a webdriver instance is passed, options that require setting up a webdriver, like debug_port, will not be used.\n\nwindow_size : tuple[int, int] = (6000, 6000)\n\nThe size of the browser window to use when laying out the table. This shouldn’t be necessary to capture a table, but may affect the tables appearance.\n\ndebug_port : None | int = None\n\nPort number to use for debugging. By default no debugging port is opened.\n\nencoding : str = 'utf-8'\n\nThe encoding used when writing temporary files.\n\n**_debug_dump** : DebugDumpOptions | None = None\n\nWhether the saved image should be a big browser window, with key elements outlined. This is helpful for debugging this function’s resizing, cropping heuristics. This is an internal parameter and subject to change.\n\n\n\n\n\n\n : None\n\nThis function does not return anything; it simply saves the image to the specified file path.\n\n\n\n\n\nWe create the output file based on the HTML version of the table.\nThis process is facilitated by two libraries:\n\nselenium, which is used to control the Chrome browser and take a screenshot of the table.\nPIL, which is used to crop the screenshot to only include the table element of the page.\n\nBoth of these packages needs to be installed before attempting to save any table as an image file. The selenium package also requires the Chrome browser to be installed on the system.\nA pip-based reinstallation of Great Tables through the following command will install these required packages:\npip install great_tables[extra]" }, { "objectID": "reference/GT.save.html#parameters", "href": "reference/GT.save.html#parameters", "title": "GT.save", "section": "", - "text": "file : Path | str\n\nThe name of the file to save the image to. Accepts names ending with .png, .bmp, and other image extensions. Also accepts the extension .pdf.\n\nselector : str = 'table'\n\n(NOT IMPLEMENTED) The HTML element name used to select table. Defaults to the whole table.\n\nscale : float = 1.0\n\nThe scaling factor that will be used when generating the image. Lower values decrease resolution. A scale of 2 is equivalent to doubling the width of the table in pixels. Note that higher resolution results in larger file sizes.\n\nexpand : int = 5\n\n(NOT IMPLEMENTED) The number of pixels to expand the screenshot by. This can be increased to capture more of the surrounding area, or decreased to capture less.\n\nweb_driver : WebDrivers | webdriver.Remote = 'chrome'\n\nThe webdriver to use when taking the screenshot. Either a driver name, or webdriver instance. By default, uses Google Chrome. Supports \\\"firefox\\\" (Mozilla Firefox), \\\"safari\\\" (Apple Safari), and \\\"edge\\\" (Microsoft Edge). Specified browser must be installed. Note that if a webdriver instance is passed, options that require setting up a webdriver, like debug_port, will not be used.\n\nwindow_size : tuple[int, int] = (6000, 6000)\n\nThe size of the browser window to use when laying out the table. This shouldn't be necessary to capture a table, but may affect the tables appearance.\n\ndebug_port : None | int = None\n\nPort number to use for debugging. By default no debugging port is opened.\n\nencoding : str = 'utf-8'\n\nThe encoding used when writing temporary files.\n\n**_debug_dump** : DebugDumpOptions | None = None\n\nWhether the saved image should be a big browser window, with key elements outlined. This is helpful for debugging this function's resizing, cropping heuristics. This is an internal parameter and subject to change." + "text": "file : Path | str\n\nThe name of the file to save the image to. Accepts names ending with .png, .bmp, and other image extensions. Also accepts the extension .pdf.\n\nselector : str = 'table'\n\n(NOT IMPLEMENTED) The HTML element name used to select table. Defaults to the whole table.\n\nscale : float = 1.0\n\nThe scaling factor that will be used when generating the image. Lower values decrease resolution. A scale of 2 is equivalent to doubling the width of the table in pixels. Note that higher resolution results in larger file sizes.\n\nexpand : int = 5\n\n(NOT IMPLEMENTED) The number of pixels to expand the screenshot by. This can be increased to capture more of the surrounding area, or decreased to capture less.\n\nweb_driver : WebDrivers | webdriver.Remote = 'chrome'\n\nThe webdriver to use when taking the screenshot. Either a driver name, or webdriver instance. By default, uses Google Chrome. Supports \"firefox\" (Mozilla Firefox), \"safari\" (Apple Safari), and \"edge\" (Microsoft Edge). Specified browser must be installed. Note that if a webdriver instance is passed, options that require setting up a webdriver, like debug_port, will not be used.\n\nwindow_size : tuple[int, int] = (6000, 6000)\n\nThe size of the browser window to use when laying out the table. This shouldn’t be necessary to capture a table, but may affect the tables appearance.\n\ndebug_port : None | int = None\n\nPort number to use for debugging. By default no debugging port is opened.\n\nencoding : str = 'utf-8'\n\nThe encoding used when writing temporary files.\n\n**_debug_dump** : DebugDumpOptions | None = None\n\nWhether the saved image should be a big browser window, with key elements outlined. This is helpful for debugging this function’s resizing, cropping heuristics. This is an internal parameter and subject to change." }, { "objectID": "reference/GT.save.html#returns", @@ -1685,14 +1685,14 @@ "href": "reference/style.text.html", "title": "style.text", "section": "", - "text": "style.text(\n color=None\n font=None\n size=None\n align=None\n v_align=None\n style=None\n weight=None\n stretch=None\n decorate=None\n transform=None\n whitespace=None\n)\nA style specification for cell text.\nThe style.text() class is to be used with the tab_style() method, which itself allows for the setting of custom styles to one or more cells. With it, you can specify the color of the text, the font family, the font size, and the horizontal and vertical alignment of the text and more.\n\n\n\ncolor : str | ColumnExpr | None = None\n\nThe text color can be modified through the color argument.\n\nfont : str | ColumnExpr | GoogleFont | None = None\n\nThe font or collection of fonts (subsequent font names are) used as fallbacks.\n\nsize : str | ColumnExpr | None = None\n\nThe size of the font. Can be provided as a number that is assumed to represent px values (or could be wrapped in the px() helper function). We can also use one of the following absolute size keywords: \\\"xx-small\\\", \\\"x-small\\\", \\\"small\\\", \\\"medium\\\", \\\"large\\\", \\\"x-large\\\", or \\\"xx-large\\\".\n\nalign : Literal['center', 'left', 'right', 'justify'] | ColumnExpr | None = None\n\nThe text in a cell can be horizontally aligned though one of the following options: \\\"center\\\", \\\"left\\\", \\\"right\\\", or \\\"justify\\\".\n\nv_align : Literal['middle', 'top', 'bottom'] | ColumnExpr | None = None\n\nThe vertical alignment of the text in the cell can be modified through the options \\\"middle\\\", \\\"top\\\", or \\\"bottom\\\".\n\nstyle : Literal['normal', 'italic', 'oblique'] | ColumnExpr | None = None\n\nCan be one of either \\\"normal\\\", \\\"italic\\\", or \\\"oblique\\\".\n\nweight : Literal['normal', 'bold', 'bolder', 'lighter'] | ColumnExpr | None = None\n\nThe weight of the font can be modified thorough a text-based option 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.\n\nstretch : Literal['normal', 'condensed', 'ultra-condensed', 'extra-condensed', 'semi-condensed', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'] | ColumnExpr | None = None\n\nAllows for text to either be condensed or expanded. We can use one of the following text-based keywords to describe the degree of condensation/expansion: \\\"ultra-condensed\\\", \\\"extra-condensed\\\", \\\"condensed\\\", \\\"semi-condensed\\\", \\\"normal\\\", \\\"semi-expanded\\\", \\\"expanded\\\", \\\"extra-expanded\\\", or \\\"ultra-expanded\\\". Alternatively, we can supply percentage values from 0% to 200%, inclusive. Negative percentage values are not allowed.\n\ndecorate : Literal['overline', 'line-through', 'underline', 'underline overline'] | ColumnExpr | None = None\n\nAllows for text decoration effect to be applied. Here, we can use \\\"overline\\\", \\\"line-through\\\", or \\\"underline\\\".\n\ntransform : Literal['uppercase', 'lowercase', 'capitalize'] | ColumnExpr | None = None\n\nAllows for the transformation of text. Options are \\\"uppercase\\\", \\\"lowercase\\\", or \\\"capitalize\\\".\n\nwhitespace : Literal['normal', 'nowrap', 'pre', 'pre-wrap', 'pre-line', 'break-spaces'] | ColumnExpr | None = None\n\nA white-space preservation option. By default, runs of white-space will be collapsed into single spaces but several options exist to govern how white-space is collapsed and how lines might wrap at soft-wrap opportunities. The options are \\\"normal\\\", \\\"nowrap\\\", \\\"pre\\\", \\\"pre-wrap\\\", \\\"pre-line\\\", and \\\"break-spaces\\\".\n\n\n\n\n\n\n : CellStyleText\n\nA CellStyleText object, which is used for a styles argument if specifying any cell text properties.\n\n\n\n\n\nSee GT.tab_style()." + "text": "style.text(\n color=None\n font=None\n size=None\n align=None\n v_align=None\n style=None\n weight=None\n stretch=None\n decorate=None\n transform=None\n whitespace=None\n)\nA style specification for cell text.\nThe style.text() class is to be used with the tab_style() method, which itself allows for the setting of custom styles to one or more cells. With it, you can specify the color of the text, the font family, the font size, and the horizontal and vertical alignment of the text and more.\n\n\n\ncolor : str | ColumnExpr | None = None\n\nThe text color can be modified through the color argument.\n\nfont : str | ColumnExpr | GoogleFont | None = None\n\nThe font or collection of fonts (subsequent font names are) used as fallbacks.\n\nsize : str | ColumnExpr | None = None\n\nThe size of the font. Can be provided as a number that is assumed to represent px values (or could be wrapped in the px() helper function). We can also use one of the following absolute size keywords: \"xx-small\", \"x-small\", \"small\", \"medium\", \"large\", \"x-large\", or \"xx-large\".\n\nalign : Literal['center', 'left', 'right', 'justify'] | ColumnExpr | None = None\n\nThe text in a cell can be horizontally aligned though one of the following options: \"center\", \"left\", \"right\", or \"justify\".\n\nv_align : Literal['middle', 'top', 'bottom'] | ColumnExpr | None = None\n\nThe vertical alignment of the text in the cell can be modified through the options \"middle\", \"top\", or \"bottom\".\n\nstyle : Literal['normal', 'italic', 'oblique'] | ColumnExpr | None = None\n\nCan be one of either \"normal\", \"italic\", or \"oblique\".\n\nweight : Literal['normal', 'bold', 'bolder', 'lighter'] | ColumnExpr | None = None\n\nThe weight of the font can be modified thorough a text-based option 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.\n\nstretch : Literal['normal', 'condensed', 'ultra-condensed', 'extra-condensed', 'semi-condensed', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'] | ColumnExpr | None = None\n\nAllows for text to either be condensed or expanded. We can use one of the following text-based keywords to describe the degree of condensation/expansion: \"ultra-condensed\", \"extra-condensed\", \"condensed\", \"semi-condensed\", \"normal\", \"semi-expanded\", \"expanded\", \"extra-expanded\", or \"ultra-expanded\". Alternatively, we can supply percentage values from 0% to 200%, inclusive. Negative percentage values are not allowed.\n\ndecorate : Literal['overline', 'line-through', 'underline', 'underline overline'] | ColumnExpr | None = None\n\nAllows for text decoration effect to be applied. Here, we can use \"overline\", \"line-through\", or \"underline\".\n\ntransform : Literal['uppercase', 'lowercase', 'capitalize'] | ColumnExpr | None = None\n\nAllows for the transformation of text. Options are \"uppercase\", \"lowercase\", or \"capitalize\".\n\nwhitespace : Literal['normal', 'nowrap', 'pre', 'pre-wrap', 'pre-line', 'break-spaces'] | ColumnExpr | None = None\n\nA white-space preservation option. By default, runs of white-space will be collapsed into single spaces but several options exist to govern how white-space is collapsed and how lines might wrap at soft-wrap opportunities. The options are \"normal\", \"nowrap\", \"pre\", \"pre-wrap\", \"pre-line\", and \"break-spaces\".\n\n\n\n\n\n\n : CellStyleText\n\nA CellStyleText object, which is used for a styles argument if specifying any cell text properties.\n\n\n\n\n\nSee GT.tab_style()." }, { "objectID": "reference/style.text.html#parameters", "href": "reference/style.text.html#parameters", "title": "style.text", "section": "", - "text": "color : str | ColumnExpr | None = None\n\nThe text color can be modified through the color argument.\n\nfont : str | ColumnExpr | GoogleFont | None = None\n\nThe font or collection of fonts (subsequent font names are) used as fallbacks.\n\nsize : str | ColumnExpr | None = None\n\nThe size of the font. Can be provided as a number that is assumed to represent px values (or could be wrapped in the px() helper function). We can also use one of the following absolute size keywords: \\\"xx-small\\\", \\\"x-small\\\", \\\"small\\\", \\\"medium\\\", \\\"large\\\", \\\"x-large\\\", or \\\"xx-large\\\".\n\nalign : Literal['center', 'left', 'right', 'justify'] | ColumnExpr | None = None\n\nThe text in a cell can be horizontally aligned though one of the following options: \\\"center\\\", \\\"left\\\", \\\"right\\\", or \\\"justify\\\".\n\nv_align : Literal['middle', 'top', 'bottom'] | ColumnExpr | None = None\n\nThe vertical alignment of the text in the cell can be modified through the options \\\"middle\\\", \\\"top\\\", or \\\"bottom\\\".\n\nstyle : Literal['normal', 'italic', 'oblique'] | ColumnExpr | None = None\n\nCan be one of either \\\"normal\\\", \\\"italic\\\", or \\\"oblique\\\".\n\nweight : Literal['normal', 'bold', 'bolder', 'lighter'] | ColumnExpr | None = None\n\nThe weight of the font can be modified thorough a text-based option 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.\n\nstretch : Literal['normal', 'condensed', 'ultra-condensed', 'extra-condensed', 'semi-condensed', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'] | ColumnExpr | None = None\n\nAllows for text to either be condensed or expanded. We can use one of the following text-based keywords to describe the degree of condensation/expansion: \\\"ultra-condensed\\\", \\\"extra-condensed\\\", \\\"condensed\\\", \\\"semi-condensed\\\", \\\"normal\\\", \\\"semi-expanded\\\", \\\"expanded\\\", \\\"extra-expanded\\\", or \\\"ultra-expanded\\\". Alternatively, we can supply percentage values from 0% to 200%, inclusive. Negative percentage values are not allowed.\n\ndecorate : Literal['overline', 'line-through', 'underline', 'underline overline'] | ColumnExpr | None = None\n\nAllows for text decoration effect to be applied. Here, we can use \\\"overline\\\", \\\"line-through\\\", or \\\"underline\\\".\n\ntransform : Literal['uppercase', 'lowercase', 'capitalize'] | ColumnExpr | None = None\n\nAllows for the transformation of text. Options are \\\"uppercase\\\", \\\"lowercase\\\", or \\\"capitalize\\\".\n\nwhitespace : Literal['normal', 'nowrap', 'pre', 'pre-wrap', 'pre-line', 'break-spaces'] | ColumnExpr | None = None\n\nA white-space preservation option. By default, runs of white-space will be collapsed into single spaces but several options exist to govern how white-space is collapsed and how lines might wrap at soft-wrap opportunities. The options are \\\"normal\\\", \\\"nowrap\\\", \\\"pre\\\", \\\"pre-wrap\\\", \\\"pre-line\\\", and \\\"break-spaces\\\"." + "text": "color : str | ColumnExpr | None = None\n\nThe text color can be modified through the color argument.\n\nfont : str | ColumnExpr | GoogleFont | None = None\n\nThe font or collection of fonts (subsequent font names are) used as fallbacks.\n\nsize : str | ColumnExpr | None = None\n\nThe size of the font. Can be provided as a number that is assumed to represent px values (or could be wrapped in the px() helper function). We can also use one of the following absolute size keywords: \"xx-small\", \"x-small\", \"small\", \"medium\", \"large\", \"x-large\", or \"xx-large\".\n\nalign : Literal['center', 'left', 'right', 'justify'] | ColumnExpr | None = None\n\nThe text in a cell can be horizontally aligned though one of the following options: \"center\", \"left\", \"right\", or \"justify\".\n\nv_align : Literal['middle', 'top', 'bottom'] | ColumnExpr | None = None\n\nThe vertical alignment of the text in the cell can be modified through the options \"middle\", \"top\", or \"bottom\".\n\nstyle : Literal['normal', 'italic', 'oblique'] | ColumnExpr | None = None\n\nCan be one of either \"normal\", \"italic\", or \"oblique\".\n\nweight : Literal['normal', 'bold', 'bolder', 'lighter'] | ColumnExpr | None = None\n\nThe weight of the font can be modified thorough a text-based option 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.\n\nstretch : Literal['normal', 'condensed', 'ultra-condensed', 'extra-condensed', 'semi-condensed', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'] | ColumnExpr | None = None\n\nAllows for text to either be condensed or expanded. We can use one of the following text-based keywords to describe the degree of condensation/expansion: \"ultra-condensed\", \"extra-condensed\", \"condensed\", \"semi-condensed\", \"normal\", \"semi-expanded\", \"expanded\", \"extra-expanded\", or \"ultra-expanded\". Alternatively, we can supply percentage values from 0% to 200%, inclusive. Negative percentage values are not allowed.\n\ndecorate : Literal['overline', 'line-through', 'underline', 'underline overline'] | ColumnExpr | None = None\n\nAllows for text decoration effect to be applied. Here, we can use \"overline\", \"line-through\", or \"underline\".\n\ntransform : Literal['uppercase', 'lowercase', 'capitalize'] | ColumnExpr | None = None\n\nAllows for the transformation of text. Options are \"uppercase\", \"lowercase\", or \"capitalize\".\n\nwhitespace : Literal['normal', 'nowrap', 'pre', 'pre-wrap', 'pre-line', 'break-spaces'] | ColumnExpr | None = None\n\nA white-space preservation option. By default, runs of white-space will be collapsed into single spaces but several options exist to govern how white-space is collapsed and how lines might wrap at soft-wrap opportunities. The options are \"normal\", \"nowrap\", \"pre\", \"pre-wrap\", \"pre-line\", and \"break-spaces\"." }, { "objectID": "reference/style.text.html#returns", @@ -1713,14 +1713,14 @@ "href": "reference/vals.fmt_number.html", "title": "vals.fmt_number", "section": "", - "text": "vals.fmt_number(\n x\n decimals=2\n n_sigfig=None\n drop_trailing_zeros=False\n drop_trailing_dec_mark=True\n use_seps=True\n scale_by=1\n compact=False\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign=False\n locale=None\n)\nFormat numeric values.\nWith numeric values in a list, we can perform number-based formatting so that the values are rendered with some level of precision. The following major options are available:\n\ndecimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\nscaling: we can choose to scale targeted values by a multiplier value\nlarge-number suffixing: larger figures (thousands, millions, etc.) can be autoscaled and decorated with the appropriate suffixes\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in number formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the val_fmt_integer() function should be considered.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1.23K, and 1230000 becomes 1.23M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." + "text": "vals.fmt_number(\n x\n decimals=2\n n_sigfig=None\n drop_trailing_zeros=False\n drop_trailing_dec_mark=True\n use_seps=True\n scale_by=1\n compact=False\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign=False\n locale=None\n)\nFormat numeric values.\nWith numeric values in a list, we can perform number-based formatting so that the values are rendered with some level of precision. The following major options are available:\n\ndecimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\nscaling: we can choose to scale targeted values by a multiplier value\nlarge-number suffixing: larger figures (thousands, millions, etc.) can be autoscaled and decorated with the appropriate suffixes\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in number formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the val_fmt_integer() function should be considered.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1.23K, and 1230000 becomes 1.23M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." }, { "objectID": "reference/vals.fmt_number.html#parameters", "href": "reference/vals.fmt_number.html#parameters", "title": "vals.fmt_number", "section": "", - "text": "x : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the val_fmt_integer() function should be considered.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1.23K, and 1230000 becomes 1.23M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "x : X\n\nA list of values to be formatted.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the val_fmt_integer() function should be considered.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1.23K, and 1230000 becomes 1.23M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/vals.fmt_number.html#returns", @@ -1741,7 +1741,7 @@ "href": "reference/GT.fmt_currency.html#parameters", "title": "GT.fmt_currency", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ncurrency : str | None = None\n\nThe currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., \\\"USD\\\" for U.S. Dollars, \\\"EUR\\\" for the Euro currency).\n\nuse_subunits : bool = True\n\nAn option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce \\\"$273.81\\\". Removing the subunits (with use_subunits = False) will give us \\\"$273\\\".\n\ndecimals : int | None = None\n\nThe decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is \\\"USD\\\" it would result in \\\"$2\\\". With 4 decimal places, the formatted value becomes \\\"$2.3400\\\".\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'left'\n\nThe placement of the currency symbol. This can be either be \\\"left\\\" (as in \\\"$450\\\") or \\\"right\\\" (which yields \\\"450$\\\").\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ncurrency : str | None = None\n\nThe currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., \"USD\" for U.S. Dollars, \"EUR\" for the Euro currency).\n\nuse_subunits : bool = True\n\nAn option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce \"$273.81\". Removing the subunits (with use_subunits = False) will give us \"$273\".\n\ndecimals : int | None = None\n\nThe decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is \"USD\" it would result in \"$2\". With 4 decimal places, the formatted value becomes \"$2.3400\".\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'left'\n\nThe placement of the currency symbol. This can be either be \"left\" (as in \"$450\") or \"right\" (which yields \"450$\").\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/GT.fmt_currency.html#returns", @@ -2140,14 +2140,14 @@ "href": "reference/vals.fmt_roman.html", "title": "vals.fmt_roman", "section": "", - "text": "vals.fmt_roman(x, case='upper', pattern='{x}')\nFormat values as Roman numerals.\nWith numeric values we can transform those to Roman numerals, rounding values as necessary.\n\n\n\nx : X\n\nA list of values to be formatted.\n\ncase : str = 'upper'\n\nShould Roman numerals should be rendered as uppercase (\\\"upper\\\") or lowercase (\\\"lower\\\") letters? By default, this is set to \\\"upper\\\".\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." + "text": "vals.fmt_roman(x, case='upper', pattern='{x}')\nFormat values as Roman numerals.\nWith numeric values we can transform those to Roman numerals, rounding values as necessary.\n\n\n\nx : X\n\nA list of values to be formatted.\n\ncase : str = 'upper'\n\nShould Roman numerals should be rendered as uppercase (\"upper\") or lowercase (\"lower\") letters? By default, this is set to \"upper\".\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." }, { "objectID": "reference/vals.fmt_roman.html#parameters", "href": "reference/vals.fmt_roman.html#parameters", "title": "vals.fmt_roman", "section": "", - "text": "x : X\n\nA list of values to be formatted.\n\ncase : str = 'upper'\n\nShould Roman numerals should be rendered as uppercase (\\\"upper\\\") or lowercase (\\\"lower\\\") letters? By default, this is set to \\\"upper\\\".\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals." + "text": "x : X\n\nA list of values to be formatted.\n\ncase : str = 'upper'\n\nShould Roman numerals should be rendered as uppercase (\"upper\") or lowercase (\"lower\") letters? By default, this is set to \"upper\".\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals." }, { "objectID": "reference/vals.fmt_roman.html#returns", @@ -2175,7 +2175,7 @@ "href": "reference/GT.opt_align_table_header.html#parameters", "title": "GT.opt_align_table_header", "section": "Parameters", - "text": "Parameters\n\nalign : str = 'center'\n\nThe alignment of the title and subtitle elements in the table header. Options are \\\"center\\\" (the default), \\\"left\\\", or \\\"right\\\"." + "text": "Parameters\n\nalign : str = 'center'\n\nThe alignment of the title and subtitle elements in the table header. Options are \"center\" (the default), \"left\", or \"right\"." }, { "objectID": "reference/GT.opt_align_table_header.html#returns", @@ -2224,7 +2224,7 @@ "href": "reference/GT.cols_width.html#parameters", "title": "GT.cols_width", "section": "Parameters", - "text": "Parameters\n\ncases : dict[str, str] | None = None\n\nA dictionary where the keys are column names and the values are the widths. Widths can be specified in pixels (e.g., \\\"50px\\\") or as percentages (e.g., \\\"20%\\\").\n\n****kwargs** : str = {}\n\nKeyword arguments to specify column widths. Each keyword corresponds to a column name, with its value indicating the width in pixels or percentages." + "text": "Parameters\n\ncases : dict[str, str] | None = None\n\nA dictionary where the keys are column names and the values are the widths. Widths can be specified in pixels (e.g., \"50px\") or as percentages (e.g., \"20%\").\n\n****kwargs** : str = {}\n\nKeyword arguments to specify column widths. Each keyword corresponds to a column name, with its value indicating the width in pixels or percentages." }, { "objectID": "reference/GT.cols_width.html#returns", @@ -2280,7 +2280,7 @@ "href": "reference/GT.fmt_roman.html#parameters", "title": "GT.fmt_roman", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ncase : str = 'upper'\n\nShould Roman numerals should be rendered as uppercase (\\\"upper\\\") or lowercase (\\\"lower\\\") letters? By default, this is set to \\\"upper\\\".\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ncase : str = 'upper'\n\nShould Roman numerals should be rendered as uppercase (\"upper\") or lowercase (\"lower\") letters? By default, this is set to \"upper\".\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals." }, { "objectID": "reference/GT.fmt_roman.html#returns", @@ -2308,14 +2308,14 @@ "href": "reference/vals.fmt_bytes.html", "title": "vals.fmt_bytes", "section": "", - "text": "vals.fmt_bytes(\n x\n standard='decimal'\n decimals=1\n n_sigfig=None\n drop_trailing_zeros=True\n drop_trailing_dec_mark=True\n use_seps=True\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign=False\n incl_space=True\n locale=None\n)\nFormat values as bytes.\nWith numeric values in a list, we can transform those to values of bytes with human readable units. The val_fmt_bytes() function allows for the formatting of byte sizes to either of two common representations: (1) with decimal units (powers of 1000, examples being \"kB\" and \"MB\"), and (2) with binary units (powers of 1024, examples being \"KiB\" and \"MiB\"). It is assumed the input numeric values represent the number of bytes and automatic truncation of values will occur. The numeric values will be scaled to be in the range of 1 to <1000 and then decorated with the correct unit symbol according to the standard chosen. For more control over the formatting of byte sizes, we can use the following options:\n\ndecimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in number formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\nstandard : str = 'decimal'\n\nThe form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., \\\"kB\\\" and \\\"MB\\\"), and (2) binary units (powers of 1024; e.g., \\\"KiB\\\" and \\\"MiB\\\"). The default is to use decimal units with the \\\"decimal\\\" option. The alternative is to use binary units with the \\\"binary\\\" option.\n\ndecimals : int = 1\n\nThis corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = True\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nincl_space : bool = True\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." + "text": "vals.fmt_bytes(\n x\n standard='decimal'\n decimals=1\n n_sigfig=None\n drop_trailing_zeros=True\n drop_trailing_dec_mark=True\n use_seps=True\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign=False\n incl_space=True\n locale=None\n)\nFormat values as bytes.\nWith numeric values in a list, we can transform those to values of bytes with human readable units. The val_fmt_bytes() function allows for the formatting of byte sizes to either of two common representations: (1) with decimal units (powers of 1000, examples being \"kB\" and \"MB\"), and (2) with binary units (powers of 1024, examples being \"KiB\" and \"MiB\"). It is assumed the input numeric values represent the number of bytes and automatic truncation of values will occur. The numeric values will be scaled to be in the range of 1 to <1000 and then decorated with the correct unit symbol according to the standard chosen. For more control over the formatting of byte sizes, we can use the following options:\n\ndecimals: choice of the number of decimal places, option to drop trailing zeros, and a choice of the decimal symbol\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\npattern: option to use a text pattern for decoration of the formatted values\nlocale-based formatting: providing a locale ID will result in number formatting specific to the chosen locale\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\nstandard : str = 'decimal'\n\nThe form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., \"kB\" and \"MB\"), and (2) binary units (powers of 1024; e.g., \"KiB\" and \"MiB\"). The default is to use decimal units with the \"decimal\" option. The alternative is to use binary units with the \"binary\" option.\n\ndecimals : int = 1\n\nThis corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = True\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nincl_space : bool = True\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." }, { "objectID": "reference/vals.fmt_bytes.html#parameters", "href": "reference/vals.fmt_bytes.html#parameters", "title": "vals.fmt_bytes", "section": "", - "text": "x : X\n\nA list of values to be formatted.\n\nstandard : str = 'decimal'\n\nThe form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., \\\"kB\\\" and \\\"MB\\\"), and (2) binary units (powers of 1024; e.g., \\\"KiB\\\" and \\\"MiB\\\"). The default is to use decimal units with the \\\"decimal\\\" option. The alternative is to use binary units with the \\\"binary\\\" option.\n\ndecimals : int = 1\n\nThis corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = True\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nincl_space : bool = True\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "x : X\n\nA list of values to be formatted.\n\nstandard : str = 'decimal'\n\nThe form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., \"kB\" and \"MB\"), and (2) binary units (powers of 1024; e.g., \"KiB\" and \"MiB\"). The default is to use decimal units with the \"decimal\" option. The alternative is to use binary units with the \"binary\" option.\n\ndecimals : int = 1\n\nThis corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = True\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nincl_space : bool = True\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/vals.fmt_bytes.html#returns", @@ -2357,7 +2357,7 @@ "href": "reference/GT.html#parameters", "title": "GT", "section": "Parameters", - "text": "Parameters\n\ndata : Any\n\nA DataFrame object.\n\nrowname_col : str | None = None\n\nThe column name in the input data= table to use as row labels to be placed in the table stub.\n\ngroupname_col : str | None = None\n\nThe column name in the input data= table to use as group labels for generation of row groups.\n\nauto_align : bool = True\n\nOptionally have column data be aligned depending on the content contained in each column of the input data=.\n\nid : str | None = None\n\nBy default (with None) the table ID will be a random, ten-letter string as generated through internal use of the random_id() function. A custom table ID can be used here by providing a string.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be set as the default locale for all functions that take a locale argument. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "Parameters\n\ndata : Any\n\nA DataFrame object.\n\nrowname_col : str | None = None\n\nThe column name in the input data= table to use as row labels to be placed in the table stub.\n\ngroupname_col : str | None = None\n\nThe column name in the input data= table to use as group labels for generation of row groups.\n\nauto_align : bool = True\n\nOptionally have column data be aligned depending on the content contained in each column of the input data=.\n\nid : str | None = None\n\nBy default (with None) the table ID will be a random, ten-letter string as generated through internal use of the random_id() function. A custom table ID can be used here by providing a string.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be set as the default locale for all functions that take a locale argument. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/GT.html#returns", @@ -2385,14 +2385,14 @@ "href": "reference/style.borders.html", "title": "style.borders", "section": "", - "text": "style.borders(sides='all', color='#000000', style='solid', weight='1px')\nA style specification for cell borders.\nThe styles.borders() class is to be used with the tab_style() method, which itself allows for the setting of custom styles to one or more cells. The sides argument is where we define which borders should be modified (e.g., \"left\", \"right\", etc.). With that selection, the color, style, and weight of the selected borders can then be modified.\n\n\n\nsides : Literal['all', 'top', 'bottom', 'left', 'right'] | list[Literal['all', 'top', 'bottom', 'left', 'right']] | ColumnExpr = 'all'\n\nThe border sides to be modified. Options include \\\"left\\\", \\\"right\\\", \\\"top\\\", and \\\"bottom\\\". For all borders surrounding the selected cells, we can use the \\\"all\\\" option.\n\ncolor : str | ColumnExpr = '#000000'\n\nThe border color can be defined with any valid CSS color value, such as a hex code, a named color, or an RGB value. The default color value is \\\"#000000\\\" (black).\n\nstyle : str | ColumnExpr = 'solid'\n\nThe border style can be one of either \\\"solid\\\" (the default), \\\"dashed\\\", \\\"dotted\\\", \\\"hidden\\\", or \\\"double\\\".\n\nweight : str | ColumnExpr = '1px'\n\nThe default value for weight is \\\"1px\\\" and higher values will become more visually prominent.\n\n\n\n\n\n\n : CellStyleBorders\n\nA CellStyleBorders object, which is used for a styles argument if specifying cell borders.\n\n\n\n\n\nSee GT.tab_style().\n\n\n\n\n\n\nName\nDescription\n\n\n\n\ncolor\nstr(object='') -> str\n\n\nsides\nstr(object='') -> str\n\n\nstyle\nstr(object='') -> str\n\n\nweight\nstr(object='') -> str" + "text": "style.borders(sides='all', color='#000000', style='solid', weight='1px')\nA style specification for cell borders.\nThe styles.borders() class is to be used with the tab_style() method, which itself allows for the setting of custom styles to one or more cells. The sides argument is where we define which borders should be modified (e.g., \"left\", \"right\", etc.). With that selection, the color, style, and weight of the selected borders can then be modified.\n\n\n\nsides : Literal['all', 'top', 'bottom', 'left', 'right'] | list[Literal['all', 'top', 'bottom', 'left', 'right']] | ColumnExpr = 'all'\n\nThe border sides to be modified. Options include \"left\", \"right\", \"top\", and \"bottom\". For all borders surrounding the selected cells, we can use the \"all\" option.\n\ncolor : str | ColumnExpr = '#000000'\n\nThe border color can be defined with any valid CSS color value, such as a hex code, a named color, or an RGB value. The default color value is \"#000000\" (black).\n\nstyle : str | ColumnExpr = 'solid'\n\nThe border style can be one of either \"solid\" (the default), \"dashed\", \"dotted\", \"hidden\", or \"double\".\n\nweight : str | ColumnExpr = '1px'\n\nThe default value for weight is \"1px\" and higher values will become more visually prominent.\n\n\n\n\n\n\n : CellStyleBorders\n\nA CellStyleBorders object, which is used for a styles argument if specifying cell borders.\n\n\n\n\n\nSee GT.tab_style().\n\n\n\n\n\n\nName\nDescription\n\n\n\n\ncolor\nstr(object=’’) -> str\n\n\nsides\nstr(object=’’) -> str\n\n\nstyle\nstr(object=’’) -> str\n\n\nweight\nstr(object=’’) -> str" }, { "objectID": "reference/style.borders.html#parameters", "href": "reference/style.borders.html#parameters", "title": "style.borders", "section": "", - "text": "sides : Literal['all', 'top', 'bottom', 'left', 'right'] | list[Literal['all', 'top', 'bottom', 'left', 'right']] | ColumnExpr = 'all'\n\nThe border sides to be modified. Options include \\\"left\\\", \\\"right\\\", \\\"top\\\", and \\\"bottom\\\". For all borders surrounding the selected cells, we can use the \\\"all\\\" option.\n\ncolor : str | ColumnExpr = '#000000'\n\nThe border color can be defined with any valid CSS color value, such as a hex code, a named color, or an RGB value. The default color value is \\\"#000000\\\" (black).\n\nstyle : str | ColumnExpr = 'solid'\n\nThe border style can be one of either \\\"solid\\\" (the default), \\\"dashed\\\", \\\"dotted\\\", \\\"hidden\\\", or \\\"double\\\".\n\nweight : str | ColumnExpr = '1px'\n\nThe default value for weight is \\\"1px\\\" and higher values will become more visually prominent." + "text": "sides : Literal['all', 'top', 'bottom', 'left', 'right'] | list[Literal['all', 'top', 'bottom', 'left', 'right']] | ColumnExpr = 'all'\n\nThe border sides to be modified. Options include \"left\", \"right\", \"top\", and \"bottom\". For all borders surrounding the selected cells, we can use the \"all\" option.\n\ncolor : str | ColumnExpr = '#000000'\n\nThe border color can be defined with any valid CSS color value, such as a hex code, a named color, or an RGB value. The default color value is \"#000000\" (black).\n\nstyle : str | ColumnExpr = 'solid'\n\nThe border style can be one of either \"solid\" (the default), \"dashed\", \"dotted\", \"hidden\", or \"double\".\n\nweight : str | ColumnExpr = '1px'\n\nThe default value for weight is \"1px\" and higher values will become more visually prominent." }, { "objectID": "reference/style.borders.html#returns", @@ -2413,7 +2413,7 @@ "href": "reference/style.borders.html#attributes", "title": "style.borders", "section": "", - "text": "Name\nDescription\n\n\n\n\ncolor\nstr(object='') -> str\n\n\nsides\nstr(object='') -> str\n\n\nstyle\nstr(object='') -> str\n\n\nweight\nstr(object='') -> str" + "text": "Name\nDescription\n\n\n\n\ncolor\nstr(object=’’) -> str\n\n\nsides\nstr(object=’’) -> str\n\n\nstyle\nstr(object=’’) -> str\n\n\nweight\nstr(object=’’) -> str" }, { "objectID": "reference/GT.fmt_scientific.html", @@ -2427,7 +2427,7 @@ "href": "reference/GT.fmt_scientific.html#parameters", "title": "GT.fmt_scientific", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\nexp_style : str = 'x10n'\n\nStyle of formatting to use for the scientific notation formatting. By default this is \\\"x10n\\\" but other options include using a single letter (e.g., \\\"e\\\", \\\"E\\\", etc.), a letter followed by a \\\"1\\\" to signal a minimum digit width of one, or \\\"low-ten\\\" for using a stylized \\\"10\\\" marker.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign_m : bool = False\n\nShould the plus sign be shown for positive values of the mantissa (first component)? This would effectively show a sign for all values except zero on the first numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nforce_sign_n : bool = False\n\nShould the plus sign be shown for positive values of the exponent (second component)? This would effectively show a sign for all values except zero on the second numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\nexp_style : str = 'x10n'\n\nStyle of formatting to use for the scientific notation formatting. By default this is \"x10n\" but other options include using a single letter (e.g., \"e\", \"E\", etc.), a letter followed by a \"1\" to signal a minimum digit width of one, or \"low-ten\" for using a stylized \"10\" marker.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign_m : bool = False\n\nShould the plus sign be shown for positive values of the mantissa (first component)? This would effectively show a sign for all values except zero on the first numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nforce_sign_n : bool = False\n\nShould the plus sign be shown for positive values of the exponent (second component)? This would effectively show a sign for all values except zero on the second numeric component of the notation. If so, use True (the default for this is False), where only negative numbers will display a sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/GT.fmt_scientific.html#returns", @@ -2462,14 +2462,14 @@ "href": "reference/vals.fmt_currency.html", "title": "vals.fmt_currency", "section": "", - "text": "vals.fmt_currency(\n x\n currency=None\n use_subunits=True\n decimals=None\n drop_trailing_dec_mark=True\n use_seps=True\n scale_by=1\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign=False\n placement='left'\n incl_space=False\n locale=None\n)\nFormat values as currencies.\nWith numeric values, we can perform currency-based formatting with the val_fmt_currency() function. This supports both automatic formatting with a three-letter currency code. We have fine control over the conversion from numeric values to currency values, where we could take advantage of the following options:\n\nthe currency: providing a currency code or common currency name will procure the correct currency symbol and number of currency subunits\ncurrency symbol placement: the currency symbol can be placed before or after the values\ndecimals/subunits: choice of the number of decimal places, and a choice of the decimal symbol, and an option on whether to include or exclude the currency subunits (the decimal portion)\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\nscaling: we can choose to scale targeted values by a multiplier value\npattern: option to use a text pattern for decoration of the formatted currency values\nlocale-based formatting: providing a locale ID will result in currency formatting specific to the chosen locale; it will also retrieve the locale’s currency if none is explicitly given\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\ncurrency : str | None = None\n\nThe currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., \\\"USD\\\" for U.S. Dollars, \\\"EUR\\\" for the Euro currency).\n\nuse_subunits : bool = True\n\nAn option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce \\\"$273.81\\\". Removing the subunits (with use_subunits = False) will give us \\\"$273\\\".\n\ndecimals : int | None = None\n\nThe decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is \\\"USD\\\" it would result in \\\"$2\\\". With 4 decimal places, the formatted value becomes \\\"$2.3400\\\".\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'left'\n\nThe placement of the currency symbol. This can be either be \\\"left\\\" (as in \\\"$450\\\") or \\\"right\\\" (which yields \\\"450$\\\").\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." + "text": "vals.fmt_currency(\n x\n currency=None\n use_subunits=True\n decimals=None\n drop_trailing_dec_mark=True\n use_seps=True\n scale_by=1\n pattern='{x}'\n sep_mark=','\n dec_mark='.'\n force_sign=False\n placement='left'\n incl_space=False\n locale=None\n)\nFormat values as currencies.\nWith numeric values, we can perform currency-based formatting with the val_fmt_currency() function. This supports both automatic formatting with a three-letter currency code. We have fine control over the conversion from numeric values to currency values, where we could take advantage of the following options:\n\nthe currency: providing a currency code or common currency name will procure the correct currency symbol and number of currency subunits\ncurrency symbol placement: the currency symbol can be placed before or after the values\ndecimals/subunits: choice of the number of decimal places, and a choice of the decimal symbol, and an option on whether to include or exclude the currency subunits (the decimal portion)\ndigit grouping separators: options to enable/disable digit separators and provide a choice of separator symbol\nscaling: we can choose to scale targeted values by a multiplier value\npattern: option to use a text pattern for decoration of the formatted currency values\nlocale-based formatting: providing a locale ID will result in currency formatting specific to the chosen locale; it will also retrieve the locale’s currency if none is explicitly given\n\n\n\n\nx : X\n\nA list of values to be formatted.\n\ncurrency : str | None = None\n\nThe currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., \"USD\" for U.S. Dollars, \"EUR\" for the Euro currency).\n\nuse_subunits : bool = True\n\nAn option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce \"$273.81\". Removing the subunits (with use_subunits = False) will give us \"$273\".\n\ndecimals : int | None = None\n\nThe decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is \"USD\" it would result in \"$2\". With 4 decimal places, the formatted value becomes \"$2.3400\".\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'left'\n\nThe placement of the currency symbol. This can be either be \"left\" (as in \"$450\") or \"right\" (which yields \"450$\").\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).\n\n\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." }, { "objectID": "reference/vals.fmt_currency.html#parameters", "href": "reference/vals.fmt_currency.html#parameters", "title": "vals.fmt_currency", "section": "", - "text": "x : X\n\nA list of values to be formatted.\n\ncurrency : str | None = None\n\nThe currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., \\\"USD\\\" for U.S. Dollars, \\\"EUR\\\" for the Euro currency).\n\nuse_subunits : bool = True\n\nAn option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce \\\"$273.81\\\". Removing the subunits (with use_subunits = False) will give us \\\"$273\\\".\n\ndecimals : int | None = None\n\nThe decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is \\\"USD\\\" it would result in \\\"$2\\\". With 4 decimal places, the formatted value becomes \\\"$2.3400\\\".\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'left'\n\nThe placement of the currency symbol. This can be either be \\\"left\\\" (as in \\\"$450\\\") or \\\"right\\\" (which yields \\\"450$\\\").\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "x : X\n\nA list of values to be formatted.\n\ncurrency : str | None = None\n\nThe currency to use for the numeric value. This input can be supplied as a 3-letter currency code (e.g., \"USD\" for U.S. Dollars, \"EUR\" for the Euro currency).\n\nuse_subunits : bool = True\n\nAn option for whether the subunits portion of a currency value should be displayed. For example, with an input value of 273.81, the default formatting will produce \"$273.81\". Removing the subunits (with use_subunits = False) will give us \"$273\".\n\ndecimals : int | None = None\n\nThe decimals values corresponds to the exact number of decimal places to use. This value is optional as a currency has an intrinsic number of decimal places (i.e., the subunits). A value such as 2.34 can, for example, be formatted with 0 decimal places and if the currency used is \"USD\" it would result in \"$2\". With 4 decimal places, the formatted value becomes \"$2.3400\".\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nplacement : str = 'left'\n\nThe placement of the currency symbol. This can be either be \"left\" (as in \"$450\") or \"right\" (which yields \"450$\").\n\nincl_space : bool = False\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/vals.fmt_currency.html#returns", @@ -2511,7 +2511,7 @@ "href": "reference/system_fonts.html#parameters", "title": "system_fonts", "section": "Parameters", - "text": "Parameters\n\nname : FontStackName = 'system-ui'\n\nThe name of a font stack. Must be drawn from the set of \\\"system-ui\\\" (the default), \\\"transitional\\\", \\\"old-style\\\", \\\"humanist\\\", \\\"geometric-humanist\\\", \\\"classical-humanist\\\", \\\"neo-grotesque\\\", \\\"monospace-slab-serif\\\", \\\"monospace-code\\\", \\\"industrial\\\", \\\"rounded-sans\\\", \\\"slab-serif\\\", \\\"antique\\\", \\\"didone\\\", and \\\"handwritten\\\"." + "text": "Parameters\n\nname : FontStackName = 'system-ui'\n\nThe name of a font stack. Must be drawn from the set of \"system-ui\" (the default), \"transitional\", \"old-style\", \"humanist\", \"geometric-humanist\", \"classical-humanist\", \"neo-grotesque\", \"monospace-slab-serif\", \"monospace-code\", \"industrial\", \"rounded-sans\", \"slab-serif\", \"antique\", \"didone\", and \"handwritten\"." }, { "objectID": "reference/system_fonts.html#returns", @@ -2679,7 +2679,7 @@ "href": "reference/loc.row_groups.html#returns", "title": "loc.row_groups", "section": "Returns", - "text": "Returns\n\n : LocRowGroups\n\nA LocRowGroups object, which is used for a locations= argument if specifying the table's row groups." + "text": "Returns\n\n : LocRowGroups\n\nA LocRowGroups object, which is used for a locations= argument if specifying the table’s row groups." }, { "objectID": "reference/loc.row_groups.html#examples", @@ -2693,14 +2693,14 @@ "href": "reference/vals.fmt_date.html", "title": "vals.fmt_date", "section": "", - "text": "vals.fmt_date(x, date_style='iso', pattern='{x}', locale=None)\nFormat values as dates.\nFormat input values to time values using one of 17 preset date styles. Input can be in the form of date type or as a ISO-8601 string (in the form of YYYY-MM-DD HH:MM:SS or YYYY-MM-DD).\n\n\n\nx : X\n\nA list of values to be formatted.\n\ndate_style : DateStyle = 'iso'\n\nThe date style to use. By default this is the short name \\\"iso\\\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France).\n\n\n\n\n\nWe need to supply a preset date style to the date_style argument. The date styles are numerous and can handle localization to any supported locale. The following table provides a listing of all date styles and their output values (corresponding to an input date of 2000-02-29).\n\n\n\n\nDate Style\nOutput\n\n\n\n\n1\n\"iso\"\n\"2000-02-29\"\n\n\n2\n\"wday_month_day_year\"\n\"Tuesday, February 29, 2000\"\n\n\n3\n\"wd_m_day_year\"\n\"Tue, Feb 29, 2000\"\n\n\n4\n\"wday_day_month_year\"\n\"Tuesday 29 February 2000\"\n\n\n5\n\"month_day_year\"\n\"February 29, 2000\"\n\n\n6\n\"m_day_year\"\n\"Feb 29, 2000\"\n\n\n7\n\"day_m_year\"\n\"29 Feb 2000\"\n\n\n8\n\"day_month_year\"\n\"29 February 2000\"\n\n\n9\n\"day_month\"\n\"29 February\"\n\n\n10\n\"day_m\"\n\"29 Feb\"\n\n\n11\n\"year\"\n\"2000\"\n\n\n12\n\"month\"\n\"February\"\n\n\n13\n\"day\"\n\"29\"\n\n\n14\n\"year.mn.day\"\n\"2000/02/29\"\n\n\n15\n\"y.mn.day\"\n\"00/02/29\"\n\n\n16\n\"year_week\"\n\"2000-W09\"\n\n\n17\n\"year_quarter\"\n\"2000-Q1\"\n\n\n\nWe can use the info_date_style() function within the console to view a similar table of date styles with example output.\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." + "text": "vals.fmt_date(x, date_style='iso', pattern='{x}', locale=None)\nFormat values as dates.\nFormat input values to time values using one of 17 preset date styles. Input can be in the form of date type or as a ISO-8601 string (in the form of YYYY-MM-DD HH:MM:SS or YYYY-MM-DD).\n\n\n\nx : X\n\nA list of values to be formatted.\n\ndate_style : DateStyle = 'iso'\n\nThe date style to use. By default this is the short name \"iso\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France).\n\n\n\n\n\nWe need to supply a preset date style to the date_style argument. The date styles are numerous and can handle localization to any supported locale. The following table provides a listing of all date styles and their output values (corresponding to an input date of 2000-02-29).\n\n\n\n\nDate Style\nOutput\n\n\n\n\n1\n\"iso\"\n\"2000-02-29\"\n\n\n2\n\"wday_month_day_year\"\n\"Tuesday, February 29, 2000\"\n\n\n3\n\"wd_m_day_year\"\n\"Tue, Feb 29, 2000\"\n\n\n4\n\"wday_day_month_year\"\n\"Tuesday 29 February 2000\"\n\n\n5\n\"month_day_year\"\n\"February 29, 2000\"\n\n\n6\n\"m_day_year\"\n\"Feb 29, 2000\"\n\n\n7\n\"day_m_year\"\n\"29 Feb 2000\"\n\n\n8\n\"day_month_year\"\n\"29 February 2000\"\n\n\n9\n\"day_month\"\n\"29 February\"\n\n\n10\n\"day_m\"\n\"29 Feb\"\n\n\n11\n\"year\"\n\"2000\"\n\n\n12\n\"month\"\n\"February\"\n\n\n13\n\"day\"\n\"29\"\n\n\n14\n\"year.mn.day\"\n\"2000/02/29\"\n\n\n15\n\"y.mn.day\"\n\"00/02/29\"\n\n\n16\n\"year_week\"\n\"2000-W09\"\n\n\n17\n\"year_quarter\"\n\"2000-Q1\"\n\n\n\nWe can use the info_date_style() function within the console to view a similar table of date styles with example output.\n\n\n\n\n : list[str]\n\nA list of formatted values is returned." }, { "objectID": "reference/vals.fmt_date.html#parameters", "href": "reference/vals.fmt_date.html#parameters", "title": "vals.fmt_date", "section": "", - "text": "x : X\n\nA list of values to be formatted.\n\ndate_style : DateStyle = 'iso'\n\nThe date style to use. By default this is the short name \\\"iso\\\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "x : X\n\nA list of values to be formatted.\n\ndate_style : DateStyle = 'iso'\n\nThe date style to use. By default this is the short name \"iso\" which corresponds to ISO 8601 date formatting. There are 41 date styles in total and their short names can be viewed using info_date_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/vals.fmt_date.html#formatting-with-the-date_style-argument", @@ -2728,7 +2728,7 @@ "href": "reference/GT.tab_options.html#parameters", "title": "GT.tab_options", "section": "Parameters", - "text": "Parameters\n\ncontainer_width : str | None = None\n\nThe width of the table's container. Can be specified as a single-length character with units of pixels or as a percentage. If provided as a scalar numeric value, it is assumed that the value is given in units of pixels.\n\ncontainer_height : str | None = None\n\nThe height of the table's container.\n\ncontainer_overflow_x : str | None = None\n\nAn option to enable scrolling in the horizontal direction when the table content overflows the container dimensions. Using True (the default) means that horizontal scrolling is enabled to view the entire table in those directions. With False, the table may be clipped if the table width or height exceeds the container_width.\n\ncontainer_overflow_y : str | None = None\n\nAn option to enable scrolling in the vertical direction when the table content overflows. Same rules apply as for container_overflow_x; the dependency here is that of the table height (container_height).\n\ntable_width : str | None = None\n\nThe width of the table. Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\ntable_layout : str | None = None\n\nThe value for the table-layout CSS style in the HTML output context. By default, this is \\\"fixed\\\" but another valid option is \\\"auto\\\".\n\ntable_margin_left : str | None = None\n\nThe size of the margins on the left of the table within the container. Can be specified as a single-length value with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels. Using table_margin_left will overwrite any values set by table_align.\n\ntable_margin_right : str | None = None\n\nThe size of the margins on the right of the table within the container. Same rules apply as for table_margin_left. Using table_margin_right will overwrite any values set by table_align.\n\ntable_background_color : str | None = None\n\nThe background color for the table. A color name or a hexadecimal color code should be provided.\n\ntable_additional_css : list[str] | None = None\n\nAdditional CSS that can be added to the table. This can be used to add any custom CSS that is not covered by the other options.\n\ntable_font_names : str | list[str] | None = None\n\nThe names of the fonts used for the table. This should be provided as a list of font names. If the first font isn't available, then the next font is tried (and so on).\n\ntable_font_size : str | None = None\n\nThe font size for the table. Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\ntable_font_weight : str | int | float | None = None\n\nThe font weight of the table. 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.\n\ntable_font_style : str | None = None\n\nThe font style for the table. Can be one of either \\\"normal\\\", \\\"italic\\\", or \\\"oblique\\\".\n\ntable_font_color : str | None = None\n\nThe text color used throughout the table. A color name or a hexadecimal color code should be provided.\n\ntable_font_color_light : str | None = None\n\nThe text color used throughout the table when the background color is dark. A color name or a hexadecimal color code should be provided.\n\ntable_border_top_style : str | None = None\n\nThe style of the table's absolute top border. Can be one of either \\\"solid\\\", \\\"dotted\\\", \\\"dashed\\\", \\\"double\\\", \\\"groove\\\", \\\"ridge\\\", \\\"inset\\\", or \\\"outset\\\".\n\ntable_border_top_width : str | None = None\n\nThe width of the table's absolute top border. Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\ntable_border_top_color : str | None = None\n\nThe color of the table's absolute top border. A color name or a hexadecimal color code should be provided.\n\ntable_border_bottom_style : str | None = None\n\nThe style of the table's absolute bottom border.\n\ntable_border_bottom_width : str | None = None\n\nThe width of the table's absolute bottom border.\n\ntable_border_bottom_color : str | None = None\n\nThe color of the table's absolute bottom border.\n\ntable_border_left_style : str | None = None\n\nThe style of the table's absolute left border.\n\ntable_border_left_width : str | None = None\n\nThe width of the table's absolute left border.\n\ntable_border_left_color : str | None = None\n\nThe color of the table's absolute left border.\n\ntable_border_right_style : str | None = None\n\nThe style of the table's absolute right border.\n\ntable_border_right_width : str | None = None\n\nThe width of the table's absolute right border.\n\ntable_border_right_color : str | None = None\n\nThe color of the table's absolute right border.\n\nheading_background_color : str | None = None\n\nThe background color for the heading. A color name or a hexadecimal color code should be provided.\n\nheading_align : str | None = None\n\nControls the horizontal alignment of the heading title and subtitle. We can either use \\\"center\\\", \\\"left\\\", or \\\"right\\\".\n\nheading_title_font_size : str | None = None\n\nThe font size for the heading title element.\n\nheading_title_font_weight : str | int | float | None = None\n\nThe font weight of the heading title.\n\nheading_subtitle_font_size : str | None = None\n\nThe font size for the heading subtitle element.\n\nheading_subtitle_font_weight : str | int | float | None = None\n\nThe font weight of the heading subtitle.\n\nheading_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the heading (title and subtitle). Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\nheading_padding_horizontal : str | None = None\n\nThe amount of horizontal padding to incorporate in the heading (title and subtitle). Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\nheading_border_bottom_style : str | None = None\n\nThe style of the header's bottom border.\n\nheading_border_bottom_width : str | None = None\n\nThe width of the header's bottom border. If the width of this border is larger, then it will be the visible border.\n\nheading_border_bottom_color : str | None = None\n\nThe color of the header's bottom border.\n\nheading_border_lr_style : str | None = None\n\nThe style of the left and right borders of the heading location.\n\nheading_border_lr_width : str | None = None\n\nThe width of the left and right borders of the heading location. If the width of this border is larger, then it will be the visible border.\n\nheading_border_lr_color : str | None = None\n\nThe color of the left and right borders of the heading location.\n\ncolumn_labels_background_color : str | None = None\n\nThe background color for the column labels. A color name or a hexadecimal color code should be provided.\n\ncolumn_labels_font_size : str | None = None\n\nThe font size to use for all column labels.\n\ncolumn_labels_font_weight : str | int | float | None = None\n\nThe font weight of the table's column labels.\n\ncolumn_labels_text_transform : str | None = None\n\nThe text transformation for the column labels. Either of the \\\"uppercase\\\", \\\"lowercase\\\", or \\\"capitalize\\\" keywords can be used.\n\ncolumn_labels_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the column_labels (this includes the column spanners).\n\ncolumn_labels_padding_horizontal : str | None = None\n\nThe amount of horizontal padding to incorporate in the column_labels (this includes the column spanners).\n\ncolumn_labels_vlines_style : str | None = None\n\nThe style of all vertical lines ('vlines') of the column_labels.\n\ncolumn_labels_vlines_width : str | None = None\n\nThe width of all vertical lines ('vlines') of the column_labels.\n\ncolumn_labels_vlines_color : str | None = None\n\nThe color of all vertical lines ('vlines') of the column_labels.\n\ncolumn_labels_border_top_style : str | None = None\n\nThe style of the top border of the column_labels location.\n\ncolumn_labels_border_top_width : str | None = None\n\nThe width of the top border of the column_labels location. If the width of this border is larger, then it will be the visible border.\n\ncolumn_labels_border_top_color : str | None = None\n\nThe color of the top border of the column_labels location.\n\ncolumn_labels_border_bottom_style : str | None = None\n\nThe style of the bottom border of the column_labels location.\n\ncolumn_labels_border_bottom_width : str | None = None\n\nThe width of the bottom border of the column_labels location. If the width of this border is larger, then it will be the visible border.\n\ncolumn_labels_border_bottom_color : str | None = None\n\nThe color of the bottom border of the column_labels location.\n\ncolumn_labels_border_lr_style : str | None = None\n\nThe style of the left and right borders of the column_labels location.\n\ncolumn_labels_border_lr_width : str | None = None\n\nThe width of the left and right borders of the column_labels location. If the width of this border is larger, then it will be the visible border.\n\ncolumn_labels_border_lr_color : str | None = None\n\nThe color of the left and right borders of the column_labels location.\n\ncolumn_labels_hidden : bool | None = None\n\nAn option to hide the column labels. If providing True then the entire column_labels location won't be seen and the table header (if present) will collapse downward.\n\nrow_group_background_color : str | None = None\n\nThe background color for the row group labels. A color name or a hexadecimal color code should be provided.\n\nrow_group_font_weight : str | int | float | None = None\n\nThe font weight for all row group labels present in the table.\n\nrow_group_font_size : str | None = None\n\nThe font size to use for all row group labels.\n\nrow_group_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the row group labels.\n\nrow_group_border_top_style : str | None = None\n\nThe style of the top border of the row_group location.\n\nrow_group_border_top_width : str | None = None\n\nThe width of the top border of the row_group location. If the width of this border is larger, then it will be the visible border.\n\nrow_group_border_top_color : str | None = None\n\nThe color of the top border of the row_group location.\n\nrow_group_border_bottom_style : str | None = None\n\nThe style of the bottom border of the row_group location.\n\nrow_group_border_bottom_width : str | None = None\n\nThe width of the bottom border of the row_group location. If the width of this border is larger, then it will be the visible border.\n\nrow_group_border_bottom_color : str | None = None\n\nThe color of the bottom border of the row_group location.\n\nrow_group_border_left_style : str | None = None\n\nThe style of the left border of the row_group location.\n\nrow_group_border_left_width : str | None = None\n\nThe width of the left border of the row_group location. If the width of this border is larger, then it will be the visible border.\n\nrow_group_border_left_color : str | None = None\n\nThe color of the left border of the row_group location.\n\nrow_group_border_right_style : str | None = None\n\nThe style of the right border of the row_group location.\n\nrow_group_border_right_width : str | None = None\n\nThe width of the right border of the row_group location. If the width of this border is\n\nrow_group_border_right_color : str | None = None\n\nThe color of the right border of the row_group location.\n\nrow_group_as_column : bool | None = None\n\nAn option to render the row group labels as a column. If True, then the row group labels will be rendered as a column to the left of the table body. If False, then the row group labels will be rendered as a separate row above the grouping of rows.\n\ntable_body_hlines_style : str | None = None\n\nThe style of all horizontal lines ('hlines') in the table_body.\n\ntable_body_hlines_width : str | None = None\n\nThe width of all horizontal lines ('hlines') in the table_body.\n\ntable_body_hlines_color : str | None = None\n\nThe color of all horizontal lines ('hlines') in the table_body.\n\ntable_body_vlines_style : str | None = None\n\nThe style of all vertical lines ('vlines') in the table_body.\n\ntable_body_vlines_width : str | None = None\n\nThe width of all vertical lines ('vlines') in the table_body.\n\ntable_body_vlines_color : str | None = None\n\nThe color of all vertical lines ('vlines') in the table_body.\n\ntable_body_border_top_style : str | None = None\n\nThe style of the top border of the table_body location.\n\ntable_body_border_top_width : str | None = None\n\nThe width of the top border of the table_body location. If the width of this border is larger, then it will be the visible border.\n\ntable_body_border_top_color : str | None = None\n\nThe color of the top border of the table_body location.\n\ntable_body_border_bottom_style : str | None = None\n\nThe style of the bottom border of the table_body location.\n\ntable_body_border_bottom_width : str | None = None\n\nThe width of the bottom border of the table_body location. If the width of this border\n\ntable_body_border_bottom_color : str | None = None\n\nThe color of the bottom border of the table_body location.\n\nstub_background_color : str | None = None\n\nThe background color for the stub. A color name or a hexadecimal color code should be provided.\n\nstub_font_size : str | None = None\n\nThe font size to use for all row labels present in the table stub.\n\nstub_font_weight : str | int | float | None = None\n\nThe font weight for all row labels present in the table stub.\n\nstub_text_transform : str | None = None\n\nThe text transformation for the row labels present in the table stub.\n\nstub_border_style : str | None = None\n\nThe style of the vertical border of the table stub.\n\nstub_border_width : str | None = None\n\nThe width of the vertical border of the table stub.\n\nstub_border_color : str | None = None\n\nThe color of the vertical border of the table stub.\n\nstub_row_group_font_size : str | None = None\n\nThe font size for the row group column in the stub.\n\nstub_row_group_font_weight : str | int | float | None = None\n\nThe font weight for the row group column in the stub.\n\nstub_row_group_text_transform : str | None = None\n\nThe text transformation for the row group column in the stub.\n\nstub_row_group_border_style : str | None = None\n\nThe style of the vertical border of the row group column in the stub.\n\nstub_row_group_border_width : str | None = None\n\nThe width of the vertical border of the row group column in the stub.\n\nstub_row_group_border_color : str | None = None\n\nThe color of the vertical border of the row group column in the stub.\n\ndata_row_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the body/stub rows.\n\ndata_row_padding_horizontal : str | None = None\n\nThe amount of horizontal padding to incorporate in the body/stub rows.\n\nsource_notes_background_color : str | None = None\n\nThe background color for the source notes. A color name or a hexadecimal color code should be provided.\n\nsource_notes_font_size : str | None = None\n\nThe font size to use for all source note text.\n\nsource_notes_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the source notes.\n\nsource_notes_padding_horizontal : str | None = None\n\nThe amount of horizontal padding to incorporate in the source notes.\n\nsource_notes_multiline : bool | None = None\n\nAn option to either put source notes in separate lines (the default, or True) or render them as a continuous line of text with source_notes_sep providing the separator (by default \\\" \\\") between notes.\n\nsource_notes_sep : str | None = None\n\nThe separating characters between adjacent source notes when rendered as a continuous line of text (when source_notes_multiline is False). The default value is a single space character (\\\" \\\").\n\nsource_notes_border_bottom_style : str | None = None\n\nThe style of the bottom border of the source_notes location.\n\nsource_notes_border_bottom_width : str | None = None\n\nThe width of the bottom border of the source_notes location. If the width of this border is larger, then it will be the visible border.\n\nsource_notes_border_bottom_color : str | None = None\n\nThe color of the bottom border of the source_notes location.\n\nsource_notes_border_lr_style : str | None = None\n\nThe style of the left and right borders of the source_notes location.\n\nsource_notes_border_lr_width : str | None = None\n\nThe width of the left and right borders of the source_notes location. If the width of this border is larger, then it will be the visible border.\n\nsource_notes_border_lr_color : str | None = None\n\nThe color of the left and right borders of the source_notes location.\n\nrow_striping_background_color : str | None = None\n\nThe background color for striped table body rows. A color name or a hexadecimal color code should be provided.\n\nrow_striping_include_stub : bool | None = None\n\nAn option for whether to include the stub when striping rows.\n\nrow_striping_include_table_body : bool | None = None\n\nAn option for whether to include the table body when striping rows." + "text": "Parameters\n\ncontainer_width : str | None = None\n\nThe width of the table’s container. Can be specified as a single-length character with units of pixels or as a percentage. If provided as a scalar numeric value, it is assumed that the value is given in units of pixels.\n\ncontainer_height : str | None = None\n\nThe height of the table’s container.\n\ncontainer_overflow_x : str | None = None\n\nAn option to enable scrolling in the horizontal direction when the table content overflows the container dimensions. Using True (the default) means that horizontal scrolling is enabled to view the entire table in those directions. With False, the table may be clipped if the table width or height exceeds the container_width.\n\ncontainer_overflow_y : str | None = None\n\nAn option to enable scrolling in the vertical direction when the table content overflows. Same rules apply as for container_overflow_x; the dependency here is that of the table height (container_height).\n\ntable_width : str | None = None\n\nThe width of the table. Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\ntable_layout : str | None = None\n\nThe value for the table-layout CSS style in the HTML output context. By default, this is \"fixed\" but another valid option is \"auto\".\n\ntable_margin_left : str | None = None\n\nThe size of the margins on the left of the table within the container. Can be specified as a single-length value with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels. Using table_margin_left will overwrite any values set by table_align.\n\ntable_margin_right : str | None = None\n\nThe size of the margins on the right of the table within the container. Same rules apply as for table_margin_left. Using table_margin_right will overwrite any values set by table_align.\n\ntable_background_color : str | None = None\n\nThe background color for the table. A color name or a hexadecimal color code should be provided.\n\ntable_additional_css : list[str] | None = None\n\nAdditional CSS that can be added to the table. This can be used to add any custom CSS that is not covered by the other options.\n\ntable_font_names : str | list[str] | None = None\n\nThe names of the fonts used for the table. This should be provided as a list of font names. If the first font isn’t available, then the next font is tried (and so on).\n\ntable_font_size : str | None = None\n\nThe font size for the table. Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\ntable_font_weight : str | int | float | None = None\n\nThe font weight of the table. 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.\n\ntable_font_style : str | None = None\n\nThe font style for the table. Can be one of either \"normal\", \"italic\", or \"oblique\".\n\ntable_font_color : str | None = None\n\nThe text color used throughout the table. A color name or a hexadecimal color code should be provided.\n\ntable_font_color_light : str | None = None\n\nThe text color used throughout the table when the background color is dark. A color name or a hexadecimal color code should be provided.\n\ntable_border_top_style : str | None = None\n\nThe style of the table’s absolute top border. Can be one of either \"solid\", \"dotted\", \"dashed\", \"double\", \"groove\", \"ridge\", \"inset\", or \"outset\".\n\ntable_border_top_width : str | None = None\n\nThe width of the table’s absolute top border. Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\ntable_border_top_color : str | None = None\n\nThe color of the table’s absolute top border. A color name or a hexadecimal color code should be provided.\n\ntable_border_bottom_style : str | None = None\n\nThe style of the table’s absolute bottom border.\n\ntable_border_bottom_width : str | None = None\n\nThe width of the table’s absolute bottom border.\n\ntable_border_bottom_color : str | None = None\n\nThe color of the table’s absolute bottom border.\n\ntable_border_left_style : str | None = None\n\nThe style of the table’s absolute left border.\n\ntable_border_left_width : str | None = None\n\nThe width of the table’s absolute left border.\n\ntable_border_left_color : str | None = None\n\nThe color of the table’s absolute left border.\n\ntable_border_right_style : str | None = None\n\nThe style of the table’s absolute right border.\n\ntable_border_right_width : str | None = None\n\nThe width of the table’s absolute right border.\n\ntable_border_right_color : str | None = None\n\nThe color of the table’s absolute right border.\n\nheading_background_color : str | None = None\n\nThe background color for the heading. A color name or a hexadecimal color code should be provided.\n\nheading_align : str | None = None\n\nControls the horizontal alignment of the heading title and subtitle. We can either use \"center\", \"left\", or \"right\".\n\nheading_title_font_size : str | None = None\n\nThe font size for the heading title element.\n\nheading_title_font_weight : str | int | float | None = None\n\nThe font weight of the heading title.\n\nheading_subtitle_font_size : str | None = None\n\nThe font size for the heading subtitle element.\n\nheading_subtitle_font_weight : str | int | float | None = None\n\nThe font weight of the heading subtitle.\n\nheading_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the heading (title and subtitle). Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\nheading_padding_horizontal : str | None = None\n\nThe amount of horizontal padding to incorporate in the heading (title and subtitle). Can be specified as a string with units of pixels or as a percentage. If provided as a numeric value, it is assumed that the value is given in units of pixels.\n\nheading_border_bottom_style : str | None = None\n\nThe style of the header’s bottom border.\n\nheading_border_bottom_width : str | None = None\n\nThe width of the header’s bottom border. If the width of this border is larger, then it will be the visible border.\n\nheading_border_bottom_color : str | None = None\n\nThe color of the header’s bottom border.\n\nheading_border_lr_style : str | None = None\n\nThe style of the left and right borders of the heading location.\n\nheading_border_lr_width : str | None = None\n\nThe width of the left and right borders of the heading location. If the width of this border is larger, then it will be the visible border.\n\nheading_border_lr_color : str | None = None\n\nThe color of the left and right borders of the heading location.\n\ncolumn_labels_background_color : str | None = None\n\nThe background color for the column labels. A color name or a hexadecimal color code should be provided.\n\ncolumn_labels_font_size : str | None = None\n\nThe font size to use for all column labels.\n\ncolumn_labels_font_weight : str | int | float | None = None\n\nThe font weight of the table’s column labels.\n\ncolumn_labels_text_transform : str | None = None\n\nThe text transformation for the column labels. Either of the \"uppercase\", \"lowercase\", or \"capitalize\" keywords can be used.\n\ncolumn_labels_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the column_labels (this includes the column spanners).\n\ncolumn_labels_padding_horizontal : str | None = None\n\nThe amount of horizontal padding to incorporate in the column_labels (this includes the column spanners).\n\ncolumn_labels_vlines_style : str | None = None\n\nThe style of all vertical lines (‘vlines’) of the column_labels.\n\ncolumn_labels_vlines_width : str | None = None\n\nThe width of all vertical lines (‘vlines’) of the column_labels.\n\ncolumn_labels_vlines_color : str | None = None\n\nThe color of all vertical lines (‘vlines’) of the column_labels.\n\ncolumn_labels_border_top_style : str | None = None\n\nThe style of the top border of the column_labels location.\n\ncolumn_labels_border_top_width : str | None = None\n\nThe width of the top border of the column_labels location. If the width of this border is larger, then it will be the visible border.\n\ncolumn_labels_border_top_color : str | None = None\n\nThe color of the top border of the column_labels location.\n\ncolumn_labels_border_bottom_style : str | None = None\n\nThe style of the bottom border of the column_labels location.\n\ncolumn_labels_border_bottom_width : str | None = None\n\nThe width of the bottom border of the column_labels location. If the width of this border is larger, then it will be the visible border.\n\ncolumn_labels_border_bottom_color : str | None = None\n\nThe color of the bottom border of the column_labels location.\n\ncolumn_labels_border_lr_style : str | None = None\n\nThe style of the left and right borders of the column_labels location.\n\ncolumn_labels_border_lr_width : str | None = None\n\nThe width of the left and right borders of the column_labels location. If the width of this border is larger, then it will be the visible border.\n\ncolumn_labels_border_lr_color : str | None = None\n\nThe color of the left and right borders of the column_labels location.\n\ncolumn_labels_hidden : bool | None = None\n\nAn option to hide the column labels. If providing True then the entire column_labels location won’t be seen and the table header (if present) will collapse downward.\n\nrow_group_background_color : str | None = None\n\nThe background color for the row group labels. A color name or a hexadecimal color code should be provided.\n\nrow_group_font_weight : str | int | float | None = None\n\nThe font weight for all row group labels present in the table.\n\nrow_group_font_size : str | None = None\n\nThe font size to use for all row group labels.\n\nrow_group_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the row group labels.\n\nrow_group_border_top_style : str | None = None\n\nThe style of the top border of the row_group location.\n\nrow_group_border_top_width : str | None = None\n\nThe width of the top border of the row_group location. If the width of this border is larger, then it will be the visible border.\n\nrow_group_border_top_color : str | None = None\n\nThe color of the top border of the row_group location.\n\nrow_group_border_bottom_style : str | None = None\n\nThe style of the bottom border of the row_group location.\n\nrow_group_border_bottom_width : str | None = None\n\nThe width of the bottom border of the row_group location. If the width of this border is larger, then it will be the visible border.\n\nrow_group_border_bottom_color : str | None = None\n\nThe color of the bottom border of the row_group location.\n\nrow_group_border_left_style : str | None = None\n\nThe style of the left border of the row_group location.\n\nrow_group_border_left_width : str | None = None\n\nThe width of the left border of the row_group location. If the width of this border is larger, then it will be the visible border.\n\nrow_group_border_left_color : str | None = None\n\nThe color of the left border of the row_group location.\n\nrow_group_border_right_style : str | None = None\n\nThe style of the right border of the row_group location.\n\nrow_group_border_right_width : str | None = None\n\nThe width of the right border of the row_group location. If the width of this border is\n\nrow_group_border_right_color : str | None = None\n\nThe color of the right border of the row_group location.\n\nrow_group_as_column : bool | None = None\n\nAn option to render the row group labels as a column. If True, then the row group labels will be rendered as a column to the left of the table body. If False, then the row group labels will be rendered as a separate row above the grouping of rows.\n\ntable_body_hlines_style : str | None = None\n\nThe style of all horizontal lines (‘hlines’) in the table_body.\n\ntable_body_hlines_width : str | None = None\n\nThe width of all horizontal lines (‘hlines’) in the table_body.\n\ntable_body_hlines_color : str | None = None\n\nThe color of all horizontal lines (‘hlines’) in the table_body.\n\ntable_body_vlines_style : str | None = None\n\nThe style of all vertical lines (‘vlines’) in the table_body.\n\ntable_body_vlines_width : str | None = None\n\nThe width of all vertical lines (‘vlines’) in the table_body.\n\ntable_body_vlines_color : str | None = None\n\nThe color of all vertical lines (‘vlines’) in the table_body.\n\ntable_body_border_top_style : str | None = None\n\nThe style of the top border of the table_body location.\n\ntable_body_border_top_width : str | None = None\n\nThe width of the top border of the table_body location. If the width of this border is larger, then it will be the visible border.\n\ntable_body_border_top_color : str | None = None\n\nThe color of the top border of the table_body location.\n\ntable_body_border_bottom_style : str | None = None\n\nThe style of the bottom border of the table_body location.\n\ntable_body_border_bottom_width : str | None = None\n\nThe width of the bottom border of the table_body location. If the width of this border\n\ntable_body_border_bottom_color : str | None = None\n\nThe color of the bottom border of the table_body location.\n\nstub_background_color : str | None = None\n\nThe background color for the stub. A color name or a hexadecimal color code should be provided.\n\nstub_font_size : str | None = None\n\nThe font size to use for all row labels present in the table stub.\n\nstub_font_weight : str | int | float | None = None\n\nThe font weight for all row labels present in the table stub.\n\nstub_text_transform : str | None = None\n\nThe text transformation for the row labels present in the table stub.\n\nstub_border_style : str | None = None\n\nThe style of the vertical border of the table stub.\n\nstub_border_width : str | None = None\n\nThe width of the vertical border of the table stub.\n\nstub_border_color : str | None = None\n\nThe color of the vertical border of the table stub.\n\nstub_row_group_font_size : str | None = None\n\nThe font size for the row group column in the stub.\n\nstub_row_group_font_weight : str | int | float | None = None\n\nThe font weight for the row group column in the stub.\n\nstub_row_group_text_transform : str | None = None\n\nThe text transformation for the row group column in the stub.\n\nstub_row_group_border_style : str | None = None\n\nThe style of the vertical border of the row group column in the stub.\n\nstub_row_group_border_width : str | None = None\n\nThe width of the vertical border of the row group column in the stub.\n\nstub_row_group_border_color : str | None = None\n\nThe color of the vertical border of the row group column in the stub.\n\ndata_row_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the body/stub rows.\n\ndata_row_padding_horizontal : str | None = None\n\nThe amount of horizontal padding to incorporate in the body/stub rows.\n\nsource_notes_background_color : str | None = None\n\nThe background color for the source notes. A color name or a hexadecimal color code should be provided.\n\nsource_notes_font_size : str | None = None\n\nThe font size to use for all source note text.\n\nsource_notes_padding : str | None = None\n\nThe amount of vertical padding to incorporate in the source notes.\n\nsource_notes_padding_horizontal : str | None = None\n\nThe amount of horizontal padding to incorporate in the source notes.\n\nsource_notes_multiline : bool | None = None\n\nAn option to either put source notes in separate lines (the default, or True) or render them as a continuous line of text with source_notes_sep providing the separator (by default \" \") between notes.\n\nsource_notes_sep : str | None = None\n\nThe separating characters between adjacent source notes when rendered as a continuous line of text (when source_notes_multiline is False). The default value is a single space character (\" \").\n\nsource_notes_border_bottom_style : str | None = None\n\nThe style of the bottom border of the source_notes location.\n\nsource_notes_border_bottom_width : str | None = None\n\nThe width of the bottom border of the source_notes location. If the width of this border is larger, then it will be the visible border.\n\nsource_notes_border_bottom_color : str | None = None\n\nThe color of the bottom border of the source_notes location.\n\nsource_notes_border_lr_style : str | None = None\n\nThe style of the left and right borders of the source_notes location.\n\nsource_notes_border_lr_width : str | None = None\n\nThe width of the left and right borders of the source_notes location. If the width of this border is larger, then it will be the visible border.\n\nsource_notes_border_lr_color : str | None = None\n\nThe color of the left and right borders of the source_notes location.\n\nrow_striping_background_color : str | None = None\n\nThe background color for striped table body rows. A color name or a hexadecimal color code should be provided.\n\nrow_striping_include_stub : bool | None = None\n\nAn option for whether to include the stub when striping rows.\n\nrow_striping_include_table_body : bool | None = None\n\nAn option for whether to include the table body when striping rows." }, { "objectID": "reference/GT.tab_options.html#returns", @@ -2805,7 +2805,7 @@ "href": "reference/GT.data_color.html#parameters", "title": "GT.data_color", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : RowSelectExpr = None\n\nIn conjunction with columns=, we can specify which rows should be colored. By default, all rows in the targeted columns will be colored. Alternatively, we can provide a list of row indices.\n\npalette : str | list[str] | None = None\n\nThe color palette to use. This should be a list of colors (e.g., [\\\"#FF0000\\\", \\\"#00FF00\\\", \\\"#0000FF\\\"]). A ColorBrewer palette could also be used, just supply the name (reference available in the Color palette access from ColorBrewer section). If None, then a default palette will be used.\n\ndomain : list[str] | list[int] | list[float] | None = None\n\nThe domain of values to use for the color scheme. This can be a list of floats, integers, or strings. If None, then the domain will be inferred from the data values.\n\nna_color : str | None = None\n\nThe color to use for missing values. If None, then the default color (\\\"#808080\\\") will be used.\n\nalpha : int | float | None = None\n\nAn optional, fixed alpha transparency value that will be applied to all color palette values.\n\nreverse : bool = False\n\nShould the colors computed operate in the reverse order? If True then colors that normally change from red to blue will change in the opposite direction.\n\nautocolor_text : bool = True\n\nWhether or not to automatically color the text of the data values. If True, then the text will be colored according to the background color of the cell." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : RowSelectExpr = None\n\nIn conjunction with columns=, we can specify which rows should be colored. By default, all rows in the targeted columns will be colored. Alternatively, we can provide a list of row indices.\n\npalette : str | list[str] | None = None\n\nThe color palette to use. This should be a list of colors (e.g., [\"#FF0000\", \"#00FF00\", \"#0000FF\"]). A ColorBrewer palette could also be used, just supply the name (reference available in the Color palette access from ColorBrewer section). If None, then a default palette will be used.\n\ndomain : list[str] | list[int] | list[float] | None = None\n\nThe domain of values to use for the color scheme. This can be a list of floats, integers, or strings. If None, then the domain will be inferred from the data values.\n\nna_color : str | None = None\n\nThe color to use for missing values. If None, then the default color (\"#808080\") will be used.\n\nalpha : int | float | None = None\n\nAn optional, fixed alpha transparency value that will be applied to all color palette values.\n\nreverse : bool = False\n\nShould the colors computed operate in the reverse order? If True then colors that normally change from red to blue will change in the opposite direction.\n\nautocolor_text : bool = True\n\nWhether or not to automatically color the text of the data values. If True, then the text will be colored according to the background color of the cell." }, { "objectID": "reference/GT.data_color.html#returns", @@ -2889,7 +2889,7 @@ "href": "reference/GT.opt_table_font.html#parameters", "title": "GT.opt_table_font", "section": "Parameters", - "text": "Parameters\n\nfont : str | list[str] | dict[str, str] | GoogleFont | None = None\n\nOne or more font names available on the user's system. This can be provided as a string or a list of strings. Alternatively, you can specify font names using the google_font() helper function. The default value is None since you could instead opt to use stack to define a list of fonts.\n\nstack : FontStackName | None = None\n\nA name that is representative of a font stack (obtained via internally via the system_fonts() helper function. If provided, this new stack will replace any defined fonts and any font= values will be prepended.\n\nstyle : str | None = None\n\nAn option to modify the text style. Can be one of either \\\"normal\\\", \\\"italic\\\", or \\\"oblique\\\".\n\nweight : str | int | float | None = None\n\nOption to set 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. Please note that typefaces have varying support for the numeric mapping of weight.\n\nadd : bool = True\n\nShould fonts be added to the beginning of any already-defined fonts for the table? By default, this is True and is recommended since those fonts already present can serve as fallbacks when everything specified in font is not available. If a stack= value is provided, then add will automatically set to False." + "text": "Parameters\n\nfont : str | list[str] | dict[str, str] | GoogleFont | None = None\n\nOne or more font names available on the user’s system. This can be provided as a string or a list of strings. Alternatively, you can specify font names using the google_font() helper function. The default value is None since you could instead opt to use stack to define a list of fonts.\n\nstack : FontStackName | None = None\n\nA name that is representative of a font stack (obtained via internally via the system_fonts() helper function. If provided, this new stack will replace any defined fonts and any font= values will be prepended.\n\nstyle : str | None = None\n\nAn option to modify the text style. Can be one of either \"normal\", \"italic\", or \"oblique\".\n\nweight : str | int | float | None = None\n\nOption to set 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. Please note that typefaces have varying support for the numeric mapping of weight.\n\nadd : bool = True\n\nShould fonts be added to the beginning of any already-defined fonts for the table? By default, this is True and is recommended since those fonts already present can serve as fallbacks when everything specified in font is not available. If a stack= value is provided, then add will automatically set to False." }, { "objectID": "reference/GT.opt_table_font.html#returns", @@ -2952,7 +2952,7 @@ "href": "reference/GT.fmt_image.html#parameters", "title": "GT.fmt_image", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\nheight : str | int | None = None\n\nThe height of the rendered images.\n\nwidth : str | int | None = None\n\nThe width of the rendered images.\n\nsep : str = ' '\n\nIn the output of images within a body cell, sep= provides the separator between each image.\n\npath : str | Path | None = None\n\nAn optional path to local image files (this is combined with all filenames).\n\nfile_pattern : str = '{}'\n\nThe pattern to use for mapping input values in the body cells to the names of the graphics files. The string supplied should use \\\"{}\\\" in the pattern to map filename fragments to input strings.\n\nencode : bool = True\n\nThe option to always use Base64 encoding for image paths that are determined to be local. By default, this is True." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\nheight : str | int | None = None\n\nThe height of the rendered images.\n\nwidth : str | int | None = None\n\nThe width of the rendered images.\n\nsep : str = ' '\n\nIn the output of images within a body cell, sep= provides the separator between each image.\n\npath : str | Path | None = None\n\nAn optional path to local image files (this is combined with all filenames).\n\nfile_pattern : str = '{}'\n\nThe pattern to use for mapping input values in the body cells to the names of the graphics files. The string supplied should use \"{}\" in the pattern to map filename fragments to input strings.\n\nencode : bool = True\n\nThe option to always use Base64 encoding for image paths that are determined to be local. By default, this is True." }, { "objectID": "reference/GT.fmt_image.html#returns", @@ -3015,7 +3015,7 @@ "href": "reference/loc.spanner_labels.html#returns", "title": "loc.spanner_labels", "section": "Returns", - "text": "Returns\n\n : LocSpannerLabels\n\nA LocSpannerLabels object, which is used for a locations= argument if specifying the table's spanner labels." + "text": "Returns\n\n : LocSpannerLabels\n\nA LocSpannerLabels object, which is used for a locations= argument if specifying the table’s spanner labels." }, { "objectID": "reference/loc.spanner_labels.html#examples", @@ -3113,7 +3113,7 @@ "href": "reference/GT.fmt_bytes.html#parameters", "title": "GT.fmt_bytes", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\nstandard : str = 'decimal'\n\nThe form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., \\\"kB\\\" and \\\"MB\\\"), and (2) binary units (powers of 1024; e.g., \\\"KiB\\\" and \\\"MiB\\\"). The default is to use decimal units with the \\\"decimal\\\" option. The alternative is to use binary units with the \\\"binary\\\" option.\n\ndecimals : int = 1\n\nThis corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = True\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nincl_space : bool = True\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\nstandard : str = 'decimal'\n\nThe form of expressing large byte sizes is divided between: (1) decimal units (powers of 1000; e.g., \"kB\" and \"MB\"), and (2) binary units (powers of 1024; e.g., \"KiB\" and \"MiB\"). The default is to use decimal units with the \"decimal\" option. The alternative is to use binary units with the \"binary\" option.\n\ndecimals : int = 1\n\nThis corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True.\n\ndrop_trailing_zeros : bool = True\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nincl_space : bool = True\n\nAn option for whether to include a space between the value and the currency symbol. The default is to not introduce a space character.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/GT.fmt_bytes.html#returns", @@ -3155,7 +3155,7 @@ "href": "reference/GT.fmt_nanoplot.html#parameters", "title": "GT.fmt_nanoplot", "section": "Parameters", - "text": "Parameters\n\ncolumns : str | None = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\nplot_type : PlotType = 'line'\n\nNanoplots can either take the form of a line plot (using \\\"line\\\") or a bar plot (with \\\"bar\\\"). A line plot, by default, contains layers for a data line, data points, and a data area. With a bar plot, the always visible layer is that of the data bars.\n\nplot_height : str = '2em'\n\nThe height of the nanoplots. The default here is a sensible value of \\\"2em\\\".\n\nmissing_vals : MissingVals = 'marker'\n\nIf missing values are encountered within the input data, there are three strategies available for their handling: (1) \\\"gap\\\" will show data gaps at the sites of missing data, where data lines will have discontinuities and bar plots will have missing bars; (2) \\\"marker\\\" will behave like \\\"gap\\\" but show prominent visual marks at the missing data locations; (3) \\\"zero\\\" will replace missing values with zero values; and (4) \\\"remove\\\" will remove any incoming missing values.\n\nautoscale : bool = False\n\nUsing autoscale=True will ensure that the bounds of all nanoplots produced are based on the limits of data combined from all input rows. This will result in a shared scale across all of the nanoplots (for y- and x-axis data), which is useful in those cases where the nanoplot data should be compared across rows.\n\nreference_line : str | int | float | None = None\n\nA reference line requires a single input to define the line. It could be a numeric value, applied to all nanoplots generated. Or, the input can be one of the following for generating the line from the underlying data: (1) \\\"mean\\\", (2) \\\"median\\\", (3) \\\"min\\\", (4) \\\"max\\\", (5) \\\"q1\\\", (6) \\\"q3\\\", (7) \\\"first\\\", or (8) \\\"last\\\".\n\nreference_area : list[Any] | None = None\n\nA reference area requires a list of two values for defining bottom and top boundaries (in the y direction) for a rectangular area. The types of values supplied are the same as those expected for reference_line=, which is either a numeric value or one of the following keywords for the generation of the value: (1) \\\"mean\\\", (2) \\\"median\\\", (3) \\\"min\\\", (4) \\\"max\\\", (5) \\\"q1\\\", (6) \\\"q3\\\", (7) \\\"first\\\", or (8) \\\"last\\\". Input can either be a vector or list with two elements.\n\nexpand_x : list[int] | list[float] | list[int | float] | None = None\n\nShould you need to have plots expand in the x direction, provide one or more values to expand_x=. Any values provided that are outside of the range of x-value data provided to the plot will result in a x-scale expansion.\n\nexpand_y : list[int] | list[float] | list[int | float] | None = None\n\nSimilar to expand_x=, one can have plots expand in the y direction. To make this happen, provide one or more values to expand_y=. If any of the provided values are outside of the range of y-value data provided, the plot will result in a y-scale expansion.\n\noptions : dict[str, Any] | None = None\n\nBy using the nanoplot_options() helper function here, you can alter the layout and styling of the nanoplots in the new column." + "text": "Parameters\n\ncolumns : str | None = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\nplot_type : PlotType = 'line'\n\nNanoplots can either take the form of a line plot (using \"line\") or a bar plot (with \"bar\"). A line plot, by default, contains layers for a data line, data points, and a data area. With a bar plot, the always visible layer is that of the data bars.\n\nplot_height : str = '2em'\n\nThe height of the nanoplots. The default here is a sensible value of \"2em\".\n\nmissing_vals : MissingVals = 'marker'\n\nIf missing values are encountered within the input data, there are three strategies available for their handling: (1) \"gap\" will show data gaps at the sites of missing data, where data lines will have discontinuities and bar plots will have missing bars; (2) \"marker\" will behave like \"gap\" but show prominent visual marks at the missing data locations; (3) \"zero\" will replace missing values with zero values; and (4) \"remove\" will remove any incoming missing values.\n\nautoscale : bool = False\n\nUsing autoscale=True will ensure that the bounds of all nanoplots produced are based on the limits of data combined from all input rows. This will result in a shared scale across all of the nanoplots (for y- and x-axis data), which is useful in those cases where the nanoplot data should be compared across rows.\n\nreference_line : str | int | float | None = None\n\nA reference line requires a single input to define the line. It could be a numeric value, applied to all nanoplots generated. Or, the input can be one of the following for generating the line from the underlying data: (1) \"mean\", (2) \"median\", (3) \"min\", (4) \"max\", (5) \"q1\", (6) \"q3\", (7) \"first\", or (8) \"last\".\n\nreference_area : list[Any] | None = None\n\nA reference area requires a list of two values for defining bottom and top boundaries (in the y direction) for a rectangular area. The types of values supplied are the same as those expected for reference_line=, which is either a numeric value or one of the following keywords for the generation of the value: (1) \"mean\", (2) \"median\", (3) \"min\", (4) \"max\", (5) \"q1\", (6) \"q3\", (7) \"first\", or (8) \"last\". Input can either be a vector or list with two elements.\n\nexpand_x : list[int] | list[float] | list[int | float] | None = None\n\nShould you need to have plots expand in the x direction, provide one or more values to expand_x=. Any values provided that are outside of the range of x-value data provided to the plot will result in a x-scale expansion.\n\nexpand_y : list[int] | list[float] | list[int | float] | None = None\n\nSimilar to expand_x=, one can have plots expand in the y direction. To make this happen, provide one or more values to expand_y=. If any of the provided values are outside of the range of y-value data provided, the plot will result in a y-scale expansion.\n\noptions : dict[str, Any] | None = None\n\nBy using the nanoplot_options() helper function here, you can alter the layout and styling of the nanoplots in the new column." }, { "objectID": "reference/GT.fmt_nanoplot.html#returns", @@ -3218,7 +3218,7 @@ "href": "reference/GT.opt_all_caps.html#parameters", "title": "GT.opt_all_caps", "section": "Parameters", - "text": "Parameters\n\nall_caps : bool = True\n\nIndicates whether the text transformation to all caps should be performed (True, the default) or reset to default values (False) for the locations targeted.\n\nlocations : str | list[str] = ['column_labels', 'stub', 'row_group']\n\nWhich locations should undergo this text transformation? By default it includes all of the \\\"column_labels\\\", the \\\"stub\\\", and the \\\"row_group\\\" locations. However, we could just choose one or two of those." + "text": "Parameters\n\nall_caps : bool = True\n\nIndicates whether the text transformation to all caps should be performed (True, the default) or reset to default values (False) for the locations targeted.\n\nlocations : str | list[str] = ['column_labels', 'stub', 'row_group']\n\nWhich locations should undergo this text transformation? By default it includes all of the \"column_labels\", the \"stub\", and the \"row_group\" locations. However, we could just choose one or two of those." }, { "objectID": "reference/GT.opt_all_caps.html#returns", @@ -3295,7 +3295,7 @@ "href": "reference/GT.fmt_time.html#parameters", "title": "GT.fmt_time", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ntime_style : TimeStyle = 'iso'\n\nThe time style to use. By default this is the short name \\\"iso\\\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ntime_style : TimeStyle = 'iso'\n\nThe time style to use. By default this is the short name \"iso\" which corresponds to how times are formatted within ISO 8601 datetime values. There are 5 time styles in total and their short names can be viewed using info_time_style().\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/GT.fmt_time.html#formatting-with-the-time_style-argument", @@ -3344,7 +3344,7 @@ "href": "reference/GT.fmt_number.html#parameters", "title": "GT.fmt_number", "section": "Parameters", - "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \\\"2\\\". With 4 decimal places, the formatted value becomes \\\"2.3400\\\". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the fmt_integer() method should be considered.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1.23K, and 1230000 becomes 1.23M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\\\",\\\" with a value of 1000 would result in a formatted value of \\\"1,000\\\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\\\",\\\" with the value 0.152 would result in a formatted value of \\\"0,152\\\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale's rules. Examples include \\\"en\\\" for English (United States) and \\\"fr\\\" for French (France)." + "text": "Parameters\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list.\n\nrows : int | list[int] | None = None\n\nIn conjunction with columns=, we can specify which of their rows should undergo formatting. The default is all rows, resulting in all rows in targeted columns being formatted. Alternatively, we can supply a list of row indices.\n\ndecimals : int = 2\n\nThe decimals values corresponds to the exact number of decimal places to use. A value such as 2.34 can, for example, be formatted with 0 decimal places and it would result in \"2\". With 4 decimal places, the formatted value becomes \"2.3400\". The trailing zeros can be removed with drop_trailing_zeros=True. If you always need decimals = 0, the fmt_integer() method should be considered.\n\nn_sigfig : int | None = None\n\nA option to format numbers to n significant figures. By default, this is None and thus number values will be formatted according to the number of decimal places set via decimals. If opting to format according to the rules of significant figures, n_sigfig must be a number greater than or equal to 1. Any values passed to the decimals and drop_trailing_zeros arguments will be ignored.\n\ndrop_trailing_zeros : bool = False\n\nA boolean value that allows for removal of trailing zeros (those redundant zeros after the decimal mark).\n\ndrop_trailing_dec_mark : bool = True\n\nA boolean value that determines whether decimal marks should always appear even if there are no decimal digits to display after formatting (e.g., 23 becomes 23. if False). By default trailing decimal marks are not shown.\n\nuse_seps : bool = True\n\nThe use_seps option allows for the use of digit group separators. The type of digit group separator is set by sep_mark and overridden if a locale ID is provided to locale. This setting is True by default.\n\nscale_by : float = 1\n\nAll numeric values will be multiplied by the scale_by value before undergoing formatting. Since the default value is 1, no values will be changed unless a different multiplier value is supplied.\n\ncompact : bool = False\n\nA boolean value that allows for compact formatting of numeric values. Values will be scaled and decorated with the appropriate suffixes (e.g., 1230 becomes 1.23K, and 1230000 becomes 1.23M). The compact option is False by default.\n\npattern : str = '{x}'\n\nA formatting pattern that allows for decoration of the formatted value. The formatted value is represented by the {x} (which can be used multiple times, if needed) and all other characters will be interpreted as string literals.\n\nsep_mark : str = ','\n\nThe string to use as a separator between groups of digits. For example, using sep_mark=\",\" with a value of 1000 would result in a formatted value of \"1,000\". This argument is ignored if a locale is supplied (i.e., is not None).\n\ndec_mark : str = '.'\n\nThe string to be used as the decimal mark. For example, using dec_mark=\",\" with the value 0.152 would result in a formatted value of \"0,152\"). This argument is ignored if a locale is supplied (i.e., is not None).\n\nforce_sign : bool = False\n\nShould the positive sign be shown for positive values (effectively showing a sign for all values except zero)? If so, use True for this option. The default is False, where only negative numbers will display a minus sign.\n\nlocale : str | None = None\n\nAn optional locale identifier that can be used for formatting values according the locale’s rules. Examples include \"en\" for English (United States) and \"fr\" for French (France)." }, { "objectID": "reference/GT.fmt_number.html#returns", @@ -3442,7 +3442,7 @@ "href": "reference/GT.cols_align.html#parameters", "title": "GT.cols_align", "section": "Parameters", - "text": "Parameters\n\nalign : str = 'left'\n\nThe alignment to apply. Must be one of \\\"left\\\", \\\"center\\\", or \\\"right\\\".\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list. If None, the alignment is applied to all columns." + "text": "Parameters\n\nalign : str = 'left'\n\nThe alignment to apply. Must be one of \"left\", \"center\", or \"right\".\n\ncolumns : SelectExpr = None\n\nThe columns to target. Can either be a single column name or a series of column names provided in a list. If None, the alignment is applied to all columns." }, { "objectID": "reference/GT.cols_align.html#returns", @@ -3484,7 +3484,7 @@ "href": "reference/GT.opt_stylize.html#parameters", "title": "GT.opt_stylize", "section": "Parameters", - "text": "Parameters\n\nstyle : int = 1\n\nSix numbered styles are available. Simply provide a number from 1 (the default) to 6 to choose a distinct look.\n\ncolor : str = 'blue'\n\nThe color scheme of the table. The default value is \\\"blue\\\". The valid values are \\\"blue\\\", \\\"cyan\\\", \\\"pink\\\", \\\"green\\\", \\\"red\\\", and \\\"gray\\\".\n\nadd_row_striping : bool = True\n\nAn option to enable row striping in the table body for the style chosen." + "text": "Parameters\n\nstyle : int = 1\n\nSix numbered styles are available. Simply provide a number from 1 (the default) to 6 to choose a distinct look.\n\ncolor : str = 'blue'\n\nThe color scheme of the table. The default value is \"blue\". The valid values are \"blue\", \"cyan\", \"pink\", \"green\", \"red\", and \"gray\".\n\nadd_row_striping : bool = True\n\nAn option to enable row striping in the table body for the style chosen." }, { "objectID": "reference/GT.opt_stylize.html#returns", diff --git a/sitemap.xml b/sitemap.xml index 675e529a3..3e970d00d 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,502 +2,502 @@ https://posit-dev.github.io/great-tables/get-started/overview.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/table-theme-options.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/basic-column-labels.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.561Z https://posit-dev.github.io/great-tables/get-started/targeted-styles.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/loc-selection.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/column-selection.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/colorizing-with-data.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/basic-styling.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.561Z https://posit-dev.github.io/great-tables/reference/GT.sub_zero.html - 2024-10-10T19:42:23.991Z + 2024-10-11T20:42:41.881Z https://posit-dev.github.io/great-tables/reference/GT.as_raw_html.html - 2024-10-10T19:42:24.227Z + 2024-10-11T20:42:42.117Z https://posit-dev.github.io/great-tables/reference/loc.column_labels.html - 2024-10-10T19:42:24.055Z + 2024-10-11T20:42:41.949Z https://posit-dev.github.io/great-tables/reference/GT.opt_table_outline.html - 2024-10-10T19:42:24.191Z + 2024-10-11T20:42:42.081Z https://posit-dev.github.io/great-tables/reference/GT.tab_spanner.html - 2024-10-10T19:42:23.707Z + 2024-10-11T20:42:41.601Z https://posit-dev.github.io/great-tables/reference/data.gibraltar.html - 2024-10-10T19:42:24.343Z + 2024-10-11T20:42:42.237Z https://posit-dev.github.io/great-tables/reference/GT.fmt_date.html - 2024-10-10T19:42:23.907Z + 2024-10-11T20:42:41.801Z https://posit-dev.github.io/great-tables/reference/GT.fmt_units.html - 2024-10-10T19:42:23.939Z + 2024-10-11T20:42:41.829Z https://posit-dev.github.io/great-tables/reference/google_font.html - 2024-10-10T19:42:24.127Z + 2024-10-11T20:42:42.017Z https://posit-dev.github.io/great-tables/reference/vals.fmt_integer.html - 2024-10-10T19:42:24.247Z + 2024-10-11T20:42:42.137Z https://posit-dev.github.io/great-tables/reference/data.films.html - 2024-10-10T19:42:24.339Z + 2024-10-11T20:42:42.229Z https://posit-dev.github.io/great-tables/reference/loc.stubhead.html - 2024-10-10T19:42:24.043Z + 2024-10-11T20:42:41.933Z https://posit-dev.github.io/great-tables/reference/GT.cols_move_to_start.html - 2024-10-10T19:42:24.019Z + 2024-10-11T20:42:41.909Z https://posit-dev.github.io/great-tables/reference/GT.fmt_percent.html - 2024-10-10T19:42:23.851Z + 2024-10-11T20:42:41.741Z https://posit-dev.github.io/great-tables/reference/vals.fmt_markdown.html - 2024-10-10T19:42:24.315Z + 2024-10-11T20:42:42.201Z https://posit-dev.github.io/great-tables/reference/GT.fmt.html - 2024-10-10T19:42:23.967Z + 2024-10-11T20:42:41.857Z https://posit-dev.github.io/great-tables/reference/data.reactions.html - 2024-10-10T19:42:24.355Z + 2024-10-11T20:42:42.245Z https://posit-dev.github.io/great-tables/reference/GT.tab_style.html - 2024-10-10T19:42:23.731Z + 2024-10-11T20:42:41.621Z https://posit-dev.github.io/great-tables/reference/GT.sub_missing.html - 2024-10-10T19:42:23.983Z + 2024-10-11T20:42:41.873Z https://posit-dev.github.io/great-tables/reference/GT.fmt_datetime.html - 2024-10-10T19:42:23.923Z + 2024-10-11T20:42:41.817Z https://posit-dev.github.io/great-tables/reference/vals.fmt_time.html - 2024-10-10T19:42:24.311Z + 2024-10-11T20:42:42.197Z https://posit-dev.github.io/great-tables/reference/GT.cols_move_to_end.html - 2024-10-10T19:42:24.023Z + 2024-10-11T20:42:41.913Z https://posit-dev.github.io/great-tables/reference/loc.stub.html - 2024-10-10T19:42:24.063Z + 2024-10-11T20:42:41.953Z https://posit-dev.github.io/great-tables/reference/data.illness.html - 2024-10-10T19:42:24.351Z + 2024-10-11T20:42:42.245Z https://posit-dev.github.io/great-tables/reference/loc.footer.html - 2024-10-10T19:42:24.075Z + 2024-10-11T20:42:41.965Z https://posit-dev.github.io/great-tables/reference/GT.cols_hide.html - 2024-10-10T19:42:24.027Z + 2024-10-11T20:42:41.921Z https://posit-dev.github.io/great-tables/reference/data.constants.html - 2024-10-10T19:42:24.347Z + 2024-10-11T20:42:42.241Z https://posit-dev.github.io/great-tables/reference/GT.tab_header.html - 2024-10-10T19:42:23.699Z + 2024-10-11T20:42:41.593Z https://posit-dev.github.io/great-tables/reference/GT.fmt_integer.html - 2024-10-10T19:42:23.835Z + 2024-10-11T20:42:41.729Z https://posit-dev.github.io/great-tables/reference/data.countrypops.html - 2024-10-10T19:42:24.315Z + 2024-10-11T20:42:42.205Z https://posit-dev.github.io/great-tables/reference/vals.fmt_percent.html - 2024-10-10T19:42:24.267Z + 2024-10-11T20:42:42.157Z https://posit-dev.github.io/great-tables/reference/data.peeps.html - 2024-10-10T19:42:24.335Z + 2024-10-11T20:42:42.225Z https://posit-dev.github.io/great-tables/reference/data.photolysis.html - 2024-10-10T19:42:24.355Z + 2024-10-11T20:42:42.249Z https://posit-dev.github.io/great-tables/reference/vals.fmt_scientific.html - 2024-10-10T19:42:24.255Z + 2024-10-11T20:42:42.145Z https://posit-dev.github.io/great-tables/reference/nanoplot_options.html - 2024-10-10T19:42:24.159Z + 2024-10-11T20:42:42.049Z https://posit-dev.github.io/great-tables/reference/loc.title.html - 2024-10-10T19:42:24.035Z + 2024-10-11T20:42:41.925Z https://posit-dev.github.io/great-tables/reference/data.sp500.html - 2024-10-10T19:42:24.323Z + 2024-10-11T20:42:42.213Z https://posit-dev.github.io/great-tables/reference/GT.opt_row_striping.html - 2024-10-10T19:42:24.171Z + 2024-10-11T20:42:42.061Z https://posit-dev.github.io/great-tables/reference/GT.show.html - 2024-10-10T19:42:24.219Z + 2024-10-11T20:42:42.109Z https://posit-dev.github.io/great-tables/reference/GT.cols_move.html - 2024-10-10T19:42:24.011Z + 2024-10-11T20:42:41.905Z https://posit-dev.github.io/great-tables/reference/GT.save.html - 2024-10-10T19:42:24.215Z + 2024-10-11T20:42:42.105Z https://posit-dev.github.io/great-tables/reference/data.sza.html - 2024-10-10T19:42:24.319Z + 2024-10-11T20:42:42.209Z https://posit-dev.github.io/great-tables/reference/loc.header.html - 2024-10-10T19:42:24.031Z + 2024-10-11T20:42:41.925Z https://posit-dev.github.io/great-tables/reference/style.text.html - 2024-10-10T19:42:24.095Z + 2024-10-11T20:42:41.985Z https://posit-dev.github.io/great-tables/reference/vals.fmt_number.html - 2024-10-10T19:42:24.239Z + 2024-10-11T20:42:42.125Z https://posit-dev.github.io/great-tables/reference/GT.fmt_currency.html - 2024-10-10T19:42:23.879Z + 2024-10-11T20:42:41.769Z https://posit-dev.github.io/great-tables/reference/data.metro.html - 2024-10-10T19:42:24.343Z + 2024-10-11T20:42:42.233Z https://posit-dev.github.io/great-tables/examples/index.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.561Z https://posit-dev.github.io/great-tables/blog/pycon-2024-great-tables-are-possible/index.html - 2024-10-10T19:41:34.954Z + 2024-10-11T20:40:53.553Z https://posit-dev.github.io/great-tables/blog/introduction-0.12.0/index.html - 2024-10-10T19:41:34.950Z + 2024-10-11T20:40:53.553Z https://posit-dev.github.io/great-tables/blog/design-philosophy/index.html - 2024-10-10T19:41:34.930Z + 2024-10-11T20:40:53.529Z https://posit-dev.github.io/great-tables/blog/introduction_great_tables.html - 2024-10-10T19:41:34.950Z + 2024-10-11T20:40:53.553Z https://posit-dev.github.io/great-tables/blog/tables-for-scientific-publishing/index.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.561Z https://posit-dev.github.io/great-tables/blog/introduction-0.4.0/index.html - 2024-10-10T19:41:34.950Z + 2024-10-11T20:40:53.553Z https://posit-dev.github.io/great-tables/blog/superbowl-squares/index.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.561Z https://posit-dev.github.io/great-tables/articles/intro.html - 2024-10-10T19:41:34.910Z + 2024-10-11T20:40:53.509Z https://posit-dev.github.io/great-tables/blog/introduction-0.13.0/index.html - 2024-10-10T19:41:34.950Z + 2024-10-11T20:40:53.553Z https://posit-dev.github.io/great-tables/blog/polars-styling/index.html - 2024-10-10T19:41:34.950Z + 2024-10-11T20:40:53.553Z https://posit-dev.github.io/great-tables/blog/introduction-0.2.0/index.html - 2024-10-10T19:41:34.950Z + 2024-10-11T20:40:53.553Z https://posit-dev.github.io/great-tables/blog/bring-your-own-df/index.html - 2024-10-10T19:41:34.922Z + 2024-10-11T20:40:53.521Z https://posit-dev.github.io/great-tables/blog/index.html - 2024-10-10T19:41:34.950Z + 2024-10-11T20:40:53.553Z https://posit-dev.github.io/great-tables/blog/introduction-0.3.0/index.html - 2024-10-10T19:41:34.950Z + 2024-10-11T20:40:53.553Z https://posit-dev.github.io/great-tables/reference/vals.fmt_roman.html - 2024-10-10T19:42:24.287Z + 2024-10-11T20:42:42.173Z https://posit-dev.github.io/great-tables/reference/GT.with_locale.html - 2024-10-10T19:42:24.111Z + 2024-10-11T20:42:42.001Z https://posit-dev.github.io/great-tables/reference/GT.opt_align_table_header.html - 2024-10-10T19:42:24.167Z + 2024-10-11T20:42:42.057Z https://posit-dev.github.io/great-tables/reference/md.html - 2024-10-10T19:42:24.115Z + 2024-10-11T20:42:42.005Z https://posit-dev.github.io/great-tables/reference/GT.cols_width.html - 2024-10-10T19:42:23.999Z + 2024-10-11T20:42:41.893Z https://posit-dev.github.io/great-tables/reference/GT.with_id.html - 2024-10-10T19:42:24.107Z + 2024-10-11T20:42:41.997Z https://posit-dev.github.io/great-tables/reference/data.pizzaplace.html - 2024-10-10T19:42:24.327Z + 2024-10-11T20:42:42.217Z https://posit-dev.github.io/great-tables/reference/GT.fmt_roman.html - 2024-10-10T19:42:23.899Z + 2024-10-11T20:42:41.793Z https://posit-dev.github.io/great-tables/reference/vals.fmt_bytes.html - 2024-10-10T19:42:24.295Z + 2024-10-11T20:42:42.185Z https://posit-dev.github.io/great-tables/reference/loc.source_notes.html - 2024-10-10T19:42:24.079Z + 2024-10-11T20:42:41.969Z https://posit-dev.github.io/great-tables/reference/GT.html - 2024-10-10T19:42:23.695Z + 2024-10-11T20:42:41.585Z https://posit-dev.github.io/great-tables/reference/style.borders.html - 2024-10-10T19:42:24.107Z + 2024-10-11T20:42:41.997Z https://posit-dev.github.io/great-tables/reference/GT.fmt_scientific.html - 2024-10-10T19:42:23.863Z + 2024-10-11T20:42:41.757Z https://posit-dev.github.io/great-tables/reference/vals.fmt_currency.html - 2024-10-10T19:42:24.279Z + 2024-10-11T20:42:42.169Z https://posit-dev.github.io/great-tables/reference/html.html - 2024-10-10T19:42:24.119Z + 2024-10-11T20:42:42.009Z https://posit-dev.github.io/great-tables/reference/system_fonts.html - 2024-10-10T19:42:24.135Z + 2024-10-11T20:42:42.025Z https://posit-dev.github.io/great-tables/reference/data.gtcars.html - 2024-10-10T19:42:24.323Z + 2024-10-11T20:42:42.213Z https://posit-dev.github.io/great-tables/reference/GT.tab_stub.html - 2024-10-10T19:42:23.715Z + 2024-10-11T20:42:41.605Z https://posit-dev.github.io/great-tables/reference/data.exibble.html - 2024-10-10T19:42:24.331Z + 2024-10-11T20:42:42.221Z https://posit-dev.github.io/great-tables/reference/define_units.html - 2024-10-10T19:42:24.139Z + 2024-10-11T20:42:42.029Z https://posit-dev.github.io/great-tables/reference/GT.fmt_markdown.html - 2024-10-10T19:42:23.931Z + 2024-10-11T20:42:41.821Z https://posit-dev.github.io/great-tables/reference/loc.row_groups.html - 2024-10-10T19:42:24.067Z + 2024-10-11T20:42:41.957Z https://posit-dev.github.io/great-tables/reference/vals.fmt_date.html - 2024-10-10T19:42:24.303Z + 2024-10-11T20:42:42.193Z https://posit-dev.github.io/great-tables/reference/GT.tab_options.html - 2024-10-10T19:42:23.811Z + 2024-10-11T20:42:41.701Z https://posit-dev.github.io/great-tables/reference/GT.tab_stubhead.html - 2024-10-10T19:42:23.719Z + 2024-10-11T20:42:41.613Z https://posit-dev.github.io/great-tables/reference/data.towny.html - 2024-10-10T19:42:24.335Z + 2024-10-11T20:42:42.221Z https://posit-dev.github.io/great-tables/reference/GT.data_color.html - 2024-10-10T19:42:23.975Z + 2024-10-11T20:42:41.869Z https://posit-dev.github.io/great-tables/reference/GT.opt_horizontal_padding.html - 2024-10-10T19:42:24.187Z + 2024-10-11T20:42:42.077Z https://posit-dev.github.io/great-tables/reference/loc.column_header.html - 2024-10-10T19:42:24.047Z + 2024-10-11T20:42:41.937Z https://posit-dev.github.io/great-tables/reference/GT.opt_table_font.html - 2024-10-10T19:42:24.199Z + 2024-10-11T20:42:42.089Z https://posit-dev.github.io/great-tables/reference/GT.tab_source_note.html - 2024-10-10T19:42:23.723Z + 2024-10-11T20:42:41.617Z https://posit-dev.github.io/great-tables/reference/GT.fmt_image.html - 2024-10-10T19:42:23.947Z + 2024-10-11T20:42:41.841Z https://posit-dev.github.io/great-tables/reference/GT.opt_vertical_padding.html - 2024-10-10T19:42:24.183Z + 2024-10-11T20:42:42.073Z https://posit-dev.github.io/great-tables/reference/loc.spanner_labels.html - 2024-10-10T19:42:24.051Z + 2024-10-11T20:42:41.941Z https://posit-dev.github.io/great-tables/reference/index.html - 2024-10-10T19:42:23.647Z + 2024-10-11T20:42:41.541Z https://posit-dev.github.io/great-tables/reference/GT.fmt_bytes.html - 2024-10-10T19:42:23.891Z + 2024-10-11T20:42:41.785Z https://posit-dev.github.io/great-tables/reference/GT.fmt_nanoplot.html - 2024-10-10T19:42:23.959Z + 2024-10-11T20:42:41.853Z https://posit-dev.github.io/great-tables/reference/style.fill.html - 2024-10-10T19:42:24.083Z + 2024-10-11T20:42:41.973Z https://posit-dev.github.io/great-tables/reference/GT.opt_all_caps.html - 2024-10-10T19:42:24.175Z + 2024-10-11T20:42:42.065Z https://posit-dev.github.io/great-tables/reference/loc.body.html - 2024-10-10T19:42:24.071Z + 2024-10-11T20:42:41.961Z https://posit-dev.github.io/great-tables/reference/loc.subtitle.html - 2024-10-10T19:42:24.039Z + 2024-10-11T20:42:41.929Z https://posit-dev.github.io/great-tables/reference/GT.fmt_time.html - 2024-10-10T19:42:23.915Z + 2024-10-11T20:42:41.809Z https://posit-dev.github.io/great-tables/reference/GT.fmt_number.html - 2024-10-10T19:42:23.823Z + 2024-10-11T20:42:41.717Z https://posit-dev.github.io/great-tables/reference/data.nuclides.html - 2024-10-10T19:42:24.359Z + 2024-10-11T20:42:42.253Z https://posit-dev.github.io/great-tables/reference/GT.cols_label.html - 2024-10-10T19:42:24.007Z + 2024-10-11T20:42:41.897Z https://posit-dev.github.io/great-tables/reference/GT.cols_align.html - 2024-10-10T19:42:23.995Z + 2024-10-11T20:42:41.885Z https://posit-dev.github.io/great-tables/reference/from_column.html - 2024-10-10T19:42:24.123Z + 2024-10-11T20:42:42.013Z https://posit-dev.github.io/great-tables/reference/GT.opt_stylize.html - 2024-10-10T19:42:24.207Z + 2024-10-11T20:42:42.097Z https://posit-dev.github.io/great-tables/get-started/table-theme-premade.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/basic-header.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.561Z https://posit-dev.github.io/great-tables/get-started/basic-formatting.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.561Z https://posit-dev.github.io/great-tables/get-started/row-selection.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/nanoplots.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/index.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.565Z https://posit-dev.github.io/great-tables/get-started/basic-stub.html - 2024-10-10T19:41:34.962Z + 2024-10-11T20:40:53.561Z