gov-uk-dashboards 18.1.0__tar.gz → 19.1.0__tar.gz

{gov_uk_dashboards-18.1.0/gov_uk_dashboards.egg-info → gov_uk_dashboards-19.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 18.1.0
+Version: 19.1.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-18.1.0 → gov_uk_dashboards-19.1.0}/gov_uk_dashboards/components/helpers/plotting_helper_functions.py

@@ -4,7 +4,7 @@
 from gov_uk_dashboards.constants import CHART_LABEL_FONT_SIZE
 
 
-def get_legend_configuration(itemclick=True, itemdoubleclick=True):
+def get_legend_configuration(itemclick=True, itemdoubleclick=True, reverse_order=False):
     """
     Returns the legend configuration for charts with customizable interaction settings.
     Args:
@@ -12,9 +12,11 @@ def get_legend_configuration(itemclick=True, itemdoubleclick=True):
                           Set to True by default, allowing click interactions.
         itemdoubleclick (bool): Determines the behavior when double-clicking on a legend item.
                                 Set to True by default, allowing double-click interactions.
+        reverse_order (bool): Whether to reverse legend order. Defaults to False.
     Returns:
         dict: A dictionary containing the configuration settings for the legend.
     """
+    traceorder = {} if not reverse_order else {"traceorder": "reversed"}
     return {
         "x": 0,
         "y": -0.22,
@@ -24,6 +26,7 @@ def get_legend_configuration(itemclick=True, itemdoubleclick=True):
         "font": {"size": CHART_LABEL_FONT_SIZE},
         "itemclick": "toggle" if itemclick else False,
         "itemdoubleclick": "toggle" if itemdoubleclick else False,
+        **traceorder,
     }
 
 

{gov_uk_dashboards-18.1.0 → gov_uk_dashboards-19.1.0}/gov_uk_dashboards/components/leaflet/leaflet_choropleth_map.py

@@ -17,8 +17,8 @@ from gov_uk_dashboards.formatting.number_formatting import (
 
 class LeafletChoroplethMap:
     """Class for  generating leaflet choropleth map charts.
-    Note: dataframe_function must contain columns: 'Region', 'Area_Code',
-    column_to_plot, hover_text_columns
+    Note: Values in the numeric column should use 1 for the highest value, with larger numbers
+    representing lower values.
     If color_scale_is_discrete is false, colour scale will be continuous, otherwise it will be
     discrete"""
 

{gov_uk_dashboards-18.1.0 → gov_uk_dashboards-19.1.0}/gov_uk_dashboards/components/plotly/stacked_barchart.py

@@ -1,5 +1,6 @@
 """stacked_barchart function"""
 
+import json
 import math
 from typing import Optional
 from dash import html
@@ -54,7 +55,7 @@ class StackedBarChart:
     def __init__(
         self,
         title_data: TitleDataStructure,
-        y_column: str,
+        y_axis_column: str,
         hover_data: HoverDataByTrace,
         df: pl.DataFrame,
         trace_name_list: list[str],
@@ -62,8 +63,11 @@ class StackedBarChart:
         xaxis_tick_text_format: XAxisFormat = XAxisFormat.YEAR.value,
         line_trace_name: Optional[str] = None,
         x_axis_column=DATE_VALID,
+        x_unified_hovermode: Optional[bool] = False,
+        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.
@@ -87,9 +91,12 @@ 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_column
+        self.y_axis_column = y_axis_column
         self.hover_data = hover_data
         self.df = df
         self.trace_name_list = trace_name_list
@@ -97,8 +104,11 @@ class StackedBarChart:
         self.xaxis_tick_text_format = xaxis_tick_text_format
         self.line_trace_name = line_trace_name
         self.x_axis_column = x_axis_column
+        self.x_unified_hovermode = x_unified_hovermode
+        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:
@@ -120,6 +130,43 @@ class StackedBarChart:
             self.download_data_button_id,
         )
 
+    def is_json_serializable(self, value):
+        "Determines whether value can be converted to json format."
+        try:
+            json.dumps(value)
+            return True
+        except (TypeError, OverflowError):
+            return False
+
+    def to_dict(self):
+        "Converts class attributes to json format."
+        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 hasattr(v, "to_dict"):
+                result[k] = {"_type": "custom", "data": v.to_dict()}
+            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 isinstance(v, dict) and "_type" in v:
+                if v["_type"] == "polars_df":
+                    restored[k] = pl.DataFrame(v["data"])
+                elif v["_type"] == "custom":
+                    # optionally restore known nested types here
+                    pass
+            else:
+                restored[k] = v
+        return cls(**restored)
+
     def get_stacked_bar_chart_for_download(self):
         """Return fig with title and subtitle for download as png"""
         return get_chart_for_download(self, self.create_stacked_bar_chart())
@@ -129,7 +176,25 @@ class StackedBarChart:
     ):
         """generates a stacked bar chart"""
         # 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
