gov-uk-dashboards 16.0.0__tar.gz → 16.2.0__tar.gz

{gov_uk_dashboards-16.0.0/gov_uk_dashboards.egg-info → gov_uk_dashboards-16.2.0}/PKG-INFO

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

@@ -20,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-16.0.0 → gov_uk_dashboards-16.2.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-16.0.0 → gov_uk_dashboards-16.2.0}/gov_uk_dashboards/components/plotly/time_series_chart.py

@@ -13,6 +13,7 @@ from gov_uk_dashboards.constants import (
     CUSTOM_DATA,
     DATE_VALID,
     HOVER_TEXT_HEADERS,
+    LEGEND_SPACING,
     MAIN_TITLE,
     REMOVE_INITIAL_MARKER,
     SUBTITLE,
@@ -76,6 +77,7 @@ class TimeSeriesChart:
         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
@@ -103,6 +105,7 @@ class TimeSeriesChart:
         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()
 
@@ -153,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
@@ -170,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,
                 ),
             )
 
@@ -217,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],
@@ -226,9 +233,10 @@ class TimeSeriesChart:
                         AFAccessibleColours.TURQUOISE.value, alpha=0.2
                     ),
                     line={"color": "rgba(255,255,255,0)"},
-                    name=self.filled_traces_dict["name"],
+                    name=self.filled_traces_dict["name"] + LEGEND_SPACING,
                     hovertemplate=hover_text_full,
                     hoveron="points",
+                    legendgroup=legendgroup,
                 )
             )
         self._format_x_axis(fig)
@@ -281,10 +289,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(
@@ -292,10 +300,18 @@ class TimeSeriesChart:
             font={"size": CHART_LABEL_FONT_SIZE},
             yaxis_tickformat=",",
             hovermode="x unified" if self.x_unified_hovermode is True else "closest",
-            hoverdistance=1,  # Increase distance to simulate hover 'always on'
+            hoverdistance=self.hover_distance,  # Increase distance to simulate hover 'always on'
         )
         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()
@@ -314,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.
 
@@ -323,12 +340,13 @@ 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],
             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,
@@ -336,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.0.0 → gov_uk_dashboards-16.2.0}/gov_uk_dashboards/constants.py

@@ -16,3 +16,5 @@ YEAR = "Year"
 
 UNIT_SIZE = "Unit size"
 DEFAULT_COLOURSCALE = "tealgrn"
+
+LEGEND_SPACING = "\u00A0" * 5

{gov_uk_dashboards-16.0.0 → gov_uk_dashboards-16.2.0/gov_uk_dashboards.egg-info}/PKG-INFO

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