gov-uk-dashboards 17.0.0__tar.gz → 17.2.0__tar.gz

{gov_uk_dashboards-17.0.0/gov_uk_dashboards.egg-info → gov_uk_dashboards-17.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 17.0.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.2.0/gov_uk_dashboards/assets/custom_map_style_functions.js

@@ -0,0 +1,44 @@
+window.myNamespace = Object.assign({}, window.myNamespace, {  
+    mapColorScaleFunctions: {  
+        continuousColorScale: function(feature, context) {
+            const {
+                colorscale,
+                colorProp,
+                style,
+                min,
+                max
+            } = context.hideout;
+            const value = feature.properties[colorProp];
+            const colors = Array.from(colorscale); // defensive copy
+            if (value === null || value === undefined) {
+                return {
+                    ...style,
+                    fillColor: "#b1b4b6"
+                };
+            }
+            // Normalize value to 0-1
+            const t = (value - min) / (max - min);
+
+            // Helper: interpolate between two hex colors
+            function interpolateColor(color1, color2, t) {
+                const c1 = parseInt(color1.slice(1), 16);
+                const c2 = parseInt(color2.slice(1), 16);
+                const r = Math.round(((c2 >> 16) - (c1 >> 16)) * t + (c1 >> 16));
+                const g = Math.round((((c2 >> 8) & 0xFF) - ((c1 >> 8) & 0xFF)) * t + ((c1 >> 8) & 0xFF));
+                const b = Math.round(((c2 & 0xFF) - (c1 & 0xFF)) * t + (c1 & 0xFF));
+                return `rgb(${r},${g},${b})`;
+            }
+
+            // Find segment and interpolate
+            const n = colors.length - 1;
+            const idx = Math.min(Math.floor(t * n), n - 1);
+            const local_t = (t * n) - idx;
+            const fillColor = interpolateColor(colors[idx], colors[idx + 1], local_t);
+
+            return {
+                ...style,
+                fillColor: fillColor
+            };
+        }
+    }
+});

gov_uk_dashboards-17.2.0/gov_uk_dashboards/components/leaflet/leaflet_choropleth_map.py

@@ -0,0 +1,203 @@
+"""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,
+)
+
+
+class LeafletChoroplethMap:
+    """Class for  generating leaflet choropleth map charts.
+    Note: dataframe_function must contain columns: 'Region', 'Area_Code',
+    column_to_plot, hover_text_columns
+    If color_scale_is_discrete is false, colour scale will be continuous, otherwise it will be
+    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,
+        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 = 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):
+        """Creates and returns leaflet choropleth map chart for display on application.
+
+        Returns:
+            dl.Map: A dash leaflet map chart.
+        """
+        choropleth_map = dl.Map(
+            children=[
+                dl.TileLayer() if self.show_tile_layer else None,
+                self._get_colorbar(),
+                self._get_colorbar_title(),
+                self._get_dl_geojson(),
+            ],
+            center=[54.5, -2.5],  # Centered on the UK
+            zoom=6.5,
+            minZoom=6.5,
+            maxZoom=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
+            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"],
+                **{col: row[col] for col in self.hover_text_columns},
+            }
+            for row in self.df.iter_rows(named=True)
+        }
+
+        for feature in self.geojson_data["features"]:
+            region_code = feature["properties"]["geo_id"]
+            info = info_map.get(region_code)
+            if info:
+
+                feature["properties"]["density"] = info["value"]
+                feature["properties"]["region"] = info["region"]
+
+                tooltip_parts = [f"<b>{info['region']}</b>"]
+                if info["value"] is None:
+                    tooltip_parts.append("<br>No data available")
+                else:
+                    for col in self.hover_text_columns:
+                        tooltip_parts.append(f"<br>{col}: {info[col]}")
+
+                feature["properties"]["tooltip"] = "".join(tooltip_parts)
+            else:
+                feature["properties"]["density"] = None
+                feature["properties"]["region"] = "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": 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,
+            id="geojson",
+            zoomToBounds=True,
+            zoomToBoundsOnClick=True,
+            style=style_handle,
+            hoverStyle=hover_style,
+            hideout={
+                "colorscale": colorscale,  # Use hex strings
+                "style": style,
+                "colorProp": "density",
+                "min": self.df["Value"].min(),
+                "max": self.df["Value"].max(),
+            },
+        )
+
+    def _get_style_handle(self):
+        ns = Namespace("myNamespace", "mapColorScaleFunctions")
+        if self.color_scale_is_discrete:
+            return ""
+        return ns("continuousColorScale")
+
+    def _get_colorscale(self):
+        if self.color_scale_is_discrete:
+            return ""
+        return ["#B0F2BC", "#257D98"]
+
+    def _get_colorbar(self):
+        min_value = self.df.select(pl.min("Value")).item()
+        colorbar_min = min(min_value, 0)
+        max_value = self.df.select(pl.max("Value")).item()
+        mid_value = (colorbar_min + max_value) / 2
+        quarter_value = (colorbar_min + max_value) / 4
+        three_quarter_value = 3 * (colorbar_min + max_value) / 4
+        tick_values = [
+            colorbar_min,
+            quarter_value,
+            mid_value,
+            three_quarter_value,
+            max_value,
+        ]
+        tick_text = [
+            format_number_into_thousands_or_millions(x) for x in tick_values
+        ]  # Optional, for formatting
+
+        return dl.Colorbar(
+            colorscale=self._get_colorscale(),
+            width=20,
+            height=200,
+            min=colorbar_min,
+            max=max_value,
+            position="topleft",
+            style={
+                "backgroundColor": "white",
+                "padding": "5px",
+                "borderRadius": "4px",
+                "marginTop": "100px",
+            },
+            tickValues=tick_values,
+            tickText=tick_text,  # Optional, makes labels look cleaner
+        )
+
+    def _get_colorbar_title(self):
+        return html.Div(
+            self.hover_text_columns[0],
+            style={
+                "position": "absolute",
+                "bottom": "700px",  # Adjusted to place above the colorbar
+                "left": "10px",  # Align with the left side of the colorbar
+                "background": "white",
+                "padding": "2px 6px",
+                "borderRadius": "5px",
+                "fontWeight": "bold",
+                "fontSize": "14px",
+                "zIndex": "999",  # Ensure it appears above map elements
+            },
+        )

gov_uk_dashboards-17.2.0/gov_uk_dashboards/formatting/number_formatting.py

@@ -0,0 +1,24 @@
+"""Functions to add formatting to number values"""
+
+
+def format_number_into_thousands_or_millions(
+    number: int, thousand_decimal_places: int = 0
+) -> str:
+    """Format number into thousands or millions, eg. 1,500 becomes 1.5k & 1,234,567 becomes 1.235m
+
+    Args:
+        number (int): Integer to format.
+        thousand_decimal_places (int or str): The number of decimal places to display for
+            1_000<=number<1_000_000. Defaults to 0. If "default" is passed, number is simply
+            divided by 1_000.
+    """
+    if number >= 1_000_000:
+        formatted_number = f"{number / 1_000_000:.3f}m"
+    elif number >= 1_000:
+        if thousand_decimal_places == "default":
+            formatted_number = f"{number / 1_000}k"
+        else:
+            formatted_number = f"{number / 1_000:.{thousand_decimal_places}f}k"
+    else:
+        formatted_number = str(number)
+    return formatted_number

{gov_uk_dashboards-17.0.0 → gov_uk_dashboards-17.2.0/gov_uk_dashboards.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gov_uk_dashboards
-Version: 17.0.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.0.0 → gov_uk_dashboards-17.2.0}/gov_uk_dashboards.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ gov_uk_dashboards.egg-info/requires.txt
 gov_uk_dashboards.egg-info/top_level.txt
 gov_uk_dashboards/assets/__init__.py
 gov_uk_dashboards/assets/attach-event-to-dash.js
+gov_uk_dashboards/assets/custom_map_style_functions.js
 gov_uk_dashboards/assets/dashboard.css
 gov_uk_dashboards/assets/get_assets_folder.py
 gov_uk_dashboards/assets/govuk-frontend-3.14.0.min.js
@@ -82,6 +83,8 @@ gov_uk_dashboards/components/helpers/generate_dash_graph_from_figure.py
 gov_uk_dashboards/components/helpers/get_chart_for_download.py
 gov_uk_dashboards/components/helpers/plotting_helper_functions.py
 gov_uk_dashboards/components/helpers/update_layout_bgcolor_margin.py
+gov_uk_dashboards/components/leaflet/__init__.py
+gov_uk_dashboards/components/leaflet/leaflet_choropleth_map.py
 gov_uk_dashboards/components/plotly/__init__.py
 gov_uk_dashboards/components/plotly/captioned_figure.py
 gov_uk_dashboards/components/plotly/choropleth_map.py
@@ -97,6 +100,7 @@ gov_uk_dashboards/figures/styles/__init__.py
 gov_uk_dashboards/figures/styles/line_style.py
 gov_uk_dashboards/formatting/__init__.py
 gov_uk_dashboards/formatting/human_readable.py
+gov_uk_dashboards/formatting/number_formatting.py
 gov_uk_dashboards/formatting/round_and_add_prefix_and_suffix.py
 gov_uk_dashboards/formatting/rounding.py
 gov_uk_dashboards/lib/__init__.py

{gov_uk_dashboards-17.0.0 → gov_uk_dashboards-17.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="17.0.0",
+    version="17.2.0",
     long_description=long_description,
     long_description_content_type="text/markdown",
     packages=find_packages(),