gov-uk-dashboards 19.1.0__py3-none-any.whl → 21.0.0__py3-none-any.whl

gov_uk_dashboards/components/helpers/display_chart_or_table_with_header.py

@@ -7,14 +7,18 @@ from gov_uk_dashboards.components.dash.download_button import (
     create_download_button_with_icon,
 )
 from gov_uk_dashboards.components.dash.heading import HeadingSizes
+from gov_uk_dashboards.components.dash.paragraph import paragraph
 
 
+# pylint: disable=too-many-arguments
+# pylint: disable=too-many-positional-arguments
 def display_chart_or_table_with_header(
     chart_or_table: Component,
     heading: str = None,
     sub_heading: str = None,
     download_button_id: str = None,
     download_data_button_id: str = None,
+    footnote: str = None,
 ) -> html.Div:
     """Generate the wrapping information/header for a chart or table.
 
@@ -25,6 +29,7 @@ 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.
+        footnote (str, optional): the footnote to be added to charts and downloads.
 
     Returns:
         html.Div: Div containing Header and chart/table.
@@ -50,6 +55,7 @@ def display_chart_or_table_with_header(
                 ]
             ),
             chart_or_table,
+            html.Div([paragraph(footnote)], style={"padding-top": "20px"}),
             html.Div(
                 (
                     [

gov_uk_dashboards/components/helpers/get_chart_for_download.py

@@ -6,6 +6,7 @@ def get_chart_for_download(self, fig):
     """Returns a fig with title and subtitle for download as png"""
     main_title = self.title_data[MAIN_TITLE]
     subtitle = self.title_data[SUBTITLE]
+    footnote = self.footnote
 
     fig.update_layout(
         title={
@@ -16,6 +17,18 @@ def get_chart_for_download(self, fig):
         title_subtitle={
             "text": f"<b><span style='color: black; margin: 0px 0px 5px'>{subtitle}</span></b>"
         },
-        margin={"t": 100},
+        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",
+            }
+        ],
     )
     return fig

gov_uk_dashboards/components/plotly/time_series_chart.py

@@ -1,6 +1,7 @@
 """get_time_series_chart function"""
 
 from datetime import datetime, date
+import json
 from typing import Optional
 from dateutil.relativedelta import relativedelta
 from dash import html
@@ -58,7 +59,7 @@ class TimeSeriesChart:
     def __init__(
         self,
         title_data: TitleDataStructure,
-        y_column: str,
+        y_axis_column: str,
         hover_data: HoverDataByTrace,
         filtered_df: pl.DataFrame,
         trace_name_list: list[str],
@@ -81,9 +82,10 @@ class TimeSeriesChart:
         number_of_traces_colour_shift_dict: Optional[dict] = None,
         additional_line: Optional[dict] = None,
         hover_distance: Optional[int] = 1,
+        footnote: Optional[str] = None,
     ):
         self.title_data = title_data
-        self.y_axis_column = y_column
+        self.y_axis_column = y_axis_column
         self.hover_data = hover_data
         self.hover_data_for_traces_with_different_hover_for_last_point = (
             hover_data_for_traces_with_different_hover_for_last_point
@@ -95,7 +97,7 @@ class TimeSeriesChart:
         self.xaxis_tick_text_format = xaxis_tick_text_format
         self.verticle_line_x_value_and_name = verticle_line_x_value_and_name
         self.filled_traces_dict = filled_traces_dict
-        self.trace_names_to_prevent_hover_of_first_point = (
+        self.trace_names_to_prevent_hover_of_first_point_list = (
             trace_names_to_prevent_hover_of_first_point_list
         )
         self.x_axis_column = x_axis_column
@@ -111,10 +113,10 @@ class TimeSeriesChart:
         self.hover_distance = hover_distance
         self.colour_list = self._get_colour_list()
         self.fig = self.create_time_series_chart()
+        self.footnote = footnote
 
     def get_time_series_chart(self) -> html.Div:
         """Creates and returns time series chart for display on application.
-
         Returns:
             html.Div: Styled div containing title, subtile and chart.
         """
@@ -130,8 +132,52 @@ class TimeSeriesChart:
             self.title_data[SUBTITLE],
             self.download_chart_button_id,
             self.download_data_button_id,
+            self.footnote,
         )
 
+    def is_json_serializable(self, value):
+        "Determines whether value can be converted to json format."
+        # pylint: disable=duplicate-code
+        try:
+            json.dumps(value)
+            return True
+        except (TypeError, OverflowError):
+            return False
+
+    def to_dict(self):
+        "Converts class attributes to json format."
+        # pylint: disable=duplicate-code
+        result = {}
+        for k, v in self.__dict__.items():
+            if self.is_json_serializable(v):
+                result[k] = v
+            elif isinstance(v, pl.DataFrame):
+                result[k] = {"_type": "polars_df", "data": v.to_dicts()}
+            elif isinstance(v, pl.Series):
+                result[k] = {"_type": "series", "data": v.to_list()}
+            else:
+                result[k] = f"<<non-serializable: {type(v).__name__}>>"
+        return result
+
+    @classmethod
+    def from_dict(cls, data):
+        "Creates a class instance from dict of attributes."
+        restored = {}
+        for k, v in data.items():
+            if k in ["markers", "colour_list", "fig"]:
+                continue
+            if isinstance(v, dict) and "_type" in v:
+                if v["_type"] == "polars_df":
+                    restored[k] = pl.DataFrame(v["data"])
+                elif v["_type"] == "polars_series":
+                    restored[k] = pl.Series(v["data"])
+                else:
+                    # Fallback for unknown _type
+                    restored[k] = v.get("data", None)
+            else:
+                restored[k] = v
+        return cls(**restored)
+
     def get_time_series_chart_for_download(self):
         """Return fig with title and subtitle for download as png"""
         return get_chart_for_download(self, self.create_time_series_chart())
@@ -340,7 +386,6 @@ class TimeSeriesChart:
         legendgroup: str,
     ):
         """Creates a trace for the plot.
-
         Args:
             df (pl.DataFrame): Dataframe to use to create trace. Must contain "Date valid" column,
             y_value column and columns defined in self.hover_data[CUSTOM_DATA].
@@ -369,8 +414,8 @@ class TimeSeriesChart:
             (
                 ""
                 if i == 0
-                and self.trace_names_to_prevent_hover_of_first_point is not None
-                and trace_name in self.trace_names_to_prevent_hover_of_first_point
+                and self.trace_names_to_prevent_hover_of_first_point_list is not None
+                and trace_name in self.trace_names_to_prevent_hover_of_first_point_list
                 else self._get_custom_hover_template(i, df, trace_name)
             )
             for i in range(df.shape[0])  # the number of rows in df

gov_uk_dashboards/lib/download_functions/convert_fig_to_image_and_download.py

@@ -9,7 +9,7 @@ def convert_fig_to_image_and_download(fig: go.Figure, name: str):
     """Converts a given Plotly figure to a PNG image and returns a Dash component
     for downloading the image.
     """
-    fig.update_layout(margin={"t": 150, "b": 100, "l": 100, "r": 50})
+    fig.update_layout(margin={"t": 150, "b": 250, "l": 100, "r": 50})
 
     filename = f"{name}-chart.png"
     img_bytes = pio.to_image(fig, format="png", width=1600, height=800)

gov_uk_dashboards/lib/download_functions/download_csv_with_headers.py

@@ -38,7 +38,7 @@ def download_csv_with_headers(
     }  # range is missing columns in first df compared to max columns across all dfs
 
     subtitle = list_of_df_title_subtitle_dicts[0]["subtitle"]
