matplotlib.github.com/2.1.2/api/container_api.html at main · matplotlib/matplotlib.github.com · GitHub

History

270 lines (232 loc) · 14.5 KB

Raw

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>container — Matplotlib 2.1.2 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.1.2',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.1.2 documentation"

href="../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.1.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="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.1.2</span></div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="dates_api.html" title="dates"

accesskey="N">next</a> |</li>

<a href="contour_api.html" title="contour"

accesskey="P">previous</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="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

</a>

<br/>

</a>

<br/>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<br/>

<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"><span class="pre">matplotlib.container</span></code></a></li>

</ul>

</li>

</ul>

<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>

</div>

<li><a href="../_sources/api/container_api.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<h1>container<a class="headerlink" href="#container" title="Permalink to this headline">¶</a></h1>

<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"><span class="pre">matplotlib.container</span></code></a><a class="headerlink" href="#module-matplotlib.container" title="Permalink to this headline">¶</a></h2>

<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="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"><span class="pre">matplotlib.container.Container</span></code></a></p>

</dd></dl>

<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="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.6)"><code class="xref py py-class docutils literal"><span class="pre">tuple</span></code></a></p>

<p>Base class for containers.</p>

<code class="descname">add_callback</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><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"><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"><span class="pre">remove_callback()</span></code></a> later.</p>

</dd></dl>

<code class="descname">get_children</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.container.Container.get_children" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_label</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>

<code class="descname">pchanged</code><span class="sig-paren">(</span><span class="sig-paren">)</span><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>

<code class="descname">remove</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.container.Container.remove" title="Permalink to this definition">¶</a></dt>

<code class="descname">remove_callback</code><span class="sig-paren">(</span><em>oid</em><span class="sig-paren">)</span><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>

<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"><span class="pre">add_callback()</span></code></a></dt>

<dd>For adding callbacks</dd>

</dl>

</div>

</dd></dl>

<code class="descname">set_label</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><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>

<p>ACCEPTS: string or anything printable with ‘%s’ conversion.</p>

</dd></dl>

<code class="descname">set_remove_method</code><span class="sig-paren">(</span><em>f</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.container.Container.set_remove_method" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<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="headerlink" href="#matplotlib.container.ErrorbarContainer" title="Permalink to this definition">¶</a></dt>

<p>Container for errobars.</p>

<p class="rubric">Attributes</p>

</colgroup>

<tr class="row-odd"><td><strong>lines</strong></td>

<td>(tuple) Tuple of <code class="docutils literal"><span class="pre">(data_line,</span> <span class="pre">caplines,</span> <span class="pre">barlinecols)</span></code>. - 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"><span class="pre">Line2D</span></code></a> instance of x, y plot markers and/or line. - 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"><span class="pre">Line2D</span></code></a> instances of the error bar caps. - 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"><span class="pre">LineCollection</span></code></a> with the horizontal and vertical error ranges.</td>

</tr>

<td>(bool) <code class="docutils literal"><span class="pre">True</span></code> if the errorbar has x/y errors.</td>

</tr>

</tbody>

</table>

</dd></dl>

<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="headerlink" href="#matplotlib.container.StemContainer" title="Permalink to this definition">¶</a></dt>

</dd></dl>

</div>

</div>

Last updated on Feb 08, 2018.

Created using <a

href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.

</div>

</body>

</footer>

</html>

matplotlib.github.com/2.1.2/api/container_api.html at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

container_api.html

Latest commit

History

Breadcrumbs

container_api.html

File metadata and controls