-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathbackend_nbagg_api.html
More file actions
332 lines (284 loc) · 21.5 KB
/
backend_nbagg_api.html
File metadata and controls
332 lines (284 loc) · 21.5 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
<!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.backends.backend_nbagg — Matplotlib 2.2.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/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.0',
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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.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 2.2.0 documentation" href="../index.html" />
<link rel="up" title="backends" href="index_backend_api.html" />
<link rel="next" title="matplotlib.backends.backend_pdf" href="backend_pdf_api.html" />
<link rel="prev" title="matplotlib.backends.backend_gtk3cairo" href="backend_gtk3cairo_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/backend_nbagg_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 (v2.2.0). For the latest version see <a href="https://matplotlib.org/stable/api/backend_nbagg_api.html">https://matplotlib.org/stable/api/backend_nbagg_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 2.2.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 class="right" >
<a href="backend_pdf_api.html" title="matplotlib.backends.backend_pdf"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="backend_gtk3cairo_api.html" title="matplotlib.backends.backend_gtk3cairo"
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>
<li><a href="index.html" >The Matplotlib API</a> »</li>
<li><a href="index_backend_api.html" accesskey="U">backends</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><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><a href="index_backend_api.html">backends</a><ul>
<li>Previous: <a href="backend_gtk3cairo_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends.backend_gtk3cairo</span></code></a></li>
<li>Next: <a href="backend_pdf_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends.backend_pdf</span></code></a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/backend_nbagg_api.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<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>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-matplotlib.backends.backend_nbagg">
<span id="matplotlib-backends-backend-nbagg"></span><h1><a class="reference internal" href="#module-matplotlib.backends.backend_nbagg" title="matplotlib.backends.backend_nbagg"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_nbagg</span></code></a><a class="headerlink" href="#module-matplotlib.backends.backend_nbagg" title="Permalink to this headline">¶</a></h1>
<p>Interactive figures in the IPython notebook</p>
<dl class="class">
<dt id="matplotlib.backends.backend_nbagg.CommSocket">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_nbagg.</code><code class="descname">CommSocket</code><span class="sig-paren">(</span><em>manager</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.CommSocket" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Manages the Comm connection between IPython and the browser (client).</p>
<p>Comms are 2 way, with the CommSocket being able to publish a message
via the send_json method, and handle a message with on_message. On the
JS side figure.send_message and figure.ws.onmessage do the sending and
receiving respectively.</p>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.CommSocket.is_open">
<code class="descname">is_open</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.CommSocket.is_open" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.CommSocket.on_close">
<code class="descname">on_close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.CommSocket.on_close" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.CommSocket.on_message">
<code class="descname">on_message</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.CommSocket.on_message" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.CommSocket.send_binary">
<code class="descname">send_binary</code><span class="sig-paren">(</span><em>blob</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.CommSocket.send_binary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.CommSocket.send_json">
<code class="descname">send_json</code><span class="sig-paren">(</span><em>content</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.CommSocket.send_json" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_nbagg.FigureCanvas">
<code class="descclassname">matplotlib.backends.backend_nbagg.</code><code class="descname">FigureCanvas</code><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureCanvas" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_nbagg.FigureCanvasNbAgg" title="matplotlib.backends.backend_nbagg.FigureCanvasNbAgg"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_nbagg.FigureCanvasNbAgg</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_nbagg.FigureCanvasNbAgg">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_nbagg.</code><code class="descname">FigureCanvasNbAgg</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureCanvasNbAgg" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_webagg_core.FigureCanvasWebAggCore</span></code></p>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.FigureCanvasNbAgg.new_timer">
<code class="descname">new_timer</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureCanvasNbAgg.new_timer" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new backend-specific subclass of
<code class="xref py py-class docutils literal notranslate"><span class="pre">backend_bases.Timer</span></code>. This is useful for getting periodic
events through the backend’s native event loop. Implemented only for
backends with GUIs.</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" colspan="2">Other Parameters:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body"><p class="first"><strong>interval</strong> : scalar</p>
<blockquote>
<div><p>Timer interval in milliseconds</p>
</div></blockquote>
<p><strong>callbacks</strong> : List[Tuple[callable, Tuple, Dict]]</p>
<blockquote class="last">
<div><p>Sequence of (func, args, kwargs) where <code class="docutils literal notranslate"><span class="pre">func(*args,</span> <span class="pre">**kwargs)</span></code>
will be executed by the timer every <em>interval</em>.</p>
<p>callbacks which return <code class="docutils literal notranslate"><span class="pre">False</span></code> or <code class="docutils literal notranslate"><span class="pre">0</span></code> will be removed from the
timer.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">timer</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">new_timer</span><span class="p">(</span><span class="n">callbacks</span><span class="o">=</span><span class="p">[(</span><span class="n">f1</span><span class="p">,</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="p">),</span> <span class="p">{</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">3</span><span class="p">}),])</span>
</pre></div>
</div>
</dd></dl>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_nbagg.FigureManager">
<code class="descclassname">matplotlib.backends.backend_nbagg.</code><code class="descname">FigureManager</code><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManager" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg" title="matplotlib.backends.backend_nbagg.FigureManagerNbAgg"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_nbagg.FigureManagerNbAgg</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_nbagg.</code><code class="descname">FigureManagerNbAgg</code><span class="sig-paren">(</span><em>canvas</em>, <em>num</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_webagg_core.FigureManagerWebAgg</span></code></p>
<dl class="attribute">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg.ToolbarCls">
<code class="descname">ToolbarCls</code><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.ToolbarCls" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backends.backend_nbagg.NavigationIPy" title="matplotlib.backends.backend_nbagg.NavigationIPy"><code class="xref py py-class docutils literal notranslate"><span class="pre">NavigationIPy</span></code></a></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg.clearup_closed">
<code class="descname">clearup_closed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.clearup_closed" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear up any closed Comms.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg.connected">
<code class="descname">connected</code><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.connected" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg.destroy">
<code class="descname">destroy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.destroy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg.display_js">
<code class="descname">display_js</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.display_js" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg.get_javascript">
<em class="property">classmethod </em><code class="descname">get_javascript</code><span class="sig-paren">(</span><em>stream=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.get_javascript" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg.remove_comm">
<code class="descname">remove_comm</code><span class="sig-paren">(</span><em>comm_id</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.remove_comm" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg.reshow">
<code class="descname">reshow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.reshow" title="Permalink to this definition">¶</a></dt>
<dd><p>A special method to re-show the figure in the notebook.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.backends.backend_nbagg.FigureManagerNbAgg.show">
<code class="descname">show</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.FigureManagerNbAgg.show" title="Permalink to this definition">¶</a></dt>
<dd><p>For GUI backends, show the figure window and redraw.
For non-GUI backends, raise an exception to be caught
by <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.show" title="matplotlib.figure.Figure.show"><code class="xref py py-meth docutils literal notranslate"><span class="pre">show()</span></code></a>, for an
optional warning.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.backends.backend_nbagg.NavigationIPy">
<em class="property">class </em><code class="descclassname">matplotlib.backends.backend_nbagg.</code><code class="descname">NavigationIPy</code><span class="sig-paren">(</span><em>canvas</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.NavigationIPy" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backends.backend_webagg_core.NavigationToolbar2WebAgg</span></code></p>
<dl class="attribute">
<dt id="matplotlib.backends.backend_nbagg.NavigationIPy.toolitems">
<code class="descname">toolitems</code><em class="property"> = [('Home', 'Reset original view', 'fa fa-home icon-home', 'home'), ('Back', 'Back to previous view', 'fa fa-arrow-left icon-arrow-left', 'back'), ('Forward', 'Forward to next view', 'fa fa-arrow-right icon-arrow-right', 'forward'), (None, None, None, None), ('Pan', 'Pan axes with left mouse, zoom with right', 'fa fa-arrows icon-move', 'pan'), ('Zoom', 'Zoom to rectangle', 'fa fa-square-o icon-check-empty', 'zoom'), (None, None, None, None), ('Download', 'Download plot', 'fa fa-floppy-o icon-save', 'download')]</em><a class="headerlink" href="#matplotlib.backends.backend_nbagg.NavigationIPy.toolitems" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_nbagg.connection_info">
<code class="descclassname">matplotlib.backends.backend_nbagg.</code><code class="descname">connection_info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.connection_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a string showing the figure and connection status for
the backend. This is intended as a diagnostic tool, and not for general
use.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_nbagg.new_figure_manager_given_figure">
<code class="descclassname">matplotlib.backends.backend_nbagg.</code><code class="descname">new_figure_manager_given_figure</code><span class="sig-paren">(</span><em>num</em>, <em>figure</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.new_figure_manager_given_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new figure manager instance for the given figure.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.backends.backend_nbagg.show">
<code class="descclassname">matplotlib.backends.backend_nbagg.</code><code class="descname">show</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.backends.backend_nbagg.show" title="Permalink to this definition">¶</a></dt>
<dd><p>Show all figures.</p>
<p><a class="reference internal" href="#matplotlib.backends.backend_nbagg.show" title="matplotlib.backends.backend_nbagg.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">show</span></code></a> blocks by calling <code class="xref py py-obj docutils literal notranslate"><span class="pre">mainloop</span></code> if <em>block</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, or if it
is <code class="docutils literal notranslate"><span class="pre">None</span></code> and we are neither in IPython’s <code class="docutils literal notranslate"><span class="pre">%pylab</span></code> mode, nor in
<code class="xref py py-obj docutils literal notranslate"><span class="pre">interactive</span></code> mode.</p>
</dd></dl>
</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 - 2017 The Matplotlib development team.
Last updated on Mar 06, 2018.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.7.1.
</div>
</body>
<footer>
</footer>
</html>