Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commite428983

Browse files
committed
Add Figure parameter layout and discourage tight_layout / constrained_layout
1 parent67d04a8 commite428983

File tree

2 files changed

+67
-12
lines changed

2 files changed

+67
-12
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Discouraged: ``Figure`` parameters *tight_layout* and *constrained_layout*
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
The ``Figure`` parameters *tight_layout* and *constrained_layout* are
4+
triggering competing layout mechanisms and thus should not be used together.
5+
6+
To make the API clearer, we've merged them under the new parameter *layout*
7+
with values 'constrained' (equal to ``constrained_layout=True``), 'tight'
8+
(equal to ``tight_layout=True``). If given *layout* takes precedence.
9+
10+
The use of *tight_layout* and *constrained_layout* is discouraged in favor
11+
of *layout*. However, these parameters will stay available for backward
12+
compatibility.

‎lib/matplotlib/figure.py

Lines changed: 55 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2149,6 +2149,8 @@ def __init__(self,
21492149
subplotpars=None,# rc figure.subplot.*
21502150
tight_layout=None,# rc figure.autolayout
21512151
constrained_layout=None,# rc figure.constrained_layout.use
2152+
*,
2153+
layout=None,
21522154
**kwargs
21532155
):
21542156
"""
@@ -2178,19 +2180,42 @@ def __init__(self,
21782180
parameters :rc:`figure.subplot.*` are used.
21792181
21802182
tight_layout : bool or dict, default: :rc:`figure.autolayout`
2181-
If ``False`` use *subplotpars*. If ``True`` adjust subplot
2182-
parameters using `.tight_layout` with default padding.
2183-
When providing a dict containing the keys ``pad``, ``w_pad``,
2184-
``h_pad``, and ``rect``, the default `.tight_layout` paddings
2185-
will be overridden.
2183+
Whether to use the tight layout mechanism. See `.set_tight_layout`.
2184+
2185+
.. admonition:: Discouraged
2186+
2187+
The use of this parameter is discouraged. Please use
2188+
``layout='tight'`` instead for the common case of
2189+
``tight_layout=True`` and use `.set_tight_layout` otherwise.
21862190
21872191
constrained_layout : bool, default: :rc:`figure.constrained_layout.use`
2188-
If ``True`` use constrained layout to adjust positioning of plot
2189-
elements. Like ``tight_layout``, but designed to be more
2190-
flexible. See
2191-
:doc:`/tutorials/intermediate/constrainedlayout_guide`
2192-
for examples. (Note: does not work with `add_subplot` or
2193-
`~.pyplot.subplot2grid`.)
2192+
This is equal to ``layout='constrained'``.
2193+
2194+
.. admonition:: Discouraged
2195+
2196+
The use of this parameter is discouraged. Please use
2197+
``layout='constrained'`` instead.
2198+
2199+
layout : {'constrained', 'tight'}, optional
2200+
The layout mechanism for positioning of plot elements.
2201+
Supported values:
2202+
2203+
- 'constrained': The constrained layout solver usually gives the
2204+
best layout results and is thus recommended. However, it is
2205+
computationally expensive and can be slow for complex figures
2206+
with many elements.
2207+
2208+
See :doc:`/tutorials/intermediate/constrainedlayout_guide`
2209+
for examples.
2210+
2211+
- 'tight': Use the tight layout mechanism. This is a relatively
2212+
simple algorithm, that adjusts the subplot parameters so that
2213+
decorations like tick labels, axis labels and titles have enough
2214+
space. See `.Figure.set_tight_layout` for further details.
2215+
2216+
If not given, fall back to using the parameters *tight_layout* and
2217+
*constrained_layout*, including their config defaults
2218+
:rc:`figure.autolayout` and :rc:`figure.constrained_layout.use`.
21942219
21952220
Other Parameters
21962221
----------------
@@ -2200,6 +2225,24 @@ def __init__(self,
22002225
"""
22012226
super().__init__(**kwargs)
22022227

2228+
iflayoutisnotNone:
2229+
iftight_layoutisnotNone:
2230+
_api.warn_external(
2231+
"The Figure parameters 'layout' and 'tight_layout' "
2232+
"cannot be used together. Please use 'layout' only.")
2233+
ifconstrained_layoutisnotNone:
2234+
_api.warn_external(
2235+
"The Figure parameters 'layout' and 'constrained_layout' "
2236+
"cannot be used together. Please use 'layout' only.")
2237+
iflayout=='constrained':
2238+
tight_layout=False
2239+
constrained_layout=True
2240+
eliflayout=='tight':
2241+
tight_layout=True
2242+
constrained_layout=False
2243+
else:
2244+
raiseValueError(f"Invalid value for 'layout':{layout!r}")
2245+
22032246
self.callbacks=cbook.CallbackRegistry()
22042247
# Callbacks traditionally associated with the canvas (and exposed with
22052248
# a proxy property), but that actually need to be on the figure for
@@ -2362,7 +2405,7 @@ def set_tight_layout(self, tight):
23622405
----------
23632406
tight : bool or dict with keys "pad", "w_pad", "h_pad", "rect" or None
23642407
If a bool, sets whether to call `.tight_layout` upon drawing.
2365-
If ``None``, usethe ``figure.autolayout`` rcparam instead.
2408+
If ``None``, use:rc:`figure.autolayout` instead.
23662409
If a dict, pass it as kwargs to `.tight_layout`, overriding the
23672410
default paddings.
23682411
"""

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp