Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathgridspec_api.html
More file actions
329 lines (282 loc) · 18.6 KB
/
Copy pathgridspec_api.html
File metadata and controls
329 lines (282 loc) · 18.6 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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<!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="Content-Type" content="text/html; charset=utf-8" />
<title>gridspec — Matplotlib 1.4.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.4.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.4.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.4.1 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="image" href="image_api.html" />
<link rel="prev" title="font_manager" href="font_manager_api.html" />
<link href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet" type="text/css">
<link rel="canonical" href="https://matplotlib.org/stable/api/gridspec_api.html" />
<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 (v1.4.1). For the latest version see <a href="https://matplotlib.org/stable/api/gridspec_api.html">https://matplotlib.org/stable/api/gridspec_api.html</a></div>
<link rel="shortcut icon" href="/_static/favicon.ico">
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<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="image_api.html" title="image"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="font_manager_api.html" title="font_manager"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">gridspec</a><ul>
<li><a class="reference internal" href="#module-matplotlib.gridspec"><code class="docutils literal"><span class="pre">matplotlib.gridspec</span></code></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="font_manager_api.html"
title="previous chapter">font_manager</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="image_api.html"
title="next chapter">image</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/gridspec_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="gridspec">
<h1>gridspec<a class="headerlink" href="#gridspec" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.gridspec">
<span id="matplotlib-gridspec"></span><h2><a class="reference internal" href="#module-matplotlib.gridspec" title="matplotlib.gridspec"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.gridspec</span></code></a><a class="headerlink" href="#module-matplotlib.gridspec" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="#module-matplotlib.gridspec" title="matplotlib.gridspec"><code class="xref py py-mod docutils literal"><span class="pre">gridspec</span></code></a> is a module which specifies the location
of the subplot in the figure.</p>
<blockquote>
<div><dl class="docutils">
<dt><code class="docutils literal"><span class="pre">GridSpec</span></code></dt>
<dd>specifies the geometry of the grid that a subplot will be
placed. The number of rows and number of columns of the grid
need to be set. Optionally, the subplot layout parameters
(e.g., left, right, etc.) can be tuned.</dd>
<dt><code class="docutils literal"><span class="pre">SubplotSpec</span></code></dt>
<dd>specifies the location of the subplot in the given <em>GridSpec</em>.</dd>
</dl>
</div></blockquote>
<dl class="class">
<dt id="matplotlib.gridspec.GridSpec">
<em class="property">class </em><code class="descclassname">matplotlib.gridspec.</code><code class="descname">GridSpec</code><span class="sig-paren">(</span><em>nrows</em>, <em>ncols</em>, <em>left=None</em>, <em>bottom=None</em>, <em>right=None</em>, <em>top=None</em>, <em>wspace=None</em>, <em>hspace=None</em>, <em>width_ratios=None</em>, <em>height_ratios=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpec" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.gridspec.GridSpecBase" title="matplotlib.gridspec.GridSpecBase"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.gridspec.GridSpecBase</span></code></a></p>
<p>A class that specifies the geometry of the grid that a subplot
will be placed. The location of grid is determined by similar way
as the SubplotParams.</p>
<p>The number of rows and number of columns of the
grid need to be set. Optionally, the subplot layout parameters
(e.g., left, right, etc.) can be tuned.</p>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpec.get_subplot_params">
<code class="descname">get_subplot_params</code><span class="sig-paren">(</span><em>fig=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpec.get_subplot_params" title="Permalink to this definition">¶</a></dt>
<dd><p>return a dictionary of subplot layout parameters. The default
parameters are from rcParams unless a figure attribute is set.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpec.locally_modified_subplot_params">
<code class="descname">locally_modified_subplot_params</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpec.locally_modified_subplot_params" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpec.tight_layout">
<code class="descname">tight_layout</code><span class="sig-paren">(</span><em>fig</em>, <em>renderer=None</em>, <em>pad=1.08</em>, <em>h_pad=None</em>, <em>w_pad=None</em>, <em>rect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpec.tight_layout" title="Permalink to this definition">¶</a></dt>
<dd><p>Adjust subplot parameters to give specified padding.</p>
<p>Parameters:</p>
<dl class="docutils">
<dt>pad <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd>padding between the figure edge and the edges of subplots, as a fraction of the font-size.</dd>
<dt>h_pad, w_pad <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd>padding (height/width) between edges of adjacent subplots.
Defaults to <code class="xref py py-obj docutils literal"><span class="pre">pad_inches</span></code>.</dd>
<dt>rect <span class="classifier-delimiter">:</span> <span class="classifier">if rect is given, it is interpreted as a rectangle</span></dt>
<dd>(left, bottom, right, top) in the normalized figure
coordinate that the whole subplots area (including
labels) will fit into. Default is (0, 0, 1, 1).</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpec.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpec.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the current values. If any kwarg is None, default to
the current value, if set, otherwise to rc.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.gridspec.GridSpecBase">
<em class="property">class </em><code class="descclassname">matplotlib.gridspec.</code><code class="descname">GridSpecBase</code><span class="sig-paren">(</span><em>nrows</em>, <em>ncols</em>, <em>height_ratios=None</em>, <em>width_ratios=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A base class of GridSpec that specifies the geometry of the grid
that a subplot will be placed.</p>
<p>The number of rows and number of columns of the grid need to
be set. Optionally, the ratio of heights and widths of rows and
columns can be specified.</p>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecBase.get_geometry">
<code class="descname">get_geometry</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_geometry" title="Permalink to this definition">¶</a></dt>
<dd><p>get the geometry of the grid, eg 2,3</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecBase.get_grid_positions">
<code class="descname">get_grid_positions</code><span class="sig-paren">(</span><em>fig</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_grid_positions" title="Permalink to this definition">¶</a></dt>
<dd><p>return lists of bottom and top position of rows, left and
right positions of columns.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecBase.get_height_ratios">
<code class="descname">get_height_ratios</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_height_ratios" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecBase.get_subplot_params">
<code class="descname">get_subplot_params</code><span class="sig-paren">(</span><em>fig=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_subplot_params" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecBase.get_width_ratios">
<code class="descname">get_width_ratios</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.get_width_ratios" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecBase.new_subplotspec">
<code class="descname">new_subplotspec</code><span class="sig-paren">(</span><em>loc</em>, <em>rowspan=1</em>, <em>colspan=1</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.new_subplotspec" title="Permalink to this definition">¶</a></dt>
<dd><p>create and return a SuplotSpec instance.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecBase.set_height_ratios">
<code class="descname">set_height_ratios</code><span class="sig-paren">(</span><em>height_ratios</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.set_height_ratios" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecBase.set_width_ratios">
<code class="descname">set_width_ratios</code><span class="sig-paren">(</span><em>width_ratios</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecBase.set_width_ratios" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.gridspec.GridSpecFromSubplotSpec">
<em class="property">class </em><code class="descclassname">matplotlib.gridspec.</code><code class="descname">GridSpecFromSubplotSpec</code><span class="sig-paren">(</span><em>nrows</em>, <em>ncols</em>, <em>subplot_spec</em>, <em>wspace=None</em>, <em>hspace=None</em>, <em>height_ratios=None</em>, <em>width_ratios=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecFromSubplotSpec" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.gridspec.GridSpecBase" title="matplotlib.gridspec.GridSpecBase"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.gridspec.GridSpecBase</span></code></a></p>
<p>GridSpec whose subplot layout parameters are inherited from the
location specified by a given SubplotSpec.</p>
<p>The number of rows and number of columns of the grid need to
be set. An instance of SubplotSpec is also needed to be set
from which the layout parameters will be inherited. The wspace
and hspace of the layout can be optionally specified or the
default values (from the figure or rcParams) will be used.</p>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecFromSubplotSpec.get_subplot_params">
<code class="descname">get_subplot_params</code><span class="sig-paren">(</span><em>fig=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecFromSubplotSpec.get_subplot_params" title="Permalink to this definition">¶</a></dt>
<dd><p>return a dictionary of subplot layout parameters.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.GridSpecFromSubplotSpec.get_topmost_subplotspec">
<code class="descname">get_topmost_subplotspec</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.GridSpecFromSubplotSpec.get_topmost_subplotspec" title="Permalink to this definition">¶</a></dt>
<dd><p>get the topmost SubplotSpec instance associated with the subplot</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.gridspec.SubplotSpec">
<em class="property">class </em><code class="descclassname">matplotlib.gridspec.</code><code class="descname">SubplotSpec</code><span class="sig-paren">(</span><em>gridspec</em>, <em>num1</em>, <em>num2=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>specifies the location of the subplot in the given <em>GridSpec</em>.</p>
<p>The subplot will occupy the num1-th cell of the given
gridspec. If num2 is provided, the subplot will span between
num1-th cell and num2-th cell.</p>
<p>The index stars from 0.</p>
<dl class="method">
<dt id="matplotlib.gridspec.SubplotSpec.get_geometry">
<code class="descname">get_geometry</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec.get_geometry" title="Permalink to this definition">¶</a></dt>
<dd><p>get the subplot geometry, eg 2,2,3. Unlike SuplorParams,
index is 0-based</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.SubplotSpec.get_gridspec">
<code class="descname">get_gridspec</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec.get_gridspec" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.SubplotSpec.get_position">
<code class="descname">get_position</code><span class="sig-paren">(</span><em>fig</em>, <em>return_all=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec.get_position" title="Permalink to this definition">¶</a></dt>
<dd><p>update the subplot position from fig.subplotpars</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.gridspec.SubplotSpec.get_topmost_subplotspec">
<code class="descname">get_topmost_subplotspec</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.gridspec.SubplotSpec.get_topmost_subplotspec" title="Permalink to this definition">¶</a></dt>
<dd><p>get the topmost SubplotSpec instance associated with the subplot</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the matplotlib development team; 2012 - 2014 The matplotlib development team.
Last updated on Oct 18, 2014.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.3b2.
</div>
</body>
</html>
You can’t perform that action at this time.