Refactor strip_text & strip_text_background

Author: has2k1

doc/changelog.qmd

@@ -112,6 +112,20 @@ title: Changelog
 - Fixed theming of `axis_text`, `axis_text_x` and  `axis_text_y` so when they can be
   overriden if previously set to `element_blank()`.
 
+- Fixed `strip_text_x_background`s to always have equal heights and `strip_text_y_background`s
+  to have equal widths. This applies to cases where the texts have unequal number of lines or
+  they are rotated but have different lengths.
+
+- Fixed the empty space below the plot title (or subtitle) when `strip_text_x_background`s are
+  partly or fully aligned within the panel. This space (hole), was not accounted for by any of
+  the themeables. This affected `theme_xkcd` and any `theme` settings that tried to slide the
+  text / background into the panel.
+
+- Fixed the empty space to the left the right margin when the `strip_text_y_background`s are
+  partly or fully aligned within the panel. This space (hole), was not accounted for by any of 
+  the themeables. This affected `theme_xkcd` and any `theme` settings that tried to slide the
+  text / background into the panel.
+
 ## v0.14.5
 (2025-01-02)
 [![](https://zenodo.org/badge/DOI/10.5281/zenodo.14587381.svg)](https://doi.org/10.5281/zenodo.14587381)

plotnine/_mpl/layout_manager/_layout_items.py

@@ -6,6 +6,8 @@
 
 from matplotlib.text import Text
 
+from plotnine._mpl.patches import StripTextPatch
+from plotnine._utils import ha_as_float, va_as_float
 from plotnine.exceptions import PlotnineError
 
 from ..utils import (
@@ -35,7 +37,11 @@
     from plotnine._mpl.text import StripText
     from plotnine.iapi import legend_artists
     from plotnine.themes.elements import margin as Margin
-    from plotnine.typing import StripPosition
+    from plotnine.typing import (
+        HorizontalJustification,
+        StripPosition,
+        VerticalJustification,
+    )
 
     from ._spaces import LayoutSpaces
 
@@ -299,9 +305,9 @@ def axis_ticks_y(self, ax: Axes) -> Iterator[Tick]:
 
         return chain(major, minor)
 
-    def strip_text_x_height(self, position: StripPosition) -> float:
+    def strip_text_x_extra_height(self, position: StripPosition) -> float:
         """
-        Height taken up by the top strips
+        Height taken up by the top strips that is outside the panels
         """
         if not self.strip_text_x:
             return 0
@@ -311,11 +317,23 @@ def strip_text_x_height(self, position: StripPosition) -> float:
             for st in self.strip_text_x
             if st.patch.position == position
         ]
-        return self.calc.max_height(artists)
 
-    def strip_text_y_width(self, position: StripPosition) -> float:
+        heights = []
+
+        for a in artists:
+            info = (
+                a.text.draw_info
+                if isinstance(a, StripTextPatch)
+                else a.draw_info
+            )
+            h = self.calc.height(a)
+            heights.append(max(h + h * info.strip_align, 0))
+
+        return max(heights)
+
+    def strip_text_y_extra_width(self, position: StripPosition) -> float:
         """
-        Width taken up by the right strips
+        Width taken up by the top strips that is outside the panels
         """
         if not self.strip_text_y:
             return 0
@@ -325,7 +343,19 @@ def strip_text_y_width(self, position: StripPosition) -> float:
             for st in self.strip_text_y
             if st.patch.position == position
         ]
-        return self.calc.max_width(artists)
+
+        widths = []
+
+        for a in artists:
+            info = (
+                a.text.draw_info
+                if isinstance(a, StripTextPatch)
+                else a.draw_info
+            )
+            w = self.calc.width(a)
+            widths.append(max(w + w * info.strip_align, 0))
+
+        return max(widths)
 
     def axis_ticks_x_max_height_at(self, location: AxesLocation) -> float:
         """
@@ -489,6 +519,8 @@ def _adjust_positions(self, spaces: LayoutSpaces):
 
         self._adjust_axis_text_x(justify)
         self._adjust_axis_text_y(justify)
+        self._strip_text_x_background_equal_heights()
+        self._strip_text_y_background_equal_widths()
 
     def _adjust_axis_text_x(self, justify: TextJustifier):
         """
@@ -574,6 +606,36 @@ def to_horizontal_axis_dimensions(value: float, ax: Axes) -> float:
                     text, ha, -axis_text_col_width, 0, width=width
                 )
 