@@ -140,7 +205,7 @@ class StackedBarChart:
         )
         for _, (df, trace_name, colour) in enumerate(
             zip(
-                self._get_df_list_for_time_series(),
+                self._get_df_list_for_bar_chart(),
                 self.trace_name_list,
                 colour_list,
             )
@@ -177,7 +242,7 @@ class StackedBarChart:
         update_layout_bgcolor_margin(fig, "#FFFFFF")
 
         fig.update_layout(
-            legend=get_legend_configuration(),
+            legend=get_legend_configuration(reverse_order=True),
             font={"size": CHART_LABEL_FONT_SIZE},
             yaxis={
                 "range": [min_y * 1.1, max_y * 1.1],
@@ -188,20 +253,12 @@ class StackedBarChart:
             showlegend=True,
             barmode="relative",
             xaxis={"categoryorder": "category ascending"},
+            ## copied from timeseries
+            hovermode="x unified" if self.x_unified_hovermode is True else "closest",
+            hoverdistance=self.hover_distance,  # Increase distance to simulate hover 'always on'
         )
         return fig
 
-    def _format_x_axis(self, fig):
-        tick_text, tick_values, range_x = self._get_x_axis_content()
-        fig.update_xaxes(
-            tickvals=tick_values,
-            ticktext=tick_text,
-            tickmode="array",
-            range=range_x,
-        )
-
-        return tick_values
-
     def create_bar_chart_trace(
         self,
         df: pl.DataFrame,
@@ -232,6 +289,8 @@ class StackedBarChart:
         )
 
     def _get_hover_template(self, trace_name):
+        if self.x_unified_hovermode is True:
+            return f"{trace_name}: " + "%{customdata[0]}<extra></extra>"
         hover_text_headers = self.hover_data[trace_name][HOVER_TEXT_HEADERS]
         hover_template = (
             f"{trace_name}<br>"
@@ -246,36 +305,7 @@ class StackedBarChart:
         customdata = df[self.hover_data[trace_name][CUSTOM_DATA]]
         return customdata
 
-    def _get_x_axis_content(self):
-        """Generates tick text and values for the x-axis based on the unique years calculated from
-        the FINANCIAL_YEAR_ENDING column in the dataframe.
-        Returns:
-            tuple: A tuple containing tick_text, tick_values and range_x.
-        """
-        if self.xaxis_tick_text_format == XAxisFormat.YEAR.value:
-            year_list = self.df[FINANCIAL_YEAR_ENDING].unique().to_list()
-            int_min_year = int(min(year_list))
-            int_max_year = int(max(year_list))
-
-            tick_text = []
-            year = int_min_year
-            while year <= int_max_year:
-                tick_text.append(str(year + 1))
-                year = year + 1
-
-            tick_values = tick_text
-
-            range_x = [
-                tick_values[0],
-                tick_values[-1],
-            ]
-        else:
-            raise ValueError(
-                f"Invalid xaxis_tick_text_format: {self.xaxis_tick_text_format}"
-            )
-        return tick_text, tick_values, range_x
-
-    def _get_df_list_for_time_series(self) -> list[pl.DataFrame]:
+    def _get_df_list_for_bar_chart(self) -> list[pl.DataFrame]:
         if self.trace_name_column is not None:
             df_list = [
                 self.df.filter(pl.col(self.trace_name_column) == trace_name)

{gov_uk_dashboards-18.1.0 → gov_uk_dashboards-19.1.0/gov_uk_dashboards.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 18.1.0
+Version: 19.1.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-18.1.0 → gov_uk_dashboards-19.1.0}/setup.py

@@ -10,7 +10,7 @@ setup(
     author="Department for Levelling Up, Housing and Communities",
     description="Provides access to functionality common to creating a data dashboard.",
     name="gov_uk_dashboards",
-    version="18.1.0",
+    version="19.1.0",
     long_description=long_description,
     long_description_content_type="text/markdown",
     packages=find_packages(),