plotnine 0.16.0a2__py3-none-any.whl → 0.16.0a3__py3-none-any.whl

plotnine/_mpl/layout_manager/_composition_layout_items.py

@@ -14,6 +14,9 @@ from plotnine._mpl.utils import (
 if TYPE_CHECKING:
     from typing import Any
 
+    from matplotlib.lines import Line2D
+    from matplotlib.patches import Rectangle
+
     from plotnine.composition._compose import Compose
 
     from ._composition_side_space import CompositionSideSpaces
@@ -44,6 +47,11 @@ class CompositionLayoutItems:
         self.plot_title: Text | None = get("plot_title")
         self.plot_subtitle: Text | None = get("plot_subtitle")
         self.plot_caption: Text | None = get("plot_caption")
+        self.plot_footer: Text | None = get("plot_footer")
+        self.plot_footer_background: Rectangle | None = get(
+            "plot_footer_background"
+        )
+        self.plot_footer_line: Line2D | None = get("plot_footer_line")
 
     def _is_blank(self, name: str) -> bool:
         return self.cmp.theme.T.is_blank(name)
@@ -55,6 +63,7 @@ class CompositionLayoutItems:
         theme = self.cmp.theme
         plot_title_position = theme.getp("plot_title_position", "panel")
         plot_caption_position = theme.getp("plot_caption_position", "panel")
+        plot_footer_position = theme.getp("plot_footer_position", "plot")
         justify = CompositionTextJustifier(spaces)
 
         if self.plot_title:
@@ -78,6 +87,40 @@ class CompositionLayoutItems:
                 self.plot_caption, ha, plot_caption_position
             )
 
+        if self.plot_footer:
+            ha = theme.getp(("plot_footer", "ha"), "left")
+            self.plot_footer.set_y(spaces.b.y1("plot_footer"))
+            justify.horizontally_about(
+                self.plot_footer, ha, plot_footer_position
+            )
+            self._resize_plot_footer_background(spaces)
+            self._resize_plot_footer_line(spaces)
+
+    def _resize_plot_footer_background(self, spaces: CompositionSideSpaces):
+        """
+        Resize the plot footer to the size of the footer
+        """
+        if not self.plot_footer_background:
+            return
+
+        self.plot_footer_background.set_x(spaces.l.offset)
+        self.plot_footer_background.set_y(spaces.b.offset)
+        self.plot_footer_background.set_height(spaces.b.footer_height)
+        self.plot_footer_background.set_width(spaces.plot_width)
+
+    def _resize_plot_footer_line(self, spaces: CompositionSideSpaces):
+        """
+        Resize the footer line to be a border above the footer
+        """
+        if not self.plot_footer_line:
+            return
+
+        x1 = spaces.l.offset
+        x2 = x1 + spaces.plot_width
+        y1 = y2 = spaces.b.offset + spaces.b.footer_height
+        self.plot_footer_line.set_xdata([x1, x2])
+        self.plot_footer_line.set_ydata([y1, y2])
+
 
 class CompositionTextJustifier(TextJustifier):
     """

plotnine/_mpl/layout_manager/_composition_side_space.py

@@ -218,6 +218,9 @@ class composition_bottom_space(_composition_side_space):
     Ordered from the edge of the figure and going inwards
     """
 
+    plot_footer_margin_bottom: float = 0
+    plot_footer: float = 0
+    plot_footer_margin_top: float = 0
     plot_margin: float = 0
     plot_caption_margin_bottom: float = 0
     plot_caption: float = 0
@@ -231,6 +234,11 @@ class composition_bottom_space(_composition_side_space):
         F = W / H
 
         self.plot_margin = theme.getp("plot_margin_bottom") * F
+        if items.plot_footer:
+            m = theme.get_margin("plot_footer").fig
+            self.plot_footer_margin_bottom = m.b * F
+            self.plot_footer = geometry.height(items.plot_footer)
+            self.plot_footer_margin_top = m.t * F
 
         if items.plot_caption:
             m = theme.get_margin("plot_caption").fig
@@ -269,6 +277,17 @@ class composition_bottom_space(_composition_side_space):
         """
         return self.to_figure_space(self.sum_incl(item))
 
+    @property
+    def footer_height(self):
+        """
+        The height of the footer including the margins
+        """
+        return (
+            self.plot_footer_margin_bottom
+            + self.plot_footer
+            + self.plot_footer_margin_top
+        )
+
     @property
     def items_bottom_relative(self):
         """
@@ -361,6 +380,20 @@ class CompositionSideSpaces:
             0,
         )
 
