gov-uk-dashboards 17.1.0__py3-none-any.whl → 17.2.0__py3-none-any.whl

gov_uk_dashboards/components/leaflet/leaflet_choropleth_map.py

@@ -1,10 +1,14 @@
 """Leaflet choropleth map class"""
 
+from typing import Optional
 from dash_extensions.javascript import arrow_function, Namespace
 import dash_leaflet as dl
 from dash import html
 import polars as pl
 
+from gov_uk_dashboards.components.helpers.display_chart_or_table_with_header import (
+    display_chart_or_table_with_header,
+)
 from gov_uk_dashboards.formatting.number_formatting import (
     format_number_into_thousands_or_millions,
 )
@@ -18,18 +22,31 @@ class LeafletChoroplethMap:
     discrete"""
 
     # pylint: disable=too-few-public-methods
+    # pylint: disable=too-many-instance-attributes
+    # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-positional-arguments
 
     def __init__(
         self,
-        get_geojson_function,
-        get_df_function,
-        hover_text_columns,
-        color_scale_is_discrete=True,
+        geojson: dict,
+        df: pl.DataFrame,
+        hover_text_columns: list[str],
+        title: str,
+        subtitle: Optional[str] = None,
+        download_chart_button_id: Optional[str] = None,
+        download_data_button_id: Optional[str] = None,
+        color_scale_is_discrete: bool = True,
+        show_tile_layer: bool = False,
     ):
-        self.geojson_data = get_geojson_function()
-        self.df = get_df_function()
+        self.geojson_data = geojson
+        self.df = df
         self.hover_text_columns = hover_text_columns
+        self.title = title
+        self.subtitle = subtitle
+        self.download_chart_button_id = download_chart_button_id
+        self.download_data_button_id = download_data_button_id
         self.color_scale_is_discrete = color_scale_is_discrete
+        self.show_tile_layer = show_tile_layer
         self._add_data_to_geojson()
 
     def get_leaflet_choropleth_map(self):
@@ -38,9 +55,9 @@ class LeafletChoroplethMap:
         Returns:
             dl.Map: A dash leaflet map chart.
         """
-        return dl.Map(
+        choropleth_map = dl.Map(
             children=[
-                dl.TileLayer(),
+                dl.TileLayer() if self.show_tile_layer else None,
                 self._get_colorbar(),
                 self._get_colorbar_title(),
                 self._get_dl_geojson(),
@@ -58,6 +75,13 @@ class LeafletChoroplethMap:
             attributionControl=False,
             style={"width": "100%", "height": "800px", "background": "white"},
         )
+        return display_chart_or_table_with_header(
+            choropleth_map,
+            self.title,
+            self.subtitle,
+            self.download_chart_button_id,
+            self.download_data_button_id,
+        )
 
     def _add_data_to_geojson(self):
         info_map = {
@@ -93,7 +117,12 @@ class LeafletChoroplethMap:
     def _get_dl_geojson(self):
         style_handle = self._get_style_handle()
         colorscale = self._get_colorscale()
-        style = {"weight": 2, "opacity": 1, "color": "white", "fillOpacity": 1}
+        style = {
+            "weight": 2,
+            "opacity": 1,
+            "color": "white",
+            "fillOpacity": 0.7 if self.show_tile_layer else 1,
+        }
         hover_style = arrow_function({"weight": 5, "color": "#666", "dashArray": ""})
         return dl.GeoJSON(
             data=self.geojson_data,

{gov_uk_dashboards-17.1.0.dist-info → gov_uk_dashboards-17.2.0.dist-info}/METADATA

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

@@ -75,7 +75,7 @@ gov_uk_dashboards/components/helpers/get_chart_for_download.py,sha256=RS5SR2tCQP
 gov_uk_dashboards/components/helpers/plotting_helper_functions.py,sha256=moD2tse2FqTBW2rOHOvZCL9BIlmDbyvU5233yFFu_aI,1635
 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
-gov_uk_dashboards/components/leaflet/leaflet_choropleth_map.py,sha256=4ysc-FxRKGPSkNuJBDtjlEOGthC7EuIliaillqX2GeI,6221
+gov_uk_dashboards/components/leaflet/leaflet_choropleth_map.py,sha256=UFLRIr2j_GTap3MzL89DUjpdnKf7OI_kaw91VeF0ztI,7310
 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
@@ -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=JYDpWObBsiKG5Rtk2ElOTgHwfIR0cRmVocr8RlTfPZQ,534
 gov_uk_dashboards/lib/download_functions/download_csv_with_headers.py,sha256=h50ejODCjoz9z-yqDt6nsE6jN6XxJN1DWH66CjLJiCk,4155
-gov_uk_dashboards-17.1.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
-gov_uk_dashboards-17.1.0.dist-info/METADATA,sha256=6wQUDbkJ1690nFpTKm5XfCPwIDhvWGgXONm6bI8xoA8,5917
-gov_uk_dashboards-17.1.0.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
-gov_uk_dashboards-17.1.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
-gov_uk_dashboards-17.1.0.dist-info/RECORD,,
+gov_uk_dashboards-17.2.0.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
+gov_uk_dashboards-17.2.0.dist-info/METADATA,sha256=XZrUEgGdjxi9hrX_3QcyRXoYCVJmYGxz0ZgtpQOHJ2Y,5917
+gov_uk_dashboards-17.2.0.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
+gov_uk_dashboards-17.2.0.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
+gov_uk_dashboards-17.2.0.dist-info/RECORD,,