-
+    footnote = list_of_df_title_subtitle_dicts[0]["footnote"]
     header_data = [
         {column_list[0]: "Date downloaded: " + get_todays_date_for_downloaded_csv()},
         *(
@@ -53,6 +53,7 @@ def download_csv_with_headers(
         ),  # Uses unpacking (*) to add the subtitle row if subtitle is not None. If subtitle is
         # None, it unpacks an empty list, effectively skipping the row.
         {column_list[0]: None},  # Blank row
+        *([{column_list[0]: footnote}] if footnote is not None else []),
         {**column_dict, **blank_dict},
     ]
 
@@ -60,12 +61,11 @@ def download_csv_with_headers(
         header_data = [{column_list[0]: sensitivity_label}] + header_data
 
     pl.DataFrame(header_data).write_csv(csv_buffer, include_header=False)
-
     for i, data in enumerate(list_of_df_title_subtitle_dicts):
         df = data["df"]
         title = data["title"]
         subtitle = data["subtitle"]
-
+        footnote = data.get("footnote")
         if i > 0 and title is not None:
             column_dict = {column_name: column_name for column_name in list(df.columns)}
             header_data = [
@@ -75,6 +75,7 @@ def download_csv_with_headers(
                 ),  # Uses unpacking (*) to add the subtitle row if subtitle is not None. If
                 # subtitle is None, it unpacks an empty list, effectively skipping the row.
                 {column_list[0]: None},  # Blank row
+                *([{column_list[0]: footnote}] if footnote is not None else []),
             ]
             pl.DataFrame(header_data).write_csv(csv_buffer, include_header=False)
         df.write_csv(csv_buffer, include_header=i > 0)

{gov_uk_dashboards-19.1.0.dist-info → gov_uk_dashboards-21.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 19.1.0
+Version: 21.0.0
 Summary: Provides access to functionality common to creating a data dashboard.
 Author: Department for Levelling Up, Housing and Communities
 Description-Content-Type: text/markdown

{gov_uk_dashboards-19.1.0.dist-info → gov_uk_dashboards-21.0.0.dist-info}/RECORD

@@ -69,9 +69,9 @@ gov_uk_dashboards/components/dash/visualisation_commentary.py,sha256=jBy8qy2DWYq
 gov_uk_dashboards/components/dash/visualisation_title.py,sha256=xXHsyVRIGkngBXCuhv8z0PmZLOeicjpMvmTbA5HhRvQ,561
 gov_uk_dashboards/components/dash/warning_text.py,sha256=31XvPUINt2QsWIaaMnqEvn23G-MpzWbDvGnzYcXIyAY,1622
 gov_uk_dashboards/components/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gov_uk_dashboards/components/helpers/display_chart_or_table_with_header.py,sha256=4Kh_qaFZUqQrS08Bb7j9T-ltSVjLtI_EOnpXY-uMvVc,2918
+gov_uk_dashboards/components/helpers/display_chart_or_table_with_header.py,sha256=wDK8VUfaK4cfJDwafN_U1tf4R0kxzv9_V98vnXO-sio,3255
 gov_uk_dashboards/components/helpers/generate_dash_graph_from_figure.py,sha256=sdhC6Mjfw6kqs1MDRDoMuOt8dNS9Bl1WEoJX9S5AssA,1813
-gov_uk_dashboards/components/helpers/get_chart_for_download.py,sha256=RS5SR2tCQPTkBpWaIr2mb98Yn6vAimBnAXpRhMx0kB4,669
+gov_uk_dashboards/components/helpers/get_chart_for_download.py,sha256=EJGShQ9r9OePnfUAcRdlTFw3FDPFQp4jDCYcVJB94nI,1113
 gov_uk_dashboards/components/helpers/plotting_helper_functions.py,sha256=WUif1mlSgWPuTZptBqaElWpJTlitmuiJofMTpOe_Bsg,1833
 gov_uk_dashboards/components/helpers/update_layout_bgcolor_margin.py,sha256=i7Nwp0CxFpkyQeR8KfOBVMBkzctG7hMpWI2OzgxB2jY,740
 gov_uk_dashboards/components/leaflet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -81,7 +81,7 @@ gov_uk_dashboards/components/plotly/captioned_figure.py,sha256=T0sbtGTiJ79FXxVdP
 gov_uk_dashboards/components/plotly/choropleth_map.py,sha256=U9RmS3MZGloQAt9HoSYh3Xad205DDfZOjz91ZD_ydbI,9849
 gov_uk_dashboards/components/plotly/enums.py,sha256=ebHiFQljA7O4HJxKoslqlNXcAjUZi1askpTSwxKEcYQ,850
 gov_uk_dashboards/components/plotly/stacked_barchart.py,sha256=61VgvGJhFX7C4QAk-A8ZF6DTNjDvZ7uU3vof54H5km4,14187
-gov_uk_dashboards/components/plotly/time_series_chart.py,sha256=QD9HjXLjNIBA-NBZQUSL3TyIAvRGrBzwnYrRboROECg,23002
+gov_uk_dashboards/components/plotly/time_series_chart.py,sha256=6mfNPStKmP9T1OmKZtLg8NIWglLm5svggSDcEApKABU,24737
 gov_uk_dashboards/figures/__init__.py,sha256=_snQeNlM81nNKERl4gg9ScH2HYbtwaBjl8yQonccx34,712
 gov_uk_dashboards/figures/chart_data.py,sha256=fEsNkQFzXKIQ0h7aLBWq3J1qAxHbxvJeKU23JrVodVc,757
 gov_uk_dashboards/figures/line_chart.py,sha256=rEB51_z9cPl7BcT94iA6ZsZXzecnVCnGpQWW_9SNGUY,2813
@@ -104,10 +104,10 @@ gov_uk_dashboards/lib/dap/get_dataframe_from_cds.py,sha256=OiusRCgYnkBjK_GZgYLGz
 gov_uk_dashboards/lib/datetime_functions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gov_uk_dashboards/lib/datetime_functions/datetime_functions.py,sha256=BQgr8I_vFNYwLi-fE4YC6jZ5PpbPea2rnD_2a_lw0YE,12209
 gov_uk_dashboards/lib/download_functions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gov_uk_dashboards/lib/download_functions/convert_fig_to_image_and_download.py,sha256=JYDpWObBsiKG5Rtk2ElOTgHwfIR0cRmVocr8RlTfPZQ,534
-gov_uk_dashboards/lib/download_functions/download_csv_with_headers.py,sha256=h50ejODCjoz9z-yqDt6nsE6jN6XxJN1DWH66CjLJiCk,4155
-gov_uk_dashboards-19.1.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
-gov_uk_dashboards-19.1.0.dist-info/METADATA,sha256=FwUetPwi9LtIIGAHFPO7nxTh38AMoORL9aABOeb28PQ,5917
-gov_uk_dashboards-19.1.0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-gov_uk_dashboards-19.1.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
-gov_uk_dashboards-19.1.0.dist-info/RECORD,,
+gov_uk_dashboards/lib/download_functions/convert_fig_to_image_and_download.py,sha256=-dkYbpTL6txftFfAZW-vfW_O9efb6Dse9WJ9MM6mAqw,534
+gov_uk_dashboards/lib/download_functions/download_csv_with_headers.py,sha256=uKMxKrdhaLj1c0ZWAmc02uu8PICjbn1fWt9YBw8FGnQ,4408
+gov_uk_dashboards-21.0.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
+gov_uk_dashboards-21.0.0.dist-info/METADATA,sha256=zejLJS9ttCDHYzULcE7TglrqfUNUz4Sfsh3hRsvt2Ok,5917
+gov_uk_dashboards-21.0.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+gov_uk_dashboards-21.0.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
+gov_uk_dashboards-21.0.0.dist-info/RECORD,,

{gov_uk_dashboards-19.1.0.dist-info → gov_uk_dashboards-21.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.3.1)
+Generator: setuptools (80.4.0)
 Root-Is-Purelib: true
 Tag: py3-none-any