plotnine 0.14.5__py3-none-any.whl → 0.15.0a2__py3-none-any.whl

plotnine/_mpl/layout_manager/_spaces.py

@@ -0,0 +1,1154 @@
+"""
+Routines to adjust subplot params so that subplots are
+nicely fit in the figure. In doing so, only axis labels, tick labels, axes
+titles and offsetboxes that are anchored to axes are currently considered.
+
+Internally, this module assumes that the margins (left margin, etc.) which are
+differences between `Axes.get_tightbbox` and `Axes.bbox` are independent of
+Axes position. This may fail if `Axes.adjustable` is `datalim` as well as
+such cases as when left or right margin are affected by xlabel.
+"""
+
+from __future__ import annotations
+
+from abc import ABC
+from dataclasses import dataclass, field, fields
+from functools import cached_property
+from typing import TYPE_CHECKING, cast
+
+from plotnine.facets import facet_grid, facet_null, facet_wrap
+
+from ._layout_items import LayoutItems
+
+if TYPE_CHECKING:
+    from dataclasses import Field
+    from typing import Generator
+
+    from plotnine import ggplot
+    from plotnine._mpl.gridspec import p9GridSpec
+    from plotnine.iapi import outside_legend
+    from plotnine.typing import Side
+
+# Note
+# Margins around the plot are specified in figure coordinates
+# We interpret that value to be a fraction of the width. So along
+# the vertical direction we multiply by W/H to get equal space
+# in both directions
+
+
+@dataclass
+class GridSpecParams:
+    """
+    Gridspec Parameters
+    """
+
+    left: float
+    right: float
+    top: float
+    bottom: float
+    wspace: float
+    hspace: float
+
+    @property
+    def valid(self) -> bool:
+        """
+        Return True if the params will create a non-empty area
+        """
+        return self.top - self.bottom > 0 and self.right - self.left > 0
+
+
+@dataclass
+class _side_spaces(ABC):
+    """
+    Base class to for spaces
+
+    A *_space class does the book keeping for all the artists that may
+    fall on that side of the panels. The same name may appear in multiple
+    side classes (e.g. legend).
+
+    The amount of space for each artist is computed in figure coordinates.
+    """
+
+    items: LayoutItems
+
+    def __post_init__(self):
+        self.side: Side = cast("Side", self.__class__.__name__[:-7])
+        """
+        Side of the panel(s) that this class applies to
+        """
+        self._calculate()
+
+    def _calculate(self):
+        """
+        Calculate the space taken up by each artist
+        """
+
+    @property
+    def total(self) -> float:
+        """
+        Total space
+        """
+        return sum(getattr(self, f.name) for f in fields(self)[1:])
+
+    def sum_upto(self, item: str) -> float:
+        """
+        Sum of space upto but not including item
+
+        Sums from the edge of the figure i.e. the "plot_margin".
+        """
+
+        def _fields_upto(item: str) -> Generator[Field, None, None]:
+            for f in fields(self)[1:]:
+                if f.name == item:
+                    break
+                yield f
+
+        return sum(getattr(self, f.name) for f in _fields_upto(item))
+
+    def sum_incl(self, item: str) -> float:
+        """
+        Sum of space upto and including the item
+
+        Sums from the edge of the figure i.e. the "plot_margin".
+        """
+
+        def _fields_upto(item: str) -> Generator[Field, None, None]:
+            for f in fields(self)[1:]:
+                yield f
+                if f.name == item:
+                    break
+
+        return sum(getattr(self, f.name) for f in _fields_upto(item))
+
+    @cached_property
+    def _legend_size(self) -> tuple[float, float]:
+        """
+        Return size of legend in figure coordinates
+
+        We need this to accurately justify the legend by proportional
+        values e.g. 0.2, instead of just left, right, top,  bottom &
+        center.
+        """
+        if not self.has_legend:
+            return (0, 0)
+
+        ol: outside_legend = getattr(self.items.legends, self.side)
+        return self.items.calc.size(ol.box)
+
+    @cached_property
+    def legend_width(self) -> float:
+        """
+        Return width of legend in figure coordinates
+        """
+        return self._legend_size[0]
+
+    @cached_property
+    def legend_height(self) -> float:
+        """
+        Return height of legend in figure coordinates
+        """
+        return self._legend_size[1]
+
+    @cached_property
+    def gs(self) -> p9GridSpec:
+        """
+        The gridspec of the plot
+        """
+        return self.items.plot._gridspec
+
+    @property
+    def offset(self) -> float:
+        """
+        Distance in figure dimensions from the edge of the figure
+
+        Derived classes should override this method
+
+        The space/margin and size consumed by artists is in figure dimensions
+        but the exact position is relative to the position of the GridSpec
+        within the figure. The offset accounts for the position of the
+        GridSpec and allows us to accurately place artists using figure
+        coordinates.
+
+        Example of an offset
+
+         Figure
+         ----------------------------------------
+        |                                        |
+        |          Plot GridSpec                 |
+        |          --------------------------    |
+        | offset  |                          |   |
+        |<------->| X                        |   |
+        |         |   Panels GridSpec        |   |
+        |         |   --------------------   |   |
+        |         |  |                    |  |   |
+        |         |  |                    |  |   |
+        |         |  |                    |  |   |
+        |         |  |                    |  |   |
+        |         |   --------------------   |   |
+        |         |                          |   |
+        |          --------------------------    |
+        |                                        |
+         ----------------------------------------
+        """
+        return 0
+
+    def to_figure_space(self, rel_value: float) -> float:
+        """
+        Convert value relative to the gridspec to one in figure space
+
+        The result is meant to be used with transFigure transforms.
+
+        Parameters
+        ----------
+        rel_value :
+            Position relative to the position of the gridspec
+        """
+        return self.offset + rel_value
+
+    @property
+    def has_tag(self) -> bool:
+        """
+        Return True if the space/margin to this side of the panel has a tag
+
+        If it does, then it will be included in the layout
+        """
+        getp = self.items.plot.theme.getp
+        return getp("plot_tag_location") == "margin" and self.side in getp(
+            "plot_tag_position"
+        )
+
+    @property
+    def has_legend(self) -> bool:
+        """
+        Return True if the space/margin to this side of the panel has a legend
+
+        If it does, then it will be included in the layout
+        """
+        if not self.items.legends:
+            return False
+        return hasattr(self.items.legends, self.side)
+
+    @property
+    def tag_width(self) -> float:
+        """
+        The width of the tag including the margins
+
+        The value is zero expect if all these are true:
+            - The tag is in the margin `theme(plot_tag_position = "margin")`
+            - The tag at one one of the the following locations;
+              left, right, topleft, topright, bottomleft or bottomright
+        """
+        return 0
+
+    @property
+    def tag_height(self) -> float:
+        """
+        The height of the tag including the margins
+
+        The value is zero expect if all these are true:
+            - The tag is in the margin `theme(plot_tag_position = "margin")`
+            - The tag at one one of the the following locations;
+              top, bottom, topleft, topright, bottomleft or bottomright
+        """
+        return 0
+
+
+@dataclass
+class left_spaces(_side_spaces):
+    """
+    Space in the figure for artists on the left of the panel area
+
+    Ordered from the edge of the figure and going inwards
+    """
+
+    plot_margin: float = 0
+    tag_alignment: float = 0
+    """
+    Space added to align the tag in this plot with others in a composition
+
+    This value is calculated during the layout process, and it ensures that
+    all tags on this side of the plot take up the same amount of space in
+    the margin. e.g. from
+
+         ------------------------------------
+        | plot_margin | tag | artists        |
+        |------------------------------------|
+        | plot_margin | A long tag | artists |
+         ------------------------------------
+
+    to
+
+         ------------------------------------
+        | plot_margin |     tag    | artists |
+        |------------------------------------|
+        | plot_margin | A long tag | artists |
+         ------------------------------------
+
+    And the tag is justified within that space e.g if ha="left" we get
+
+         ------------------------------------
+        | plot_margin | tag        | artists |
+        |------------------------------------|
+        | plot_margin | A long tag | artists |
+         ------------------------------------
+
+    So, contrary to the order in which the space items are laid out, the 
+    tag_alignment does not necessarily come before the plot_tag.
+    """
+    plot_tag_margin_left: float = 0
+    plot_tag: float = 0
+    plot_tag_margin_right: float = 0
+    margin_alignment: float = 0
+    """
+    Space added to align this plot with others in a composition
+
+    This value is calculated during the layout process in a tree structure
+    that has convenient access to the sides/edges of the panels in the
+    composition.
+    """
+    legend: float = 0
+    legend_box_spacing: float = 0
+    axis_title_y_margin_left: float = 0
+    axis_title_y: float = 0
+    axis_title_y_margin_right: float = 0
+    axis_text_y_margin_left: float = 0
+    axis_text_y: float = 0
+    axis_text_y_margin_right: float = 0
+    axis_ticks_y: float = 0
+
+    def _calculate(self):
+        theme = self.items.plot.theme
+        calc = self.items.calc
+        items = self.items
+
+        self.plot_margin = theme.getp("plot_margin_left")
+
+        if self.has_tag and items.plot_tag:
+            m = theme.get_margin("plot_tag").fig
+            self.plot_tag_margin_left = m.l
+            self.plot_tag = calc.width(items.plot_tag)
+            self.plot_tag_margin_right = m.r
+
+        if items.legends and items.legends.left:
+            self.legend = self.legend_width
+            self.legend_box_spacing = theme.getp("legend_box_spacing")
+
+        if items.axis_title_y:
+            m = theme.get_margin("axis_title_y").fig
+            self.axis_title_y_margin_left = m.l
+            self.axis_title_y = calc.width(items.axis_title_y)
+            self.axis_title_y_margin_right = m.r
+
+        # Account for the space consumed by the axis
+        self.axis_text_y = items.axis_text_y_max_width_at("first_col")
+        if self.axis_text_y:
+            m = theme.get_margin("axis_text_y").fig
+            self.axis_text_y_margin_left = m.l
+            self.axis_text_y_margin_right = m.r
+
+        self.axis_ticks_y = items.axis_ticks_y_max_width_at("first_col")
+
+        # Adjust plot_margin to make room for ylabels that protude well
+        # beyond the axes
+        # NOTE: This adjustment breaks down when the protrusion is large
+        protrusion = items.axis_text_x_left_protrusion("all")
+        adjustment = protrusion - (self.total - self.plot_margin)
+        if adjustment > 0:
+            self.plot_margin += adjustment
+
+    @property
+    def offset(self) -> float:
+        """
+        Distance from left of the figure to the left of the plot gridspec
+
+              ----------------(1, 1)
+             |      ----      |
+             |  dx |    |     |
+             |<--->|    |     |
+             |     |    |     |
+             |      ----      |
+        (0, 0)----------------
+
+        """
+        return self.gs.bbox_relative.x0
+
+    def x1(self, item: str) -> float:
+        """
+        Lower x-coordinate in figure space of the item
+        """
+        return self.to_figure_space(self.sum_upto(item))
+
+    def x2(self, item: str) -> float:
+        """
+        Higher x-coordinate in figure space of the item
+        """
+        return self.to_figure_space(self.sum_incl(item))
+
+    @property
+    def left_relative(self):
+        """
+        Left (relative to the gridspec) of the panels in figure dimensions
+        """
+        return self.total
+
+    @property
+    def left(self):
+        """
+        Left of the panels in figure space
+        """
+        return self.to_figure_space(self.left_relative)
+
+    @property
+    def plot_left(self):
+        """
+        Distance up to the left-most artist in figure space
+        """
+        return self.x1("legend")
+
+    @property
+    def tag_width(self):
+        """
+        The width of the tag including the margins
+        """
+        return (
+            self.plot_tag_margin_left
+            + self.plot_tag
+            + self.plot_tag_margin_right
+        )
+
+
+@dataclass
+class right_spaces(_side_spaces):
+    """
+    Space in the figure for artists on the right of the panel area
+
+    Ordered from the edge of the figure and going inwards
+    """
+
+    plot_margin: float = 0
+    tag_alignment: float = 0
+    plot_tag_margin_right: float = 0
+    plot_tag: float = 0
+    plot_tag_margin_left: float = 0
+    margin_alignment: float = 0
+    legend: float = 0
+    legend_box_spacing: float = 0
+    strip_text_y_extra_width: float = 0
+
+    def _calculate(self):
+        items = self.items
+        theme = self.items.plot.theme
+        calc = self.items.calc
+
+        self.plot_margin = theme.getp("plot_margin_right")
+
+        if self.has_tag and items.plot_tag:
+            m = theme.get_margin("plot_tag").fig
+            self.plot_tag_margin_right = m.r
+            self.plot_tag = calc.width(items.plot_tag)
+            self.plot_tag_margin_left = m.l
+
+        if items.legends and items.legends.right:
+            self.legend = self.legend_width
+            self.legend_box_spacing = theme.getp("legend_box_spacing")
+
+        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
+        # NOTE: This adjustment breaks down when the protrusion is large
+        protrusion = items.axis_text_x_right_protrusion("all")
+        adjustment = protrusion - (self.total - self.plot_margin)
+        if adjustment > 0:
+            self.plot_margin += adjustment
+
+    @property
+    def offset(self):
+        """
+        Distance from right of the figure to the right of the plot gridspec
+
+              ---------------(1, 1)
+             |     ----      |
+             |    |    | -dx |
+             |    |    |<--->|
+             |    |    |     |
+             |     ----      |
+        (0, 0)---------------
+
+        """
+        return self.gs.bbox_relative.x1 - 1
+
+    def x1(self, item: str) -> float:
+        """
+        Lower x-coordinate in figure space of the item
+        """
+        return self.to_figure_space(1 - self.sum_incl(item))
+
+    def x2(self, item: str) -> float:
+        """
+        Higher x-coordinate in figure space of the item
+        """
+        return self.to_figure_space(1 - self.sum_upto(item))
+
+    @property
+    def right_relative(self):
+        """
+        Right (relative to the gridspec) of the panels in figure dimensions
+        """
+        return 1 - self.total
+
+    @property
+    def right(self):
+        """
+        Right of the panels in figure space
+        """
+        return self.to_figure_space(self.right_relative)
+
+    @property
+    def plot_right(self):
+        """
+        Distance up to the right-most artist in figure space
+        """
+        return self.x2("legend")
+
+    @property
+    def tag_width(self):
+        """
+        The width of the tag including the margins
+        """
+        return (
+            self.plot_tag_margin_right
+            + self.plot_tag
+            + self.plot_tag_margin_left
+        )
+
+
+@dataclass
+class top_spaces(_side_spaces):
+    """
+    Space in the figure for artists above the panel area
+
+    Ordered from the edge of the figure and going inwards
+    """
+
+    plot_margin: float = 0
+    tag_alignment: float = 0
+    plot_tag_margin_top: float = 0
+    plot_tag: float = 0
+    plot_tag_margin_bottom: float = 0
+    margin_alignment: float = 0
+    plot_title_margin_top: float = 0
+    plot_title: float = 0
+    plot_title_margin_bottom: float = 0
+    plot_subtitle_margin_top: float = 0
+    plot_subtitle: float = 0
+    plot_subtitle_margin_bottom: float = 0
+    legend: float = 0
+    legend_box_spacing: float = 0
+    strip_text_x_extra_height: float = 0
+
+    def _calculate(self):
+        items = self.items
+        theme = self.items.plot.theme
+        calc = self.items.calc
+        W, H = theme.getp("figure_size")
+        F = W / H
+
+        self.plot_margin = theme.getp("plot_margin_top") * F
+
+        if self.has_tag and items.plot_tag:
+            m = theme.get_margin("plot_tag").fig
+            self.plot_tag_margin_top = m.t
+            self.plot_tag = calc.height(items.plot_tag)
+            self.plot_tag_margin_bottom = m.b
+
+        if items.plot_title:
+            m = theme.get_margin("plot_title").fig
+            self.plot_title_margin_top = m.t * F
+            self.plot_title = calc.height(items.plot_title)
+            self.plot_title_margin_bottom = m.b * F
+
+        if items.plot_subtitle:
+            m = theme.get_margin("plot_subtitle").fig
+            self.plot_subtitle_margin_top = m.t * F
+            self.plot_subtitle = calc.height(items.plot_subtitle)
+            self.plot_subtitle_margin_bottom = m.b * F
+
+        if items.legends and items.legends.top:
+            self.legend = self.legend_height
+            self.legend_box_spacing = theme.getp("legend_box_spacing") * F
+
+        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
+        # NOTE: This adjustment breaks down when the protrusion is large
+        protrusion = items.axis_text_y_top_protrusion("all")
+        adjustment = protrusion - (self.total - self.plot_margin)
+        if adjustment > 0:
+            self.plot_margin += adjustment
+
+    @property
+    def offset(self) -> float:
+        """
+        Distance from top of the figure to the top of the plot gridspec
+
+              ----------------(1, 1)
+             |       ^        |
+             |       |-dy     |
+             |       v        |
+             |      ----      |
+             |     |    |     |
+             |     |    |     |
+             |     |    |     |
+             |      ----      |
+             |                |
+        (0, 0)----------------
+        """
+        return self.gs.bbox_relative.y1 - 1
+
+    def y1(self, item: str) -> float:
+        """
+        Lower y-coordinate in figure space of the item
+        """
+        return self.to_figure_space(1 - self.sum_incl(item))
+
+    def y2(self, item: str) -> float:
+        """
+        Higher y-coordinate in figure space of the item
+        """
+        return self.to_figure_space(1 - self.sum_upto(item))
+
+    @property
+    def top_relative(self):
+        """
+        Top (relative to the gridspec) of the panels in figure dimensions
+        """
+        return 1 - self.total
+
+    @property
+    def top(self):
+        """
+        Top of the panels in figure space
+        """
+        return self.to_figure_space(self.top_relative)
+
+    @property
+    def plot_top(self):
+        """
+        Distance up to the top-most artist in figure space
+        """
+        return self.y2("legend")
+
+    @property
+    def tag_height(self):
+        """
+        The height of the tag including the margins
+        """
+        return (
+            self.plot_tag_margin_top
+            + self.plot_tag
+            + self.plot_tag_margin_bottom
+        )
+
+
+@dataclass
+class bottom_spaces(_side_spaces):
+    """
+    Space in the figure for artists below the panel area
+
+    Ordered from the edge of the figure and going inwards
+    """
+
+    plot_margin: float = 0
+    tag_alignment: float = 0
+    plot_tag_margin_bottom: float = 0
+    plot_tag: float = 0
+    plot_tag_margin_top: float = 0
+    margin_alignment: float = 0
+    plot_caption_margin_bottom: float = 0
+    plot_caption: float = 0
+    plot_caption_margin_top: float = 0
+    legend: float = 0
+    legend_box_spacing: float = 0
+    axis_title_x_margin_bottom: float = 0
+    axis_title_x: float = 0
+    axis_title_x_margin_top: float = 0
+    axis_text_x_margin_bottom: float = 0
+    axis_text_x: float = 0
+    axis_text_x_margin_top: float = 0
+    axis_ticks_x: float = 0
+
+    def _calculate(self):
+        items = self.items
+        theme = self.items.plot.theme
+        calc = self.items.calc
+        W, H = theme.getp("figure_size")
+        F = W / H
+
+        self.plot_margin = theme.getp("plot_margin_bottom") * F
+
+        if self.has_tag and items.plot_tag:
+            m = theme.get_margin("plot_tag").fig
+            self.plot_tag_margin_bottom = m.b
+            self.plot_tag = calc.height(items.plot_tag)
+            self.plot_tag_margin_top = m.t
+
+        if items.plot_caption:
+            m = theme.get_margin("plot_caption").fig
+            self.plot_caption_margin_bottom = m.b * F
+            self.plot_caption = calc.height(items.plot_caption)
+            self.plot_caption_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
+
+        if items.axis_title_x:
+            m = theme.get_margin("axis_title_x").fig
+            self.axis_title_x_margin_bottom = m.b * F
+            self.axis_title_x = calc.height(items.axis_title_x)
+            self.axis_title_x_margin_top = m.t * F
+
+        # Account for the space consumed by the axis
+        self.axis_text_x = items.axis_text_x_max_height_at("last_row")
+        if self.axis_text_x:
+            m = theme.get_margin("axis_text_x").fig
+            self.axis_text_x_margin_bottom = m.b
+            self.axis_text_x_margin_top = m.t
+        self.axis_ticks_x = items.axis_ticks_x_max_height_at("last_row")
+
+        # Adjust plot_margin to make room for ylabels that protude well
+        # beyond the axes
+        # NOTE: This adjustment breaks down when the protrusion is large
+        protrusion = items.axis_text_y_bottom_protrusion("all")
+        adjustment = protrusion - (self.total - self.plot_margin)
+        if adjustment > 0:
+            self.plot_margin += adjustment
+
+    @property
+    def offset(self) -> float:
+        """
+        Distance from bottom of the figure to the bottom of the plot gridspec
+
+              ----------------(1, 1)
+             |                |
+             |      ----      |
+             |     |    |     |
+             |     |    |     |
+             |     |    |     |
+             |      ----      |
+             |       ^        |
+             |       |dy      |
+             |       v        |
+        (0, 0)----------------
+        """
+        return self.gs.bbox_relative.y0
+
+    def y1(self, item: str) -> float:
+        """
+        Lower y-coordinate in figure space of the item
+        """
+        return self.to_figure_space(self.sum_upto(item))
+
+    def y2(self, item: str) -> float:
+        """
+        Higher y-coordinate in figure space of the item
+        """
+        return self.to_figure_space(self.sum_incl(item))
+
+    @property
+    def bottom_relative(self):
+        """
+        Bottom (relative to the gridspec) of the panels in figure dimensions
+        """
+        return self.total
+
+    @property
+    def bottom(self):
+        """
+        Bottom of the panels in figure space
+        """
+        return self.to_figure_space(self.bottom_relative)
+
+    @property
+    def plot_bottom(self):
+        """
+        Distance up to the bottom-most artist in figure space
+        """
+        return self.y1("legend")
+
+    @property
+    def tag_height(self):
+        """
+        The height of the tag including the margins
+        """
+        return (
+            self.plot_tag_margin_bottom
+            + self.plot_tag
+            + self.plot_tag_margin_top
+        )
+
+
+@dataclass
+class LayoutSpaces:
+    """
+    Compute the all the spaces required in the layout
+
+    These are:
+
+    1. The space of each artist between the panel and the edge of the
+       figure.
+    2. The space in-between the panels
+
+    From these values, we put together the grid-spec parameters required
+    by matplotblib to position the axes. We also use the values to adjust
+    the coordinates of all the artists that occupy these spaces, placing
+    them in their final positions.
+    """
+
+    plot: ggplot
+
+    l: left_spaces = field(init=False)
+    """All subspaces to the left of the panels"""
+
+    r: right_spaces = field(init=False)
+    """All subspaces to the right of the panels"""
+
+    t: top_spaces = field(init=False)
+    """All subspaces above the top of the panels"""
+
+    b: bottom_spaces = field(init=False)
+    """All subspaces below the bottom of the panels"""
+
+    W: float = field(init=False, default=0)
+    """Figure Width [inches]"""
+
+    H: float = field(init=False, default=0)
+    """Figure Height [inches]"""
+
+    w: float = field(init=False, default=0)
+    """Axes width w.r.t figure in [0, 1]"""
+
+    h: float = field(init=False, default=0)
+    """Axes height w.r.t figure in [0, 1]"""
+
+    sh: float = field(init=False, default=0)
+    """horizontal spacing btn panels w.r.t figure"""
+
+    sw: float = field(init=False, default=0)
+    """vertical spacing btn panels w.r.t figure"""
+
+    gsparams: GridSpecParams = field(init=False, repr=False)
+    """Grid spacing btn panels w.r.t figure"""
+
+    def __post_init__(self):
+        self.items = LayoutItems(self.plot)
+        self.W, self.H = self.plot.theme.getp("figure_size")
+
+        # Calculate the spacing along the edges of the panel area
+        # (spacing required by plotnine)
+        self.l = left_spaces(self.items)
+        self.r = right_spaces(self.items)
+        self.t = top_spaces(self.items)
+        self.b = bottom_spaces(self.items)
+
+    def get_gridspec_params(self) -> GridSpecParams:
+        # Calculate the gridspec params
+        # (spacing required by mpl)
+        self.gsparams = self._calculate_panel_spacing()
+
+        # Adjust the spacing parameters for the desired aspect ratio
+        # It is simpler to adjust for the aspect ratio than to calculate
+        # the final parameters that are true to the aspect ratio in
+        # one-short
+        if (ratio := self.plot.facet._aspect_ratio()) is not None:
+            current_ratio = self.aspect_ratio
+            if ratio > current_ratio:
+                # Increase aspect ratio, taller panels
+                self._reduce_width(ratio)
+            elif ratio < current_ratio:
+                # Increase aspect ratio, wider panels
+                self._reduce_height(ratio)
+
+        return self.gsparams
+
+    @property
+    def plot_width(self) -> float:
+        """
+        Width [figure dimensions] of the whole plot
+        """
+        return self.plot._gridspec.bbox_relative.width
+
+    @property
+    def plot_height(self) -> float:
+        """
+        Height [figure dimensions] of the whole plot
+        """
+        return self.plot._gridspec.bbox_relative.height
+
+    @property
+    def panel_width(self) -> float:
+        """
+        Width [figure dimensions] of panels
+        """
+        return self.r.right - self.l.left
+
+    @property
+    def panel_height(self) -> float:
+        """
+        Height [figure dimensions] of panels
+        """
+        return self.t.top - self.b.bottom
+
+    @property
+    def tag_width(self) -> float:
+        """
+        Width [figure dimensions] of space taken up by the tag
+        """
+        # Atleast one of these is zero
+        return max(self.l.tag_width, self.r.tag_width)
+
+    @property
+    def tag_height(self) -> float:
+        """
+        Height [figure dimensions] of space taken up by the tag
+        """
+        # Atleast one of these is zero
+        return max(self.t.tag_height, self.b.tag_height)
+
+    @property
+    def left_tag_width(self) -> float:
+        """
+        Width [figure dimensions] of space taken up by a left tag
+        """
+        return self.l.tag_width
+
+    @property
+    def right_tag_width(self) -> float:
+        """
+        Width [figure dimensions] of space taken up by a right tag
+        """
+        return self.r.tag_width
+
+    @property
+    def top_tag_height(self) -> float:
+        """
+        Width [figure dimensions] of space taken up by a top tag
+        """
+        return self.t.tag_height
+
+    @property
+    def bottom_tag_height(self) -> float:
+        """
+        Height [figure dimensions] of space taken up by a bottom tag
+        """
+        return self.b.tag_height
+
+    def increase_horizontal_plot_margin(self, dw: float):
+        """
+        Increase the plot_margin to the right & left of the panels
+        """
+        self.l.plot_margin += dw
+        self.r.plot_margin += dw
+
+    def increase_vertical_plot_margin(self, dh: float):
+        """
+        Increase the plot_margin to the above & below of the panels
+        """
+        self.t.plot_margin += dh
+        self.b.plot_margin += dh
+
+    @property
+    def plot_area_coordinates(
+        self,
+    ) -> tuple[tuple[float, float], tuple[float, float]]:
+        """
+        Lower-left and upper-right coordinates of the plot area
+
+        This is the area surrounded by the plot_margin.
+        """
+        x1, x2 = self.l.x2("plot_margin"), self.r.x1("plot_margin")
+        y1, y2 = self.b.y2("plot_margin"), self.t.y1("plot_margin")
+        return ((x1, y1), (x2, y2))
+
+    @property
+    def panel_area_coordinates(
+        self,
+    ) -> tuple[tuple[float, float], tuple[float, float]]:
+        """
+        Lower-left and upper-right coordinates of the panel area
+
+        This is the area in which the panels are drawn.
+        """
+        x1, x2 = self.l.left, self.r.right
+        y1, y2 = self.b.bottom, self.t.top
+        return ((x1, y1), (x2, y2))
+
+    def _calculate_panel_spacing(self) -> GridSpecParams:
+        """
+        Spacing between the panels (wspace & hspace)
+
+        Both spaces are calculated from a fraction of the width.
+        This ensures that the same fraction gives equals space
+        in both directions.
+        """
+        if isinstance(self.plot.facet, facet_wrap):
+            wspace, hspace = self._calculate_panel_spacing_facet_wrap()
+        elif isinstance(self.plot.facet, facet_grid):
+            wspace, hspace = self._calculate_panel_spacing_facet_grid()
+        elif isinstance(self.plot.facet, facet_null):
+            wspace, hspace = self._calculate_panel_spacing_facet_null()
+        else:
+            raise TypeError(f"Unknown type of facet: {type(self.plot.facet)}")
+
+        return GridSpecParams(
+            self.l.left_relative,
+            self.r.right_relative,
+            self.t.top_relative,
+            self.b.bottom_relative,
+            wspace,
+            hspace,
+        )
+
+    def _calculate_panel_spacing_facet_grid(self) -> tuple[float, float]:
+        """
+        Calculate spacing parts for facet_grid
+        """
+        theme = self.plot.theme
+
+        ncol = self.plot.facet.ncol
+        nrow = self.plot.facet.nrow
+
+        # Both spacings are specified as fractions of the figure width
+        # Multiply the vertical by (W/H) so that the gullies along both
+        # directions are equally spaced.
+        self.sw = theme.getp("panel_spacing_x")
+        self.sh = theme.getp("panel_spacing_y") * self.W / self.H
+
+        # width and height of axes as fraction of figure width & height
+        self.w = ((self.r.right - self.l.left) - self.sw * (ncol - 1)) / ncol
+        self.h = ((self.t.top - self.b.bottom) - self.sh * (nrow - 1)) / nrow
+
+        # Spacing as fraction of axes width & height
+        wspace = self.sw / self.w
+        hspace = self.sh / self.h
+        return (wspace, hspace)
+
+    def _calculate_panel_spacing_facet_wrap(self) -> tuple[float, float]:
+        """
+        Calculate spacing parts for facet_wrap
+        """
+        facet = self.plot.facet
+        theme = self.plot.theme
+
+        ncol = facet.ncol
+        nrow = facet.nrow
+
+        # Both spacings are specified as fractions of the figure width
+        self.sw = theme.getp("panel_spacing_x")
+        self.sh = theme.getp("panel_spacing_y") * self.W / self.H
+
+        # A fraction of the strip height
+        # Effectively slides the strip
+        #   +ve: Away from the panel
+        #    0:  Top of the panel
+        #   -ve: Into the panel
+        # Where values <= -1, put the strip completely into
+        # the panel. We do not worry about larger -ves.
+        strip_align_x = theme.getp("strip_align_x")
+
+        # 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_extra_height * (1 + strip_align_x)
+
+        if facet.free["x"]:
+            self.sh += self.items.axis_text_x_max_height_at(
+                "all"
+            ) + self.items.axis_ticks_x_max_height_at("all")
+        if facet.free["y"]:
+            self.sw += self.items.axis_text_y_max_width_at(
+                "all"
+            ) + self.items.axis_ticks_y_max_width_at("all")
+
+        # width and height of axes as fraction of figure width & height
+        self.w = ((self.r.right - self.l.left) - self.sw * (ncol - 1)) / ncol
+        self.h = ((self.t.top - self.b.bottom) - self.sh * (nrow - 1)) / nrow
+
+        # Spacing as fraction of axes width & height
+        wspace = self.sw / self.w
+        hspace = self.sh / self.h
+        return (wspace, hspace)
+
+    def _calculate_panel_spacing_facet_null(self) -> tuple[float, float]:
+        """
+        Calculate spacing parts for facet_null
+        """
+        self.w = self.r.right - self.l.left
+        self.h = self.t.top - self.b.bottom
+        self.sw = 0
+        self.sh = 0
+        return 0, 0
+
+    def _reduce_height(self, ratio: float):
+        """
+        Reduce the height of axes to get the aspect ratio
+        """
+        # New height w.r.t figure height
+        h1 = ratio * self.w * (self.W / self.H)
+
+        # Half of the total vertical reduction w.r.t figure height
+        dh = (self.h - h1) * self.plot.facet.nrow / 2
+
+        # Reduce plot area height
+        self.gsparams.top -= dh
+        self.gsparams.bottom += dh
+        self.gsparams.hspace = self.sh / h1
+
+        # Add more vertical plot margin
+        self.increase_vertical_plot_margin(dh)
+
+    def _reduce_width(self, ratio: float):
+        """
+        Reduce the width of axes to get the aspect ratio
+        """
+        # New width w.r.t figure width
+        w1 = (self.h * self.H) / (ratio * self.W)
+
+        # Half of the total horizontal reduction w.r.t figure width
+        dw = (self.w - w1) * self.plot.facet.ncol / 2
+
+        # Reduce width
+        self.gsparams.left += dw
+        self.gsparams.right -= dw
+        self.gsparams.wspace = self.sw / w1
+
+        # Add more horizontal margin
+        self.increase_horizontal_plot_margin(dw)
+
+    @property
+    def aspect_ratio(self) -> float:
+        """
+        Default aspect ratio of the panels
+        """
+        return (self.h * self.H) / (self.w * self.W)
+
+    @cached_property
+    def gs(self) -> p9GridSpec:
+        """
+        The gridspec
+        """
+        return self.plot._gridspec
+
+    def to_figure_space(
+        self,
+        position: tuple[float, float],
+    ) -> tuple[float, float]:
+        """
+        Convert position from gridspec space to figure space
+        """
+        _x, _y = position
+        x = self.l.plot_left + (self.r.plot_right - self.l.plot_left) * _x
+        y = self.b.plot_bottom + (self.t.plot_top - self.b.plot_bottom) * _y
+        return (x, y)