gov-uk-dashboards 19.0.0__py3-none-any.whl → 20.0.0__py3-none-any.whl

gov_uk_dashboards/components/plotly/stacked_barchart.py

@@ -67,6 +67,7 @@ class StackedBarChart:
         hover_distance: Optional[int] = 1,
         download_chart_button_id: Optional[str] = None,
         download_data_button_id: Optional[str] = None,
+        total_trace_name: Optional[str] = None,
     ):
         """Initializes the StackedBarChart instance.
         To display the chart, call the `get_stacked_bar_chart()` method.
@@ -90,6 +91,9 @@ class StackedBarChart:
                 if applicable. Defaults to None.
             download_data_button_id (Optional[str], optional): ID for the data download button, if
                 applicable. Defaults to None.
+            total_trace_name (Optional[str], optional): Name for an optional total to be added to
+                bottom of hover text, must be in MEASURE column of df, line_trace_name will display
+                in legend. Defaults to None.
         """
         self.title_data = title_data
         self.y_axis_column = y_axis_column
@@ -104,6 +108,7 @@ class StackedBarChart:
         self.hover_distance = hover_distance
         self.download_chart_button_id = download_chart_button_id
         self.download_data_button_id = download_data_button_id
+        self.total_trace_name = total_trace_name
         self.fig = self.create_stacked_bar_chart()
 
     def get_stacked_bar_chart(self) -> html.Div:
@@ -173,6 +178,23 @@ class StackedBarChart:
         # pylint: disable=too-many-locals
 
         fig = go.Figure()
+        if self.total_trace_name is not None:
+            df = self.df.filter(pl.col(MEASURE) == self.total_trace_name)
+
+            fig.add_trace(
+                go.Scatter(
+                    x=df[self.x_axis_column],
+                    y=df[self.y_axis_column],
+                    customdata=self._get_custom_data(self.total_trace_name, df),
+                    mode="markers",
+                    marker={"color": "white", "opacity": 0},
+                    name=self.total_trace_name + LEGEND_SPACING,
+                    hovertemplate="Total income: %{customdata[0]}<extra></extra>",
+                    showlegend=False,
+                    hoverinfo="skip",
+                    legendrank=1,
+                )
+            )
         colour_list = (
             AFAccessibleColours.CATEGORICAL.value
             if len(self.trace_name_list) != 2

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],
@@ -83,7 +84,7 @@ class TimeSeriesChart:
         hover_distance: Optional[int] = 1,
     ):
         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 +96,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
@@ -114,7 +115,6 @@ class TimeSeriesChart:
 
     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.
         """
@@ -132,6 +132,49 @@ class TimeSeriesChart:
             self.download_data_button_id,
         )
 
+    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 +383,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 +411,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-19.0.0.dist-info → gov_uk_dashboards-20.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 19.0.0
+Version: 20.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.0.0.dist-info → gov_uk_dashboards-20.0.0.dist-info}/RECORD

@@ -80,8 +80,8 @@ gov_uk_dashboards/components/plotly/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQ
 gov_uk_dashboards/components/plotly/captioned_figure.py,sha256=T0sbtGTiJ79FXxVdPb__hqISuyTc3Dl11cKhgcuW-5U,2804
 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=07egbXxZwWyhlwniQzbr7iBNGJkE2pdw96JaQSwdEGY,13111
-gov_uk_dashboards/components/plotly/time_series_chart.py,sha256=QD9HjXLjNIBA-NBZQUSL3TyIAvRGrBzwnYrRboROECg,23002
+gov_uk_dashboards/components/plotly/stacked_barchart.py,sha256=61VgvGJhFX7C4QAk-A8ZF6DTNjDvZ7uU3vof54H5km4,14187
+gov_uk_dashboards/components/plotly/time_series_chart.py,sha256=rsWaxh4fNbedz8NIQfwh5xUC2SOS7nCiR7uWXd3Hq6o,24637
 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
@@ -106,8 +106,8 @@ gov_uk_dashboards/lib/datetime_functions/datetime_functions.py,sha256=BQgr8I_vFN
 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.0.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
-gov_uk_dashboards-19.0.0.dist-info/METADATA,sha256=sp97E7xIhHGjoadUdtujJEuoKX3plUBKJNPSHTLegV8,5917
-gov_uk_dashboards-19.0.0.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
-gov_uk_dashboards-19.0.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
-gov_uk_dashboards-19.0.0.dist-info/RECORD,,
+gov_uk_dashboards-20.0.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
+gov_uk_dashboards-20.0.0.dist-info/METADATA,sha256=uXL0Qg3yth1-u_u1K5URWHxZYLj9kEkPNOEl76OmNU8,5917
+gov_uk_dashboards-20.0.0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+gov_uk_dashboards-20.0.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
+gov_uk_dashboards-20.0.0.dist-info/RECORD,,

{gov_uk_dashboards-19.0.0.dist-info → gov_uk_dashboards-20.0.0.dist-info}/WHEEL

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