{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathinteractive.html
More file actions
440 lines (417 loc) · 35.9 KB
/
Copy pathinteractive.html
File metadata and controls
440 lines (417 loc) · 35.9 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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Interactive Figures — Matplotlib 3.4.3 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/mpl.css?v3.4.3-2-ge48e4acce0" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-rendered-html.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.4.3 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="next" title="Interactive Figures and Asynchronous Programming" href="interactive_guide.html" />
<link rel="prev" title="The mplot3d Toolkit" href="../tutorials/toolkits/mplot3d.html" />
<link rel="top" title="Matplotlib 3.4.3 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/users/interactive.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<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.4.3). For the latest version see <a href="https://matplotlib.org/stable/users/interactive.html">https://matplotlib.org/stable/users/interactive.html</a></div>
<!--
<div id="annc-banner">
</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.4.3</span></div>
<img src="../_static/logo2_compressed.svg" 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>
<nav class="main-nav">
<ul>
<li><a href="installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<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="interactive_guide.html" title="Interactive Figures and Asynchronous Programming"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../tutorials/toolkits/mplot3d.html" title="The mplot3d Toolkit"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">User's Guide</a> »</li>
<li class="nav-item nav-item-this"><a href="">Interactive Figures</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Interactive Figures</a><ul>
<li><a class="reference internal" href="#ipython-integration">IPython integration</a></li>
<li><a class="reference internal" href="#interactive-mode">Interactive mode</a></li>
<li><a class="reference internal" href="#default-ui">Default UI</a><ul>
<li><a class="reference internal" href="#navigation-keyboard-shortcuts">Navigation Keyboard Shortcuts</a></li>
</ul>
</li>
<li><a class="reference internal" href="#other-python-prompts">Other Python prompts</a><ul>
<li><a class="reference internal" href="#jupyter-notebooks-lab">Jupyter Notebooks / Lab</a><ul>
<li><a class="reference internal" href="#guis-jupyter">GUIs + Jupyter</a></li>
</ul>
</li>
<li><a class="reference internal" href="#pycharm-spyder-and-vscode">PyCharm, Spyder, and VSCode</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<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/users/interactive.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" role="main">
<div class="section" id="interactive-figures">
<span id="mpl-shell"></span><h1>Interactive Figures<a class="headerlink" href="#interactive-figures" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<p>When working with data, interactivity can be invaluable. The pan/zoom and
mouse-location tools built into the Matplotlib GUI windows are often sufficient, but
you can also use the event system to build customized data exploration tools.</p>
<p>Matplotlib ships with <a class="reference internal" href="../tutorials/introductory/usage.html#what-is-a-backend"><span class="std std-ref">backends</span></a> binding to
several GUI toolkits (Qt, Tk, Wx, GTK, macOS, JavaScript) and third party
packages provide bindings to <a class="reference external" href="https://github.com/kivy-garden/garden.matplotlib">kivy</a> and <a class="reference external" href="https://github.com/matplotlib/ipympl">Jupyter Lab</a>. For the figures to be responsive to
mouse, keyboard, and paint events, the GUI event loop needs to be integrated
with an interactive prompt. We recommend using IPython (see <a class="reference internal" href="#ipython-pylab"><span class="std std-ref">below</span></a>).</p>
<p>The <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot</span></code></a> module provides functions for explicitly creating figures
that include interactive tools, a toolbar, a tool-tip, and
<a class="reference internal" href="#key-event-handling"><span class="std std-ref">key bindings</span></a>:</p>
<dl class="docutils">
<dt><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.figure</span></code></a></dt><dd>Creates a new empty <a class="reference internal" href="../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">figure.Figure</span></code></a> or selects an existing figure</dd>
<dt><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="matplotlib.pyplot.subplots"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplots</span></code></a></dt><dd>Creates a new <a class="reference internal" href="../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">figure.Figure</span></code></a> and fills it with a grid of <a class="reference internal" href="../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes.Axes</span></code></a></dd>
</dl>
<p><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot</span></code></a> has a notion of "The Current Figure" which can be accessed
through <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.gcf.html#matplotlib.pyplot.gcf" title="matplotlib.pyplot.gcf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.gcf</span></code></a> and a notion of "The Current Axes" accessed
through <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.gca.html#matplotlib.pyplot.gca" title="matplotlib.pyplot.gca"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.gca</span></code></a>. Almost all of the functions in <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot</span></code></a> pass
through the current <a class="reference internal" href="../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> / <a class="reference internal" href="../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes.Axes</span></code></a> (or create one) as
appropriate.</p>
<p>Matplotlib keeps a reference to all of the open figures
created via <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.figure</span></code></a> or <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="matplotlib.pyplot.subplots"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplots</span></code></a> so that the figures will not be garbage
collected. <a class="reference internal" href="../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a>s can be closed and deregistered from <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot</span></code></a> individually via
<a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.close.html#matplotlib.pyplot.close" title="matplotlib.pyplot.close"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.close</span></code></a>; all open <a class="reference internal" href="../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a>s can be closed via <code class="docutils literal notranslate"><span class="pre">plt.close('all')</span></code>.</p>
<p>For more discussion of Matplotlib's event system and integrated event loops, please read:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="interactive_guide.html">Interactive Figures and Asynchronous Programming</a></li>
<li class="toctree-l1"><a class="reference internal" href="event_handling.html">Event handling and picking</a></li>
</ul>
</div>
<div class="section" id="ipython-integration">
<span id="ipython-pylab"></span><h2>IPython integration<a class="headerlink" href="#ipython-integration" title="Permalink to this headline">¶</a></h2>
<p>We recommend using IPython for an interactive shell. In addition to
all of its features (improved tab-completion, magics, multiline editing, etc),
it also ensures that the GUI toolkit event loop is properly integrated
with the command line (see <a class="reference internal" href="interactive_guide.html#cp-integration"><span class="std std-ref">Command Prompt Integration</span></a>).</p>
<p>In this example, we create and modify a figure via an IPython prompt.
The figure displays in a Qt5Agg GUI window. To configure the integration
and enable <a class="reference internal" href="#controlling-interactive"><span class="std std-ref">interactive mode</span></a> use the
<code class="docutils literal notranslate"><span class="pre">%matplotlib</span></code> magic:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [1]: </span><span class="o">%</span><span class="k">matplotlib</span>
<span class="go">Using matplotlib backend: Qt5Agg</span>
<span class="gp">In [2]: </span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
</pre></div>
</div>
<p>Create a new figure window:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [3]: </span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span>
</pre></div>
</div>
<p>Add a line plot of the data to the window:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [4]: </span><span class="n">ln</span><span class="p">,</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">5</span><span class="p">))</span>
</pre></div>
</div>
<p>Change the color of the line from blue to orange:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [5]: </span><span class="n">ln</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s1">'orange'</span><span class="p">)</span>
</pre></div>
</div>
<p>If you wish to disable automatic redrawing of the plot:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [6]: </span><span class="n">plt</span><span class="o">.</span><span class="n">ioff</span><span class="p">()</span>
</pre></div>
</div>
<p>If you wish to re-enable automatic redrawing of the plot:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [7]: </span><span class="n">plt</span><span class="o">.</span><span class="n">ion</span><span class="p">()</span>
</pre></div>
</div>
<p>In recent versions of <code class="docutils literal notranslate"><span class="pre">Matplotlib</span></code> and <code class="docutils literal notranslate"><span class="pre">IPython</span></code>, it is
sufficient to import <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pyplot</span></code></a> and call <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.ion.html#matplotlib.pyplot.ion" title="matplotlib.pyplot.ion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ion</span></code></a>.
Using the <code class="docutils literal notranslate"><span class="pre">%</span></code> magic is guaranteed to work in all versions of Matplotlib and IPython.</p>
</div>
<div class="section" id="interactive-mode">
<span id="controlling-interactive"></span><h2>Interactive mode<a class="headerlink" href="#interactive-mode" title="Permalink to this headline">¶</a></h2>
<table border="1" class="longtable docutils align-default">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.ion.html#matplotlib.pyplot.ion" title="matplotlib.pyplot.ion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ion</span></code></a></td>
<td>Enable interactive mode.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.ioff.html#matplotlib.pyplot.ioff" title="matplotlib.pyplot.ioff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ioff</span></code></a></td>
<td>Disable interactive mode.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.isinteractive.html#matplotlib.pyplot.isinteractive" title="matplotlib.pyplot.isinteractive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.isinteractive</span></code></a></td>
<td>Return whether plots are updated after every plotting command.</td>
</tr>
</tbody>
</table>
<table border="1" class="longtable docutils align-default">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show</span></code></a></td>
<td>Display all open figures.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.pause.html#matplotlib.pyplot.pause" title="matplotlib.pyplot.pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.pause</span></code></a></td>
<td>Run the GUI event loop for <em>interval</em> seconds.</td>
</tr>
</tbody>
</table>
<p>Interactive mode controls:</p>
<ul class="simple">
<li>whether created figures are automatically shown</li>
<li>whether changes to artists automatically trigger re-drawing existing figures</li>
<li>when <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show()</span></code></a> returns if given no arguments: immediately, or after all of the figures have been closed</li>
</ul>
<p>If in interactive mode:</p>
<ul class="simple">
<li>newly created figures will be displayed immediately</li>
<li>figures will automatically redraw when elements are changed</li>
<li><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show()</span></code></a> displays the figures and immediately returns</li>
</ul>
<p>If not in interactive mode:</p>
<ul class="simple">
<li><dl class="first docutils">
<dt>newly created figures and changes to figures are not displayed until</dt><dd><ul>
<li><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show()</span></code></a> is called</li>
<li><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.pause.html#matplotlib.pyplot.pause" title="matplotlib.pyplot.pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.pause()</span></code></a> is called</li>
<li><a class="reference internal" href="../api/backend_bases_api.html#matplotlib.backend_bases.FigureCanvasBase.flush_events" title="matplotlib.backend_bases.FigureCanvasBase.flush_events"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FigureCanvasBase.flush_events()</span></code></a> is called</li>
</ul>
</dd>
</dl>
</li>
<li><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show()</span></code></a> runs the GUI event loop and does not return until all the plot windows are closed</li>
</ul>
<p>If you are in non-interactive mode (or created figures while in
non-interactive mode) you may need to explicitly call <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show</span></code></a>
to display the windows on your screen. If you only want to run the
GUI event loop for a fixed amount of time, you can use <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.pause.html#matplotlib.pyplot.pause" title="matplotlib.pyplot.pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.pause</span></code></a>.
This will block the progress of your code as if you had called
<a class="reference external" href="https://docs.python.org/3/library/time.html#time.sleep" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time.sleep</span></code></a>, ensure the current window is shown and re-drawn if needed,
and run the GUI event loop for the specified period of time.</p>
<p>The GUI event loop being integrated with your command prompt and
the figures being in interactive mode are independent of each other.
If you use <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.ion.html#matplotlib.pyplot.ion" title="matplotlib.pyplot.ion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ion</span></code></a> but have not arranged for the event loop integration,
your figures will appear but will not be interactive while the prompt is waiting for input.
You will not be able to pan/zoom and the figure may not even render
(the window might appear black, transparent, or as a snapshot of the
desktop under it). Conversely, if you configure the event loop
integration, displayed figures will be responsive while waiting for input
at the prompt, regardless of pyplot's "interactive mode".</p>
<p>No matter what combination of interactive mode setting and event loop integration,
figures will be responsive if you use <code class="docutils literal notranslate"><span class="pre">pyplot.show(block=True)</span></code>, <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.pause.html#matplotlib.pyplot.pause" title="matplotlib.pyplot.pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.pause</span></code></a>, or run
the GUI main loop in some other way.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Using <a class="reference internal" href="../api/figure_api.html#matplotlib.figure.Figure.show" title="matplotlib.figure.Figure.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">figure.Figure.show</span></code></a> it is possible to display a figure on
the screen without starting the event loop and without being in
interactive mode. This may work (depending on the GUI toolkit) but
will likely result in a non-responsive figure.</p>
</div>
</div>
<div class="section" id="default-ui">
<span id="navigation-toolbar"></span><h2>Default UI<a class="headerlink" href="#default-ui" title="Permalink to this headline">¶</a></h2>
<p>The windows created by <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pyplot</span></code></a> have an interactive toolbar with navigation
buttons and a readout of the data values the cursor is pointing at. A number of
helpful keybindings are registered by default.</p>
<div class="section" id="navigation-keyboard-shortcuts">
<span id="key-event-handling"></span><h3>Navigation Keyboard Shortcuts<a class="headerlink" href="#navigation-keyboard-shortcuts" title="Permalink to this headline">¶</a></h3>
<p>The following table holds all the default keys, which can be
overwritten by use of your <a class="reference internal" href="../tutorials/introductory/customizing.html"><span class="doc">matplotlibrc</span></a>.</p>
<table border="1" class="docutils align-default">
<colgroup>
<col width="41%" />
<col width="59%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Command</th>
<th class="head">Default key binding and rcParam</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Home/Reset</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.home#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.home"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['h',</span> <span class="pre">'r',</span> <span class="pre">'home']</span></code>)</td>
</tr>
<tr class="row-odd"><td>Back</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.back#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.back"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['left',</span> <span class="pre">'c',</span> <span class="pre">'backspace',</span> <span class="pre">'MouseButton.BACK']</span></code>)</td>
</tr>
<tr class="row-even"><td>Forward</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.forward#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.forward"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['right',</span> <span class="pre">'v',</span> <span class="pre">'MouseButton.FORWARD']</span></code>)</td>
</tr>
<tr class="row-odd"><td>Pan/Zoom</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.pan#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.pan"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['p']</span></code>)</td>
</tr>
<tr class="row-even"><td>Zoom-to-rect</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.zoom#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.zoom"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['o']</span></code>)</td>
</tr>
<tr class="row-odd"><td>Save</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.save#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.save"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['s',</span> <span class="pre">'ctrl+s']</span></code>)</td>
</tr>
<tr class="row-even"><td>Toggle fullscreen</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.fullscreen#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.fullscreen"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['f',</span> <span class="pre">'ctrl+f']</span></code>)</td>
</tr>
<tr class="row-odd"><td>Toggle major grids</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.grid#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.grid"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['g']</span></code>)</td>
</tr>
<tr class="row-even"><td>Toggle minor grids</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.grid_minor#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.grid_minor"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['G']</span></code>)</td>
</tr>
<tr class="row-odd"><td>Toggle x axis scale (log/linear)</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.xscale#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.xscale"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['k',</span> <span class="pre">'L']</span></code>)</td>
</tr>
<tr class="row-even"><td>Toggle y axis scale (log/linear)</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.yscale#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.yscale"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['l']</span></code>)</td>
</tr>
<tr class="row-odd"><td>Close Figure</td>
<td><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=keymap.quit#a-sample-matplotlibrc-file"><span class="pre">rcParams["keymap.quit"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['ctrl+w',</span> <span class="pre">'cmd+w',</span> <span class="pre">'q']</span></code>)</td>
</tr>
<tr class="row-even"><td>Constrain pan/zoom to x axis</td>
<td>hold <strong>x</strong> when panning/zooming with mouse</td>
</tr>
<tr class="row-odd"><td>Constrain pan/zoom to y axis</td>
<td>hold <strong>y</strong> when panning/zooming with mouse</td>
</tr>
<tr class="row-even"><td>Preserve aspect ratio</td>
<td>hold <strong>CONTROL</strong> when panning/zooming with mouse</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="other-python-prompts">
<span id="other-shells"></span><h2>Other Python prompts<a class="headerlink" href="#other-python-prompts" title="Permalink to this headline">¶</a></h2>
<p>Interactive mode works in the default Python prompt:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="gp">>>> </span><span class="n">plt</span><span class="o">.</span><span class="n">ion</span><span class="p">()</span>
<span class="go">>>></span>
</pre></div>
</div>
<p>however this does not ensure that the event hook is properly installed
and your figures may not be responsive. Please consult the
documentation of your GUI toolkit for details.</p>
<div class="section" id="jupyter-notebooks-lab">
<h3>Jupyter Notebooks / Lab<a class="headerlink" href="#jupyter-notebooks-lab" title="Permalink to this headline">¶</a></h3>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">To get the interactive functionality described here, you must be
using an interactive backend. The default backend in notebooks,
the inline backend, is not. <code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_inline</span></code>
renders the figure once and inserts a static image into the
notebook when the cell is executed. Because the images are static, they
can not be panned / zoomed, take user input, or be updated from other
cells.</p>
</div>
<p>To get interactive figures in the 'classic' notebook or Jupyter lab,
use the <a class="reference external" href="https://github.com/matplotlib/ipympl">ipympl</a> backend
(must be installed separately) which uses the <strong>ipywidget</strong> framework.
If <code class="docutils literal notranslate"><span class="pre">ipympl</span></code> is installed use the magic:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="k">matplotlib</span> widget
</pre></div>
</div>
<p>to select and enable it.</p>
<p>If you only need to use the classic notebook, you can use</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="k">matplotlib</span> notebook
</pre></div>
</div>
<p>which uses the <a class="reference internal" href="../api/backend_nbagg_api.html#module-matplotlib.backends.backend_nbagg" title="matplotlib.backends.backend_nbagg"><code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_nbagg</span></code></a> backend provided by Matplotlib;
however, nbagg does not work in Jupyter Lab.</p>
<div class="section" id="guis-jupyter">
<h4>GUIs + Jupyter<a class="headerlink" href="#guis-jupyter" title="Permalink to this headline">¶</a></h4>
<p>You can also use one of the non-<code class="docutils literal notranslate"><span class="pre">ipympl</span></code> GUI backends in a Jupyter Notebook.
If you are running your Jupyter kernel locally, the GUI window will spawn on
your desktop adjacent to your web browser. If you run your notebook on a remote server,
the kernel will try to open the GUI window on the remote computer. Unless you have
arranged to forward the xserver back to your desktop, you will not be able to
see or interact with the window. It may also raise an exception.</p>
</div>
</div>
<div class="section" id="pycharm-spyder-and-vscode">
<h3>PyCharm, Spyder, and VSCode<a class="headerlink" href="#pycharm-spyder-and-vscode" title="Permalink to this headline">¶</a></h3>
<p>Many IDEs have built-in integration with Matplotlib, please consult their
documentation for configuration details.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.
<br />
Last updated on Aug 13, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.4.3.
Doc version v3.4.3-2-ge48e4acce0.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.