forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_subplots.html
More file actions
389 lines (324 loc) · 42.7 KB
/
_subplots.html
File metadata and controls
389 lines (324 loc) · 42.7 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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
<!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>matplotlib.axes._subplots — Matplotlib 3.1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></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>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script type="text/javascript" src="../../../_static/copybutton.js"></script>
<script async="async" type="text/javascript" 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.1.0 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="top" title="Matplotlib 3.1.0 documentation" href="../../../index.html" />
<link rel="up" title="matplotlib" href="../../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.1.0/_modules/matplotlib/axes/_subplots.html" />
</head>
<body>
<div id="plotting-contest" style="padding: 6px; background-color: teal; color: white;">
<p style="margin: 0;">The 2019 SciPy John Hunter Excellence in Plotting Contest is accepting submissions!
<br />
<a href="https://docs.google.com/forms/d/e/1FAIpQLSe-_AnKvYSzeQWfNDRoXgW0vl7_8q6jj3QbLIac8eUcb9lSAA/viewform?usp=sf_link" style="font-weight: bold;">Apply by June 8th</a></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.1.0</span></div>
<img src="../../../_static/logo2.png" 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>
<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><a href="../../../index.html">home</a>| </li>
<li><a href="../../../gallery/index.html">examples</a>| </li>
<li><a href="../../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../../../api/index.html">API</a>| </li>
<li><a href="../../../contents.html">contents</a> »</li>
<li><a href="../../index.html" >Module code</a> »</li>
<li><a href="../../matplotlib.html" accesskey="U">matplotlib</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<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>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../../contents.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
<li><a href="../../matplotlib.html">matplotlib</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for matplotlib.axes._subplots</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">functools</span>
<span class="kn">import</span> <span class="nn">uuid</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">cbook</span><span class="p">,</span> <span class="n">docstring</span>
<span class="kn">import</span> <span class="nn">matplotlib.artist</span> <span class="k">as</span> <span class="nn">martist</span>
<span class="kn">from</span> <span class="nn">matplotlib.axes._axes</span> <span class="k">import</span> <span class="n">Axes</span>
<span class="kn">from</span> <span class="nn">matplotlib.gridspec</span> <span class="k">import</span> <span class="n">GridSpec</span><span class="p">,</span> <span class="n">SubplotSpec</span>
<span class="kn">import</span> <span class="nn">matplotlib._layoutbox</span> <span class="k">as</span> <span class="nn">layoutbox</span>
<div class="viewcode-block" id="SubplotBase"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase">[docs]</a><span class="k">class</span> <span class="nc">SubplotBase</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Base class for subplots, which are :class:`Axes` instances with</span>
<span class="sd"> additional methods to facilitate generating and manipulating a set</span>
<span class="sd"> of :class:`Axes` within a figure.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> *fig* is a :class:`matplotlib.figure.Figure` instance.</span>
<span class="sd"> *args* is the tuple (*numRows*, *numCols*, *plotNum*), where</span>
<span class="sd"> the array of subplots in the figure has dimensions *numRows*,</span>
<span class="sd"> *numCols*, and where *plotNum* is the number of the subplot</span>
<span class="sd"> being created. *plotNum* starts at 1 in the upper left</span>
<span class="sd"> corner and increases to the right.</span>
<span class="sd"> If *numRows* <= *numCols* <= *plotNum* < 10, *args* can be the</span>
<span class="sd"> decimal integer *numRows* * 100 + *numCols* * 10 + *plotNum*.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">figure</span> <span class="o">=</span> <span class="n">fig</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">SubplotSpec</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="n">rows</span><span class="p">,</span> <span class="n">cols</span><span class="p">,</span> <span class="n">num</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Single argument to subplot must be '</span>
<span class="s1">'a 3-digit integer'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span> <span class="o">=</span> <span class="n">GridSpec</span><span class="p">(</span><span class="n">rows</span><span class="p">,</span> <span class="n">cols</span><span class="p">,</span>
<span class="n">figure</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="p">)[</span><span class="n">num</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span>
<span class="c1"># num - 1 for converting from MATLAB to python indexing</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
<span class="n">rows</span><span class="p">,</span> <span class="n">cols</span><span class="p">,</span> <span class="n">num</span> <span class="o">=</span> <span class="n">args</span>
<span class="n">rows</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">rows</span><span class="p">)</span>
<span class="n">cols</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">cols</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">num</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">num</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">num</span> <span class="o">=</span> <span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">num</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span> <span class="o">=</span> <span class="n">GridSpec</span><span class="p">(</span>
<span class="n">rows</span><span class="p">,</span> <span class="n">cols</span><span class="p">,</span>
<span class="n">figure</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="p">)[(</span><span class="n">num</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span><span class="n">num</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">num</span> <span class="o"><</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">num</span> <span class="o">></span> <span class="n">rows</span><span class="o">*</span><span class="n">cols</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">f</span><span class="s2">"num must be 1 <= num <= {rows*cols}, not </span><span class="si">{num}</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span> <span class="o">=</span> <span class="n">GridSpec</span><span class="p">(</span>
<span class="n">rows</span><span class="p">,</span> <span class="n">cols</span><span class="p">,</span> <span class="n">figure</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="p">)[</span><span class="nb">int</span><span class="p">(</span><span class="n">num</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span>
<span class="c1"># num - 1 for converting from MATLAB to python indexing</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">f</span><span class="s1">'Illegal argument(s) to subplot: </span><span class="si">{args}</span><span class="s1">'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_params</span><span class="p">()</span>
<span class="c1"># _axes_class is set in the subplot_class_factory</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_axes_class</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">figbox</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="c1"># add a layout box to this, for both the full axis, and the poss</span>
<span class="c1"># of the axis. We need both because the axes may become smaller</span>
<span class="c1"># due to parasitic axes and hence no longer fill the subplotspec.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span><span class="o">.</span><span class="n">_layoutbox</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_layoutbox</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_poslayoutbox</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span><span class="o">.</span><span class="n">_layoutbox</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s1">'.ax'</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">name</span> <span class="o">+</span> <span class="n">layoutbox</span><span class="o">.</span><span class="n">seq_id</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_layoutbox</span> <span class="o">=</span> <span class="n">layoutbox</span><span class="o">.</span><span class="n">LayoutBox</span><span class="p">(</span>
<span class="n">parent</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span><span class="o">.</span><span class="n">_layoutbox</span><span class="p">,</span>
<span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span>
<span class="n">artist</span><span class="o">=</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_poslayoutbox</span> <span class="o">=</span> <span class="n">layoutbox</span><span class="o">.</span><span class="n">LayoutBox</span><span class="p">(</span>
<span class="n">parent</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_layoutbox</span><span class="p">,</span>
<span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_layoutbox</span><span class="o">.</span><span class="n">name</span><span class="o">+</span><span class="s1">'.pos'</span><span class="p">,</span>
<span class="n">pos</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">subplot</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">artist</span><span class="o">=</span><span class="bp">self</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__reduce__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># get the first axes class which does not inherit from a subplotbase</span>
<span class="n">axes_class</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span>
<span class="n">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="vm">__mro__</span>
<span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">Axes</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">SubplotBase</span><span class="p">))</span>
<span class="k">return</span> <span class="p">(</span><span class="n">_picklable_subplot_class_constructor</span><span class="p">,</span>
<span class="p">(</span><span class="n">axes_class</span><span class="p">,),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__getstate__</span><span class="p">())</span>
<div class="viewcode-block" id="SubplotBase.get_geometry"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.get_geometry">[docs]</a> <span class="k">def</span> <span class="nf">get_geometry</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""get the subplot geometry, e.g., 2,2,3"""</span>
<span class="n">rows</span><span class="p">,</span> <span class="n">cols</span><span class="p">,</span> <span class="n">num1</span><span class="p">,</span> <span class="n">num2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_subplotspec</span><span class="p">()</span><span class="o">.</span><span class="n">get_geometry</span><span class="p">()</span>
<span class="k">return</span> <span class="n">rows</span><span class="p">,</span> <span class="n">cols</span><span class="p">,</span> <span class="n">num1</span> <span class="o">+</span> <span class="mi">1</span> <span class="c1"># for compatibility</span></div>
<span class="c1"># COVERAGE NOTE: Never used internally or from examples</span>
<div class="viewcode-block" id="SubplotBase.change_geometry"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.change_geometry">[docs]</a> <span class="k">def</span> <span class="nf">change_geometry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">numrows</span><span class="p">,</span> <span class="n">numcols</span><span class="p">,</span> <span class="n">num</span><span class="p">):</span>
<span class="sd">"""change subplot geometry, e.g., from 1,1,1 to 2,2,3"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span> <span class="o">=</span> <span class="n">GridSpec</span><span class="p">(</span><span class="n">numrows</span><span class="p">,</span> <span class="n">numcols</span><span class="p">,</span>
<span class="n">figure</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="p">)[</span><span class="n">num</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_params</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_position</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">figbox</span><span class="p">)</span></div>
<div class="viewcode-block" id="SubplotBase.get_subplotspec"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.get_subplotspec">[docs]</a> <span class="k">def</span> <span class="nf">get_subplotspec</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""get the SubplotSpec instance associated with the subplot"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span></div>
<div class="viewcode-block" id="SubplotBase.set_subplotspec"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.set_subplotspec">[docs]</a> <span class="k">def</span> <span class="nf">set_subplotspec</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">subplotspec</span><span class="p">):</span>
<span class="sd">"""set the SubplotSpec instance associated with the subplot"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span> <span class="o">=</span> <span class="n">subplotspec</span></div>
<div class="viewcode-block" id="SubplotBase.get_gridspec"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.get_gridspec">[docs]</a> <span class="k">def</span> <span class="nf">get_gridspec</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""get the GridSpec instance associated with the subplot"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_subplotspec</span><span class="o">.</span><span class="n">get_gridspec</span><span class="p">()</span></div>
<div class="viewcode-block" id="SubplotBase.update_params"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.update_params">[docs]</a> <span class="k">def</span> <span class="nf">update_params</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""update the subplot position from fig.subplotpars"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">figbox</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">rowNum</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">colNum</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">numRows</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">numCols</span> <span class="o">=</span> \
<span class="bp">self</span><span class="o">.</span><span class="n">get_subplotspec</span><span class="p">()</span><span class="o">.</span><span class="n">get_position</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="p">,</span>
<span class="n">return_all</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
<div class="viewcode-block" id="SubplotBase.is_first_col"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.is_first_col">[docs]</a> <span class="k">def</span> <span class="nf">is_first_col</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">colNum</span> <span class="o">==</span> <span class="mi">0</span></div>
<div class="viewcode-block" id="SubplotBase.is_first_row"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.is_first_row">[docs]</a> <span class="k">def</span> <span class="nf">is_first_row</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">rowNum</span> <span class="o">==</span> <span class="mi">0</span></div>
<div class="viewcode-block" id="SubplotBase.is_last_row"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.is_last_row">[docs]</a> <span class="k">def</span> <span class="nf">is_last_row</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">rowNum</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">numRows</span> <span class="o">-</span> <span class="mi">1</span></div>
<div class="viewcode-block" id="SubplotBase.is_last_col"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.is_last_col">[docs]</a> <span class="k">def</span> <span class="nf">is_last_col</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">colNum</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">numCols</span> <span class="o">-</span> <span class="mi">1</span></div>
<span class="c1"># COVERAGE NOTE: Never used internally.</span>
<div class="viewcode-block" id="SubplotBase.label_outer"><a class="viewcode-back" href="../../../api/_as_gen/matplotlib.axes.SubplotBase.html#matplotlib.axes.SubplotBase.label_outer">[docs]</a> <span class="k">def</span> <span class="nf">label_outer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Only show "outer" labels and tick labels.</span>
<span class="sd"> x-labels are only kept for subplots on the last row; y-labels only for</span>
<span class="sd"> subplots on the first column.</span>
<span class="sd"> """</span>
<span class="n">lastrow</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_last_row</span><span class="p">()</span>
<span class="n">firstcol</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_first_col</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">lastrow</span><span class="p">:</span>
<span class="k">for</span> <span class="n">label</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_xticklabels</span><span class="p">(</span><span class="n">which</span><span class="o">=</span><span class="s2">"both"</span><span class="p">):</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_xaxis</span><span class="p">()</span><span class="o">.</span><span class="n">get_offset_text</span><span class="p">()</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_xlabel</span><span class="p">(</span><span class="s2">""</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">firstcol</span><span class="p">:</span>
<span class="k">for</span> <span class="n">label</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_yticklabels</span><span class="p">(</span><span class="n">which</span><span class="o">=</span><span class="s2">"both"</span><span class="p">):</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_yaxis</span><span class="p">()</span><span class="o">.</span><span class="n">get_offset_text</span><span class="p">()</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_ylabel</span><span class="p">(</span><span class="s2">""</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_make_twin_axes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Make a twinx axes of self. This is used for twinx and twiny.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="s1">'sharex'</span> <span class="ow">in</span> <span class="n">kwargs</span> <span class="ow">and</span> <span class="s1">'sharey'</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="c1"># The following line is added in v2.2 to avoid breaking Seaborn,</span>
<span class="c1"># which currently uses this internal API.</span>
<span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">"sharex"</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">self</span> <span class="ow">and</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">"sharey"</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">self</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Twinned Axes may share only one axis"</span><span class="p">)</span>
<span class="c1"># The dance here with label is to force add_subplot() to create a new</span>
<span class="c1"># Axes (by passing in a label never seen before). Note that this does</span>
<span class="c1"># not affect plot reactivation by subplot() as twin axes can never be</span>
<span class="c1"># reactivated by subplot().</span>
<span class="n">sentinel</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">())</span>
<span class="n">real_label</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"label"</span><span class="p">,</span> <span class="n">sentinel</span><span class="p">)</span>
<span class="n">twin</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_subplotspec</span><span class="p">(),</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="n">sentinel</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">if</span> <span class="n">real_label</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">sentinel</span><span class="p">:</span>
<span class="n">twin</span><span class="o">.</span><span class="n">set_label</span><span class="p">(</span><span class="n">real_label</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_adjustable</span><span class="p">(</span><span class="s1">'datalim'</span><span class="p">)</span>
<span class="n">twin</span><span class="o">.</span><span class="n">set_adjustable</span><span class="p">(</span><span class="s1">'datalim'</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_layoutbox</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">twin</span><span class="o">.</span><span class="n">_layoutbox</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># make the layout boxes be explicitly the same</span>
<span class="n">twin</span><span class="o">.</span><span class="n">_layoutbox</span><span class="o">.</span><span class="n">constrain_same</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_layoutbox</span><span class="p">)</span>
<span class="n">twin</span><span class="o">.</span><span class="n">_poslayoutbox</span><span class="o">.</span><span class="n">constrain_same</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_poslayoutbox</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_twinned_axes</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">twin</span><span class="p">)</span>
<span class="k">return</span> <span class="n">twin</span></div>
<span class="c1"># this here to support cartopy which was using a private part of the</span>
<span class="c1"># API to register their Axes subclasses.</span>
<span class="c1"># In 3.1 this should be changed to a dict subclass that warns on use</span>
<span class="c1"># In 3.3 to a dict subclass that raises a useful exception on use</span>
<span class="c1"># In 3.4 should be removed</span>
<span class="c1"># The slow timeline is to give cartopy enough time to get several</span>
<span class="c1"># release out before we break them.</span>
<span class="n">_subplot_classes</span> <span class="o">=</span> <span class="p">{}</span>
<span class="nd">@functools</span><span class="o">.</span><span class="n">lru_cache</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">subplot_class_factory</span><span class="p">(</span><span class="n">axes_class</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This makes a new class that inherits from `.SubplotBase` and the</span>
<span class="sd"> given axes_class (which is assumed to be a subclass of `.axes.Axes`).</span>
<span class="sd"> This is perhaps a little bit roundabout to make a new class on</span>
<span class="sd"> the fly like this, but it means that a new Subplot class does</span>
<span class="sd"> not have to be created for every type of Axes.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">axes_class</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">axes_class</span> <span class="o">=</span> <span class="n">Axes</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># Avoid creating two different instances of GeoAxesSubplot...</span>
<span class="c1"># Only a temporary backcompat fix. This should be removed in</span>
<span class="c1"># 3.4</span>
<span class="k">return</span> <span class="nb">next</span><span class="p">(</span><span class="bp">cls</span> <span class="k">for</span> <span class="bp">cls</span> <span class="ow">in</span> <span class="n">SubplotBase</span><span class="o">.</span><span class="n">__subclasses__</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="vm">__bases__</span> <span class="o">==</span> <span class="p">(</span><span class="n">SubplotBase</span><span class="p">,</span> <span class="n">axes_class</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2">Subplot"</span> <span class="o">%</span> <span class="n">axes_class</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span>
<span class="p">(</span><span class="n">SubplotBase</span><span class="p">,</span> <span class="n">axes_class</span><span class="p">),</span>
<span class="p">{</span><span class="s1">'_axes_class'</span><span class="p">:</span> <span class="n">axes_class</span><span class="p">})</span>
<span class="c1"># This is provided for backward compatibility</span>
<span class="n">Subplot</span> <span class="o">=</span> <span class="n">subplot_class_factory</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_picklable_subplot_class_constructor</span><span class="p">(</span><span class="n">axes_class</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This stub class exists to return the appropriate subplot class when called</span>
<span class="sd"> with an axes class. This is purely to allow pickling of Axes and Subplots.</span>
<span class="sd"> """</span>
<span class="n">subplot_class</span> <span class="o">=</span> <span class="n">subplot_class_factory</span><span class="p">(</span><span class="n">axes_class</span><span class="p">)</span>
<span class="k">return</span> <span class="n">subplot_class</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="n">subplot_class</span><span class="p">)</span>
<span class="n">docstring</span><span class="o">.</span><span class="n">interpd</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">Axes</span><span class="o">=</span><span class="n">martist</span><span class="o">.</span><span class="n">kwdoc</span><span class="p">(</span><span class="n">Axes</span><span class="p">))</span>
<span class="n">docstring</span><span class="o">.</span><span class="n">dedent_interpd</span><span class="p">(</span><span class="n">Axes</span><span class="o">.</span><span class="fm">__init__</span><span class="p">)</span>
<span class="n">docstring</span><span class="o">.</span><span class="n">interpd</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">Subplot</span><span class="o">=</span><span class="n">martist</span><span class="o">.</span><span class="n">kwdoc</span><span class="p">(</span><span class="n">Axes</span><span class="p">))</span>
</pre></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 - 2018 The Matplotlib development team.
<br />
Last updated on May 18, 2019.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v3.1.0-4-g0078324e4.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55954603-1', 'auto');
ga('send', 'pageview');
</script>
</body>
<footer>
</footer>
</html>