@@ -2172,31 +2172,26 @@ def __init__(self,
2172
2172
"""
2173
2173
Parameters
2174
2174
----------
2175
- figsize : 2-tuple of floats, default: :rc:`figure.figsize`
2176
- Figure dimension ``(width, height)`` in inches.
2175
+ figsize : 2-tuple of floats, default: :rc:`figure.figsize` Figure
2176
+ dimension ``(width, height)`` in inches.
2177
2177
2178
- dpi : float, default: :rc:`figure.dpi`
2179
- Dots per inch.
2178
+ dpi : float, default: :rc:`figure.dpi` Dots per inch.
2180
2179
2181
- facecolor : default: :rc:`figure.facecolor`
2182
- The figure patch facecolor.
2180
+ facecolor : default: :rc:`figure.facecolor` The figure patch facecolor.
2183
2181
2184
- edgecolor : default: :rc:`figure.edgecolor`
2185
- The figure patch edge color.
2182
+ edgecolor : default: :rc:`figure.edgecolor` The figure patch edge color.
2186
2183
2187
- linewidth : float
2188
- The linewidth of the frame (i.e. the edge linewidth of the figure
2189
- patch).
2184
+ linewidth : float The linewidth of the frame (i.e. the edge linewidth of
2185
+ the figure patch).
2190
2186
2191
- frameon : bool, default: :rc:`figure.frameon`
2192
- If ``False``, suppress drawing the figure background patch.
2187
+ frameon : bool, default: :rc:`figure.frameon` If ``False``, suppress
2188
+ drawing the figure background patch.
2193
2189
2194
- subplotpars : `SubplotParams`
2195
- Subplot parameters. If not given, the default subplot
2196
- parameters :rc:`figure.subplot.*` are used.
2190
+ subplotpars : `SubplotParams` Subplot parameters. If not given, the
2191
+ default subplot parameters :rc:`figure.subplot.*` are used.
2197
2192
2198
- tight_layout : bool or dict, default: :rc:`figure.autolayout`
2199
- Whether to use the tight layout mechanism. See `.set_tight_layout`.
2193
+ tight_layout : bool or dict, default: :rc:`figure.autolayout` Whether to
2194
+ use the tight layout mechanism. See `.set_tight_layout`.
2200
2195
2201
2196
.. admonition:: Discouraged
2202
2197
@@ -2212,22 +2207,25 @@ def __init__(self,
2212
2207
The use of this parameter is discouraged. Please use
2213
2208
``layout='constrained'`` instead.
2214
2209
2215
- layout : {'constrained', 'tight'}, optional
2216
- The layout mechanism for positioning of plot elements.
2210
+ layout : {'constrained', 'tight'}, optional, default: None
2211
+ The layout mechanism for positioning of plot elements to avoid
2212
+ overlapping Axes decorations (labels, ticks, etc). Note that
2213
+ layout managers can have significant performance penalties as
2214
+ they require an extra draw and solve an inverse problem.
2215
+
2217
2216
Supported values:
2218
2217
2219
- - 'constrained': The constrained layout solver usually gives the
2220
- best layout results and is thus recommended. However, it is
2221
- computationally expensive and can be slow for complex figures
2222
- with many elements.
2218
+ - 'constrained': The constrained layout solver adjusts axes sizes
2219
+ to avoid overlapping axes decorations. Can handle complex plot
2220
+ layouts and colorbars, and is thus recommended.
2223
2221
2224
2222
See :doc:`/tutorials/intermediate/constrainedlayout_guide`
2225
2223
for examples.
2226
2224
2227
2225
- 'tight': Use the tight layout mechanism. This is a relatively
2228
- simple algorithm, that adjusts the subplot parameters so that
2229
- decorations like tick labels, axis labels and titles have enough
2230
- space. See `.Figure.set_tight_layout` for further details.
2226
+ simple algorithm that adjusts the subplot parameters so that
2227
+ decorations do not overlap. See `.Figure.set_tight_layout` for
2228
+ further details.
2231
2229
2232
2230
If not given, fall back to using the parameters *tight_layout* and
2233
2231
*constrained_layout*, including their config defaults
0 commit comments