gov-uk-dashboards 16.1.0__py3-none-any.whl → 16.2.0__py3-none-any.whl

gov_uk_dashboards/components/plotly/time_series_chart.py

@@ -156,6 +156,7 @@ class TimeSeriesChart:
                 line={"color": line_color},
                 hoverinfo="skip",  # 👈 This line disables hover for this trace
                 showlegend=False,  # Optional: hide it from legend too
+                legendgroup=self.additional_line["legend_group"],
             )
             fig.add_trace(trace_connector)
         # pylint: disable=unused-variable
@@ -173,12 +174,14 @@ class TimeSeriesChart:
                 marker_sizes = [0] + [12] * (len(df.with_row_count()) - 1)
             else:
                 marker_sizes = [12] * (len(df.with_row_count()))
+            legendgroup = self._get_legend_group(df)
             fig.add_trace(
                 self.create_time_series_trace(
                     df.sort(self.x_axis_column),
                     trace_name,
                     line_style={"dash": "solid", "color": colour},
                     marker={"symbol": marker, "size": marker_sizes, "opacity": 1},
+                    legendgroup=legendgroup,
                 ),
             )
 
@@ -220,6 +223,7 @@ class TimeSeriesChart:
             ]
 
             hover_text_full = hover_text + hover_text[::-1]
+            legendgroup = self._get_legend_group(fill_df)
             fig.add_trace(
                 go.Scatter(
                     x=x_series + x_series[::-1],
@@ -232,6 +236,7 @@ class TimeSeriesChart:
                     name=self.filled_traces_dict["name"] + LEGEND_SPACING,
                     hovertemplate=hover_text_full,
                     hoveron="points",
+                    legendgroup=legendgroup,
                 )
             )
         self._format_x_axis(fig)
@@ -299,6 +304,14 @@ class TimeSeriesChart:
         )
         return fig
 
+    def _get_legend_group(self, df):
+        if "legend_group" in df.columns and len(df) > 0:
+            value = df["legend_group"][0]
+            legendgroup = value if value is not None else None
+        else:
+            legendgroup = None
+        return legendgroup
+
     # pylint: disable=duplicate-code
     def _format_x_axis(self, fig):
         tick_text, tick_values, range_x = self._get_x_axis_content()
@@ -317,6 +330,7 @@ class TimeSeriesChart:
         trace_name: str,
         line_style: dict[str, str],
         marker: dict[str, str],
+        legendgroup: str,
     ):
         """Creates a trace for the plot.
 
@@ -326,6 +340,7 @@ class TimeSeriesChart:
             trace_name (str): Name of trace.
             line_style (dict[str, str]): Properties for line_style parameter.
             marker (dict[str,str]): Properties for marker parameter.
+            legendgroup (str): Name to group by in legend,
         """
         return go.Scatter(
             x=df[self.x_axis_column],
@@ -339,6 +354,7 @@ class TimeSeriesChart:
             showlegend=(
                 trace_name in self.legend_dict if self.legend_dict is not None else True
             ),
+            legendgroup=legendgroup,
         )
 
     def _get_hover_template(self, df, trace_name):

{gov_uk_dashboards-16.1.0.dist-info → gov_uk_dashboards-16.2.0.dist-info}/METADATA

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

@@ -79,7 +79,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=_81WlxelE5Gxozj80uYRIkQJLyv2i6xZr2T0g3db4ks,12229
-gov_uk_dashboards/components/plotly/time_series_chart.py,sha256=flZT0PfEaFftk6icS6GJ_iN8i3JR5mr9VbvDFfe2MBg,22040
+gov_uk_dashboards/components/plotly/time_series_chart.py,sha256=Z8p4oQ6ohiv7qaIVC6oDUEdVteryvIr7YuzQL0RpYyU,22701
 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-16.1.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
-gov_uk_dashboards-16.1.0.dist-info/METADATA,sha256=-9RYFzZ15FbJuBYvP_VQNbeCeJxvvxlq8DGYjllddt8,5917
-gov_uk_dashboards-16.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-gov_uk_dashboards-16.1.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
-gov_uk_dashboards-16.1.0.dist-info/RECORD,,
+gov_uk_dashboards-16.2.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
+gov_uk_dashboards-16.2.0.dist-info/METADATA,sha256=XWp4ZyTku_CZxzeDiuTCSLoaKUYREIvZO6olgDyxhZA,5917
+gov_uk_dashboards-16.2.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+gov_uk_dashboards-16.2.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
+gov_uk_dashboards-16.2.0.dist-info/RECORD,,