{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathtight_layout_api.html
More file actions
243 lines (218 loc) · 15.2 KB
/
Copy pathtight_layout_api.html
File metadata and controls
243 lines (218 loc) · 15.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.tight_layout — Matplotlib 3.2.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.2.1-13-g7a9bc5ebb-dirty" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.2.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="matplotlib.transforms" href="transformations.html" />
<link rel="prev" title="matplotlib.ticker" href="ticker_api.html" />
<link rel="top" title="Matplotlib 3.2.1 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/tight_layout_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.2.1). For the latest version see <a href="https://matplotlib.org/stable/api/tight_layout_api.html">https://matplotlib.org/stable/api/tight_layout_api.html</a></div>
<div id="annc-banner">
<p>John Hunter Excellence in Plotting Contest 2020
<a href="https://jhepc.github.io/about.html"> submissions are open!
</a>
Entries are due June 1, 2020.</p>
</div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.2.1</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="transformations.html" title="matplotlib.transforms"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="ticker_api.html" title="matplotlib.ticker"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="ticker_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.ticker</span></code></a></li>
<li>Next: <a href="transformations.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.transforms</span></code></a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/tight_layout_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.tight_layout">
<span id="matplotlib-tight-layout"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.tight_layout</span></code><a class="headerlink" href="#module-matplotlib.tight_layout" title="Permalink to this headline">¶</a></h1>
<p>This module provides 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.</p>
<p>Internally, it assumes that the margins (left_margin, etc.) which are
differences between ax.get_tightbbox and ax.bbox are independent of axes
position. This may fail if Axes.adjustable is datalim. Also, This will fail
for some cases (for example, left or right margin is affected by xlabel).</p>
<dl class="py function">
<dt id="matplotlib.tight_layout.auto_adjust_subplotpars">
<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">auto_adjust_subplotpars</code><span class="sig-paren">(</span><em><span class="n">fig</span></em>, <em><span class="n">renderer</span></em>, <em><span class="n">nrows_ncols</span></em>, <em><span class="n">num1num2_list</span></em>, <em><span class="n">subplot_list</span></em>, <em><span class="n">ax_bbox_list</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">pad</span><span class="o">=</span><span class="default_value">1.08</span></em>, <em><span class="n">h_pad</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">w_pad</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">rect</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/tight_layout.html#auto_adjust_subplotpars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.tight_layout.auto_adjust_subplotpars" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dict of subplot parameters to adjust spacing between subplots
or <code class="docutils literal notranslate"><span class="pre">None</span></code> if resulting axes would have zero height or width.</p>
<p>Note that this function ignores geometry information of subplot
itself, but uses what is given by the <em>nrows_ncols</em> and <em>num1num2_list</em>
parameters. Also, the results could be incorrect if some subplots have
<code class="docutils literal notranslate"><span class="pre">adjustable=datalim</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>nrows_ncols</strong><span class="classifier">Tuple[int, int]</span></dt><dd><p>Number of rows and number of columns of the grid.</p>
</dd>
<dt><strong>num1num2_list</strong><span class="classifier">List[int]</span></dt><dd><p>List of numbers specifying the area occupied by the subplot</p>
</dd>
<dt><strong>subplot_list</strong><span class="classifier">list of subplots</span></dt><dd><p>List of subplots that will be used to calculate optimal subplot_params.</p>
</dd>
<dt><strong>pad</strong><span class="classifier">float</span></dt><dd><p>Padding between the figure edge and the edges of subplots, as a
fraction of the font size.</p>
</dd>
<dt><strong>h_pad, w_pad</strong><span class="classifier">float</span></dt><dd><p>Padding (height/width) between edges of adjacent subplots, as a
fraction of the font size. Defaults to <em>pad</em>.</p>
</dd>
<dt><strong>rect</strong><span class="classifier">Tuple[float, float, float, float]</span></dt><dd><p>[left, bottom, right, top] in normalized (0, 1) figure coordinates.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.tight_layout.get_renderer">
<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">get_renderer</code><span class="sig-paren">(</span><em><span class="n">fig</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/tight_layout.html#get_renderer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.tight_layout.get_renderer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="matplotlib.tight_layout.get_subplotspec_list">
<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">get_subplotspec_list</code><span class="sig-paren">(</span><em><span class="n">axes_list</span></em>, <em><span class="n">grid_spec</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/tight_layout.html#get_subplotspec_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.tight_layout.get_subplotspec_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of subplotspec from the given list of axes.</p>
<p>For an instance of axes that does not support subplotspec, None is inserted
in the list.</p>
<p>If grid_spec is given, None is inserted for those not from the given
grid_spec.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.tight_layout.get_tight_layout_figure">
<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">get_tight_layout_figure</code><span class="sig-paren">(</span><em><span class="n">fig</span></em>, <em><span class="n">axes_list</span></em>, <em><span class="n">subplotspec_list</span></em>, <em><span class="n">renderer</span></em>, <em><span class="n">pad</span><span class="o">=</span><span class="default_value">1.08</span></em>, <em><span class="n">h_pad</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">w_pad</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">rect</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/tight_layout.html#get_tight_layout_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.tight_layout.get_tight_layout_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Return subplot parameters for tight-layouted-figure with specified padding.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>fig</strong><span class="classifier">Figure</span></dt><dd></dd>
<dt><strong>axes_list</strong><span class="classifier">list of Axes</span></dt><dd></dd>
<dt><strong>subplotspec_list</strong><span class="classifier">list of <a class="reference internal" href="_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec" title="matplotlib.gridspec.SubplotSpec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubplotSpec</span></code></a></span></dt><dd><p>The subplotspecs of each axes.</p>
</dd>
<dt><strong>renderer</strong><span class="classifier">renderer</span></dt><dd></dd>
<dt><strong>pad</strong><span class="classifier">float</span></dt><dd><p>Padding between the figure edge and the edges of subplots, as a
fraction of the font size.</p>
</dd>
<dt><strong>h_pad, w_pad</strong><span class="classifier">float</span></dt><dd><p>Padding (height/width) between edges of adjacent subplots. Defaults to
<em>pad</em>.</p>
</dd>
<dt><strong>rect</strong><span class="classifier">Tuple[float, float, float, float], optional</span></dt><dd><p>(left, bottom, right, top) rectangle in normalized figure coordinates
that the whole subplots area (including labels) will fit into.
Defaults to using the entire figure.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>subplotspec or None</dt><dd><p>subplotspec kwargs to be passed to <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.subplots_adjust" title="matplotlib.figure.Figure.subplots_adjust"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.subplots_adjust</span></code></a> or
None if tight_layout could not be accomplished.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Apr 08, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.0.0.
Doc version v3.2.1-13-g7a9bc5ebb-dirty.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.