{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathcontainer_api.html
More file actions
326 lines (288 loc) · 21.2 KB
/
Copy pathcontainer_api.html
File metadata and controls
326 lines (288 loc) · 21.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
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
<!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>container — Matplotlib 3.0.2 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" 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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.0.2 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.0.2 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="dates" href="dates_api.html" />
<link rel="prev" title="contour" href="contour_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/container_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 (v3.0.2). For the latest version see <a href="https://matplotlib.org/stable/api/container_api.html">https://matplotlib.org/stable/api/container_api.html</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 3.0.2</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="dates_api.html" title="dates"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="contour_api.html" title="contour"
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="api_overview.html">API</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">
<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="#">container</a><ul>
<li><a class="reference internal" href="#module-matplotlib.container"><code class="docutils literal notranslate"><span class="pre">matplotlib.container</span></code></a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li>Previous: <a href="contour_api.html" title="previous chapter">contour</a></li>
<li>Next: <a href="dates_api.html" title="next chapter">dates</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/container_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">
<div class="section" id="container">
<h1>container<a class="headerlink" href="#container" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.container">
<span id="matplotlib-container"></span><h2><a class="reference internal" href="#module-matplotlib.container" title="matplotlib.container"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.container</span></code></a><a class="headerlink" href="#module-matplotlib.container" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="matplotlib.container.BarContainer">
<em class="property">class </em><code class="descclassname">matplotlib.container.</code><code class="descname">BarContainer</code><span class="sig-paren">(</span><em>patches</em>, <em>errorbar=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#BarContainer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.BarContainer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.container.Container" title="matplotlib.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.container.Container</span></code></a></p>
<p>Container for the artists of bar plots (e.g. created by <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.bar</span></code></a>).</p>
<p>The container can be treated as a tuple of the <em>patches</em> themselves.
Additionally, you can access these and further parameters by the
attributes.</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">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>patches</strong> <span class="classifier-delimiter">:</span> <span class="classifier">list of <a class="reference internal" href="_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">Rectangle</span></code></a></span></dt>
<dd><p class="first last">The artists of the bars.</p>
</dd>
<dt><strong>errorbar</strong> <span class="classifier-delimiter">:</span> <span class="classifier">None or <a class="reference internal" href="#matplotlib.container.ErrorbarContainer" title="matplotlib.container.ErrorbarContainer"><code class="xref py py-class docutils literal notranslate"><span class="pre">ErrorbarContainer</span></code></a></span></dt>
<dd><p class="first last">A container for the error bar artists if error bars are present.
<em>None</em> otherwise.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="matplotlib.container.Container">
<em class="property">class </em><code class="descclassname">matplotlib.container.</code><code class="descname">Container</code><span class="sig-paren">(</span><em>kl</em>, <em>label=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#Container"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.Container" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
<p>Base class for containers.</p>
<p>Containers are classes that collect semantically related Artists such as
the bars of a bar plot.</p>
<dl class="method">
<dt id="matplotlib.container.Container.add_callback">
<code class="descname">add_callback</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#Container.add_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.Container.add_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a callback function that will be called whenever one of
the <code class="xref py py-class docutils literal notranslate"><span class="pre">Artist</span></code>'s properties changes.</p>
<p>Returns an <em>id</em> that is useful for removing the callback with
<a class="reference internal" href="#matplotlib.container.Container.remove_callback" title="matplotlib.container.Container.remove_callback"><code class="xref py py-meth docutils literal notranslate"><span class="pre">remove_callback()</span></code></a> later.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.container.Container.get_children">
<code class="descname">get_children</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#Container.get_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.Container.get_children" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.container.Container.get_label">
<code class="descname">get_label</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#Container.get_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.Container.get_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the label used for this artist in the legend.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.container.Container.pchanged">
<code class="descname">pchanged</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#Container.pchanged"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.Container.pchanged" title="Permalink to this definition">¶</a></dt>
<dd><p>Fire an event when property changed, calling all of the
registered callbacks.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.container.Container.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#Container.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.Container.remove" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.container.Container.remove_callback">
<code class="descname">remove_callback</code><span class="sig-paren">(</span><em>oid</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#Container.remove_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.Container.remove_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a callback based on its <em>id</em>.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="#matplotlib.container.Container.add_callback" title="matplotlib.container.Container.add_callback"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_callback()</span></code></a></dt>
<dd>For adding callbacks</dd>
</dl>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.container.Container.set_label">
<code class="descname">set_label</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#Container.set_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.Container.set_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the label to <em>s</em> for auto legend.</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>s</strong> <span class="classifier-delimiter">:</span> <span class="classifier">string or anything printable with '%s' conversion.</span></dt>
<dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.container.Container.set_remove_method">
<code class="descname">set_remove_method</code><span class="sig-paren">(</span><em>f</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#Container.set_remove_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.Container.set_remove_method" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified">Deprecated since version 3.0: </span>The set_remove_method function was deprecated in Matplotlib 3.0 and will be removed in 3.2.</p>
</div>
<p></p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.container.ErrorbarContainer">
<em class="property">class </em><code class="descclassname">matplotlib.container.</code><code class="descname">ErrorbarContainer</code><span class="sig-paren">(</span><em>lines</em>, <em>has_xerr=False</em>, <em>has_yerr=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#ErrorbarContainer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.ErrorbarContainer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.container.Container" title="matplotlib.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.container.Container</span></code></a></p>
<p>Container for the artists of error bars (e.g. created by <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.errorbar.html#matplotlib.axes.Axes.errorbar" title="matplotlib.axes.Axes.errorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.errorbar</span></code></a>).</p>
<p>The container can be treated as the <em>lines</em> tuple itself.
Additionally, you can access these and further parameters by the
attributes.</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">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>lines</strong> <span class="classifier-delimiter">:</span> <span class="classifier">tuple</span></dt>
<dd><p class="first">Tuple of <code class="docutils literal notranslate"><span class="pre">(data_line,</span> <span class="pre">caplines,</span> <span class="pre">barlinecols)</span></code>.</p>
<ul class="last simple">
<li>data_line : <a class="reference internal" href="_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a> instance of
x, y plot markers and/or line.</li>
<li>caplines : tuple of <a class="reference internal" href="_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a> instances of
the error bar caps.</li>
<li>barlinecols : list of <a class="reference internal" href="collections_api.html#matplotlib.collections.LineCollection" title="matplotlib.collections.LineCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">LineCollection</span></code></a>
with the horizontal and vertical error ranges.</li>
</ul>
</dd>
<dt><strong>has_xerr, has_yerr</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last"><code class="docutils literal notranslate"><span class="pre">True</span></code> if the errorbar has x/y errors.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="matplotlib.container.StemContainer">
<em class="property">class </em><code class="descclassname">matplotlib.container.</code><code class="descname">StemContainer</code><span class="sig-paren">(</span><em>markerline_stemlines_baseline</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/container.html#StemContainer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.container.StemContainer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.container.Container" title="matplotlib.container.Container"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.container.Container</span></code></a></p>
<p>Container for the artists created in a <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.stem.html#matplotlib.axes.Axes.stem" title="matplotlib.axes.Axes.stem"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Axes.stem()</span></code></a> plot.</p>
<p>The container can be treated like a namedtuple <code class="docutils literal notranslate"><span class="pre">(markerline,</span> <span class="pre">stemlines,</span>
<span class="pre">baseline)</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">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>markerline</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a></span></dt>
<dd><p class="first last">The artist of the markers at the stem heads.</p>
</dd>
<dt><strong>stemlines</strong> <span class="classifier-delimiter">:</span> <span class="classifier">list of <a class="reference internal" href="_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a></span></dt>
<dd><p class="first last">The artists of the vertical lines for all stems.</p>
</dd>
<dt><strong>baseline</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a></span></dt>
<dd><p class="first last">The artist of the horizontal baseline.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</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 - 2018 The Matplotlib development team.
<br />
Last updated on Nov 11, 2018.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.1.
Doc version v3.0.2-2-g91e2d00a8.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.