{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathindex.html
More file actions
324 lines (300 loc) · 20.4 KB
/
Copy pathindex.html
File metadata and controls
324 lines (300 loc) · 20.4 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
<!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>Toolkits — Matplotlib 2.2.5 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" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.2.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.5 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 2.2.5 documentation" href="../../index.html" />
<link rel="next" title="mplot3d" href="mplot3d/index.html" />
<link rel="prev" title="Working with Matplotlib on OSX" href="../../faq/osx_framework.html" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/api/toolkits/index.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 (v2.2.5). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </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 2.2.5</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 class="right" >
<a href="mplot3d/index.html" title="mplot3d"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../../faq/osx_framework.html" title="Working with Matplotlib on OSX"
accesskey="P">previous</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="../pyplot_summary.html">pyplot</a>| </li>
<li><a href="../../contents.html">docs</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>
<h3><a href="../../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Toolkits</a><ul>
<li><a class="reference internal" href="#mplot3d">mplot3d</a><ul>
<li><a class="reference internal" href="#links">Links</a></li>
</ul>
</li>
<li><a class="reference internal" href="#matplotlib-axes-grid1-toolkit">Matplotlib axes_grid1 Toolkit</a></li>
<li><a class="reference internal" href="#matplotlib-axisartist-toolkit">Matplotlib axisartist Toolkit</a></li>
<li><a class="reference internal" href="#matplotlib-axes-grid-toolkit">Matplotlib axes_grid Toolkit</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li>Previous: <a href="../../faq/osx_framework.html" title="previous chapter">Working with Matplotlib on OSX</a></li>
<li>Next: <a href="mplot3d/index.html" title="next chapter">mplot3d</a></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/toolkits/index.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">
<div class="section" id="toolkits">
<span id="toolkits-index"></span><span id="id1"></span><h1>Toolkits<a class="headerlink" href="#toolkits" title="Permalink to this headline">¶</a></h1>
<p>Toolkits are collections of application-specific functions that extend
Matplotlib.</p>
<div class="section" id="mplot3d">
<span id="toolkit-mplot3d"></span><h2>mplot3d<a class="headerlink" href="#mplot3d" title="Permalink to this headline">¶</a></h2>
<p><code class="xref py py-mod docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d</span></code> provides some basic 3D
plotting (scatter, surf, line, mesh) tools. Not the fastest or most feature
complete 3D library out there, but it ships with Matplotlib and thus may be a
lighter weight solution for some use cases. Check out the
<a class="reference internal" href="../../tutorials/toolkits/mplot3d.html"><span class="doc">mplot3d tutorial</span></a> for more
information.</p>
<div class="figure align-center" id="id2">
<a class="reference external image-reference" href="../../gallery/mplot3d/contourf3d_2.html"><img alt="../../_images/sphx_glr_contourf3d_2_0012.png" src="../../_images/sphx_glr_contourf3d_2_0012.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Contourf3d 2</span></p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="mplot3d/index.html">mplot3d</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mplot3d/index.html#matplotlib-mplot3d-toolkit">Matplotlib mplot3d toolkit</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mplot3d/faq.html">mplot3d FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mplot3d/faq.html#how-is-mplot3d-different-from-mayavi">How is mplot3d different from MayaVi?</a></li>
<li class="toctree-l2"><a class="reference internal" href="mplot3d/faq.html#my-3d-plot-doesn-t-look-right-at-certain-viewing-angles">My 3D plot doesn't look right at certain viewing angles</a></li>
<li class="toctree-l2"><a class="reference internal" href="mplot3d/faq.html#i-don-t-like-how-the-3d-plot-is-laid-out-how-do-i-change-that">I don't like how the 3D plot is laid out, how do I change that?</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="links">
<h3>Links<a class="headerlink" href="#links" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>mpl3d API: <a class="reference internal" href="mplot3d.html#toolkit-mplot3d-api"><span class="std std-ref">mplot3d API</span></a></li>
</ul>
</div>
</div>
<div class="section" id="matplotlib-axes-grid1-toolkit">
<span id="toolkit-axes-grid1-incl"></span><h2>Matplotlib axes_grid1 Toolkit<a class="headerlink" href="#matplotlib-axes-grid1-toolkit" title="Permalink to this headline">¶</a></h2>
<p>The matplotlib <code class="xref py py-class docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid1</span></code> toolkit is a collection of
helper classes to ease displaying multiple images in matplotlib. While the
aspect parameter in matplotlib adjust the position of the single axes,
axes_grid1 toolkit provides a framework to adjust the position of
multiple axes according to their aspects.</p>
<p>See <a class="reference internal" href="../../tutorials/toolkits/axes_grid.html#axes-grid1-users-guide-index"><span class="std std-ref">What is axes_grid1 toolkit?</span></a> for a guide on the usage of axes_grid1.</p>
<div class="figure align-center">
<a class="reference external image-reference" href="../../gallery/axes_grid1/demo_axes_grid.html"><img alt="../../_images/sphx_glr_demo_axes_grid_0012.png" src="../../_images/sphx_glr_demo_axes_grid_0012.png" style="width: 525.0px; height: 125.0px;" /></a>
</div>
<p><strong>The submodules of the axes_grid1 API are:</strong></p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.anchored_artists.html#module-mpl_toolkits.axes_grid1.anchored_artists" title="mpl_toolkits.axes_grid1.anchored_artists"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.anchored_artists</span></code></a></td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.axes_divider.html#module-mpl_toolkits.axes_grid1.axes_divider" title="mpl_toolkits.axes_grid1.axes_divider"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.axes_divider</span></code></a></td>
<td>The axes_divider module provides helper classes to adjust the positions of multiple axes at drawing time.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.axes_grid.html#module-mpl_toolkits.axes_grid1.axes_grid" title="mpl_toolkits.axes_grid1.axes_grid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.axes_grid</span></code></a></td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.axes_rgb.html#module-mpl_toolkits.axes_grid1.axes_rgb" title="mpl_toolkits.axes_grid1.axes_rgb"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.axes_rgb</span></code></a></td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.axes_size.html#module-mpl_toolkits.axes_grid1.axes_size" title="mpl_toolkits.axes_grid1.axes_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.axes_size</span></code></a></td>
<td>provides a classes of simple units that will be used with AxesDivider class (or others) to determine the size of each axes.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.colorbar.html#module-mpl_toolkits.axes_grid1.colorbar" title="mpl_toolkits.axes_grid1.colorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.colorbar</span></code></a></td>
<td>Colorbar toolkit with two classes and a function:</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.inset_locator.html#module-mpl_toolkits.axes_grid1.inset_locator" title="mpl_toolkits.axes_grid1.inset_locator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.inset_locator</span></code></a></td>
<td>A collection of functions and objects for creating or placing inset axes.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.mpl_axes.html#module-mpl_toolkits.axes_grid1.mpl_axes" title="mpl_toolkits.axes_grid1.mpl_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.mpl_axes</span></code></a></td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.parasite_axes.html#module-mpl_toolkits.axes_grid1.parasite_axes" title="mpl_toolkits.axes_grid1.parasite_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.parasite_axes</span></code></a></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="matplotlib-axisartist-toolkit">
<span id="toolkit-axisartist-incl"></span><h2>Matplotlib axisartist Toolkit<a class="headerlink" href="#matplotlib-axisartist-toolkit" title="Permalink to this headline">¶</a></h2>
<p>The <em>axisartist</em> namespace includes a derived Axes implementation (
<code class="xref py py-class docutils literal notranslate"><span class="pre">mpl_toolkits.axisartist.Axes</span></code>). The
biggest difference is that the artists that are responsible for drawing
axis lines, ticks, ticklabels, and axis labels are separated out from the
mpl's Axis class. This change was strongly motivated to support curvilinear grid.</p>
<p>You can find a tutorial describing usage of axisartist at the
<a class="reference internal" href="../../tutorials/toolkits/axisartist.html#axisartist-users-guide-index"><span class="std std-ref">axisartist</span></a> user guide.</p>
<div class="figure align-center">
<a class="reference external image-reference" href="../../gallery/axisartist/demo_curvelinear_grid.html"><img alt="../../_images/sphx_glr_demo_curvelinear_grid_0012.png" src="../../_images/sphx_glr_demo_curvelinear_grid_0012.png" style="width: 350.0px; height: 200.0px;" /></a>
</div>
<p><strong>The submodules of the axisartist API are:</strong></p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.angle_helper.html#module-mpl_toolkits.axisartist.angle_helper" title="mpl_toolkits.axisartist.angle_helper"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.angle_helper</span></code></a></td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.axes_divider.html#module-mpl_toolkits.axisartist.axes_divider" title="mpl_toolkits.axisartist.axes_divider"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.axes_divider</span></code></a></td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.axes_grid.html#module-mpl_toolkits.axisartist.axes_grid" title="mpl_toolkits.axisartist.axes_grid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.axes_grid</span></code></a></td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.axes_rgb.html#module-mpl_toolkits.axisartist.axes_rgb" title="mpl_toolkits.axisartist.axes_rgb"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.axes_rgb</span></code></a></td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.axis_artist.html#module-mpl_toolkits.axisartist.axis_artist" title="mpl_toolkits.axisartist.axis_artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.axis_artist</span></code></a></td>
<td>axis_artist.py module provides axis-related artists.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.axisline_style.html#module-mpl_toolkits.axisartist.axisline_style" title="mpl_toolkits.axisartist.axisline_style"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.axisline_style</span></code></a></td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.axislines.html#module-mpl_toolkits.axisartist.axislines" title="mpl_toolkits.axisartist.axislines"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.axislines</span></code></a></td>
<td>Axislines includes modified implementation of the Axes class.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.clip_path.html#module-mpl_toolkits.axisartist.clip_path" title="mpl_toolkits.axisartist.clip_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.clip_path</span></code></a></td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.floating_axes.html#module-mpl_toolkits.axisartist.floating_axes" title="mpl_toolkits.axisartist.floating_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.floating_axes</span></code></a></td>
<td>An experimental support for curvilinear grid.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.grid_finder.html#module-mpl_toolkits.axisartist.grid_finder" title="mpl_toolkits.axisartist.grid_finder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.grid_finder</span></code></a></td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.grid_helper_curvelinear.html#module-mpl_toolkits.axisartist.grid_helper_curvelinear" title="mpl_toolkits.axisartist.grid_helper_curvelinear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.grid_helper_curvelinear</span></code></a></td>
<td>An experimental support for curvilinear grid.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../_as_gen/mpl_toolkits.axisartist.parasite_axes.html#module-mpl_toolkits.axisartist.parasite_axes" title="mpl_toolkits.axisartist.parasite_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axisartist.parasite_axes</span></code></a></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="matplotlib-axes-grid-toolkit">
<span id="toolkit-axes-grid-incl"></span><h2>Matplotlib axes_grid Toolkit<a class="headerlink" href="#matplotlib-axes-grid-toolkit" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">AxesGrid toolkit has been a part of matplotlib since v
0.99. Originally, the toolkit had a single namespace of
<em>axes_grid</em>. In more recent version, the toolkit
has divided into two separate namespace (<em>axes_grid1</em> and <em>axisartist</em>).
While <em>axes_grid</em> namespace is maintained for the backward compatibility,
use of <em>axes_grid1</em> and <em>axisartist</em> is recommended.
For the documentation on <code class="docutils literal notranslate"><span class="pre">axes_grid</span></code>,
see the <a class="reference external" href="https://matplotlib.org/2.0.1/mpl_toolkits/axes_grid/index.html#toolkit-axesgrid-index">previous version of the docs</a>.</p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="axes_grid1.html">Matplotlib axes_grid1 Toolkit</a></li>
<li class="toctree-l1"><a class="reference internal" href="axisartist.html">Matplotlib axisartist Toolkit</a></li>
</ul>
</div>
</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 - 2018 The Matplotlib development team.
<br />
Last updated on Feb 09, 2020.
Created using
<ahref="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v2.2.5-2-ga847ffac5.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.