gov-uk-dashboards 15.2.1__py3-none-any.whl → 16.0.0__py3-none-any.whl

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):

gov_uk_dashboards/components/plotly/time_series_chart.py

@@ -12,7 +12,6 @@ from gov_uk_dashboards.constants import (
     CHART_LABEL_FONT_SIZE,
     CUSTOM_DATA,
     DATE_VALID,
-    FILL_TO_PREVIOUS_TRACE,
     HOVER_TEXT_HEADERS,
     MAIN_TITLE,
     REMOVE_INITIAL_MARKER,
@@ -66,15 +65,17 @@ 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,
     ):
         self.title_data = title_data
         self.y_axis_column = y_column
@@ -88,18 +89,20 @@ 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.colour_list = self._get_colour_list()
         self.fig = self.create_time_series_chart()
 
@@ -136,7 +139,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 +164,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 +174,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"],
+                    hovertemplate=hover_text_full,
+                    hoveron="points",
                 )
             )
         self._format_x_axis(fig)
@@ -243,7 +292,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=1,  # Increase distance to simulate hover 'always on'
         )
         return fig
 
@@ -264,8 +313,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,8 +322,6 @@ 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(
@@ -287,15 +332,7 @@ class TimeSeriesChart:
             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 +352,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 +534,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/constants.py

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

{gov_uk_dashboards-15.2.1.dist-info → gov_uk_dashboards-16.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 15.2.1
+Version: 16.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-15.2.1.dist-info → gov_uk_dashboards-16.0.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 gov_uk_dashboards/__init__.py,sha256=4y4hozrL4hzRUna8b22UQwtkZcvvCgeXsAtA6AJww8g,1299
 gov_uk_dashboards/axes.py,sha256=Oh8zyWzxwZWq8bQl-vJoXwTANZ7ACZiYPmIXlM62Fvk,712
 gov_uk_dashboards/colours.py,sha256=MezFI_3hgEuZ7f8F5TdtgaQO00B3G7ylRTCVq3SlSF4,2371
-gov_uk_dashboards/constants.py,sha256=s4HzMHtIAu10n-uhqPL-jUi8rbffEb0tjF9COGM7Uls,479
+gov_uk_dashboards/constants.py,sha256=o29g1rKeZ7ZZi-cKpmFtiTU6QBK6wm0PGHKVPn1rPFw,480
 gov_uk_dashboards/symbols.py,sha256=6_lq8yl1l7sGUlOY29wip_PXeUUoM53_fakKY1omVwY,424
 gov_uk_dashboards/template.html,sha256=uFAki9bEpcei5dP_NZYP8dsxpxXpNIDQPn7ezsE7VXc,498
 gov_uk_dashboards/template.py,sha256=WNVkAW3LCNoUHcxQ1kiUPkGCKIan5DgZQaAA_ZbE5WA,534
@@ -72,14 +72,14 @@ gov_uk_dashboards/components/dash/warning_text.py,sha256=31XvPUINt2QsWIaaMnqEvn2
 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=7Z52uZGrs15Q31OJjztnF0iqA5VRUrfJB_nPy6aZMMc,3060
 gov_uk_dashboards/components/helpers/generate_dash_graph_from_figure.py,sha256=sdhC6Mjfw6kqs1MDRDoMuOt8dNS9Bl1WEoJX9S5AssA,1813
-gov_uk_dashboards/components/helpers/plotting_helper_functions.py,sha256=ZyO0hYcSJqhjuLnhEgSWpKT9v2uD0thAbSSUYe10_k8,1644
+gov_uk_dashboards/components/helpers/plotting_helper_functions.py,sha256=8OMplDZSc0yPI6KjcHzBsV1hA35I6b09fKCiByfAFtY,1635
 gov_uk_dashboards/components/helpers/update_layout_bgcolor_margin.py,sha256=i7Nwp0CxFpkyQeR8KfOBVMBkzctG7hMpWI2OzgxB2jY,740
 gov_uk_dashboards/components/plotly/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 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=y2XOf96tMfy5ythPb5RzqW5qGc2sKU3W508UbWO2iC0,12175
-gov_uk_dashboards/components/plotly/time_series_chart.py,sha256=ZwD61uCvQz1D4zD8kvG-CZvNNh8UIjhBCZuYu3Sczo8,19961
+gov_uk_dashboards/components/plotly/time_series_chart.py,sha256=Hqs4LW99ymUIVQvkQZtYRAiPZpEBa84Z9Jjpz_p12VU,21900
 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
@@ -100,8 +100,8 @@ gov_uk_dashboards/lib/dap/dap_deployment.py,sha256=ZXixeOAtRNjMsPdGKLwwLNamlo0mi
 gov_uk_dashboards/lib/dap/get_dataframe_from_cds.py,sha256=OiusRCgYnkBjK_GZgYLGzNrxOGizYt8CgThiWRCVKK0,3921
 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-15.2.1.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
-gov_uk_dashboards-15.2.1.dist-info/METADATA,sha256=v-9s8m75_YYPvDFN7C9L65oG0IjLRvtOm8GxfYIy-DE,5917
-gov_uk_dashboards-15.2.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-gov_uk_dashboards-15.2.1.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
-gov_uk_dashboards-15.2.1.dist-info/RECORD,,
+gov_uk_dashboards-16.0.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
+gov_uk_dashboards-16.0.0.dist-info/METADATA,sha256=0ftn3jstpqyF2k913ym1UarZusc0cteZjJgOcVgW3YE,5917
+gov_uk_dashboards-16.0.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+gov_uk_dashboards-16.0.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
+gov_uk_dashboards-16.0.0.dist-info/RECORD,,