gov-uk-dashboards 21.0.0__py3-none-any.whl → 21.1.0__py3-none-any.whl

gov_uk_dashboards/components/helpers/get_chart_for_download.py

@@ -6,7 +6,7 @@ def get_chart_for_download(self, fig):
     """Returns a fig with title and subtitle for download as png"""
     main_title = self.title_data[MAIN_TITLE]
     subtitle = self.title_data[SUBTITLE]
-    footnote = self.footnote
+    footnote = getattr(self, "footnote", None)
 
     fig.update_layout(
         title={
@@ -29,6 +29,8 @@ def get_chart_for_download(self, fig):
                 "showarrow": False,
                 "align": "left",
             }
-        ],
+        ]
+        if footnote is not None
+        else [],
     )
     return fig

gov_uk_dashboards/components/plotly/stacked_barchart.py

@@ -60,9 +60,11 @@ class StackedBarChart:
         df: pl.DataFrame,
         trace_name_list: list[str],
         trace_name_column: Optional[str] = None,
+        initially_hidden_traces: Optional[list[str]] = None,
         xaxis_tick_text_format: XAxisFormat = XAxisFormat.YEAR.value,
         line_trace_name: Optional[str] = None,
         x_axis_column=DATE_VALID,
+        show_x_axis_title=False,
         x_unified_hovermode: Optional[bool] = False,
         hover_distance: Optional[int] = 1,
         download_chart_button_id: Optional[str] = None,
@@ -101,9 +103,11 @@ class StackedBarChart:
         self.df = df
         self.trace_name_list = trace_name_list
         self.trace_name_column = trace_name_column
+        self.initially_hidden_traces = initially_hidden_traces
         self.xaxis_tick_text_format = xaxis_tick_text_format
         self.line_trace_name = line_trace_name
         self.x_axis_column = x_axis_column
+        self.show_x_axis_title = show_x_axis_title
         self.x_unified_hovermode = x_unified_hovermode
         self.hover_distance = hover_distance
         self.download_chart_button_id = download_chart_button_id
@@ -253,6 +257,7 @@ class StackedBarChart:
             showlegend=True,
             barmode="relative",
             xaxis={"categoryorder": "category ascending"},
+            xaxis_title=self.x_axis_column if self.show_x_axis_title else None,
             ## copied from timeseries
             hovermode="x unified" if self.x_unified_hovermode is True else "closest",
             hoverdistance=self.hover_distance,  # Increase distance to simulate hover 'always on'
@@ -275,11 +280,19 @@ class StackedBarChart:
             hover_label (dict[str,str]): Properties for hoverlabel parameter.
             colour (str): Colour for bar.
         """
+        if (
+            self.initially_hidden_traces is not None
+            and trace_name in self.initially_hidden_traces
+        ):
+            visible = "legendonly"
+        else:
+            visible = True
 
         return go.Bar(
             x=df[self.x_axis_column],
             y=df[self.y_axis_column],
             name=trace_name + LEGEND_SPACING,
+            visible=visible,
             hovertemplate=[
                 self._get_hover_template(trace_name) for i in range(df.shape[0])
             ],

gov_uk_dashboards/formatting/human_readable.py

@@ -45,9 +45,25 @@ def format_as_human_readable(
         value = value_to_format / 1_000
         value_suffix = "k"
 
-    if decimal_places is not None:
-        value = round(value, decimal_places)
-    if value < 0:
+    # Handle negative numbers
+    is_negative = value < 0
+    if is_negative:
         prefix = f"-{prefix}"
         value = abs(value)
-    return f"{prefix}{value:g}{value_suffix}{suffix}"
+
+    if decimal_places is not None:
+        if decimal_places < 0:
+            # Round to significant digits when decimal_places is negative
+            magnitude = 10 ** (-decimal_places)
+            value = round(value / magnitude) * magnitude
+            formatted_value = (
+                f"{value:g}"  # Use general format to show significant digits
+            )
+        else:
+            # Round to the specified number of decimal places
+            value = round(value, decimal_places)
+            formatted_value = f"{value:.{decimal_places}f}"
+    else:
+        formatted_value = f"{value:g}"
+
+    return f"{prefix}{formatted_value}{value_suffix}{suffix}"

{gov_uk_dashboards-21.0.0.dist-info → gov_uk_dashboards-21.1.0.dist-info}/METADATA

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

@@ -71,7 +71,7 @@ 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=wDK8VUfaK4cfJDwafN_U1tf4R0kxzv9_V98vnXO-sio,3255
 gov_uk_dashboards/components/helpers/generate_dash_graph_from_figure.py,sha256=sdhC6Mjfw6kqs1MDRDoMuOt8dNS9Bl1WEoJX9S5AssA,1813
-gov_uk_dashboards/components/helpers/get_chart_for_download.py,sha256=EJGShQ9r9OePnfUAcRdlTFw3FDPFQp4jDCYcVJB94nI,1113
+gov_uk_dashboards/components/helpers/get_chart_for_download.py,sha256=I0IH7bE3B8UmdIHTn5tM26iGR6bfnB_fCfgnFQEIF4o,1179
 gov_uk_dashboards/components/helpers/plotting_helper_functions.py,sha256=WUif1mlSgWPuTZptBqaElWpJTlitmuiJofMTpOe_Bsg,1833
 gov_uk_dashboards/components/helpers/update_layout_bgcolor_margin.py,sha256=i7Nwp0CxFpkyQeR8KfOBVMBkzctG7hMpWI2OzgxB2jY,740
 gov_uk_dashboards/components/leaflet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -80,7 +80,7 @@ gov_uk_dashboards/components/plotly/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQ
 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=61VgvGJhFX7C4QAk-A8ZF6DTNjDvZ7uU3vof54H5km4,14187
+gov_uk_dashboards/components/plotly/stacked_barchart.py,sha256=AVX9w6_TlAXOkJVmQL_owd60AW5QXSrL4Jb2bwSMElE,14716
 gov_uk_dashboards/components/plotly/time_series_chart.py,sha256=6mfNPStKmP9T1OmKZtLg8NIWglLm5svggSDcEApKABU,24737
 gov_uk_dashboards/figures/__init__.py,sha256=_snQeNlM81nNKERl4gg9ScH2HYbtwaBjl8yQonccx34,712
 gov_uk_dashboards/figures/chart_data.py,sha256=fEsNkQFzXKIQ0h7aLBWq3J1qAxHbxvJeKU23JrVodVc,757
@@ -90,7 +90,7 @@ gov_uk_dashboards/figures/enums/dash_patterns.py,sha256=wEdjOe1UDx2u7tG8p4vN1000
 gov_uk_dashboards/figures/styles/__init__.py,sha256=wVa8BU0TvXnanksOUVWN4utFKW4OTLC5q-7J07rPE6Y,215
 gov_uk_dashboards/figures/styles/line_style.py,sha256=sXc9pGrAVxFrxqXSTsrw0hEgyhmhMOLhqhwx93J-PtI,559
 gov_uk_dashboards/formatting/__init__.py,sha256=bQk9_OEubUhuTRQjXUs4ZItgSY7yyDpwQcLauxf11Tk,460
-gov_uk_dashboards/formatting/human_readable.py,sha256=e-ROPS7oFLHCV58MXBIhLsZQut-F-bAYz0TOz33gX2M,1844
+gov_uk_dashboards/formatting/human_readable.py,sha256=o5-Xlbm7wP_4wU9mIdsG0ztU5aDEL4nZnJ-z5uA9QwI,2437
 gov_uk_dashboards/formatting/number_formatting.py,sha256=9LVqKqx0mMQyv8XLI_im1pdASZDJxRjzRWtRN-g6kPs,913
 gov_uk_dashboards/formatting/round_and_add_prefix_and_suffix.py,sha256=_DboRfdvwb9Y62H9LFDFJ0ju4626z-_oFuwagRgyZDY,1456
 gov_uk_dashboards/formatting/rounding.py,sha256=Em1yri_j18IYHbZ64d3bhVKX-XEllRSM9FzAUo1o6fU,968
@@ -106,8 +106,8 @@ gov_uk_dashboards/lib/datetime_functions/datetime_functions.py,sha256=BQgr8I_vFN
 gov_uk_dashboards/lib/download_functions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gov_uk_dashboards/lib/download_functions/convert_fig_to_image_and_download.py,sha256=-dkYbpTL6txftFfAZW-vfW_O9efb6Dse9WJ9MM6mAqw,534
 gov_uk_dashboards/lib/download_functions/download_csv_with_headers.py,sha256=uKMxKrdhaLj1c0ZWAmc02uu8PICjbn1fWt9YBw8FGnQ,4408
-gov_uk_dashboards-21.0.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
-gov_uk_dashboards-21.0.0.dist-info/METADATA,sha256=zejLJS9ttCDHYzULcE7TglrqfUNUz4Sfsh3hRsvt2Ok,5917
-gov_uk_dashboards-21.0.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-gov_uk_dashboards-21.0.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
-gov_uk_dashboards-21.0.0.dist-info/RECORD,,
+gov_uk_dashboards-21.1.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
+gov_uk_dashboards-21.1.0.dist-info/METADATA,sha256=9tniS5FEZhzGdIV4dZjeFYL4PjAD9fm3lRHYbb_4yJ0,5917
+gov_uk_dashboards-21.1.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+gov_uk_dashboards-21.1.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
+gov_uk_dashboards-21.1.0.dist-info/RECORD,,