+    @property
+    def plot_width(self) -> float:
+        """
+        Width [figure dimensions] of the whole plot composition
+        """
+        return float(self.gridspec.width)
+
+    @property
+    def plot_height(self) -> float:
+        """
+        Height [figure dimensions] of the whole plot composition
+        """
+        return float(self.gridspec.height)
+
     @property
     def horizontal_space(self) -> float:
         """

plotnine/_mpl/layout_manager/_plot_layout_items.py

@@ -26,6 +26,8 @@ if TYPE_CHECKING:
 
     from matplotlib.axes import Axes
     from matplotlib.axis import Tick
+    from matplotlib.lines import Line2D
+    from matplotlib.patches import Rectangle
     from matplotlib.transforms import Transform
 
     from plotnine import ggplot
@@ -86,12 +88,18 @@ class PlotLayoutItems:
         # # AnchoredOffsetboxes (groups of legends)
         self.legends: legend_artists | None = get("legends")
         self.plot_caption: Text | None = get("plot_caption")
+        self.plot_footer: Text | None = get("plot_footer")
         self.plot_subtitle: Text | None = get("plot_subtitle")
         self.plot_title: Text | None = get("plot_title")
         self.plot_tag: Text | None = get("plot_tag")
         self.strip_text_x: list[StripText] | None = get("strip_text_x")
         self.strip_text_y: list[StripText] | None = get("strip_text_y")
 
+        self.plot_footer_background: Rectangle | None = get(
+            "plot_footer_background"
+        )
+        self.plot_footer_line: Line2D | None = get("plot_footer_line")
+
     def _is_blank(self, name: str) -> bool:
         return self.plot.theme.T.is_blank(name)
 
@@ -345,6 +353,7 @@ class PlotLayoutItems:
         theme = self.plot.theme
         plot_title_position = theme.getp("plot_title_position", "panel")
         plot_caption_position = theme.getp("plot_caption_position", "panel")
+        plot_footer_position = theme.getp("plot_footer_position", "plot")
         justify = PlotTextJustifier(spaces)
 
         if self.plot_tag:
@@ -371,6 +380,15 @@ class PlotLayoutItems:
                 self.plot_caption, ha, plot_caption_position
             )
 
+        if self.plot_footer:
+            ha = theme.getp(("plot_footer", "ha"), "left")
+            self.plot_footer.set_y(spaces.b.y1("plot_footer"))
+            justify.horizontally_about(
+                self.plot_footer, ha, plot_footer_position
+            )
+            self._resize_plot_footer_background(spaces)
+            self._resize_plot_footer_line(spaces)
+
         if self.axis_title_x:
             ha = theme.getp(("axis_title_x", "ha"), "center")
             self.axis_title_x.set_y(spaces.b.y1("axis_title_x"))
@@ -505,6 +523,31 @@ class PlotLayoutItems:
         for text, scale in zip(self.strip_text_y, relative_widths):
             text.patch.expand = scale
 
+    def _resize_plot_footer_background(self, spaces: PlotSideSpaces):
+        """
+        Resize the plot footer to the size of the footer
+        """
+        if not self.plot_footer_background:
+            return
+
+        self.plot_footer_background.set_x(spaces.l.offset)
+        self.plot_footer_background.set_y(spaces.b.offset)
+        self.plot_footer_background.set_height(spaces.b.footer_height)
+        self.plot_footer_background.set_width(spaces.plot_width)
+
+    def _resize_plot_footer_line(self, spaces: PlotSideSpaces):
+        """
+        Resize the footer line to be a border above the footer
+        """
+        if not self.plot_footer_line:
+            return
+
+        x1 = spaces.l.offset
+        x2 = x1 + spaces.plot_width
+        y1 = y2 = spaces.b.offset + spaces.b.footer_height
+        self.plot_footer_line.set_xdata([x1, x2])
+        self.plot_footer_line.set_ydata([y1, y2])
+
 
 def _text_is_visible(text: Text) -> bool:
     """

plotnine/_mpl/layout_manager/_plot_side_space.py

@@ -553,6 +553,9 @@ class bottom_space(_plot_side_space):
     Ordered from the edge of the figure and going inwards
     """
 
+    plot_footer_margin_bottom: float = 0
+    plot_footer: float = 0
+    plot_footer_margin_top: float = 0
     plot_margin: float = 0
     tag_alignment: float = 0
     plot_tag_margin_bottom: float = 0
@@ -602,6 +605,12 @@ class bottom_space(_plot_side_space):
             self.plot_caption = geometry.height(items.plot_caption)
             self.plot_caption_margin_top = m.t * F
 
+        if items.plot_footer:
+            m = theme.get_margin("plot_footer").fig
+            self.plot_footer_margin_bottom = m.b * F
+            self.plot_footer = geometry.height(items.plot_footer)
+            self.plot_footer_margin_top = m.t * F
+
         if items.legends and items.legends.bottom:
             self.legend = self.legend_height
             self.legend_box_spacing = theme.getp("legend_box_spacing") * F
@@ -680,6 +689,17 @@ class bottom_space(_plot_side_space):
         """
         return self.y1("legend")
 
+    @property
+    def footer_height(self):
+        """
+        The height of the footer including the margins
+        """
+        return (
+            self.plot_footer_margin_bottom
+            + self.plot_footer
+            + self.plot_footer_margin_top
+        )
+
     @property
     def tag_height(self):
         """

plotnine/_utils/context.py

@@ -4,6 +4,7 @@ from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
 import pandas as pd
+from packaging.version import Version
 
 if TYPE_CHECKING:
     from typing_extensions import Self
@@ -11,6 +12,8 @@ if TYPE_CHECKING:
     from plotnine import ggplot
     from plotnine.composition import Compose
 
+PANDAS_LT_3 = Version(pd.__version__) < Version("3.0")
+
 
 def reopen(fig):
     """
@@ -55,12 +58,11 @@ class plot_context:
 
         # Contexts
         self.rc_context = mpl.rc_context(plot.theme.rcParams)
-        # TODO: Remove this context when copy-on-write is permanent, i.e.
-        # pandas >= 3.0
-        self.pd_option_context = pd.option_context(
-            "mode.copy_on_write",
-            True,
-        )
+        if PANDAS_LT_3:
+            self.pd_option_context = pd.option_context(
+                "mode.copy_on_write",
+                True,
+            )
 
     def __enter__(self) -> Self:
         """
@@ -68,7 +70,8 @@ class plot_context:
         """
 
         self.rc_context.__enter__()
-        self.pd_option_context.__enter__()
+        if PANDAS_LT_3:
+            self.pd_option_context.__enter__()
 
         return self
 
