gov-uk-dashboards 15.2.1__tar.gz → 16.1.0__tar.gz

{gov_uk_dashboards-15.2.1/gov_uk_dashboards.egg-info → gov_uk_dashboards-16.1.0}/PKG-INFO

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

@@ -1,9 +1,7 @@
 """Helper functions for use to plot charts"""
 
 
-from gov_uk_dashboards.constants import (
-    CHART_LABEL_FONT_SIZE,
-)
+from gov_uk_dashboards.constants import CHART_LABEL_FONT_SIZE
 
 
 def get_legend_configuration(itemclick=True, itemdoubleclick=True):
@@ -22,7 +20,7 @@ def get_legend_configuration(itemclick=True, itemdoubleclick=True):
         "y": -0.22,
         "yanchor": "top",
         "traceorder": "normal",
-        "orientation": "v",
+        "orientation": "h",
         "font": {"size": CHART_LABEL_FONT_SIZE},
         "itemclick": "toggle" if itemclick else False,
         "itemdoubleclick": "toggle" if itemdoubleclick else False,

{gov_uk_dashboards-15.2.1 → gov_uk_dashboards-16.1.0}/gov_uk_dashboards/components/plotly/stacked_barchart.py

@@ -13,6 +13,7 @@ from gov_uk_dashboards.constants import (
     DATE_VALID,
     FINANCIAL_YEAR_ENDING,
     HOVER_TEXT_HEADERS,
+    LEGEND_SPACING,
     MAIN_TITLE,
     MEASURE,
     SUBTITLE,
@@ -157,7 +158,7 @@ class StackedBarChart:
                     customdata=self._get_custom_data(self.line_trace_name, df),
                     mode="lines",
                     line={"color": colour, "width": 3},
-                    name=self.line_trace_name,
+                    name=self.line_trace_name + LEGEND_SPACING,
                     hovertemplate=self._get_hover_template(self.line_trace_name),
                     legendrank=99999,  # a high number to ensure it is bottom of the legend
                 )
@@ -214,7 +215,7 @@ class StackedBarChart:
         return go.Bar(
             x=df[self.x_axis_column],
             y=df[self.y_axis_column],
-            name=trace_name,
+            name=trace_name + LEGEND_SPACING,
             hovertemplate=[
                 self._get_hover_template(trace_name) for i in range(df.shape[0])
             ],

{gov_uk_dashboards-15.2.1 → gov_uk_dashboards-16.1.0}/gov_uk_dashboards/components/plotly/time_series_chart.py

@@ -12,8 +12,8 @@ from gov_uk_dashboards.constants import (
     CHART_LABEL_FONT_SIZE,
     CUSTOM_DATA,
     DATE_VALID,
-    FILL_TO_PREVIOUS_TRACE,
     HOVER_TEXT_HEADERS,
+    LEGEND_SPACING,
     MAIN_TITLE,
     REMOVE_INITIAL_MARKER,
     SUBTITLE,
@@ -66,15 +66,18 @@ class TimeSeriesChart:
         trace_name_column: Optional[str] = None,
         xaxis_tick_text_format: XAxisFormat = XAxisFormat.YEAR.value,
         verticle_line_x_value_and_name: tuple = None,
-        last_2_traces_filled=False,
+        filled_traces_dict: dict[str] = None,
         trace_names_to_prevent_hover_of_first_point_list=None,
         x_axis_column=DATE_VALID,
         x_unified_hovermode: Optional[bool] = False,
         x_hoverformat: Optional[str] = None,
+        x_unified_hovertemplate: Optional[str] = None,
         x_axis_title: Optional[str] = None,
         download_chart_button_id: Optional[str] = None,
         download_data_button_id: Optional[str] = None,
         number_of_traces_colour_shift_dict: Optional[dict] = None,
+        additional_line: Optional[dict] = None,
+        hover_distance: Optional[int] = 1,
     ):
         self.title_data = title_data
         self.y_axis_column = y_column
@@ -88,18 +91,21 @@ class TimeSeriesChart:
         self.trace_name_column = trace_name_column
         self.xaxis_tick_text_format = xaxis_tick_text_format
         self.verticle_line_x_value_and_name = verticle_line_x_value_and_name
-        self.last_2_traces_filled = last_2_traces_filled
+        self.filled_traces_dict = filled_traces_dict
         self.trace_names_to_prevent_hover_of_first_point = (
             trace_names_to_prevent_hover_of_first_point_list
         )
         self.x_axis_column = x_axis_column
         self.x_unified_hovermode = x_unified_hovermode
         self.x_hoverformat = x_hoverformat
+        self.x_unified_hovertemplate = x_unified_hovertemplate
         self.x_axis_title = x_axis_title
         self.download_chart_button_id = download_chart_button_id
         self.download_data_button_id = download_data_button_id
         self.markers = ["square", "diamond", "circle", "triangle-up"]
         self.number_of_traces_colour_shift_dict = number_of_traces_colour_shift_dict
+        self.additional_line = additional_line
+        self.hover_distance = hover_distance
         self.colour_list = self._get_colour_list()
         self.fig = self.create_time_series_chart()
 
@@ -136,7 +142,24 @@ class TimeSeriesChart:
             )
 
         fig = go.Figure()
-        for i, (df, trace_name, colour, marker) in enumerate(
+        if self.additional_line:
+            x_0 = self.additional_line["x0"]
+            y_0 = self.additional_line["y0"]
+            x_1 = self.additional_line["x1"]
+            y_1 = self.additional_line["y1"]
+            line_color = self.additional_line["color"]
+            trace_connector = go.Scatter(
+                x=[x_0, x_1],
+                y=[y_0, y_1],
+                mode="lines",
+                name="Transition",
+                line={"color": line_color},
+                hoverinfo="skip",  # 👈 This line disables hover for this trace
+                showlegend=False,  # Optional: hide it from legend too
+            )
+            fig.add_trace(trace_connector)
+        # pylint: disable=unused-variable
+        for i, (df, trace_name, colour, marker,) in enumerate(
             zip(
                 self._get_df_list_for_time_series(),
                 self.trace_name_list,
@@ -144,11 +167,6 @@ class TimeSeriesChart:
                 self.markers,
             )
         ):
-            is_last = is_second_last = False
-            if self.last_2_traces_filled is True:
-                number_of_traces = len(self._get_df_list_for_time_series())
-                is_last = i == number_of_traces - 1
-                is_second_last = i == number_of_traces - 2
             if REMOVE_INITIAL_MARKER in df.columns and True in df.get_column(
                 REMOVE_INITIAL_MARKER
             ):
@@ -159,27 +177,61 @@ class TimeSeriesChart:
                 self.create_time_series_trace(
                     df.sort(self.x_axis_column),
                     trace_name,
-                    (
-                        {"width": 0}
-                        if is_last or is_second_last
-                        else {"dash": "solid", "color": colour}
-                    ),
-                    fill=(
-                        "tonexty"
-                        if FILL_TO_PREVIOUS_TRACE in df.columns
-                        and True in df.get_column(FILL_TO_PREVIOUS_TRACE)
-                        else None
-                    ),
-                    hover_label=(
-                        {"bgcolor": AFAccessibleColours.TURQUOISE.value}
-                        if is_last or is_second_last
-                        else None
-                    ),
-                    marker=(
-                        {"opacity": 0}
-                        if is_last or is_second_last
-                        else {"symbol": marker, "size": marker_sizes, "opacity": 1}
+                    line_style={"dash": "solid", "color": colour},
+                    marker={"symbol": marker, "size": marker_sizes, "opacity": 1},
+                ),
+            )
+
+        if self.filled_traces_dict:
+            fill_df = self.filtered_df.filter(
+                pl.col(self.trace_name_column).is_in(
+                    [
+                        self.filled_traces_dict["upper"],
+                        self.filled_traces_dict["lower"],
+                    ]
+                )
+            ).sort(self.x_axis_column)
+            x_series = fill_df[self.x_axis_column].unique().sort().to_list()
+            upper_trace = self.filled_traces_dict["upper"]
+            lower_trace = self.filled_traces_dict["lower"]
+            y_upper = fill_df.filter(pl.col(self.trace_name_column) == upper_trace)[
+                self.y_axis_column
+            ].to_list()
+            y_lower = fill_df.filter(pl.col(self.trace_name_column) == lower_trace)[
+                self.y_axis_column
+            ].to_list()
+            y_upper_formatted_value = fill_df.filter(
+                pl.col(self.trace_name_column) == upper_trace
+            )["FORMATTED_VALUE"].to_list()
+            y_lower_formatted_value = fill_df.filter(
+                pl.col(self.trace_name_column) == lower_trace
+            )["FORMATTED_VALUE"].to_list()
+            formatted_dates = fill_df.filter(
+                pl.col(self.trace_name_column) == upper_trace
+            )["FORMATTED_DATE"].to_list()
+            hover_text = [
+                f"{self.filled_traces_dict['name']} - {date}: "
+                f"{low_value} - {high_value}<extra></extra>"
+                for low_value, high_value, date in zip(
+                    y_lower_formatted_value,
+                    y_upper_formatted_value,
+                    formatted_dates,
+                )
+            ]
+
+            hover_text_full = hover_text + hover_text[::-1]
+            fig.add_trace(
+                go.Scatter(
+                    x=x_series + x_series[::-1],
+                    y=y_upper + y_lower[::-1],
+                    fill="toself",
+                    fillcolor=get_rgba_from_hex_colour_and_alpha(
+                        AFAccessibleColours.TURQUOISE.value, alpha=0.2
                     ),
+                    line={"color": "rgba(255,255,255,0)"},
+                    name=self.filled_traces_dict["name"] + LEGEND_SPACING,
+                    hovertemplate=hover_text_full,
+                    hoveron="points",
                 )
             )
         self._format_x_axis(fig)
@@ -232,10 +284,10 @@ class TimeSeriesChart:
                 xref="x domain",
                 yref="y domain",
                 x=1,
-                y=-0.25,
+                y=-0.2,
                 text=self.x_axis_title,
                 showarrow=False,
-                font={"size": CHART_LABEL_FONT_SIZE},
+                font={"size": 16},
             )
 
         fig.update_layout(
@@ -243,7 +295,7 @@ class TimeSeriesChart:
             font={"size": CHART_LABEL_FONT_SIZE},
             yaxis_tickformat=",",
             hovermode="x unified" if self.x_unified_hovermode is True else "closest",
-            hoverdistance=100,  # Increase distance to simulate hover 'always on'
+            hoverdistance=self.hover_distance,  # Increase distance to simulate hover 'always on'
         )
         return fig
 
