gov-uk-dashboards 15.1.0__tar.gz → 15.2.0__tar.gz

{gov_uk_dashboards-15.1.0/gov_uk_dashboards.egg-info → gov_uk_dashboards-15.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 15.1.0
+Version: 15.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-15.1.0 → gov_uk_dashboards-15.2.0}/gov_uk_dashboards/components/plotly/time_series_chart.py

@@ -69,6 +69,8 @@ class TimeSeriesChart:
         last_2_traces_filled=False,
         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_axis_title: Optional[str] = None,
         download_chart_button_id: Optional[str] = None,
         download_data_button_id: Optional[str] = None,
@@ -91,6 +93,8 @@ class TimeSeriesChart:
             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_axis_title = x_axis_title
         self.download_chart_button_id = download_chart_button_id
         self.download_data_button_id = download_data_button_id
@@ -125,6 +129,12 @@ class TimeSeriesChart:
         """generates a time series chart"""
         # pylint: disable=too-many-locals
         # pylint: disable=duplicate-code
+
+        if not self.x_unified_hovermode and self.x_hoverformat is not None:
+            raise ValueError(
+                "x_hoverformat can only be specified if x_unified_hovermode is True"
+            )
+
         fig = go.Figure()
         for i, (df, trace_name, colour, marker) in enumerate(
             zip(
@@ -232,6 +242,8 @@ class TimeSeriesChart:
             legend=get_legend_configuration(),
             font={"size": CHART_LABEL_FONT_SIZE},
             yaxis_tickformat=",",
+            hovermode="x unified" if self.x_unified_hovermode is True else "closest",
+            hoverdistance=1000,  # Increase distance to simulate hover 'always on'
         )
         return fig
 
@@ -244,6 +256,7 @@ class TimeSeriesChart:
             ticktext=tick_text,
             tickmode="array",
             range=range_x,
+            hoverformat=self.x_hoverformat,
         )
 
     def create_time_series_trace(
@@ -301,6 +314,8 @@ class TimeSeriesChart:
         ]
 
     def _get_custom_hover_template(self, i, df, trace_name):
+        if self.x_unified_hovermode is True:
+            return "%{customdata[0]}"
         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

{gov_uk_dashboards-15.1.0 → gov_uk_dashboards-15.2.0/gov_uk_dashboards.egg-info}/PKG-INFO

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