@@ -89,7 +92,8 @@ class plot_context:
                 plt.close(self.plot.figure)
 
         self.rc_context.__exit__(exc_type, exc_value, exc_traceback)
-        self.pd_option_context.__exit__(exc_type, exc_value, exc_traceback)
+        if PANDAS_LT_3:
+            self.pd_option_context.__exit__(exc_type, exc_value, exc_traceback)
 
 
 @dataclass

plotnine/composition/_compose.py

@@ -123,6 +123,8 @@ class Compose:
     |   -------------   |
     |                   |
     |           caption |
+    |-------------------|
+    |       footer      |
      -------------------
     """
     _sidespaces: CompositionSideSpaces
@@ -573,13 +575,28 @@ class Compose:
         """
         Draw the background rectangle of the composition
         """
+        from matplotlib.lines import Line2D
         from matplotlib.patches import Rectangle
 
-        rect = Rectangle((0, 0), 0, 0, facecolor="none", zorder=-1000)
+        zorder = -1000
+        rect = Rectangle((0, 0), 0, 0, facecolor="none", zorder=zorder)
         self.figure.add_artist(rect)
         self._gridspec.patch = rect
         self.theme.targets.plot_background = rect
 
+        if self.annotation.footer:
+            rect = Rectangle(
+                (0, 0), 0, 0, facecolor="none", linewidth=0, zorder=zorder + 1
+            )
+            self.figure.add_artist(rect)
+            self.theme.targets.plot_footer_background = rect
+
+            line = Line2D(
+                [0, 0], [0, 0], color="none", linewidth=0, zorder=zorder + 2
+            )
+            self.figure.add_artist(line)
+            self.theme.targets.plot_footer_line = line
+
     def _draw_annotation(self):
         """
         Draw the items in the annotation
@@ -602,6 +619,9 @@ class Compose:
         if caption := self.annotation.caption:
             targets.plot_caption = figure.text(0, 0, caption)
 
+        if footer := self.annotation.footer:
+            targets.plot_footer = figure.text(0, 0, footer)
+
     def save(
         self,
         filename: str | Path | BytesIO,

plotnine/composition/_plot_annotation.py

@@ -36,9 +36,14 @@ class plot_annotation(ComposeAddable):
     The caption of the composition
     """
 
+    footer: str | None = None
+    """
+    The footer of the composition
+    """
+
     theme: theme = field(default_factory=theme)  # pyright: ignore[reportUnboundVariable]
     """
-    Theme to use for the plot title, subtitle, caption, margin and background
+    Theme for the plot title, subtitle, caption, footer, margin and background
 
     It also controls the [](`~plotnine.themes.themeables.figure_size`) of the
     composition. The default theme is the same as the default one used for the

plotnine/ggplot.py

@@ -127,6 +127,8 @@ class ggplot:
     |   axis_text             |
     |   axis_title            |
     |                 caption |
+    |-------------------------|
+    |          footer         |
      -------------------------
     """
 
@@ -553,6 +555,7 @@ class ggplot:
         subtitle = self.labels.get("subtitle", "")
         caption = self.labels.get("caption", "")
         tag = self.labels.get("tag", "")
+        footer = self.labels.get("footer", "")
 
         # Get the axis labels (default or specified by user)
         # and let the coordinate modify them e.g. flip
@@ -570,6 +573,9 @@ class ggplot:
         if caption:
             targets.plot_caption = figure.text(0, 0, caption)
 
+        if footer:
+            targets.plot_footer = figure.text(0, 0, footer)
+
         if tag:
             targets.plot_tag = figure.text(0, 0, tag)
 
@@ -587,13 +593,30 @@ class ggplot:
             wm.draw(self.figure)
 
     def _draw_plot_background(self):
+        from matplotlib.lines import Line2D
         from matplotlib.patches import Rectangle
 
-        rect = Rectangle((0, 0), 0, 0, facecolor="none", zorder=-1000)
+        zorder = -1000
+        rect = Rectangle((0, 0), 0, 0, facecolor="none", zorder=zorder)
         self.figure.add_artist(rect)
         self._gridspec.patch = rect
         self.theme.targets.plot_background = rect
 
+        # Footer background and line only if there is a footer, and put
+        # it on top of the plot background
+        if self.labels.get("footer", ""):
+            rect = Rectangle(
+                (0, 0), 0, 0, facecolor="none", linewidth=0, zorder=zorder + 1
+            )
+            self.figure.add_artist(rect)
+            self.theme.targets.plot_footer_background = rect
+
+            line = Line2D(
+                [0, 0], [0, 0], color="none", linewidth=0, zorder=zorder + 2
+            )
+            self.figure.add_artist(line)
+            self.theme.targets.plot_footer_line = line
+
     def _save_filename(self, ext: str) -> Path:
         """
         Make a filename for use by the save method

plotnine/guides/guide_legend.py

@@ -272,9 +272,12 @@ class guide_legend(guide):
         # Drawings
         drawings: list[ColoredDrawingArea] = []
         for i in range(nbreak):
-            da = ColoredDrawingArea(
-                elements.key_widths[i], elements.key_heights[i], 0, 0
-            )
+            try:
+                w, h = elements.key_widths[i], elements.key_heights[i]
+            except IndexError:
+                w, h = elements.empty_key_size
+
+            da = ColoredDrawingArea(w, h, 0, 0)
 
             # overlay geoms
             for params in self._layer_parameters:
@@ -482,3 +485,14 @@ class GuideElementsLegend(GuideElements):
         if self.is_horizontal:
             return [max(hs)] * len(hs)
         return hs
+
+    @cached_property
+    def empty_key_size(self) -> tuple[float, float]:
+        """
+        Size of an empty key
+        """
+        return (
+            (max(self.key_widths), min(self.key_heights))
+            if self.is_vertical
+            else (min(self.key_widths), max(self.key_heights))
+        )

plotnine/iapi.py

@@ -66,7 +66,7 @@ class range_view:
 @dataclass
 class labels_view:
     """
-    Scale labels (incl. caption & title) for the plot
+    Scale labels (incl. caption, title, footer) for the plot
     """
 
     x: Optional[str] = None
@@ -80,8 +80,9 @@ class labels_view:
     size: Optional[str] = None
     stroke: Optional[str] = None
     title: Optional[str] = None
-    caption: Optional[str] = None
     subtitle: Optional[str] = None
+    caption: Optional[str] = None
+    footer: Optional[str] = None
     tag: Optional[str] = None
 
     def update(self, other: labels_view):

plotnine/labels.py

@@ -90,6 +90,13 @@ class labs:
     The caption at the bottom of the plot.
     """
 
+    footer: str | None = None
+    """
+    The footer at the bottom of the plot
+
+    The footer when added is below the caption
+    """
+
     tag: str | None = None
     """
     A plot tag

plotnine/themes/targets.py

@@ -7,6 +7,7 @@ if TYPE_CHECKING:
     from typing import Optional
 
     from matplotlib.collections import LineCollection
+    from matplotlib.lines import Line2D
     from matplotlib.patches import Rectangle
     from matplotlib.text import Text
 
@@ -37,9 +38,12 @@ class ThemeTargets:
     panel_border: list[Rectangle] = field(default_factory=list)
     plot_caption: Optional[Text] = None
     plot_subtitle: Optional[Text] = None
+    plot_footer: Optional[Text] = None
     plot_tag: Optional[Text] = None
     plot_title: Optional[Text] = None
     plot_background: Optional[Rectangle] = None
+    plot_footer_background: Optional[Rectangle] = None
+    plot_footer_line: Optional[Line2D] = None
     strip_background_x: list[StripTextPatch] = field(default_factory=list)
     strip_background_y: list[StripTextPatch] = field(default_factory=list)
     strip_text_x: list[StripText] = field(default_factory=list)

plotnine/themes/theme.py

@@ -124,9 +124,11 @@ class theme:
         plot_title=None,
         plot_subtitle=None,
         plot_caption=None,
+        plot_footer=None,
         plot_tag=None,
         plot_title_position=None,
         plot_caption_position=None,
+        plot_footer_position=None,
         plot_tag_location=None,
         plot_tag_position=None,
         strip_text_x=None,
@@ -157,6 +159,7 @@ class theme:
         panel_grid_major=None,
         panel_grid_minor=None,
         panel_grid=None,
+        plot_footer_line=None,
         line=None,
         legend_key=None,
         legend_frame=None,
@@ -165,6 +168,7 @@ class theme:
         panel_background=None,
         panel_border=None,
         plot_background=None,
+        plot_footer_background=None,
         strip_background_x=None,
         strip_background_y=None,
         strip_background=None,

plotnine/themes/theme_gray.py

@@ -109,6 +109,15 @@ class theme_gray(theme):
                 ma="left",
                 margin=margin(t=m, unit="fig"),
             ),
