gov-uk-dashboards 17.1.0__tar.gz → 18.0.0__tar.gz

{gov_uk_dashboards-17.1.0/gov_uk_dashboards.egg-info → gov_uk_dashboards-18.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 17.1.0
+Version: 18.0.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 → gov_uk_dashboards-18.0.0}/gov_uk_dashboards/assets/custom_map_style_functions.js

@@ -35,6 +35,35 @@ window.myNamespace = Object.assign({}, window.myNamespace, {
             const local_t = (t * n) - idx;
             const fillColor = interpolateColor(colors[idx], colors[idx + 1], local_t);
 
+            return {
+                ...style,
+                fillColor: fillColor
+            };
+        },
+        discreteColorScale: function(feature, context) {
+            const {
+                colorscale,  // e.g., ["#d7191c", "#fdae61", "#abdda4", "#2b83ba"]
+                colorProp,   // e.g., "category"
+                style,
+                min          // e.g., 1
+            } = context.hideout;
+        
+            const value = feature.properties[colorProp];
+            const colors = Array.from(colorscale); // ensure no mutation
+        
+            if (value === null || value === undefined) {
+                return {
+                    ...style,
+                    fillColor: "#b1b4b6"  // default gray
+                };
+            }
+        
+            // Convert value to zero-based index
+            const idx = value - min;
+        
+            // Defensive check
+            const fillColor = colors[idx] || "#b1b4b6";
+        
             return {
                 ...style,
                 fillColor: fillColor

{gov_uk_dashboards-17.1.0 → gov_uk_dashboards-18.0.0}/gov_uk_dashboards/assets/dashboard.css

@@ -9347,4 +9347,8 @@ mark.expenditure {
 
 .font-weight-normal-override {
   font-weight: normal !important;
+}
+
+.leaflet-interactive:focus {
+  outline: none !important;
 }

{gov_uk_dashboards-17.1.0 → gov_uk_dashboards-18.0.0}/gov_uk_dashboards/components/leaflet/leaflet_choropleth_map.py

@@ -1,10 +1,15 @@
 """Leaflet choropleth map class"""
 
+from typing import Optional
 from dash_extensions.javascript import arrow_function, Namespace
 import dash_leaflet as dl
+import dash_leaflet.express as dlx
 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 +23,39 @@ 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],
+        column_to_plot: str,
+        legend_column: str,
+        area_column: str,
+        title: str,
+        subtitle: Optional[str] = None,
+        enable_zoom: bool = True,
+        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.column_to_plot = column_to_plot
+        self.legend_column = legend_column
+        self.area_column = area_column
+        self.title = title
+        self.subtitle = subtitle
+        self.enable_zoom = enable_zoom
+        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 +64,17 @@ class LeafletChoroplethMap:
         Returns:
             dl.Map: A dash leaflet map chart.
         """
-        return dl.Map(
+        disabled_zoom_controls = {
+            "scrollWheelZoom": False,
+            "dragging": False,
+            "zoomControl": False,
+            "doubleClickZoom": False,
+            "touchZoom": False,
+        }
+        zoom_controls = {} if self.enable_zoom else disabled_zoom_controls
+        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(),
@@ -48,22 +82,25 @@ class LeafletChoroplethMap:
             center=[54.5, -2.5],  # Centered on the UK
             zoom=6.5,
             minZoom=6.5,
-            maxZoom=6.5,
+            maxZoom=10 if self.enable_zoom else 6.5,
             maxBounds=[[49.8, -10], [55.9, 1.8]],
-            scrollWheelZoom=False,  # Disable zooming via mouse scroll
-            dragging=False,  # Optional: prevent dragging too if you want
-            zoomControl=False,  # Hide the zoom buttons (+/-)
-            doubleClickZoom=False,  # Prevent double click zoom
-            touchZoom=False,  # Prevent pinch zoom
+            **zoom_controls,
             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 = {
             row["Area_Code"]: {
-                "value": row["Value"],
-                "region": row["Region"],
+                "value": row[self.column_to_plot],
+                "area": row[self.area_column],
                 **{col: row[col] for col in self.hover_text_columns},
             }
             for row in self.df.iter_rows(named=True)
@@ -75,9 +112,9 @@ class LeafletChoroplethMap:
             if info:
 
                 feature["properties"]["density"] = info["value"]
-                feature["properties"]["region"] = info["region"]
+                feature["properties"]["area"] = info["area"]
 
-                tooltip_parts = [f"<b>{info['region']}</b>"]
+                tooltip_parts = [f"<b>{info['area']}</b>"]
                 if info["value"] is None:
                     tooltip_parts.append("<br>No data available")
                 else:
@@ -87,13 +124,18 @@ class LeafletChoroplethMap:
                 feature["properties"]["tooltip"] = "".join(tooltip_parts)
             else:
                 feature["properties"]["density"] = None
-                feature["properties"]["region"] = "Unknown"
+                feature["properties"]["area"] = "Unknown"
                 feature["properties"]["tooltip"] = "No data available"
 
     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,
@@ -106,26 +148,53 @@ class LeafletChoroplethMap:
                 "colorscale": colorscale,  # Use hex strings
                 "style": style,
                 "colorProp": "density",
-                "min": self.df["Value"].min(),
-                "max": self.df["Value"].max(),
+                "min": self.df[self.column_to_plot].min(),
+                "max": self.df[self.column_to_plot].max(),
             },
         )
 
     def _get_style_handle(self):
         ns = Namespace("myNamespace", "mapColorScaleFunctions")
         if self.color_scale_is_discrete:
-            return ""
+            return ns("discreteColorScale")
         return ns("continuousColorScale")
 
     def _get_colorscale(self):
         if self.color_scale_is_discrete:
-            return ""
+            discrete_colours = ["#217847", "#23BBBE", "#8CCE69", "#FFEA80"]
+            if len(self.df[self.column_to_plot].unique()) == 3:
+                discrete_colours.pop(1)
+            return discrete_colours
         return ["#B0F2BC", "#257D98"]
 
+    def _get_color_bar_categories(self):
+        return (
+            self.df.select([self.legend_column, self.column_to_plot])
+            .unique()
+            .sort(self.column_to_plot, descending=True)
+            .select(self.legend_column)
+            .to_series()
+            .to_list()
+        )
+
     def _get_colorbar(self):
-        min_value = self.df.select(pl.min("Value")).item()
+        if self.color_scale_is_discrete:
+            self._get_color_bar_categories()
+            return dlx.categorical_colorbar(
+                categories=self._get_color_bar_categories(),  # reversed order
+                colorscale=self._get_colorscale()[::-1],
+                width=30,
+                height=300,
+                position="topleft",
+                style={
+                    "padding": "6px",
+                    "backgroundColor": "white",
+                    "borderRadius": "4px",
+                },
+            )
+        min_value = self.df.select(pl.min(self.column_to_plot)).item()
         colorbar_min = min(min_value, 0)
-        max_value = self.df.select(pl.max("Value")).item()
+        max_value = self.df.select(pl.max(self.column_to_plot)).item()
         mid_value = (colorbar_min + max_value) / 2
         quarter_value = (colorbar_min + max_value) / 4
         three_quarter_value = 3 * (colorbar_min + max_value) / 4
@@ -158,6 +227,8 @@ class LeafletChoroplethMap:
         )
 
     def _get_colorbar_title(self):
+        if self.color_scale_is_discrete:
+            return None
         return html.Div(
             self.hover_text_columns[0],
             style={

{gov_uk_dashboards-17.1.0 → gov_uk_dashboards-18.0.0/gov_uk_dashboards.egg-info}/PKG-INFO

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