@@ -264,8 +316,6 @@ class TimeSeriesChart:
         df: pl.DataFrame,
         trace_name: str,
         line_style: dict[str, str],
-        fill: str,
-        hover_label: dict[str, str],
         marker: dict[str, str],
     ):
         """Creates a trace for the plot.
@@ -275,27 +325,17 @@ class TimeSeriesChart:
             y_value column and columns defined in self.hover_data[CUSTOM_DATA].
             trace_name (str): Name of trace.
             line_style (dict[str, str]): Properties for line_style parameter.
-            fill (str): Properties for fill parameter.
-            hover_label (dict[str,str]): Properties for hoverlabel parameter.
             marker (dict[str,str]): Properties for marker parameter.
         """
         return go.Scatter(
             x=df[self.x_axis_column],
             y=df[self.y_axis_column],
             line=line_style,
-            name=self._get_trace_name(trace_name),
+            name=self._get_trace_name(trace_name) + LEGEND_SPACING,
             hovertemplate=self._get_hover_template(df, trace_name),
             customdata=self._get_custom_data(df, trace_name),
             marker=marker,
-            fill=fill,
-            hoverlabel=hover_label,
-            fillcolor=(
-                get_rgba_from_hex_colour_and_alpha(
-                    AFAccessibleColours.TURQUOISE.value, alpha=0.2
-                )
-                if fill
-                else None
-            ),
+            hoverlabel=None,
             showlegend=(
                 trace_name in self.legend_dict if self.legend_dict is not None else True
             ),
@@ -315,7 +355,10 @@ class TimeSeriesChart:
 
     def _get_custom_hover_template(self, i, df, trace_name):
         if self.x_unified_hovermode is True:
+            if self.x_unified_hovertemplate is not None:
+                return self.x_unified_hovertemplate.format(trace_name=trace_name)
             return f"{trace_name}: " + "%{customdata[0]}<extra></extra>"
+
         hover_text_headers = self.hover_data[trace_name][HOVER_TEXT_HEADERS]
         if (
             self.hover_data_for_traces_with_different_hover_for_last_point is not None
@@ -494,7 +537,7 @@ class TimeSeriesChart:
     def _get_colour_list(self):
         """Returns a list of colours."""
         number_of_traces = len(self.trace_name_list)
-        if number_of_traces == 2:
+        if number_of_traces == 2 and self.filled_traces_dict is None:
             colour_list = [
                 AFAccessibleColours.DARK_BLUE.value,
                 AFAccessibleColours.ORANGE.value,

{gov_uk_dashboards-15.2.1 → gov_uk_dashboards-16.1.0}/gov_uk_dashboards/constants.py

@@ -13,5 +13,8 @@ FILL_TO_PREVIOUS_TRACE = "Fill to previous trace"
 REMOVE_INITIAL_MARKER = "Remove initial marker"
 YEAR = "Year"
 
+
 UNIT_SIZE = "Unit size"
 DEFAULT_COLOURSCALE = "tealgrn"
+
+LEGEND_SPACING = "\u00A0" * 5

{gov_uk_dashboards-15.2.1 → gov_uk_dashboards-16.1.0/gov_uk_dashboards.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 15.2.1
+Version: 16.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-15.2.1 → gov_uk_dashboards-16.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="15.2.1",
+    version="16.1.0",
     long_description=long_description,
     long_description_content_type="text/markdown",
     packages=find_packages(),