diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
index 73f1629180aa..60e9a40252bf 100644
--- a/lib/matplotlib/figure.py
+++ b/lib/matplotlib/figure.py
@@ -288,6 +288,64 @@ def set_figure(self, fig):
doc=("The root `Figure`. To get the parent of a `SubFigure`, "
"use the `get_figure` method."))
+ def set_subplotparams(self, subplotparams={}):
+ """
+ .. Set the subplot layout parameters.
+ Accepts either a `.SubplotParams` object, from which the relevant
+ parameters are copied, or a dictionary of subplot layout parameters.
+ If a dictionary is provided, this function is a convenience wrapper for
+ `matplotlib.figure.Figure.subplots_adjust`
+ Parameters
+ ----------
+ subplotparams : `~matplotlib.figure.SubplotParams` or dict with keys
+ "left", "bottom", "right", 'top", "wspace", "hspace"] , optional
+ SubplotParams object to copy new subplot parameters from, or a dict
+ of SubplotParams constructor arguments.
+ By default, an empty dictionary is passed, which maintains the
+ current state of the figure's `.SubplotParams`
+ See Also
+ --------
+ matplotlib.figure.Figure.subplots_adjust
+ matplotlib.figure.Figure.get_subplotparams
+ """
+
+ subplotparams_args = ["left", "bottom", "right",
+ "top", "wspace", "hspace"]
+ kwargs = {}
+ if isinstance(subplotparams, SubplotParams):
+ for key in subplotparams_args:
+ kwargs[key] = getattr(subplotparams, key)
+ elif isinstance(subplotparams, dict):
+ for key in subplotparams.keys():
+ if key in subplotparams_args:
+ kwargs[key] = subplotparams[key]
+ else:
+ _api.warn_external(
+ f"'{key}' is not a valid key for set_subplotparams;"
+ " this key was ignored.")
+ else:
+ raise TypeError(
+ "subplotparams must be a dictionary of keyword-argument pairs or"
+ " an instance of SubplotParams()")
+ if kwargs == {}:
+ self.set_subplotparams(self.get_subplotparams())
+ self.subplots_adjust(**kwargs)
+
+ def get_subplotparams(self):
+ """
+ Return the `.SubplotParams` object associated with the Figure.
+ Returns
+ -------
+ .SubplotParams`
+ See Also
+ --------
+ matplotlib.figure.Figure.subplots_adjust
+ matplotlib.figure.Figure.get_subplotparams
+ """
+ subplotparms = []
+ for subfig in self.subfigs:
+ subplotparms.append(subfig.get_subplotparams())
+ return subplotparms
def contains(self, mouseevent):
"""
Test whether the mouse event occurred on the figure.
@@ -2866,6 +2924,70 @@ def set_tight_layout(self, tight):
self.set_layout_engine(_tight, **_tight_parameters)
self.stale = True
+ def get_subplotparams(self):
+ """
+ Return the `.SubplotParams` object associated with the Figure.
+ Returns
+ -------
+ .SubplotParams`
+ See Also
+ --------
+ matplotlib.figure.Figure.subplots_adjust
+ matplotlib.figure.Figure.get_subplotparams
+ """
+ return self.subplotpars
+
+ def set_subplotparams(self, subplotparams={}):
+ """
+ .. Set the subplot layout parameters.
+ Accepts either a `.SubplotParams` object, from which the relevant
+ parameters are copied, or a dictionary of subplot layout parameters.
+ If a dictionary is provided, this function is a convenience wrapper for
+ `matplotlib.figure.Figure.subplots_adjust`
+ Parameters
+ ----------
+ subplotparams : `~matplotlib.figure.SubplotParams` or dict with keys
+ "left", "bottom", "right", 'top", "wspace", "hspace"] , optional
+ SubplotParams object to copy new subplot parameters from, or a dict
+ of SubplotParams constructor arguments.
+ By default, an empty dictionary is passed, which maintains the
+ current state of the figure's `.SubplotParams`
+ See Also
+ --------
+ matplotlib.figure.Figure.subplots_adjust
+ matplotlib.figure.Figure.get_subplotparams
+ """
+ subplotparams_args = ["left", "bottom", "right",
+ "top", "wspace", "hspace"]
+ kwargs = {}
+ if isinstance(subplotparams, SubplotParams):
+ for key in subplotparams_args:
+ kwargs[key] = getattr(subplotparams, key)
+ elif isinstance(subplotparams, dict):
+ for key in subplotparams.keys():
+ if key in subplotparams_args:
+ kwargs[key] = subplotparams[key]
+ else:
+ _api.warn_external(
+ f"'{key}' is not a valid key for set_subplotparams;"
+ " this key was ignored.")
+ else:
+ raise TypeError(
+ "subplotparams must be a dictionary of keyword-argument pairs or"
+ " an instance of SubplotParams()")
+ if kwargs == {}:
+ self.set_subplotparams(self.get_subplotparams())
+ self.subplots_adjust(**kwargs)
+
+ @property
+ def get_figsize(self):
+ return self.get_size_inches()
+
+ @property
+ def set_figsize(self, w, h=None, forward=True):
+ self.set_size_inches(self, w, h=None, forward=True)
+
+
def get_constrained_layout(self):
"""
Return whether constrained layout is being used.
diff --git a/lib/matplotlib/figure.pyi b/lib/matplotlib/figure.pyi
index ade4cfd6f16d..b37c464689ee 100644
--- a/lib/matplotlib/figure.pyi
+++ b/lib/matplotlib/figure.pyi
@@ -67,6 +67,8 @@ class FigureBase(Artist):
def get_figure(self, root: Literal[False]) -> Figure | SubFigure: ...
@overload
def get_figure(self, root: bool = ...) -> Figure | SubFigure: ...
+
+ def get_subplotparams(self) -> SubplotParams: ...
def set_frameon(self, b: bool) -> None: ...
@property
def frameon(self) -> bool: ...
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
index 99045e773d02..9abfd5b17318 100644
--- a/lib/matplotlib/tests/test_figure.py
+++ b/lib/matplotlib/tests/test_figure.py
@@ -241,7 +241,33 @@ def test_gca():
assert fig.axes == [ax0, ax1]
assert fig.gca() is ax1
+def test_get_subplot_params():
+ fig = plt.figure()
+ subplotparams_keys = ["left", "bottom", "right", "top", "wspace", "hspace"]
+ subplotparams = fig.get_subplotparams()
+ test_dict = {}
+ for key in subplotparams_keys:
+ attr = getattr(subplotparams, key)
+ assert attr == mpl.rcParams[f"figure.subplot.{key}"]
+ test_dict[key] = attr * 2
+
+ fig.set_subplotparams(test_dict)
+ for key, value in test_dict.items():
+ assert getattr(fig.get_subplotparams(), key) == value
+
+ test_dict['foo'] = 'bar'
+ with pytest.warns(UserWarning,
+ match="'foo' is not a valid key for set_subplotparams;"
+ " this key was ignored"):
+ fig.set_subplotparams(test_dict)
+
+ with pytest.raises(TypeError,
+ match="subplotparams must be a dictionary of "
+ "keyword-argument pairs or "
+ "an instance of SubplotParams()"):
+ fig.set_subplotparams(['foo'])
+ assert fig.subplotpars == fig.get_subplotparams()
def test_add_subplot_subclass():
fig = plt.figure()
fig.add_subplot(axes_class=Axes)
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy