forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathblocking_input_api.html
More file actions
460 lines (409 loc) · 34.5 KB
/
blocking_input_api.html
File metadata and controls
460 lines (409 loc) · 34.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
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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
<!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>matplotlib.blocking_input — Matplotlib 3.3.3 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.3-2-g447bdbbf58" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.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" />
<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/language_data.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.3.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="matplotlib.category" href="category_api.html" />
<link rel="prev" title="matplotlib.bezier" href="bezier_api.html" />
<link rel="top" title="Matplotlib 3.3.3 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/blocking_input_api.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" />
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.3). For the latest version see <a href="https://matplotlib.org/stable/api/blocking_input_api.html">https://matplotlib.org/stable/api/blocking_input_api.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.3.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="../users/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"/>
</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="category_api.html" title="matplotlib.category"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="bezier_api.html" title="matplotlib.bezier"
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">API Overview</a> »</li>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.blocking_input</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<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">API Overview</a><ul>
<li>Previous: <a href="bezier_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.bezier</span></code></a></li>
<li>Next: <a href="category_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.category</span></code></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/blocking_input_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" role="main">
<div class="section" id="module-matplotlib.blocking_input">
<span id="matplotlib-blocking-input"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.blocking_input</span></code><a class="headerlink" href="#module-matplotlib.blocking_input" title="Permalink to this headline">¶</a></h1>
<p>Classes used for blocking interaction with figure windows:</p>
<dl class="docutils">
<dt><a class="reference internal" href="#matplotlib.blocking_input.BlockingInput" title="matplotlib.blocking_input.BlockingInput"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BlockingInput</span></code></a></dt><dd>Creates a callable object to retrieve events in a blocking way for
interactive sessions. Base class of the other classes listed here.</dd>
<dt><a class="reference internal" href="#matplotlib.blocking_input.BlockingKeyMouseInput" title="matplotlib.blocking_input.BlockingKeyMouseInput"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BlockingKeyMouseInput</span></code></a></dt><dd>Creates a callable object to retrieve key or mouse clicks in a blocking
way for interactive sessions. Used by <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.waitforbuttonpress" title="matplotlib.figure.Figure.waitforbuttonpress"><code class="xref py py-obj docutils literal notranslate"><span class="pre">waitforbuttonpress</span></code></a>.</dd>
<dt><a class="reference internal" href="#matplotlib.blocking_input.BlockingMouseInput" title="matplotlib.blocking_input.BlockingMouseInput"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BlockingMouseInput</span></code></a></dt><dd>Creates a callable object to retrieve mouse clicks in a blocking way for
interactive sessions. Used by <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.ginput" title="matplotlib.figure.Figure.ginput"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ginput</span></code></a>.</dd>
<dt><a class="reference internal" href="#matplotlib.blocking_input.BlockingContourLabeler" title="matplotlib.blocking_input.BlockingContourLabeler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BlockingContourLabeler</span></code></a></dt><dd>Creates a callable object to retrieve mouse clicks in a blocking way that
will then be used to place labels on a <a class="reference internal" href="contour_api.html#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ContourSet</span></code></a>. Used by
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.clabel.html#matplotlib.axes.Axes.clabel" title="matplotlib.axes.Axes.clabel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clabel</span></code></a>.</dd>
</dl>
<dl class="py class">
<dt id="matplotlib.blocking_input.BlockingContourLabeler">
<em class="property">class </em><code class="descclassname">matplotlib.blocking_input.</code><code class="descname">BlockingContourLabeler</code><span class="sig-paren">(</span><em><span class="n">cs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingContourLabeler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingContourLabeler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.blocking_input.BlockingMouseInput" title="matplotlib.blocking_input.BlockingMouseInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.blocking_input.BlockingMouseInput</span></code></a></p>
<p>Callable for retrieving mouse clicks and key presses in a blocking way.</p>
<p>Used to place contour labels.</p>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingContourLabeler.add_click">
<code class="descname">add_click</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingContourLabeler.add_click"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingContourLabeler.add_click" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the coordinates of an event to the list of clicks.</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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingContourLabeler.button1">
<code class="descname">button1</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingContourLabeler.button1"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingContourLabeler.button1" title="Permalink to this definition">¶</a></dt>
<dd><p>Process an button-1 event (add a label to a contour).</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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingContourLabeler.button3">
<code class="descname">button3</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingContourLabeler.button3"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingContourLabeler.button3" title="Permalink to this definition">¶</a></dt>
<dd><p>Process an button-3 event (remove a label if not in inline mode).</p>
<p>Unfortunately, if one is doing inline labels, then there is currently
no way to fix the broken contour - once humpty-dumpty is broken, he
can't be put back together. In inline mode, this does nothing.</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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingContourLabeler.pop_click">
<code class="descname">pop_click</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em>, <em><span class="n">index</span><span class="o">=</span><span class="default_value">- 1</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingContourLabeler.pop_click"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingContourLabeler.pop_click" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a click (by default, the last) from the list of clicks.</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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.blocking_input.BlockingInput">
<em class="property">class </em><code class="descclassname">matplotlib.blocking_input.</code><code class="descname">BlockingInput</code><span class="sig-paren">(</span><em><span class="n">fig</span></em>, <em><span class="n">eventslist</span><span class="o">=</span><span class="default_value">()</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingInput" 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.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Callable for retrieving events in a blocking way.</p>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingInput.add_event">
<code class="descname">add_event</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingInput.add_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingInput.add_event" title="Permalink to this definition">¶</a></dt>
<dd><p>For base class, this just appends an event to events.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingInput.cleanup">
<code class="descname">cleanup</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingInput.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingInput.cleanup" title="Permalink to this definition">¶</a></dt>
<dd><p>Disconnect all callbacks.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingInput.on_event">
<code class="descname">on_event</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingInput.on_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingInput.on_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Event handler; will be passed to the current figure to retrieve events.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingInput.pop">
<code class="descname">pop</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">index</span><span class="o">=</span><span class="default_value">- 1</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.blocking_input.BlockingInput.pop" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove an event from the event list -- by default, the last.</p>
<p>Note that this does not check that there are events, much like the
normal pop method. If no events exist, this will throw an exception.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingInput.pop_event">
<code class="descname">pop_event</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">index</span><span class="o">=</span><span class="default_value">- 1</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingInput.pop_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingInput.pop_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove an event from the event list -- by default, the last.</p>
<p>Note that this does not check that there are events, much like the
normal pop method. If no events exist, this will throw an exception.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingInput.post_event">
<code class="descname">post_event</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingInput.post_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingInput.post_event" title="Permalink to this definition">¶</a></dt>
<dd><p>For baseclass, do nothing but collect events.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.blocking_input.BlockingKeyMouseInput">
<em class="property">class </em><code class="descclassname">matplotlib.blocking_input.</code><code class="descname">BlockingKeyMouseInput</code><span class="sig-paren">(</span><em><span class="n">fig</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingKeyMouseInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingKeyMouseInput" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.blocking_input.BlockingInput" title="matplotlib.blocking_input.BlockingInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.blocking_input.BlockingInput</span></code></a></p>
<p>Callable for retrieving mouse clicks and key presses in a blocking way.</p>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingKeyMouseInput.post_event">
<code class="descname">post_event</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingKeyMouseInput.post_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingKeyMouseInput.post_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine if it is a key event.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.blocking_input.BlockingMouseInput">
<em class="property">class </em><code class="descclassname">matplotlib.blocking_input.</code><code class="descname">BlockingMouseInput</code><span class="sig-paren">(</span><em>fig</em>, <em>mouse_add=<MouseButton.LEFT: 1></em>, <em>mouse_pop=<MouseButton.RIGHT: 3></em>, <em>mouse_stop=<MouseButton.MIDDLE: 2></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.blocking_input.BlockingInput" title="matplotlib.blocking_input.BlockingInput"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.blocking_input.BlockingInput</span></code></a></p>
<p>Callable for retrieving mouse clicks in a blocking way.</p>
<p>This class will also retrieve keypresses and map them to mouse clicks:
delete and backspace are a right click, enter is like a middle click,
and all others are like a left click.</p>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.add_click">
<code class="descname">add_click</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.add_click"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.add_click" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the coordinates of an event to the list of clicks.</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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.blocking_input.BlockingMouseInput.button_add">
<code class="descname">button_add</code><em class="property"> = 1</em><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.button_add" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.blocking_input.BlockingMouseInput.button_pop">
<code class="descname">button_pop</code><em class="property"> = 3</em><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.button_pop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.blocking_input.BlockingMouseInput.button_stop">
<code class="descname">button_stop</code><em class="property"> = 2</em><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.button_stop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.cleanup">
<code class="descname">cleanup</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.cleanup" title="Permalink to this definition">¶</a></dt>
<dd><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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a>, optional</span></dt><dd><p>Not used</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.key_event">
<code class="descname">key_event</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.key_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.key_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Process a key press event, mapping keys to appropriate mouse clicks.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.mouse_event">
<code class="descname">mouse_event</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.mouse_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.mouse_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Process a mouse click event.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.mouse_event_add">
<code class="descname">mouse_event_add</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.mouse_event_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.mouse_event_add" title="Permalink to this definition">¶</a></dt>
<dd><p>Process an button-1 event (add a click if inside axes).</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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.mouse_event_pop">
<code class="descname">mouse_event_pop</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.mouse_event_pop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.mouse_event_pop" title="Permalink to this definition">¶</a></dt>
<dd><p>Process an button-3 event (remove the last click).</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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.mouse_event_stop">
<code class="descname">mouse_event_stop</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.mouse_event_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.mouse_event_stop" title="Permalink to this definition">¶</a></dt>
<dd><p>Process an button-2 event (end blocking input).</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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.pop">
<code class="descname">pop</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em>, <em><span class="n">index</span><span class="o">=</span><span class="default_value">- 1</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.pop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.pop" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a click and the associated event from the list of clicks.</p>
<p>Defaults to the last click.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.pop_click">
<code class="descname">pop_click</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">event</span></em>, <em><span class="n">index</span><span class="o">=</span><span class="default_value">- 1</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.pop_click"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.pop_click" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a click (by default, the last) from the list of clicks.</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>event</strong><span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseEvent</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.blocking_input.BlockingMouseInput.post_event">
<code class="descname">post_event</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/blocking_input.html#BlockingMouseInput.post_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.blocking_input.BlockingMouseInput.post_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Process an event.</p>
</dd></dl>
</dd></dl>
</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 - 2020 The Matplotlib development team.
<br />
Last updated on Nov 12, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.
Doc version v3.3.3-2-g447bdbbf58.
</div>
</footer>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55954603-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>