gov-uk-dashboards 21.2.2__py3-none-any.whl → 26.26.0__py3-none-any.whl

gov_uk_dashboards/components/dash/table.py

@@ -1,109 +1,15 @@
 """Function for creating a table component from a dataframe"""
+
 from typing import Optional
-from pandas import DataFrame
+import polars as pl
 from dash import html, dcc
 from gov_uk_dashboards.components.dash.card import card
 from gov_uk_dashboards.components.dash.paragraph import paragraph
-
-# from gov_uk_dashboards.components.plotly.row_component import row_component
-
-
-def table_from_dataframe(
-    dataframe: DataFrame,
-    title: Optional[str] = None,
-    first_column_is_header: bool = True,
-    title_is_subtitle: bool = False,
-    short_table: bool = True,
-    last_row_unbolded: bool = False,
-    format_column_headers_as_markdown: bool = False,
-    **table_properties,
-):  # pylint: disable=too-many-arguments
-    # pylint: disable=too-many-positional-arguments
-    """
-    Displays a pandas DataFrame as a table formatted in the Gov.UK style
-
-    Part of the Gov.UK Design System:
-    https://design-system.service.gov.uk/components/table/
-
-
-    Args:
-        dataframe (DataFrame): Dataframe containing formatted data to display.
-        title (str, optional): Title to display above the table. Defaults to None.
-        first_column_is_header (bool, optional): Sets if the first column is a header column.
-            Defaults to True.
-        title_is_subtitle (bool, optional): Sets if the title should be displayed as a subtitle
-            or full title. Defaults to False.
-        short_table: (bool, optional): if False the header of the table will scroll with window.
-        last_row_unbolded: (bool, optional): Sets if the last row should not be bolded if
-            first_column_is_header is True. Defaults to False.
-        format_column_headers_as_markdown: (bool, optional): Sets if the column headers should
-            be formatted as markdown. Defaults to False.
-        **table_properties: Any additional arguments for the html.Table object,
-            such as setting a width or id.
-
-    Returns:
-        html.Table: The dash HTML object for the table.
-    """
-    table_contents = []
-
-    if title:
-        table_contents.append(
-            html.Caption(
-                title,
-                className="govuk-table__caption govuk-table__caption--s"
-                if title_is_subtitle
-                else "govuk-table__caption govuk-table__caption--m",
-            )
-        )
-
-    table_contents.append(
-        html.Thead(
-            html.Tr(
-                [
-                    html.Th(
-                        dcc.Markdown(header),
-                        scope="col",
-                        className="govuk-table__header",
-                    )
-                    if format_column_headers_as_markdown
-                    else html.Th(header, scope="col", className="govuk-table__header")
-                    for header in dataframe.columns
-                ],
-                className="govuk-table__row",
-            ),
-            className="govuk-table__head-short" if short_table else "govuk-table__head",
-        )
-    )
-
-    last_row_index = len(dataframe) - 1 if last_row_unbolded else len(dataframe)
-    table_contents.append(
-        html.Tbody(
-            [
-                html.Tr(
-                    [html.Th(row.iloc[0], scope="row", className="govuk-table__header")]
-                    + [html.Td(cell, className="govuk-table__cell") for cell in row[1:]]
-                )
-                if first_column_is_header and index != last_row_index
-                else html.Tr(
-                    [html.Td(cell, className="govuk-table__cell") for cell in row]
-                )
-                for index, row in dataframe.iterrows()
-            ],
-            className="govuk-table__body",
-        )
-    )
-
-    return html.Table(
-        table_contents,
-        className="govuk-table",
-        id="table",
-        role="table",
-        **table_properties,
-    )
+from gov_uk_dashboards.formatting.text_functions import create_id_from_string
 
 
 def table_from_polars_dataframe(
-    dataframe: DataFrame,
+    dataframe: pl.DataFrame,
     title: Optional[str] = None,
     subtitle: Optional[str] = None,
     first_column_is_header: bool = True,
@@ -112,6 +18,7 @@ def table_from_polars_dataframe(
     format_column_headers_as_markdown: bool = False,
     sortable_headers: bool = False,
     table_id: str = "table",
+    assign_ids_to_rows: bool = False,
     table_footer: str = None,
     column_widths: Optional[list[str]] = None,
     columns_to_right_align: Optional[list[str]] = None,
@@ -144,6 +51,7 @@ def table_from_polars_dataframe(
         sortable_headers: (bool, optional): Sets if the column headers should be sortable. Defaults
             to False.
         table_id: (str, optional): ID for the table Defaults to "table".
+        assign_ids_to_rows: (bool, optional): Adds id's to table rows when True. Defaults to False.
         table_footer: (str, optional): Text to display underneath table as footer.
         column_widths: (list[str], optional): Determines width of table columns. Format as a list,
             "x%". List must be same length as dataframe columns. Defaults to None.
@@ -205,17 +113,26 @@ def table_from_polars_dataframe(
                         # If sortable_headers is True, use a button for the header with sorting
                         # functionality
                         html.Th(
-                            html.Button(
-                                dcc.Markdown(header)
-                                if format_column_headers_as_markdown
-                                else header,
-                                id={"type": f"{table_id}-header-button", "index": idx},
-                                n_clicks=0,
-                            )
-                            if header not in non_sortable_columns
-                            else dcc.Markdown(header)
-                            if format_column_headers_as_markdown
-                            else header,
+                            (
+                                html.Button(
+                                    (
+                                        dcc.Markdown(header)
+                                        if format_column_headers_as_markdown
+                                        else header
+                                    ),
+                                    id={
+                                        "type": f"{table_id}-header-button",
+                                        "index": idx,
+                                    },
+                                    n_clicks=0,
+                                )
+                                if header not in non_sortable_columns
+                                else (
+                                    dcc.Markdown(header)
+                                    if format_column_headers_as_markdown
+                                    else header
+                                )
+                            ),
                             **(
                                 {"aria-sort": sorted_header_dict.get(header, "none")}
                                 if header
@@ -227,7 +144,7 @@ def table_from_polars_dataframe(
                             style={
                                 **({"width": width} if width else {}),
                                 **(
-                                    {"text-align": "right"}
+                                    {"textAlign": "right"}
                                     if header in columns_to_right_align
                                     else {}
                                 ),
@@ -235,15 +152,17 @@ def table_from_polars_dataframe(
                         )
                         if sortable_headers
                         else html.Th(
-                            dcc.Markdown(header)
-                            if format_column_headers_as_markdown
-                            else header,
+                            (
+                                dcc.Markdown(header)
+                                if format_column_headers_as_markdown
+                                else header
+                            ),
                             scope="col",
                             className="govuk-table__header",
                             style={
                                 **({"width": width} if width else {}),
                                 **(
-                                    {"text-align": "right"}
+                                    {"textAlign": "right"}
                                     if header in columns_to_right_align
                                     else {}
                                 ),
@@ -260,8 +179,8 @@ def table_from_polars_dataframe(
             style={
                 "position": "sticky",
                 "top": 0,
-                "z-index": 1,
-                "background-color": "#fff",
+                "zIndex": 1,
+                "backgroundColor": "#fff",
             },
         )
     )
@@ -278,12 +197,19 @@ def table_from_polars_dataframe(
                             html.Td(
                                 cell,
                                 className="govuk-table__cell",
-                                style={"text-align": "right"}
-                                if column_name in columns_to_right_align
-                                else {},
+                                style=(
+                                    {"textAlign": "right"}
+                                    if column_name in columns_to_right_align
+                                    else {}
+                                ),
                             )
                             for cell, column_name in zip(row[1:], dataframe.columns[1:])
-                        ]
+                        ],
+                        **(
+                            {"id": create_id_from_string(row[0])}
+                            if assign_ids_to_rows and create_id_from_string(row[0])
+                            else {}
+                        ),
                     )
                     if first_column_is_header and index != last_row_index
                     else html.Tr(
@@ -291,12 +217,24 @@ def table_from_polars_dataframe(
                             html.Td(
                                 cell,
                                 className="govuk-table__cell",
-                                style={"text-align": "right"}
-                                if column_name in columns_to_right_align
-                                else {},
+                                style=(
+                                    {"textAlign": "right"}
+                                    if column_name in columns_to_right_align
+                                    else {}
+                                ),
                             )
                             for cell, column_name in zip(row, dataframe.columns)
-                        ]
+                        ],
+                        **(
+                            {
+                                "id": (
+                                    create_id_from_string(row[0])
+                                    if assign_ids_to_rows
+                                    and create_id_from_string(row[0])
+                                    else {}
+                                )
+                            }
+                        ),
                     )
                 )
                 for index, row in enumerate(dataframe.rows())

gov_uk_dashboards/components/dash/tooltip.py

@@ -1,4 +1,5 @@
 """tooltip"""
+
 from dash import html
 import dash_bootstrap_components as dbc
 
@@ -25,7 +26,7 @@ def tooltip(
                 tooltip_text,
                 target=tooltip_id,
                 class_name="tooltip tooltiptext",
-                style={"color": color, "font-size": font_size},
+                style={"color": color, "fontSize": font_size},
             ),
         ],
         id=tooltip_id,

gov_uk_dashboards/components/dash/tooltip_title.py

@@ -1,4 +1,5 @@
 """tooltip_title"""
+
 from dash import html
 import dash_bootstrap_components as dbc
 
@@ -23,7 +24,7 @@ def tooltip_title(title, tooltiptext):
                 tooltiptext,
                 target="tooltip-target",
                 class_name="tooltip tooltiptext",
-                style={"color": "white", "font-size": 12, "width": "10px"},
+                style={"color": "white", "fontSize": 12, "width": "10px"},
             ),
         ]
     )

gov_uk_dashboards/components/dash/visualisation_commentary.py

@@ -1,4 +1,5 @@
 """format_visualisation_commentary"""
+
 from dash import html
 
 

gov_uk_dashboards/components/dash/visualisation_title.py

@@ -1,4 +1,5 @@
 """format_visualisation_title"""
+
 from dash import html
 
 

gov_uk_dashboards/components/dash/warning_text.py

@@ -1,4 +1,5 @@
 """warning_text"""
+
 from dash import html
 
 

gov_uk_dashboards/components/helpers/display_chart_or_table_with_header.py

@@ -18,7 +18,13 @@ def display_chart_or_table_with_header(
     sub_heading: str = None,
     download_button_id: str = None,
     download_data_button_id: str = None,
+    download_map_button_id: str = None,
+    download_all_data_button_id: str = None,
+    alternative_data_button_text: str = None,
+    alternative_all_data_button_text: str = None,
     footnote: str = None,
+    instance=1,
+    text_below_subheading: str = None,
 ) -> html.Div:
     """Generate the wrapping information/header for a chart or table.
 
@@ -29,7 +35,17 @@ def display_chart_or_table_with_header(
         download_button_id (str, optional): id for download button if required. Defaults to None.
                                             if None then the button will not be included.
         download_data_button_id (str, optional): the id to be applied to the download data button.
+        download_map_button_id (str, optional): the id to be applied to the download map button.
+        download_all_data_button_id (str, optional): the id to be applied to the download all data
+            button
+        alternative_data_button_text (str, optional): Optional alternative to button text
+            "Download data"
+        alternative_all_data_button_text (str, optional): Optional alternative to button text
+            "Download all data"
         footnote (str, optional): the footnote to be added to charts and downloads.
+        instance (int or str): Optional additional paramter for id dict.
+        text_below_subheading (str, optional): Optional text to go below subheading but above
+            chart_or_table.
 
     Returns:
         html.Div: Div containing Header and chart/table.
@@ -54,26 +70,59 @@ def display_chart_or_table_with_header(
                     ),
                 ]
             ),
+            paragraph(text_below_subheading),
             chart_or_table,
-            html.Div([paragraph(footnote)], style={"padding-top": "20px"}),
+            html.Div([paragraph(footnote)], style={"paddingTop": "20px"}),
             html.Div(
                 (
                     [
                         html.Div(
                             [
-                                create_download_button_with_icon(
-                                    "Download chart", download_button_id
-                                )
-                                if download_button_id
-                                else [],
-                                create_download_button_with_icon(
-                                    "Download data", download_data_button_id
-                                )
-                                if download_data_button_id
-                                else [],
+                                (
+                                    create_download_button_with_icon(
+                                        "Download chart", download_button_id, instance
+                                    )
+                                    if download_button_id
+                                    else []
+                                ),
+                                (
+                                    create_download_button_with_icon(
+                                        "Download map", download_map_button_id, instance
+                                    )
+                                    if download_map_button_id
+                                    else []
+                                ),
+                                (
+                                    create_download_button_with_icon(
+                                        (
+                                            alternative_data_button_text
+                                            if alternative_data_button_text
+                                            else "Download data"
+                                        ),
+                                        download_data_button_id,
+                                        instance,
+                                        "data",
+                                    )
+                                    if download_data_button_id
+                                    else []
+                                ),
+                                (
+                                    create_download_button_with_icon(
+                                        (
+                                            alternative_all_data_button_text
+                                            if alternative_all_data_button_text
+                                            else "Download all data"
+                                        ),
+                                        download_all_data_button_id,
+                                        instance,
+                                        "data",
+                                    )
+                                    if download_all_data_button_id
+                                    else []
+                                ),
                             ],
                             className="govuk-button-group",
-                            style={"padding-top": "20px"},
+                            style={"paddingTop": "20px"},
                         ),
                     ]
                 ),

gov_uk_dashboards/components/helpers/get_chart_for_download.py

@@ -1,4 +1,5 @@
 """get_chart_for_download"""
+
 from gov_uk_dashboards.constants import MAIN_TITLE, SUBTITLE
 
 
@@ -17,20 +18,22 @@ def get_chart_for_download(self, fig):
         title_subtitle={
             "text": f"<b><span style='color: black; margin: 0px 0px 5px'>{subtitle}</span></b>"
         },
-        annotations=[
-            {
-                "text": f"<span style='color: black; font-size: 18px;'>{footnote}</span>",
-                "x": -0.01,
-                "y": -0.4,  # Bottom of the plotting area
-                "xref": "paper",
-                "yref": "paper",
-                "xanchor": "left",
-                "yanchor": "top",
-                "showarrow": False,
-                "align": "left",
-            }
-        ]
-        if footnote is not None
-        else [],
+        annotations=(
+            [
+                {
+                    "text": f"<span style='color: black; fontSize: 18px;'>{footnote}</span>",
+                    "x": -0.01,
+                    "y": -0.4,  # Bottom of the plotting area
+                    "xref": "paper",
+                    "yref": "paper",
+                    "xanchor": "left",
+                    "yanchor": "top",
+                    "showarrow": False,
+                    "align": "left",
+                }
+            ]
+            if footnote is not None
+            else []
+        ),
     )
     return fig

gov_uk_dashboards/components/helpers/plotting_helper_functions.py

@@ -1,6 +1,5 @@
 """Helper functions for use to plot charts"""
 
-
 from gov_uk_dashboards.constants import CHART_LABEL_FONT_SIZE