+    def _strip_text_x_background_equal_heights(self):
+        """
+        Make the strip_text_x_backgrounds have equal heights
+
+        The smaller heights are expanded to match the largest height
+        """
+        if not self.strip_text_x:
+            return
+
+        heights = [self.calc.bbox(t.patch).height for t in self.strip_text_x]
+        max_height = max(heights)
+        relative_heights = [max_height / h for h in heights]
+        for text, scale in zip(self.strip_text_x, relative_heights):
+            text.patch.expand = scale
+
+    def _strip_text_y_background_equal_widths(self):
+        """
+        Make the strip_text_y_backgrounds have equal widths
+
+        The smaller widths are expanded to match the largest width
+        """
+        if not self.strip_text_y:
+            return
+
+        widths = [self.calc.bbox(t.patch).width for t in self.strip_text_y]
+        max_width = max(widths)
+        relative_widths = [max_width / w for w in widths]
+        for text, scale in zip(self.strip_text_y, relative_widths):
+            text.patch.expand = scale
+
 
 def _text_is_visible(text: Text) -> bool:
     """
@@ -596,16 +658,15 @@ class TextJustifier:
     def horizontally(
         self,
         text: Text,
-        ha: str | float,
+        ha: HorizontalJustification | float,
         left: float,
         right: float,
         width: float | None = None,
     ):
         """
         Horizontally Justify text between left and right
         """
-        lookup = {"left": 0.0, "center": 0.5, "right": 1.0}
-        rel = lookup.get(ha, ha)  # pyright: ignore[reportCallIssue, reportArgumentType]
+        rel = ha_as_float(ha)
         if width is None:
             width = self.spaces.items.calc.width(text)
         x = rel_position(rel, width, left, right)
@@ -615,50 +676,51 @@ def horizontally(
     def vertically(
         self,
         text: Text,
-        va: str | float,
+        va: VerticalJustification | float,
         bottom: float,
         top: float,
         height: float | None = None,
     ):
         """
         Vertically Justify text between bottom and top
         """
-        lookup = {
-            "top": 1.0,
-            "center": 0.5,
-            "baseline": 0.5,
-            "center_baseline": 0.5,
-            "bottom": 0.0,
-        }
-        rel = lookup.get(va, va)  # pyright: ignore[reportCallIssue, reportArgumentType]
+        rel = va_as_float(va)
 
         if height is None:
             height = self.spaces.items.calc.height(text)
         y = rel_position(rel, height, bottom, top)
         text.set_y(y)
         text.set_verticalalignment("bottom")
 
-    def horizontally_across_panel(self, text: Text, ha: str | float):
+    def horizontally_across_panel(
+        self, text: Text, ha: HorizontalJustification | float
+    ):
         """
         Horizontally Justify text accross the panel(s) width
         """
         self.horizontally(text, ha, self.spaces.l.left, self.spaces.r.right)
 
-    def horizontally_across_plot(self, text: Text, ha: str | float):
+    def horizontally_across_plot(
+        self, text: Text, ha: HorizontalJustification | float
+    ):
         """
         Horizontally Justify text across the plot's width
         """
         self.horizontally(
             text, ha, self.spaces.l.plot_left, self.spaces.r.plot_right
         )
 
-    def vertically_along_panel(self, text: Text, va: str | float):
+    def vertically_along_panel(
+        self, text: Text, va: VerticalJustification | float
+    ):
         """
         Horizontally Justify text along the panel(s) height
         """
         self.vertically(text, va, self.spaces.b.bottom, self.spaces.t.top)
 
-    def vertically_along_plot(self, text: Text, va: str | float):
+    def vertically_along_plot(
+        self, text: Text, va: VerticalJustification | float
+    ):
         """
         Vertically Justify text along the plot's height
         """

plotnine/_mpl/layout_manager/_spaces.py

@@ -433,7 +433,7 @@ class right_spaces(_side_spaces):
     margin_alignment: float = 0
     legend: float = 0
     legend_box_spacing: float = 0
-    strip_text_y_width_right: float = 0
+    strip_text_y_extra_width: float = 0
 
     def _calculate(self):
         items = self.items
@@ -452,7 +452,7 @@ def _calculate(self):
             self.legend = self.legend_width
             self.legend_box_spacing = theme.getp("legend_box_spacing")
 
-        self.strip_text_y_width_right = items.strip_text_y_width("right")
+        self.strip_text_y_extra_width = items.strip_text_y_extra_width("right")
 
         # Adjust plot_margin to make room for ylabels that protude well
         # beyond the axes
@@ -545,7 +545,7 @@ class top_spaces(_side_spaces):
     plot_subtitle_margin_bottom: float = 0
     legend: float = 0
     legend_box_spacing: float = 0
-    strip_text_x_height_top: float = 0
+    strip_text_x_extra_height: float = 0
 
     def _calculate(self):
         items = self.items
@@ -578,7 +578,7 @@ def _calculate(self):
             self.legend = self.legend_height
             self.legend_box_spacing = theme.getp("legend_box_spacing") * F
 
-        self.strip_text_x_height_top = items.strip_text_x_height("top")
+        self.strip_text_x_extra_height = items.strip_text_x_extra_height("top")
 
         # Adjust plot_margin to make room for ylabels that protude well
         # beyond the axes
@@ -1061,7 +1061,7 @@ def _calculate_panel_spacing_facet_wrap(self) -> tuple[float, float]:
         # Only interested in the proportion of the strip that
         # does not overlap with the panel
         if strip_align_x > -1:
-            self.sh += self.t.strip_text_x_height_top * (1 + strip_align_x)
+            self.sh += self.t.strip_text_x_extra_height * (1 + strip_align_x)
 
         if facet.free["x"]:
             self.sh += self.items.axis_text_x_max_height_at(