+            plot_footer=element_text(
+                size=base_size * 0.8,
+                ha="left",
+                va="bottom",
+                ma="left",
+                margin=margin(t=1 / 3, b=1 / 3, unit="lines"),
+            ),
+            plot_footer_background=element_blank(),
+            plot_footer_line=element_blank(),
             plot_margin=m,
             plot_subtitle=element_text(
                 va="top",
@@ -128,6 +137,7 @@ class theme_gray(theme):
             ),
             plot_title_position="panel",
             plot_caption_position="panel",
+            plot_footer_position="plot",
             plot_tag_location="margin",
             plot_tag_position="topleft",
             strip_align=0,

plotnine/themes/theme_matplotlib.py

@@ -85,6 +85,12 @@ class theme_matplotlib(theme):
                 ma="left",
                 margin=margin(t=m, unit="fig"),
             ),
+            plot_footer=element_text(
+                ha="left",
+                va="bottom",
+                ma="left",
+                margin=margin(t=1 / 3, b=1 / 3, unit="lines"),
+            ),
             plot_margin=m,
             plot_subtitle=element_text(
                 size=base_size * 0.9,
@@ -92,6 +98,8 @@ class theme_matplotlib(theme):
                 ma="left",
                 margin=margin(b=m, unit="fig"),
             ),
+            plot_footer_background=element_blank(),
+            plot_footer_line=element_blank(),
             plot_title=element_text(
                 va="top",
                 ma="left",
@@ -104,6 +112,7 @@ class theme_matplotlib(theme):
             ),
             plot_title_position="panel",
             plot_caption_position="panel",
+            plot_footer_position="plot",
             plot_tag_location="margin",
             plot_tag_position="topleft",
             strip_align=0,

plotnine/themes/theme_seaborn.py

@@ -100,6 +100,15 @@ class theme_seaborn(theme):
                 ma="left",
                 margin=margin(t=m, unit="fig"),
             ),
+            plot_footer=element_text(
+                size=base_size * 0.8,
+                ha="left",
+                va="bottom",
+                ma="left",
+                margin=margin(t=1 / 3, b=1 / 3, unit="lines"),
+            ),
+            plot_footer_background=element_blank(),
+            plot_footer_line=element_blank(),
             plot_margin=m,
             plot_subtitle=element_text(
                 size=base_size * 1,
@@ -120,6 +129,7 @@ class theme_seaborn(theme):
             ),
             plot_title_position="panel",
             plot_caption_position="panel",
+            plot_footer_position="plot",
             plot_tag_location="margin",
             plot_tag_position="topleft",
             strip_align=0,

plotnine/themes/theme_void.py

@@ -74,6 +74,13 @@ class theme_void(theme):
                 ma="left",
                 margin=margin(t=m, unit="fig"),
             ),
+            plot_footer=element_text(
+                size=base_size * 0.8,
+                ha="left",
+                va="bottom",
+                ma="left",
+                margin=margin(t=1 / 3, b=1 / 3, unit="lines"),
+            ),
             plot_margin=0,
             plot_subtitle=element_text(
                 size=base_size * 1,
@@ -94,6 +101,7 @@ class theme_void(theme):
             ),
             plot_title_position="panel",
             plot_caption_position="panel",
+            plot_footer_position="plot",
             plot_tag_location="margin",
             plot_tag_position="topleft",
             strip_align=0,

plotnine/themes/themeable.py

@@ -768,6 +768,28 @@ class plot_caption(themeable):
             text.set_visible(False)
 
 
+class plot_footer(themeable):
+    """
+    Plot footer
+
+    Parameters
+    ----------
+    theme_element : element_text
+    """
+
+    _omit = ["margin"]
+
+    def apply_figure(self, figure: Figure, targets: ThemeTargets):
+        super().apply_figure(figure, targets)
+        if text := targets.plot_footer:
+            text.set(**self.properties)
+
+    def blank_figure(self, figure: Figure, targets: ThemeTargets):
+        super().blank_figure(figure, targets)
+        if text := targets.plot_footer:
+            text.set_visible(False)
+
+
 class plot_tag(themeable):
     """
     Plot tag
@@ -834,6 +856,19 @@ class plot_caption_position(themeable):
     """
 
 
+class plot_footer_position(themeable):
+    """
+    How to align the plot footer
+
+    Parameters
+    ----------
+    theme_element : Literal["panel", "plot"], default = "plot"
+        If "panel", the footer is aligned with respect to the
+        panels. If "plot", it is aligned with the plot, excluding
+        the margin space.
+    """
+
+
 class plot_tag_location(themeable):
     """
     The area where the tag will be positioned
@@ -919,7 +954,13 @@ class strip_text(strip_text_x, strip_text_y):
 
 
 class title(
-    axis_title, legend_title, plot_title, plot_subtitle, plot_caption, plot_tag
+    axis_title,
+    legend_title,
+    plot_title,
+    plot_subtitle,
+    plot_caption,
+    plot_footer,
+    plot_tag,
 ):
     """
     All titles on the plot
@@ -1476,7 +1517,27 @@ class panel_grid(panel_grid_major, panel_grid_minor):
     """
 
 
-class line(axis_line, axis_ticks, panel_grid, legend_ticks):
+class plot_footer_line(themeable):
+    """
+    Line above the footer
+
+    Parameters
+    ----------
+    theme_element : element_line
+    """
+
+    def apply_figure(self, figure: Figure, targets: ThemeTargets):
+        super().apply_figure(figure, targets)
+        if targets.plot_footer_line:
+            targets.plot_footer_line.set(**self.properties)
+
+    def blank_figure(self, figure: Figure, targets: ThemeTargets):
+        super().blank_figure(figure, targets)
+        if targets.plot_footer_line:
+            targets.plot_footer_line.set_visible(False)
+
+
+class line(axis_line, axis_ticks, panel_grid, legend_ticks, plot_footer_line):
     """
     All line elements
 
@@ -1691,6 +1752,33 @@ class plot_background(themeable):
             targets.plot_background.set_visible(False)
 
 
+class plot_footer_background(themeable):
+    """
+    Footer background
+
+    The background is placed across the entire with of the plot,
+    or the composition. And the height is determined by the height
+    of the footer including the top and bottom margin.
+
+    Parameters
+    ----------
+    theme_element : element_rect
+    """
+
+    def apply_figure(self, figure: Figure, targets: ThemeTargets):
+        super().apply_figure(figure, targets)
+        if targets.plot_footer_background:
+            props = self.properties
+            props["linewidth"] = 0
+            props["edgecolor"] = "none"
+            targets.plot_footer_background.set(**props)
+
+    def blank_figure(self, figure: Figure, targets: ThemeTargets):
+        super().blank_figure(figure, targets)
+        if targets.plot_footer_background:
+            targets.plot_footer_background.set_visible(False)
+
+
 class strip_background_x(MixinSequenceOfValues):
     """
     Horizontal facet label background
@@ -1747,6 +1835,7 @@ class rect(
     panel_background,
     panel_border,
     plot_background,
+    plot_footer_background,
     strip_background,
 ):
     """

{plotnine-0.16.0a2.dist-info → plotnine-0.16.0a3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plotnine
-Version: 0.16.0a2
+Version: 0.16.0a3
 Summary: A Grammar of Graphics for Python
 Author-email: Hassan Kibirige <has2k1@gmail.com>
 License: The MIT License (MIT)
@@ -49,7 +49,7 @@ Requires-Dist: pandas>=2.2.0
 Requires-Dist: mizani~=0.14.0
 Requires-Dist: numpy>=1.23.5
 Requires-Dist: scipy>=1.8.0
-Requires-Dist: statsmodels>=0.14.5
+Requires-Dist: statsmodels>=0.14.6
 Provides-Extra: all
 Requires-Dist: plotnine[extra]; extra == "all"
 Requires-Dist: plotnine[doc]; extra == "all"

{plotnine-0.16.0a2.dist-info → plotnine-0.16.0a3.dist-info}/RECORD

@@ -2,10 +2,10 @@ plotnine/__init__.py,sha256=_Q18ZKrippC4L27KdYUhuJon95AE8JPZXEYeXZyutms,10372
 plotnine/animation.py,sha256=5UK3Y5IHHRtf0sRU5x288XCldn1OhK1NGdMQoTi_Tlg,7683
 plotnine/doctools.py,sha256=JBF55q1MX2fXYQcGDpVrGPdlKf5OiQ5gyTdWhnM_IzU,14558
 plotnine/exceptions.py,sha256=SgTxBHkV65HjGI3aFy2q1_lHP9HAdiuxVLN3U-PJWSQ,1616
-plotnine/ggplot.py,sha256=wUoSUcYcseRv6pq9kqEh23L3vvfNOTPcb_c37Xxy_CI,25771
+plotnine/ggplot.py,sha256=nPa16xmivwCHsNLWer2kJ418sp0RIArcpzAOaziUwhI,26628
 plotnine/helpers.py,sha256=4R3KZmtGH46-kRNSGOA0JxZaLKBo0ge8Vnx1cDQ8_gI,966
-plotnine/iapi.py,sha256=nA49ur2AksGUnu8P5DGBVzPOk9YHYaNLSWzZetV2qoc,9429
-plotnine/labels.py,sha256=3pOXth2Xma_qCqB_xXAGIkPQ9gcaUaaFEAsa5if1iR0,2830
+plotnine/iapi.py,sha256=YGOM4U2z3RB87o2S3p4M3VJkfFHcTHEko_yJ1EyMMI0,9469
+plotnine/labels.py,sha256=5uZdYLXutzife_a7xJIqJ31L_bNCThiIbIqh84PLwVU,2966
 plotnine/layer.py,sha256=l9ehqvWoDpaZdVFLGoiA5USL79NYWWaiZM_ZuDeGzpo,17294
 plotnine/options.py,sha256=j3zXv4wc3J4nOI_TqJ5s_abuifodt_UN8MR8M4i8UVA,3108
 plotnine/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -21,16 +21,16 @@ plotnine/_mpl/ticker.py,sha256=RY_7AdTggc7QBq9_t0KBJXg36oxKfB-Vtc9FzLnaGnQ,393
 plotnine/_mpl/transforms.py,sha256=DNaOlNq76xlT696sN8ot1bmYyp4mmrjXQHk3kTi4HIg,76
 plotnine/_mpl/utils.py,sha256=CHRhcOnB7O3Fj953COiwBi6ccF2TQG8puvUVLWO3e_k,11051
 plotnine/_mpl/layout_manager/__init__.py,sha256=w3OZfdMJAFIDrQYVoYG6pvRPqwTNoQ4KJ0zXdJq8L7U,79
-plotnine/_mpl/layout_manager/_composition_layout_items.py,sha256=6Byw7I15Ax-htkb22ekbSQYG-DoGSxOKWoErWd-druo,3018
-plotnine/_mpl/layout_manager/_composition_side_space.py,sha256=PH9YlkxUp5MGAEFST-lhrgCPTg05jszH32QnPzrj1es,13552
+plotnine/_mpl/layout_manager/_composition_layout_items.py,sha256=1GQwH1ZvzbenRyi3zmDnLkLck5ndC8UV3u0WdMp0qpw,4705
+plotnine/_mpl/layout_manager/_composition_side_space.py,sha256=VZ56K0agpcQ0XSMgMyCluFkPI1NKS0YmzYD0-LF5H9Q,14538
 plotnine/_mpl/layout_manager/_engine.py,sha256=Fn5Xsk2oPywlG5qj6PTqjgTxxR9tN8npGw7XEaZyXL4,1511
 plotnine/_mpl/layout_manager/_grid.py,sha256=dLzLv5BFVErVoI0DsDeca3zn4JMMcg5tv-BajSV9Ag0,2382
 plotnine/_mpl/layout_manager/_layout_tree.py,sha256=m9QVRa3N6pBVMaoZPTzhXzh_RUVdF54wUgKoxlMpfgw,20794
-plotnine/_mpl/layout_manager/_plot_layout_items.py,sha256=EHzThpxg-XAK1DD2sGVXGcbAfAR1bW4bF8NhXhKou8M,23867
-plotnine/_mpl/layout_manager/_plot_side_space.py,sha256=bUoDHXUrw_1v54oGuq8JLlCoBDSj01DBsDEUkJoGDGQ,33026
+plotnine/_mpl/layout_manager/_plot_layout_items.py,sha256=XyRDmqEbZSCKeowfx2_OVfZNnhNDR5RS6uoGTHIAyEM,25540
+plotnine/_mpl/layout_manager/_plot_side_space.py,sha256=NqhYZeQBXoqQNpSag26nEh-dnyr8uyhiZF53quAWg0Q,33650
 plotnine/_mpl/layout_manager/_side_space.py,sha256=RjsVctYLzDJyoGpPVEEyGEfJSfEetVhRRiBVz-eQXkI,5303
 plotnine/_utils/__init__.py,sha256=wefs_rvVdrWwhyWtDLarI6Bm7CDNUSSBWYlvbdWDzLQ,31528
-plotnine/_utils/context.py,sha256=e2W9PM5OyGuyAEOxyu5YE0HXmlsNgbMpdjqdOABQA3s,3896
+plotnine/_utils/context.py,sha256=VrM2SP91xSwYZAflJYgp4WaglxFBn222NyrMM8ux-sk,3988
 plotnine/_utils/dataclasses.py,sha256=ahEoC7WeMsRB4_M9YBAuMpR-xm6LkpryAueLwJMXkNo,609
 plotnine/_utils/dev.py,sha256=0qgRbMhcd4dfuLuYxx0skocKAtfwHF02ntyILRBogbg,1629
 plotnine/_utils/ipython.py,sha256=mGD83wi3q0Sk2XfAbr9zyBxYNXVwXv-lmgnA3QXH0bI,1768
@@ -39,8 +39,8 @@ plotnine/_utils/registry.py,sha256=HoiB2NnbEHufXjYnVJyrJKflk2RwKtTYk2L3n7tH4XA,3
 plotnine/_utils/yippie.py,sha256=DbmxvVrd34P24CCmOZrAulyGQ35rXNaSr8BuutS2Uio,2392
 plotnine/composition/__init__.py,sha256=OoJG-K08x_c7abAGRfdWIBnGcBfRlC_WekjMd2ktQ6g,360
 plotnine/composition/_beside.py,sha256=TxrmQCFnmMnqoMawDhTLj5l-J4_VWL1XRDnjoQChFBQ,1436
-plotnine/composition/_compose.py,sha256=Tu7hwFX97VLNNg2i_ZnQFHtpvkPhYNWGxgkTdYjPotw,17763
-plotnine/composition/_plot_annotation.py,sha256=zulwsFJ-dlEEoZIsYh14b02eSlvp4MsW_PgqY6guYp0,2034
+plotnine/composition/_compose.py,sha256=4wPU3P-2WNBGnLFhPLaQZSyy_vTujovJhpe3cBOtpiw,18465
+plotnine/composition/_plot_annotation.py,sha256=RMA_vdcHFT9KVUbhwS-NZdPTbqb-XgAYRflWs8J3bVE,2116
 plotnine/composition/_plot_layout.py,sha256=JPYPtRutHtILOLU1xf6x0c1G_263Q_62GtN0kI0LqxE,3732
 plotnine/composition/_plot_spacer.py,sha256=RSzH4yRdcK0iairZZ88CE8onpr6NzNaDgtNnSW6ePzY,1859
 plotnine/composition/_stack.py,sha256=djjFrqO3-lOvKMYw87OSrF4BbHU9deFrk0l1wpUYSS8,1454
@@ -131,7 +131,7 @@ plotnine/guides/__init__.py,sha256=ulI-mDhtq3jAQEAqPv8clrn3UHGFOu3xRuO7jXlq-LY,2
 plotnine/guides/guide.py,sha256=09Zojde0stGEZbVNyx6m5As2PCaLRxzQvYNid-Y0YBU,8596
 plotnine/guides/guide_axis.py,sha256=zG_5Ot1kTuHOeuQspL5V1A1-7c7X8cNeMDoF01Ghh2w,296
 plotnine/guides/guide_colorbar.py,sha256=1RbF2WjqrouoELBdZNpy-4olsnJoSTOX--RYgbCx-Gw,18322
-plotnine/guides/guide_legend.py,sha256=gJ8AKr_YRL66Xxp4_nyWzhnQk5a1Bmns5PJhLZDwVBU,15084
+plotnine/guides/guide_legend.py,sha256=EshNFzbYUiR31J0ZFLGrJmdZk9AwRawIcY5INpr8vcw,15486
 plotnine/guides/guides.py,sha256=SzdmK-XX5cR6YgysjNjdoynCATThX1pDDX2a6ghvseU,15485
 plotnine/mapping/__init__.py,sha256=DLu9E0kwwuHxzTUenoVjCNTTdkWMwIDtkExLleBq1MI,205
 plotnine/mapping/_atomic.py,sha256=TbobHVJlHRoSHibi6OOWMVM2J1r_kKQJMS6G5zvEhrg,4029
@@ -199,22 +199,22 @@ plotnine/stats/stat_unique.py,sha256=1SdLNm2CjhjONAwo714uB3tc5KX7vSDHAi1geJdWtDY
 plotnine/stats/stat_ydensity.py,sha256=_OVYc-QELPKMc24BvQaA9cPkfEoC_hW2teeo8yL8iao,5661
 plotnine/themes/__init__.py,sha256=tEKIF4gYmOF2Z1-_UDdK8zh41dLl-61HUGIhOQvki6I,916
 plotnine/themes/seaborn_rcmod.py,sha256=Pi-UX5LyH9teSuteYpqPOEnfLgKUz01LnKDyDA7Aois,15502
-plotnine/themes/targets.py,sha256=MjBRWWRgsLXXM_PJffPsV4DttQJB_m11jdD837BteuU,1686
-plotnine/themes/theme.py,sha256=UAgV-xx0eSQzIO0_fmZcupXmc7vCS3mQgxY9eyxjegA,16089
+plotnine/themes/targets.py,sha256=yEwkaDhL1UoOBdlx9SWCQsSRg9oOjnFZgtJrtY_LyFA,1866
+plotnine/themes/theme.py,sha256=zucHnZ4pJC_iLxBEy-ZNRLa6sRuKEeMq6SHW-sywoiE,16218
 plotnine/themes/theme_538.py,sha256=hr0FaGAffZYU3m8o90WuUWntaPgI2O_eGiaBz259MiM,1088
 plotnine/themes/theme_bw.py,sha256=XXUt9KXEIkROiU0ZVIZicypneb-zL5K1cQFPqYd5WAI,1010
 plotnine/themes/theme_classic.py,sha256=B6QkU6blGnEY5iaiPtu4VsvFzC0peWSAhlKiC2SJSkM,923
 plotnine/themes/theme_dark.py,sha256=tF6BJ2A4jE6C-Mhl95DQiAbu-mK0Hr1MaymhbJzaD2Q,1255
-plotnine/themes/theme_gray.py,sha256=VRPCWvorGLnqNRVgtvACYDPEvHMQigtp-qMrgOcyar8,5265
+plotnine/themes/theme_gray.py,sha256=yKbjIowSSFiP5lBDk30dBSuUwtRyv8L8b5XZi6TEfWQ,5641
 plotnine/themes/theme_light.py,sha256=1vDa6QlLz2vJaa1gYfyttVuXxde2MwDnMnJAqToJMGs,1415
 plotnine/themes/theme_linedraw.py,sha256=woMr18xoEJmsD8ZCiUpdyn-CE-P1AGFHRNapwCGWUjg,1350
-plotnine/themes/theme_matplotlib.py,sha256=3JPOGhFz6Nul2s03Djd254RPtHtcQ0fsi3Hc9OIi0kc,4248
+plotnine/themes/theme_matplotlib.py,sha256=8isOcIJlq8c3RbZnPLj6aUIAMHbTzLSF7gFHGdiO0Wk,4586
 plotnine/themes/theme_minimal.py,sha256=YhkKNA48jP2OLa8-kHMfXFEFRjcsfWBLMID2orITrmo,884
-plotnine/themes/theme_seaborn.py,sha256=8giJh8QvkMJ8pr_XXHPDMfkysoI2_yr0vJhz48_sQGI,4319
+plotnine/themes/theme_seaborn.py,sha256=iJM3HR0BlElhIj0PvqR1bGyJGaWPKQnz6K7AQGkGmps,4695
 plotnine/themes/theme_tufte.py,sha256=qUOrZhQyfJgc0fmy8Es7tT7aYqUSzCjvkP7-dBilwHE,1926
-plotnine/themes/theme_void.py,sha256=itsmb9pWCZAwgccw_zHDjQRfhRRbAiMNo4zZ1zeBgIU,3223
+plotnine/themes/theme_void.py,sha256=e7OgZPR0pmAewwKxKYtRR2X6zGSySGjdXKPHikZK6S0,3501
 plotnine/themes/theme_xkcd.py,sha256=5MOdj_H23Kr_jbDnepmq1DQDbn8-TfUmtzYBZTb4RB4,2207
-plotnine/themes/themeable.py,sha256=nH6bluQ87wpVpQDB5qzE5ZfoxgaNEML6NK0FcTFMdPI,72387
+plotnine/themes/themeable.py,sha256=mCqZzo7gm0J1AqpSfeUOsfKijwuI8o1dOcU33he6kT4,74782
 plotnine/themes/elements/__init__.py,sha256=xV1la_mTv1BQ3zQp7ZGVGPdV6KohvEVhKAi1uPTeAs0,327
 plotnine/themes/elements/element_base.py,sha256=D7cfEglzsSuhW91KpZVAZ2MAHWZp64r9Aajoh8uMGZ4,832
 plotnine/themes/elements/element_blank.py,sha256=4r7-6HeR1494oWNIGQh0ASrFQ4SLvYa6aQHA85eH-Ds,187
@@ -222,8 +222,8 @@ plotnine/themes/elements/element_line.py,sha256=zJ6KL2_LcQ0aQjT4fzNA1f9c1QZ3xEeT
 plotnine/themes/elements/element_rect.py,sha256=w5cLH-Sr4cTRXVdkRiu8kBqFt3TXHhIb1MUITfi89gE,1767
 plotnine/themes/elements/element_text.py,sha256=NrHlGKB0cO0v_C7hkarTMPb2QVsTOoxVuCMS6hmv62U,6552
 plotnine/themes/elements/margin.py,sha256=jMHe-UKHHer_VYwAVDC-Tz2-AP_4YDuXPTWAuacoqgU,4080
-plotnine-0.16.0a2.dist-info/licenses/LICENSE,sha256=GY4tQiUd17Tq3wWR42Zs9MRTFOTf6ahIXhZTcwAdOeU,1082
-plotnine-0.16.0a2.dist-info/METADATA,sha256=xj-INX2wadP6ZX7rAP0LBZBbLWwoZMMp3At6ZeusAY8,9498
-plotnine-0.16.0a2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-plotnine-0.16.0a2.dist-info/top_level.txt,sha256=t340Mbko1ZbmvYPkQ81dIiPHcaQdTUszYz-bWUpr8ys,9
-plotnine-0.16.0a2.dist-info/RECORD,,
+plotnine-0.16.0a3.dist-info/licenses/LICENSE,sha256=GY4tQiUd17Tq3wWR42Zs9MRTFOTf6ahIXhZTcwAdOeU,1082
+plotnine-0.16.0a3.dist-info/METADATA,sha256=O9d0UTthOHQ1pUScUwJSfK9v02LSQlJASwALXCa3vNs,9498
+plotnine-0.16.0a3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+plotnine-0.16.0a3.dist-info/top_level.txt,sha256=t340Mbko1ZbmvYPkQ81dIiPHcaQdTUszYz-bWUpr8ys,9
+plotnine-0.16.0a3.dist-info/RECORD,,

{plotnine-0.16.0a2.dist-info → plotnine-0.16.0a3.dist-info}/WHEEL

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