gov-uk-dashboards 13.4.2__py3-none-any.whl → 13.5.1__py3-none-any.whl

gov_uk_dashboards/components/plotly/choropleth_map.py

@@ -3,6 +3,9 @@
 import polars as pl
 import plotly.graph_objects as go
 from dash import dcc
+
+from constants import DEFAULT_COLOURSCALE
+
 from gov_uk_dashboards import colours
 from gov_uk_dashboards.components.display_chart_or_table_with_header import (
     display_chart_or_table_with_header,
@@ -11,8 +14,10 @@ from gov_uk_dashboards.components.display_chart_or_table_with_header import (
 
 class ChoroplethMap:
     """Class for  generating choropleth map charts.
-    Note: dataframe_function must contain columns: 'Region', 'Area_Code', 'Local authority',
-    category_column, column_to_plot, custom_data"""
+    Note: dataframe_function must contain columns: 'Region', 'Area_Code',
+    discrete_category_column, column_to_plot, hover_data_list
+    If discrete_category_column & discrete_category_order are None,
+    the choropleth map will be a continuos one, otherwise discrete"""
 
     # pylint: disable=too-many-instance-attributes
     # pylint: disable=too-many-arguments
@@ -20,34 +25,42 @@ class ChoroplethMap:
     # pylint: disable=too-few-public-methods
     def __init__(
         self,
-        dataframe_function,
-        region,
-        get_geos_function,
-        category_column,
-        column_to_plot,
-        desired_category_order,
-        custom_data,
-        hover_header_list,
-        download_data_button_id,
-        legend_title_text=None,
+        map_name: str,  # used for the id in the choropleth map and the data download button
+        get_dataframe: callable,
+        get_geos: callable,
+        region: str,
+        area_focus_level: str,
+        column_to_plot: str,
+        hover_header_list: list[str],
+        hover_data_list: list[str],
+        discrete_category_column: str = None,
+        discrete_category_order: list[str] = None,
+        legend_title_text: str = None,
         **choropleth_properties,
     ):
-        self.dataframe = dataframe_function()
+        self.map_name = map_name
+        self.dataframe = get_dataframe()
+        self.geographic_boundaries = get_geos()
         self.region = region
-        self.geographic_boundaries = get_geos_function()
-        self.boundaries_by_area = self._get_boundaries_by_area(self.dataframe)
-        self.category_column = category_column
+        self.area_focus_level = area_focus_level
         self.column_to_plot = column_to_plot
-        self.df_dict = self._get_dataframe_dict_by_category()
-        self.desired_category_order = desired_category_order
-        self.colours_list = self._get_colour_list()
-        self.custom_data = custom_data
         self.hover_header_list = hover_header_list
-        self.download_data_button_id = download_data_button_id
+        self.hover_data_list = hover_data_list
+
+        self.discrete_category_column = discrete_category_column
         self.legend_title_text = legend_title_text
-        self.fig = go.Figure()
+        self.discrete_category_order = discrete_category_order
         self.choropleth_properties = choropleth_properties
 
+        self.fig = go.Figure()
+        self.discrete_map = (
+            self.discrete_category_column is not None
+            and self.discrete_category_order is not None
+        )
+        if self.discrete_map:
+            self.df_dict = self._get_dataframe_dict_by_category()
+            self.colours_list = self._get_colour_list()
+
     def get_choropleth_map(self):
         """Creates and returns choropleth map chart for display on application.
 
@@ -56,7 +69,7 @@ class ChoroplethMap:
         """
         self._update_fig()
         choropleth_map = dcc.Graph(
-            id="local-authority-choropleth",
+            id=f"{self.map_name}-choropleth",
             responsive=True,
             config={"topojsonURL": "/assets/topojson/", "displayModeBar": False},
             figure=self.fig,
@@ -66,7 +79,7 @@ class ChoroplethMap:
             },  # height hard-coded so that map always displays within tab
         )
         return display_chart_or_table_with_header(
-            choropleth_map, download_data_button_id=self.download_data_button_id
+            choropleth_map, download_data_button_id=self.map_name
         )
 
     def _update_fig(self):
@@ -75,61 +88,10 @@ class ChoroplethMap:
         self._crop_to_region()
         self._remove_background_map()
 
-    def _get_dataframe_dict_by_category(self):
-        if self.region is not None and self.region != "England":
-            self.dataframe = self.dataframe.filter(pl.col("Region") == self.region)
-        else:
-            self.dataframe = self.dataframe
-        grouped_dfs_dict_keys_as_tuples = self.dataframe.partition_by(
-            self.category_column, as_dict=True
-        )
-        grouped_dfs_dict = {
-            key[0]: value for key, value in grouped_dfs_dict_keys_as_tuples.items()
-        }
-        return grouped_dfs_dict
-
-    def _get_boundaries_by_area(self, dataframe):
-        las_to_display = dataframe["Area_Code"].to_list()
-        filtered_boundaries = {
-            key: (
-                value
-                if key != "features"
-                else [
-                    features
-                    for features in value
-                    if features["properties"]["geo_id"] in las_to_display
-                ]
-            )
-            for key, value in self.geographic_boundaries.items()
-        }
-        return filtered_boundaries
-
-    def _add_traces(self):
-        for count, category in enumerate(self.desired_category_order):
-            if category not in self.df_dict:
-                df = self._create_df_for_empty_trace(category)
-            else:
-                df = self.df_dict[category]
-            colour = self.colours_list[count % len(self.colours_list)]
-            self.fig.add_trace(
-                self._create_choropleth_trace(
-                    df,
-                    colour,
-                )
-            )
-
-    def _create_df_for_empty_trace(self, category):
-        """Method to create df where all columns are empty except for the category column to force
-        all legend items to always appear"""
-        columns = next(iter(self.df_dict.values())).columns
-        data = {col: [None] for col in columns}
-        data[self.category_column] = [category]
-        return pl.DataFrame(data)
-
     def _create_choropleth_trace(
         self,
         dataframe,
-        colour,
+        colourscale,
         column_to_plot=None,
         is_missing_data=False,
         marker=None,
@@ -151,6 +113,7 @@ class ChoroplethMap:
             hovertemplate = (
                 "<b>%{customdata[0]}</b><br>" + "%{hovertext}<extra></extra>"
             )
+
         return go.Choropleth(
             geojson=self.geographic_boundaries,
             featureidkey="properties.geo_id",
@@ -158,48 +121,79 @@ class ChoroplethMap:
             locationmode="geojson-id",
             z=dataframe[column_to_plot],
             hovertext=(
-                dataframe["Local authority"]
+                dataframe[self.area_focus_level]
                 if not is_missing_data
-                else ["No data available"] * len(dataframe["Local authority"])
+                else ["No data available"] * len(dataframe[self.area_focus_level])
             ),
             customdata=(
-                dataframe[self.custom_data]
+                dataframe[self.hover_data_list]
                 if not is_missing_data
-                else dataframe[["Local authority"]]
+                else dataframe[[self.area_focus_level]]
             ),
+            colorbar=self._get_color_bar(),
             hovertemplate=hovertemplate,
             marker=marker,
             marker_line_color=colours.GovUKColours.DARK_GREY.value,
-            showscale=False,
-            showlegend=True,
-            colorscale=[
-                [0, colour],
-                [1, colour],
-            ],  # dataframe is grouped by column_to_plot, hence only
-            # contains one value for column_to_plot- this ensures a discrete categorical colourscale
-            # for trace
-            name=(
-                dataframe[self.category_column][0]
-                if not is_missing_data
-                else "No data available"
-            ),
+            showscale=self._get_scale(),
+            showlegend=self._get_legend(),
+            colorscale=colourscale,
+            name=self._get_trace_name(dataframe, is_missing_data),
             **self.choropleth_properties,
         )
 
+    def _add_traces(self):
+        if not self.discrete_map:
+            self.fig.add_trace(
+                self._create_choropleth_trace(self.dataframe, DEFAULT_COLOURSCALE)
+            )
+        else:
+            for count, category in enumerate(self.discrete_category_order):
+                if category not in self.df_dict:
+                    df = self._create_df_for_empty_trace(category)
+                else:
+                    df = self.df_dict[category]
+                colour = [
+                    [0, self.colours_list[count % len(self.colours_list)]],
+                    [1, self.colours_list[count % len(self.colours_list)]],
+                ]
+                self.fig.add_trace(
+                    self._create_choropleth_trace(
+                        df,
+                        colour,
+                    )
+                )
+
     def _handle_missing_data(self):
         missing_data = self.dataframe.filter(pl.col(self.column_to_plot).is_null())
         missing_data = missing_data.with_columns(pl.lit(0).alias("data"))
 
+        colour = [
+            [0, colours.GovUKColours.MID_GREY.value],
+            [1, colours.GovUKColours.MID_GREY.value],
+        ]
         if not missing_data.is_empty():
             self.fig.add_trace(
                 self._create_choropleth_trace(
                     missing_data,
-                    colours.GovUKColours.MID_GREY.value,
+                    colour,
                     column_to_plot="data",
                     is_missing_data=True,
                 )
             )
 
+    def _get_dataframe_dict_by_category(self):
+        if self.region is not None and self.region != "England":
+            self.dataframe = self.dataframe.filter(pl.col("Region") == self.region)
+        else:
+            self.dataframe = self.dataframe
+        grouped_dfs_dict_keys_as_tuples = self.dataframe.partition_by(
+            self.discrete_category_column, as_dict=True
+        )
+        grouped_dfs_dict = {
+            key[0]: value for key, value in grouped_dfs_dict_keys_as_tuples.items()
+        }
+        return grouped_dfs_dict
+
     def _crop_to_region(self):
         self.fig.update_layout(
             {
@@ -216,6 +210,33 @@ class ChoroplethMap:
             },
         )
 
+    def _get_color_bar(self):
+        if self.discrete_map:
+            return None
+
+        return {
+            "title": self.column_to_plot,
+            "thickness": 20,
+            "len": 0.8,
+            "x": 0.9,
+            "y": 0.5,
+        }
+
+    def _get_scale(self):
+        return not self.discrete_map
+
+    def _get_legend(self):
+        return self.discrete_map
+
+    def _get_trace_name(self, dataframe, missing_data=False):
+        if self.discrete_category_column is None:
+            return None
+
+        if not missing_data:
+            return dataframe[self.discrete_category_column][0]
+
+        return "No data available"
+
     def _remove_background_map(self):
         self.fig.update_geos(
             center={"lat": 53, "lon": -2},
@@ -226,6 +247,15 @@ class ChoroplethMap:
     def _get_colour_list(self):
         """Amends colour list based on the number of categories"""
         colour_list = ["#217847", "#23BBBE", "#8CCE69", "#FFEA80"]
-        if len(self.desired_category_order) == 3:
+
+        if self.discrete_map and len(self.discrete_category_order) == 3:
             colour_list.pop(1)
         return colour_list
+
+    def _create_df_for_empty_trace(self, category):
+        """Method to create df where all columns are empty except for the category column to force
+        all legend items to always appear"""
+        columns = next(iter(self.df_dict.values())).columns
+        data = {col: [None] for col in columns}
+        data[self.discrete_category_column] = [category]
+        return pl.DataFrame(data)

gov_uk_dashboards/components/plotly/generate_dash_graph_from_figure.py

@@ -0,0 +1,49 @@
+"""Creates a Dash Graph component from a given Plotly figure"""
+
+from typing import Any, Dict, Union
+import plotly.graph_objects as Figure
+from dash import dcc
+
+
+def generate_dash_graph_from_figure(
+    figure: Figure,
+    graph_name: str,
+    graph_style: Union[Dict[str, Any], None] = None,
+    double_click_attribute: Union[str, bool] = False,
+    class_name: str = "",
+) -> dcc.Graph:
+    """
+    Creates a Dash Graph component from a given Plotly figure. This function allows for the
+    customisation of the graph's appearance and behavior, and includes default pointer cursor,
+    from "default-cursor-graph" class.
+    Args:
+    - figure: Plotly.graph_objects.Figure instance to be displayed within the Dash Graph component.
+    - graph_name: A name for the id of the graph component.
+    - graph_style: An optional dictionary specifying CSS styles to apply to the graph component.
+    - double_click_attribute: Determines the action taken on double-clicking the graph.
+                              Can be a boolean or a string specifying the mode.
+    - className (str): A string containing one or more CSS class names to apply to the graph.
+    Returns:
+    - A dash.dcc.Graph component configured with the provided parameters and styles.
+    """
+
+    if not graph_style:
+        graph_style = {}
+
+    if "height" not in graph_style.keys():
+        graph_style["height"] = "450px"
+
+    figure.update_layout(dragmode=False)
+    # pylint: disable=duplicate-code
+    return dcc.Graph(
+        id=f"{graph_name}-graph",
+        responsive=True,
+        figure=figure,
+        style=graph_style,
+        config={
+            "displayModeBar": False,
+            "doubleClick": double_click_attribute,
+            "scrollZoom": False,
+        },
+        className="default-cursor-graph " + class_name,
+    )

gov_uk_dashboards/components/plotly/stacked_barchart.py

@@ -0,0 +1,354 @@
+"""stacked_barchart function"""
+
+from enum import Enum
+import math
+from typing import Optional, TypedDict
+from dash import html
+import polars as pl
+
+import plotly.graph_objects as go
+
+from constants import (
+    CHART_LABEL_FONT_SIZE,
+    CUSTOM_DATA,
+    DATE_VALID,
+    FINANCIAL_YEAR_ENDING,
+    HOVER_TEXT_HEADERS,
+    MAIN_TITLE,
+    MEASURE,
+    SUBTITLE,
+    VALUE,
+)
+from gov_uk_dashboards.colours import AFAccessibleColours
+from gov_uk_dashboards.components.display_chart_or_table_with_header import (
+    display_chart_or_table_with_header,
+)
+from gov_uk_dashboards.components.plotly.generate_dash_graph_from_figure import (
+    generate_dash_graph_from_figure,
+)
+from gov_uk_dashboards.lib.plotting_helper_functions import get_legend_configuration
+from gov_uk_dashboards.formatting.human_readable import format_as_human_readable
+
+from gov_uk_dashboards.lib.update_layout_bgcolor_margin import (
+    update_layout_bgcolor_margin,
+)
+
+
+class XAxisFormat(Enum):
+    """Enum for date format on x axis"""
+
+    YEAR = "year"
+    MONTH_YEAR = "month_year"
+    FINANCIAL_QUARTER = "financial_quarter"
+
+
+class TitleDataStructure(TypedDict):
+    """A TypedDict representing the structure of title_data"""
+
+    MAIN_TITLE: str
+    SUBTITLE: str
+
+
+class HoverDataStructure(TypedDict):
+    """A TypedDict representing the structure of hover_data"""
+
+    CUSTOM_DATA: list[str]
+    HOVER_TEXT_HEADERS: list[str]
+
+
+class HoverDataByTrace(TypedDict):
+    """A TypedDict representing hover_data organized by tracename"""
+
+    tracename: dict[
+        str, HoverDataStructure
+    ]  # Each tracename maps to a HoverDataStructure
+
+
+class StackedBarChart:
+    """Class for use in generating stacked bar charts."""
+
+    # pylint: disable=too-many-instance-attributes
+    # pylint: disable=too-many-arguments
+    # pylint: disable=too-many-locals
+    # pylint: disable = too-many-positional-arguments
+    def __init__(
+        self,
+        title_data: TitleDataStructure,
+        y_column: str,
+        hover_data: HoverDataByTrace,
+        df: pl.DataFrame,
+        trace_name_list: list[str],
+        trace_name_column: Optional[str] = None,
+        xaxis_tick_text_format: XAxisFormat = XAxisFormat.YEAR.value,
+        line_trace_name: Optional[str] = None,
+        x_axis_column=DATE_VALID,
+        download_chart_button_id: Optional[str] = None,
+        download_data_button_id: Optional[str] = None,
+    ):
+        """Initializes the StackedBarChart instance.
+        To display the chart, call the `get_stacked_bar_chart()` method.
+
+        Args:
+            title_data (TitleDataStructure): Data structure containing the chart title information.
+            y_column (str): The column name representing the Y-axis data.
+            hover_data (HoverDataByTrace): Data structure for hover information.
+            df (pl.DataFrame): The dataset for the chart.
+            trace_name_list (list[str]): List of trace names for the stacked bars.
+            trace_name_column (Optional[str], optional): Column name representing trace categories,
+                if applicable. Defaults to None.
+            xaxis_tick_text_format (XAxisFormat, optional): Format for X-axis tick labels.
+                Defaults to XAxisFormat.YEAR.value.
+            line_trace_name (Optional[str], optional): Name for an optional line trace overlay,
+                must be in MEASURE column of df, line_trace_name will display in legend.
+                Defaults to None.
+            x_axis_column (_type_, optional): The column used for the X-axis values.
+                Defaults to DATE_VALID.
+            download_chart_button_id (Optional[str], optional): ID for the chart download button,
+                if applicable. Defaults to None.
+            download_data_button_id (Optional[str], optional): ID for the data download button, if
+                applicable. Defaults to None.
+        """
+        self.title_data = title_data
+        self.y_axis_column = y_column
+        self.hover_data = hover_data
+        self.df = df
+        self.trace_name_list = trace_name_list
+        self.trace_name_column = trace_name_column
+        self.xaxis_tick_text_format = xaxis_tick_text_format
+        self.line_trace_name = line_trace_name
+        self.x_axis_column = x_axis_column
+        self.download_chart_button_id = download_chart_button_id
+        self.download_data_button_id = download_data_button_id
+        self.fig = self.create_stacked_bar_chart()
+
+    def get_stacked_bar_chart(self) -> html.Div:
+        """Creates and returns stacked bar chart for display on application.
+
+        Returns:
+            html.Div: Styled div containing title, subtile and chart.
+        """
+        graph_name = self.title_data[MAIN_TITLE].replace(" ", "-")
+        return display_chart_or_table_with_header(
+            generate_dash_graph_from_figure(
+                self.fig,
+                graph_name,
+                class_name="default-cursor-graph non-interactive-legend-cursor",
+            ),
+            self.title_data[MAIN_TITLE],
+            self.title_data[SUBTITLE],
+            self.download_chart_button_id,
+            self.download_data_button_id,
+        )
+
+    def create_stacked_bar_chart(
+        self,
+    ):
+        """generates a stacked bar chart"""
+        # pylint: disable=too-many-locals
+        fig = go.Figure()
+        colour_list = (
+            AFAccessibleColours.CATEGORICAL.value
+            if len(self.trace_name_list) != 2
+            else [
+                AFAccessibleColours.DARK_BLUE.value,
+                AFAccessibleColours.ORANGE.value,
+            ]  # if 2 lines should use dark blue & orange as have highest contrast ratio
+        )
+        for _, (df, trace_name, colour) in enumerate(
+            zip(
+                self._get_df_list_for_time_series(),
+                self.trace_name_list,
+                colour_list,
+            )
+        ):
+            fig.add_trace(
+                self.create_bar_chart_trace(
+                    df.sort(self.x_axis_column),
+                    trace_name,
+                    hover_label=None,
+                    colour=colour,
+                )
+            )
+
+        if self.line_trace_name is not None:
+            colour = AFAccessibleColours.CATEGORICAL.value[len(self.trace_name_list)]
+            df = self.df.filter(pl.col(MEASURE) == self.line_trace_name)
+
+            fig.add_trace(
+                go.Scatter(
+                    x=df[FINANCIAL_YEAR_ENDING],
+                    y=df[VALUE],
+                    customdata=self._get_custom_data(self.line_trace_name, df),
+                    mode="lines",
+                    line={"color": colour, "width": 3},
+                    name=self.line_trace_name,
+                    hovertemplate=self._get_hover_template(self.line_trace_name),
+                    legendrank=99999,  # a high number to ensure it is bottom of the legend
+                )
+            )
+
+        max_y, min_y, tickvals, ticktext = _get_y_range_tickvals_and_ticktext(
+            self.df, "£", self.trace_name_list
+        )
+        update_layout_bgcolor_margin(fig, "#FFFFFF")
+
+        fig.update_layout(
+            legend=get_legend_configuration(),
+            font={"size": CHART_LABEL_FONT_SIZE},
+            yaxis={
+                "range": [min_y * 1.1, max_y * 1.1],
+                "tickmode": "array",
+                "tickvals": tickvals,
+                "ticktext": ticktext,
+            },
+            showlegend=True,
+            barmode="relative",
+            xaxis={"categoryorder": "category ascending"},
+        )
+        return fig
+
+    def _format_x_axis(self, fig):
+        tick_text, tick_values, range_x = self._get_x_axis_content()
+        fig.update_xaxes(
+            tickvals=tick_values,
+            ticktext=tick_text,
+            tickmode="array",
+            range=range_x,
+        )
+
+        return tick_values
+
+    def create_bar_chart_trace(
+        self,
+        df: pl.DataFrame,
+        trace_name: str,
+        hover_label: dict[str, str],
+        colour: str,
+    ):
+        """Creates a trace for the plot.
+
+        Args:
+            df (pl.DataFrame): Dataframe to use to create trace. Must contain x and y columns,
+            and columns defined in self.hover_data[CUSTOM_DATA].
+            trace_name (str): Name of trace.
+            hover_label (dict[str,str]): Properties for hoverlabel parameter.
+            colour (str): Colour for bar.
+        """
+
+        return go.Bar(
+            x=df[self.x_axis_column],
+            y=df[self.y_axis_column],
+            name=trace_name,
+            hovertemplate=[
+                self._get_hover_template(trace_name) for i in range(df.shape[0])
+            ],
+            customdata=self._get_custom_data(trace_name, df),
+            hoverlabel=hover_label,
+            marker={"color": colour},
+        )
+
+    def _get_hover_template(self, trace_name):
+        hover_text_headers = self.hover_data[trace_name][HOVER_TEXT_HEADERS]
+        hover_template = (
+            f"{trace_name}<br>"
+            f"{hover_text_headers[0]}"
+            ": %{customdata[0]}<br>"
+            f"{hover_text_headers[1]}"
+            ": %{customdata[1]}<extra></extra>"
+        )
+        return hover_template
+
+    def _get_custom_data(self, trace_name, df):
+        customdata = df[self.hover_data[trace_name][CUSTOM_DATA]]
+        return customdata
+
+    def _get_x_axis_content(self):
+        """Generates tick text and values for the x-axis based on the unique years calculated from
+        the FINANCIAL_YEAR_ENDING column in the dataframe.
+        Returns:
+            tuple: A tuple containing tick_text, tick_values and range_x.
+        """
+        if self.xaxis_tick_text_format == XAxisFormat.YEAR.value:
+            year_list = self.df[FINANCIAL_YEAR_ENDING].unique().to_list()
+            int_min_year = int(min(year_list))
+            int_max_year = int(max(year_list))
+
+            tick_text = []
+            year = int_min_year
+            while year <= int_max_year:
+                tick_text.append(str(year + 1))
+                year = year + 1
+
+            tick_values = tick_text
+
+            range_x = [
+                tick_values[0],
+                tick_values[-1],
+            ]
+        else:
+            raise ValueError(
+                f"Invalid xaxis_tick_text_format: {self.xaxis_tick_text_format}"
+            )
+        return tick_text, tick_values, range_x
+
+    def _get_df_list_for_time_series(self) -> list[pl.DataFrame]:
+        if self.trace_name_column is not None:
+            df_list = [
+                self.df.filter(pl.col(self.trace_name_column) == trace_name)
+                for trace_name in self.trace_name_list
+            ]
+        else:
+            df_list = [self.df]
+        return df_list
+
+
+def _get_y_range_tickvals_and_ticktext(
+    dataframe: pl.DataFrame, tick_prefix: str, yaxis_with_values: list[str]
+):
+    barchart_df = dataframe.pivot(
+        index=FINANCIAL_YEAR_ENDING, columns=MEASURE, values=VALUE
+    )
+    positive_sum = sum(
+        pl.when(pl.col(col) > 0).then(pl.col(col)).otherwise(0)
+        for col in yaxis_with_values
+    )
+    negative_sum = sum(
+        pl.when(pl.col(col) < 0).then(pl.col(col)).otherwise(0)
+        for col in yaxis_with_values
+    )
+    barchart_df = barchart_df.with_columns(positive_sum.alias("Positive sum"))
+    barchart_df = barchart_df.with_columns(negative_sum.alias("Negative sum"))
+    maxy = barchart_df.select([pl.col("Positive sum").max()]).item()
+    miny = barchart_df.select([pl.col("Negative sum").min()]).item()
+    tickvals = _generate_tickvals(maxy, miny)
+    ticktext = [format_as_human_readable(val, prefix=tick_prefix) for val in tickvals]
+    return tickvals[-1], tickvals[0], tickvals, ticktext
+
+
+def _generate_tickvals(maxy, miny):
+    range_size = maxy - miny
+
+    # Determine the order of magnitude of the range
+    order = int(math.log10(range_size))
+
+    # Start with an initial step size
+    step_size = 10**order
+
+    # Calculate the number of ticks based on the step size
+    num_ticks = math.ceil(range_size / step_size)
+
+    # Adjust step size to ensure the number of ticks is between 6 and 10
+    while num_ticks < 6 or num_ticks > 10:
+        if num_ticks < 6:  # Too few ticks -> decrease step size
+            step_size /= 2
+        elif num_ticks > 10:  # Too many ticks -> increase step size
+            step_size *= 2
+        num_ticks = math.ceil(range_size / step_size)
+
+    # Adjust the start and end of the range to align with the step size
+    start = math.floor(miny / step_size) * step_size
+    end = math.ceil(maxy / step_size) * step_size
+
+    # Generate tick values
+    tickvals = list(range(int(start), int(end) + 1, int(step_size)))
+    return tickvals

gov_uk_dashboards/lib/plotting_helper_functions.py

@@ -0,0 +1,29 @@
+"""Helper functions for use to plot charts"""
+
+
+from constants import (
+    CHART_LABEL_FONT_SIZE,
+)
+
+
+def get_legend_configuration(itemclick=True, itemdoubleclick=True):
+    """
+    Returns the legend configuration for charts with customizable interaction settings.
+    Args:
+        itemclick (bool): Determines whether clicking on a legend item toggles its visibility.
+                          Set to True by default, allowing click interactions.
+        itemdoubleclick (bool): Determines the behavior when double-clicking on a legend item.
+                                Set to True by default, allowing double-click interactions.
+    Returns:
+        dict: A dictionary containing the configuration settings for the legend.
+    """
+    return {
+        "x": 0,
+        "y": -0.22,
+        "yanchor": "top",
+        "traceorder": "normal",
+        "orientation": "v",
+        "font": {"size": CHART_LABEL_FONT_SIZE},
+        "itemclick": "toggle" if itemclick else False,
+        "itemdoubleclick": "toggle" if itemdoubleclick else False,
+    }

gov_uk_dashboards/lib/update_layout_bgcolor_margin.py

@@ -0,0 +1,24 @@
+"""Function to update the background colour and margin for plots"""
+
+import plotly.graph_objects as go
+from gov_uk_dashboards import colours
+
+
+def update_layout_bgcolor_margin(fig: go.Figure, colour: str):
+    """update background colour and margin for plot"""
+    fig.update_layout(
+        plot_bgcolor=colour,
+        paper_bgcolor=colour,
+        yaxis_zerolinecolor=colour,
+        margin={"l": 0, "r": 0, "b": 0, "t": 0},
+    )
+    fig.update_xaxes(
+        gridcolor=colour,
+        zerolinecolor=colour,
+        ticks="outside",
+        tickcolor=colours.GovUKColours.MID_GREY.value,
+    )
+    fig.update_yaxes(
+        gridcolor=colours.GovUKColours.MID_GREY.value,
+        zerolinecolor=colours.GovUKColours.MID_GREY.value,
+    )

{gov_uk_dashboards-13.4.2.dist-info → gov_uk_dashboards-13.5.1.dist-info}/METADATA

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

@@ -42,7 +42,7 @@ gov_uk_dashboards/components/plotly/banners.py,sha256=TDHdJQSb7mCqtmM6ylSnVh_Qpd
 gov_uk_dashboards/components/plotly/captioned_figure.py,sha256=T0sbtGTiJ79FXxVdPb__hqISuyTc3Dl11cKhgcuW-5U,2804
 gov_uk_dashboards/components/plotly/card.py,sha256=aErz9h536nYvpp9LZsFHo_Rn5rRXXfyGh358VcLksaE,420
 gov_uk_dashboards/components/plotly/card_full_width.py,sha256=ItwNgb5YQ1n6Fznvy_ngQ70gy0QqtgAmWFh8Dw3QmHQ,412
-gov_uk_dashboards/components/plotly/choropleth_map.py,sha256=h2ZKxBxkCYF6mzwPAHTqgFE9wYZQ5N_pkhz-IrOzp6o,8417
+gov_uk_dashboards/components/plotly/choropleth_map.py,sha256=zbXD6BmpR4UKPowyO2x9KUoeYspZ4TmMFy5ZY5EWzu0,9266
 gov_uk_dashboards/components/plotly/collapsible_panel.py,sha256=WrC5IFzM9mNavPfeSpBvMvYQfrmfhpTPCG1Ay70Jtw8,1191
 gov_uk_dashboards/components/plotly/comparison_la_filter_button.py,sha256=mhtmYVyToabuYzal00cB07YfKSx_wjDfjB8W-IKDXPc,670
 gov_uk_dashboards/components/plotly/context_banner.py,sha256=2o44AzS0pTYTY0r3OVbKW7dJg2lA1J8PW4RCeGQ15gg,1010
@@ -51,6 +51,7 @@ gov_uk_dashboards/components/plotly/details.py,sha256=-Rgat95pCnU3fF4O0MkyymzMQP
 gov_uk_dashboards/components/plotly/download_button.py,sha256=8jGAadB3f_wVYWz5wIkObh0Q4NeFESM6kNRUYx0TIRs,1882
 gov_uk_dashboards/components/plotly/filter_panel.py,sha256=ejcDQK1bgEtNJSF_GG0iY9mQ_RwV-Ipvq6_z1abrZ_Q,1998
 gov_uk_dashboards/components/plotly/footer.py,sha256=RnJKN1YTP88GuJ4e7ci2T-jDqIe0-jDuHAQ8OhSCK50,3155
+gov_uk_dashboards/components/plotly/generate_dash_graph_from_figure.py,sha256=sdhC6Mjfw6kqs1MDRDoMuOt8dNS9Bl1WEoJX9S5AssA,1813
 gov_uk_dashboards/components/plotly/graph.py,sha256=bd49W5sVyhtWd4lNBfQST1RyLNlTLA0KRxS7jTgVMwE,886
 gov_uk_dashboards/components/plotly/header.py,sha256=ncwPcrGLLSpEL2E1NzSh6qtVW92B5JgAmA-qcTnNBhE,2886
 gov_uk_dashboards/components/plotly/heading.py,sha256=VjyBng591B_366vnan96PukpCDBTTj-2iJWuq0s0CLw,766
@@ -64,6 +65,7 @@ gov_uk_dashboards/components/plotly/paragraph.py,sha256=yoWa_B6RLiebBX2QaszY3lyZ
 gov_uk_dashboards/components/plotly/phase_banner.py,sha256=7XIk_y-kStSaptXnk9yHVu8S0n-ypwWehDqOwjb5l-c,1787
 gov_uk_dashboards/components/plotly/row_component.py,sha256=SdmJqyFJA1Kngyzxy0ooZUegIOiN6Bz1wRq6jGigfII,687
 gov_uk_dashboards/components/plotly/side_navbar.py,sha256=pupA0FdjSbPbzdX9up6wEoIKWIuk3zGRun4opnBieCU,1332
+gov_uk_dashboards/components/plotly/stacked_barchart.py,sha256=J4-8nRf-OBBJCR9jLFSs5fkWz9uZu1ZUKMyjV89mApI,12700
 gov_uk_dashboards/components/plotly/table.py,sha256=JkrH51znqAKTy-b5p3gXhOzvPwFmc2LcCQiaKuKwMu4,13753
 gov_uk_dashboards/components/plotly/tooltip.py,sha256=qTkRWQanhG535Yi4NiaLlEMJqqzjubgRdKJDIhxXzd4,978
 gov_uk_dashboards/components/plotly/tooltip_title.py,sha256=2exMYItzR17yOu3gTL77DyUU4Hi3CIB-ZPS8ftetqZg,874
@@ -85,11 +87,13 @@ gov_uk_dashboards/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 gov_uk_dashboards/lib/enable_basic_auth.py,sha256=Ul2tnopTJm6_UQ1ljKGwk-Ay3Z8KnPNKNjwiBOf1yd0,749
 gov_uk_dashboards/lib/http_headers.py,sha256=Hur3R0_hAsWz8PntBhD66w4kgdW6EvwHNNugnA0DIJM,1592
 gov_uk_dashboards/lib/logging.py,sha256=osLxh5KDsEgAsaGQSM05h8MBJgLG-RFy8gLtWSivEik,354
+gov_uk_dashboards/lib/plotting_helper_functions.py,sha256=X5rJ63DaADOXcZ2GpK_ZesRRwKjiMCA-D7wpNAhdptk,1052
+gov_uk_dashboards/lib/update_layout_bgcolor_margin.py,sha256=i7Nwp0CxFpkyQeR8KfOBVMBkzctG7hMpWI2OzgxB2jY,740
 gov_uk_dashboards/lib/dap/__init__.py,sha256=bYga8kJuf9TGkfpnd16SInrD1FcN8iPn4SzcUSHAH48,76
 gov_uk_dashboards/lib/dap/dap_deployment.py,sha256=ZXixeOAtRNjMsPdGKLwwLNamlo0miZLaKCckKtq8_iI,2313
 gov_uk_dashboards/lib/dap/get_dataframe_from_cds.py,sha256=OiusRCgYnkBjK_GZgYLGzNrxOGizYt8CgThiWRCVKK0,3921
-gov_uk_dashboards-13.4.2.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
-gov_uk_dashboards-13.4.2.dist-info/METADATA,sha256=UhAylRWUU3TMvHg5_Oy9VROpHm7VpQn10NMbSsPZyso,5917
-gov_uk_dashboards-13.4.2.dist-info/WHEEL,sha256=tTnHoFhvKQHCh4jz3yCn0WPTYIy7wXx3CJtJ7SJGV7c,91
-gov_uk_dashboards-13.4.2.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
-gov_uk_dashboards-13.4.2.dist-info/RECORD,,
+gov_uk_dashboards-13.5.1.dist-info/licenses/LICENSE,sha256=GDiD7Y2Gx7JucPV1JfVySJeah-qiSyBPdpJ6RHCEHTc,1126
+gov_uk_dashboards-13.5.1.dist-info/METADATA,sha256=oPk-ivgHqCnoq7PFrS6nNO0p6--uALhlACcFDHczzhA,5917
+gov_uk_dashboards-13.5.1.dist-info/WHEEL,sha256=DK49LOLCYiurdXXOXwGJm6U4DkHkg4lcxjhqwRa0CP4,91
+gov_uk_dashboards-13.5.1.dist-info/top_level.txt,sha256=gPaN1P3-H3Rgi2me6tt-fX_cxo19CZfA4PjlZPjGRpo,18
+gov_uk_dashboards-13.5.1.dist-info/RECORD,,

{gov_uk_dashboards-13.4.2.dist-info → gov_uk_dashboards-13.5.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (77.0.1)
+Generator: setuptools (78.0.2)
 Root-Is-Purelib: true
 Tag: py3-none-any