diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
index 08bb483d606b..da2a50ffa2c6 100644
--- a/lib/matplotlib/figure.py
+++ b/lib/matplotlib/figure.py
@@ -1201,6 +1201,67 @@ def text(self, x, y, s, fontdict=None, **kwargs):
self.stale = True
return text
+ 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
+ """
+ return self.subplotpars
+
@_docstring.dedent_interpd
def colorbar(
self, mappable, cax=None, ax=None, use_gridspec=True, **kwargs):
@@ -2346,6 +2407,10 @@ def draw(self, renderer):
@_docstring.interpd
+@_api.define_aliases({
+ "size_inches": ["figsize"],
+ "layout_engine": ["layout"],
+})
class Figure(FigureBase):
"""
The top level container for all the plot elements.
diff --git a/lib/matplotlib/figure.pyi b/lib/matplotlib/figure.pyi
index 2b2bd9a49326..f1d294dbf115 100644
--- a/lib/matplotlib/figure.pyi
+++ b/lib/matplotlib/figure.pyi
@@ -241,6 +241,13 @@ class FigureBase(Artist):
gridspec_kw: dict[str, Any] | None = ...
) -> dict[Any, Axes]: ...
+ def set_subplotparams(
+ self,
+ subplotparams: SubplotParams | dict[str, Any] = ...,
+ ) -> None: ...
+
+ def get_subplotparams(self) -> SubplotParams: ...
+
class SubFigure(FigureBase):
figure: Figure
subplotpars: SubplotParams
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
index 474331bf9149..8effd129a050 100644
--- a/lib/matplotlib/tests/test_figure.py
+++ b/lib/matplotlib/tests/test_figure.py
@@ -1611,3 +1611,42 @@ def test_get_constrained_layout_pads():
fig = plt.figure(layout=mpl.layout_engine.ConstrainedLayoutEngine(**params))
with pytest.warns(PendingDeprecationWarning, match="will be deprecated"):
assert fig.get_constrained_layout_pads() == expected
+
+
+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_fig_get_set():
+ varnames = filter(lambda var: var not in ['self', 'kwargs', 'args'],
+ Figure.__init__.__code__.co_varnames)
+ fig = plt.figure()
+ for var in varnames:
+ # if getattr fails then the getter and setter does not exist
+ getfunc = getattr(fig, f"get_{var}")
+ setfunc = getattr(fig, f"set_{var}")
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