Repository navigation
Expand file tree
/
Copy pathwidgets_api.html
More file actions
1404 lines (1285 loc) · 113 KB
/
Copy pathwidgets_api.html
File metadata and controls
1404 lines (1285 loc) · 113 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
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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>widgets — Matplotlib 2.2.2 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.2',
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.2 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.2.2 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="matplotlib.pyplot" href="_as_gen/matplotlib.pyplot.html" />
<link rel="prev" title="units" href="units_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/widgets_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.2). For the latest version see <a href="https://matplotlib.org/stable/api/widgets_api.html">https://matplotlib.org/stable/api/widgets_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.2</span></div>
<img src="../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="_as_gen/matplotlib.pyplot.html" title="matplotlib.pyplot"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="units_api.html" title="units"
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" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">widgets</a><ul>
<li><a class="reference internal" href="#module-matplotlib.widgets"><code class="docutils literal notranslate"><span class="pre">matplotlib.widgets</span></code></a><ul>
<li><a class="reference internal" href="#gui-neutral-widgets">GUI neutral widgets</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li>Previous: <a href="units_api.html" title="previous chapter">units</a></li>
<li>Next: <a href="_as_gen/matplotlib.pyplot.html" title="next chapter">matplotlib.pyplot</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/widgets_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="widgets">
<h1>widgets<a class="headerlink" href="#widgets" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.widgets">
<span id="matplotlib-widgets"></span><h2><a class="reference internal" href="#module-matplotlib.widgets" title="matplotlib.widgets"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.widgets</span></code></a><a class="headerlink" href="#module-matplotlib.widgets" title="Permalink to this headline">¶</a></h2>
<div class="section" id="gui-neutral-widgets">
<h3>GUI neutral widgets<a class="headerlink" href="#gui-neutral-widgets" title="Permalink to this headline">¶</a></h3>
<p>Widgets that are designed to work for any of the GUI backends.
All of these widgets require you to predefine a <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>
instance and pass that as the first arg. matplotlib doesn’t try to
be too smart with respect to layout – you will have to figure out how
wide and tall you want your Axes to be to accommodate your widget.</p>
<dl class="class">
<dt id="matplotlib.widgets.AxesWidget">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">AxesWidget</code><span class="sig-paren">(</span><em>ax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#AxesWidget"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.AxesWidget" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.widgets.Widget" title="matplotlib.widgets.Widget"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets.Widget</span></code></a></p>
<p>Widget that is connected to a single
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a>.</p>
<p>To guarantee that the widget remains responsive and not garbage-collected,
a reference to the object should be maintained by the user.</p>
<p>This is necessary because the callback registry
maintains only weak-refs to the functions, which are member
functions of the widget. If there are no references to the widget
object it may be garbage collected which will disconnect the
callbacks.</p>
<p>Attributes:</p>
<dl class="docutils">
<dt><em>ax</em> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a></span></dt>
<dd>The parent axes for the widget</dd>
<dt><em>canvas</em> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.FigureCanvasBase" title="matplotlib.backend_bases.FigureCanvasBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">FigureCanvasBase</span></code></a> subclass</span></dt>
<dd>The parent figure canvas for the widget.</dd>
<dt><em>active</em> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd>If False, the widget does not respond to events.</dd>
</dl>
<dl class="method">
<dt id="matplotlib.widgets.AxesWidget.connect_event">
<code class="descname">connect_event</code><span class="sig-paren">(</span><em>event</em>, <em>callback</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#AxesWidget.connect_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.AxesWidget.connect_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Connect callback with an event.</p>
<p>This should be used in lieu of <code class="xref py py-obj docutils literal notranslate"><span class="pre">figure.canvas.mpl_connect</span></code> since this
function stores callback ids for later clean up.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.AxesWidget.disconnect_events">
<code class="descname">disconnect_events</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#AxesWidget.disconnect_events"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.AxesWidget.disconnect_events" title="Permalink to this definition">¶</a></dt>
<dd><p>Disconnect all events created by this widget.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.Button">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">Button</code><span class="sig-paren">(</span><em>ax</em>, <em>label</em>, <em>image=None</em>, <em>color='0.85'</em>, <em>hovercolor='0.95'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Button"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Button" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.widgets.AxesWidget" title="matplotlib.widgets.AxesWidget"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets.AxesWidget</span></code></a></p>
<p>A GUI neutral button.</p>
<p>For the button to remain responsive you must keep a reference to it.
Call <a class="reference internal" href="#matplotlib.widgets.Button.on_clicked" title="matplotlib.widgets.Button.on_clicked"><code class="xref py py-meth docutils literal notranslate"><span class="pre">on_clicked()</span></code></a> to connect to the button.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>ax :</strong></dt>
<dd><p class="first last">The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a> the button renders into.</p>
</dd>
<dt><strong>label :</strong></dt>
<dd><p class="first last">A <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.text.Text</span></code></a> instance.</p>
</dd>
<dt><strong>color :</strong></dt>
<dd><p class="first last">The color of the button when not hovering.</p>
</dd>
<dt><strong>hovercolor :</strong></dt>
<dd><p class="first last">The color of the button when hovering.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>ax</strong> <span class="classifier-delimiter">:</span> <span class="classifier">matplotlib.axes.Axes</span></dt>
<dd><p class="first last">The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a> instance the button
will be placed into.</p>
</dd>
<dt><strong>label</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">The button text. Accepts string.</p>
</dd>
<dt><strong>image</strong> <span class="classifier-delimiter">:</span> <span class="classifier">array, mpl image, Pillow Image</span></dt>
<dd><p class="first last">The image to place in the button, if not <em>None</em>.
Can be any legal arg to imshow (numpy array,
matplotlib Image instance, or Pillow Image).</p>
</dd>
<dt><strong>color</strong> <span class="classifier-delimiter">:</span> <span class="classifier">color</span></dt>
<dd><p class="first last">The color of the button when not activated</p>
</dd>
<dt><strong>hovercolor</strong> <span class="classifier-delimiter">:</span> <span class="classifier">color</span></dt>
<dd><p class="first last">The color of the button when the mouse is over it</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.widgets.Button.disconnect">
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>cid</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Button.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Button.disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>remove the observer with connection id <em>cid</em></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.Button.on_clicked">
<code class="descname">on_clicked</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Button.on_clicked"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Button.on_clicked" title="Permalink to this definition">¶</a></dt>
<dd><p>When the button is clicked, call this <em>func</em> with event.</p>
<p>A connection id is returned. It can be used to disconnect
the button from its callback.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.CheckButtons">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">CheckButtons</code><span class="sig-paren">(</span><em>ax</em>, <em>labels</em>, <em>actives</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#CheckButtons"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.CheckButtons" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.widgets.AxesWidget" title="matplotlib.widgets.AxesWidget"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets.AxesWidget</span></code></a></p>
<p>A GUI neutral set of check buttons.</p>
<p>For the check buttons to remain responsive you must keep a
reference to this object.</p>
<p>The following attributes are exposed</p>
<blockquote>
<div><dl class="docutils">
<dt><em>ax</em></dt>
<dd>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a> instance the buttons are
located in</dd>
<dt><em>labels</em></dt>
<dd>List of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.text.Text</span></code></a> instances</dd>
<dt><em>lines</em></dt>
<dd>List of (line1, line2) tuples for the x’s in the check boxes.
These lines exist for each box, but have <code class="docutils literal notranslate"><span class="pre">set_visible(False)</span></code>
when its box is not checked.</dd>
<dt><em>rectangles</em></dt>
<dd>List of <a class="reference internal" href="_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.patches.Rectangle</span></code></a> instances</dd>
</dl>
</div></blockquote>
<p>Connect to the CheckButtons with the <a class="reference internal" href="#matplotlib.widgets.CheckButtons.on_clicked" title="matplotlib.widgets.CheckButtons.on_clicked"><code class="xref py py-meth docutils literal notranslate"><span class="pre">on_clicked()</span></code></a> method</p>
<p>Add check buttons to <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a> instance <em>ax</em></p>
<dl class="docutils">
<dt><em>labels</em></dt>
<dd>A len(buttons) list of labels as strings</dd>
<dt><em>actives</em></dt>
<dd><dl class="first last docutils">
<dt>A len(buttons) list of booleans indicating whether</dt>
<dd>the button is active</dd>
</dl>
</dd>
</dl>
<dl class="method">
<dt id="matplotlib.widgets.CheckButtons.disconnect">
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>cid</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#CheckButtons.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.CheckButtons.disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>remove the observer with connection id <em>cid</em></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.CheckButtons.get_status">
<code class="descname">get_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#CheckButtons.get_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.CheckButtons.get_status" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a tuple of the status (True/False) of all of the check buttons</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.CheckButtons.on_clicked">
<code class="descname">on_clicked</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#CheckButtons.on_clicked"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.CheckButtons.on_clicked" title="Permalink to this definition">¶</a></dt>
<dd><p>When the button is clicked, call <em>func</em> with button label</p>
<p>A connection id is returned which can be used to disconnect</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.CheckButtons.set_active">
<code class="descname">set_active</code><span class="sig-paren">(</span><em>index</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#CheckButtons.set_active"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.CheckButtons.set_active" title="Permalink to this definition">¶</a></dt>
<dd><p>Directly (de)activate a check button by index.</p>
<dl class="docutils">
<dt><em>index</em> is an index into the original label list</dt>
<dd>that this object was constructed with.
Raises ValueError if <em>index</em> is invalid.</dd>
</dl>
<p>Callbacks will be triggered if <code class="xref py py-attr docutils literal notranslate"><span class="pre">eventson</span></code> is True.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.Cursor">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">Cursor</code><span class="sig-paren">(</span><em>ax</em>, <em>horizOn=True</em>, <em>vertOn=True</em>, <em>useblit=False</em>, <em>**lineprops</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Cursor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Cursor" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.widgets.AxesWidget" title="matplotlib.widgets.AxesWidget"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets.AxesWidget</span></code></a></p>
<p>A horizontal and vertical line that spans the axes and moves with
the pointer. You can turn off the hline or vline respectively with
the following attributes:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>horizOn</em></dt>
<dd>Controls the visibility of the horizontal line</dd>
<dt><em>vertOn</em></dt>
<dd>Controls the visibility of the horizontal line</dd>
</dl>
</div></blockquote>
<p>and the visibility of the cursor itself with the <em>visible</em> attribute.</p>
<p>For the cursor to remain responsive you must keep a reference to
it.</p>
<p>Add a cursor to <em>ax</em>. If <code class="docutils literal notranslate"><span class="pre">useblit=True</span></code>, use the backend-dependent
blitting features for faster updates. <em>lineprops</em> is a dictionary of
line properties.</p>
<dl class="method">
<dt id="matplotlib.widgets.Cursor.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Cursor.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Cursor.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>clear the cursor</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.Cursor.onmove">
<code class="descname">onmove</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Cursor.onmove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Cursor.onmove" title="Permalink to this definition">¶</a></dt>
<dd><p>on mouse motion draw the cursor if visible</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.EllipseSelector">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">EllipseSelector</code><span class="sig-paren">(</span><em>ax</em>, <em>onselect</em>, <em>drawtype='box'</em>, <em>minspanx=None</em>, <em>minspany=None</em>, <em>useblit=False</em>, <em>lineprops=None</em>, <em>rectprops=None</em>, <em>spancoords='data'</em>, <em>button=None</em>, <em>maxdist=10</em>, <em>marker_props=None</em>, <em>interactive=False</em>, <em>state_modifier_keys=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#EllipseSelector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.EllipseSelector" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.widgets.RectangleSelector" title="matplotlib.widgets.RectangleSelector"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets.RectangleSelector</span></code></a></p>
<p>Select an elliptical region of an axes.</p>
<p>For the cursor to remain responsive you must keep a reference to
it.</p>
<p>Example usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib.widgets</span> <span class="k">import</span> <span class="n">EllipseSelector</span>
<span class="kn">from</span> <span class="nn">pylab</span> <span class="k">import</span> <span class="o">*</span>
<span class="k">def</span> <span class="nf">onselect</span><span class="p">(</span><span class="n">eclick</span><span class="p">,</span> <span class="n">erelease</span><span class="p">):</span>
<span class="s1">'eclick and erelease are matplotlib events at press and release'</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' startposition : (</span><span class="si">%f</span><span class="s1">, </span><span class="si">%f</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">eclick</span><span class="o">.</span><span class="n">xdata</span><span class="p">,</span> <span class="n">eclick</span><span class="o">.</span><span class="n">ydata</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' endposition : (</span><span class="si">%f</span><span class="s1">, </span><span class="si">%f</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">erelease</span><span class="o">.</span><span class="n">xdata</span><span class="p">,</span> <span class="n">erelease</span><span class="o">.</span><span class="n">ydata</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' used button : '</span><span class="p">,</span> <span class="n">eclick</span><span class="o">.</span><span class="n">button</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">toggle_selector</span><span class="p">(</span><span class="n">event</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' Key pressed.'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">key</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'Q'</span><span class="p">,</span> <span class="s1">'q'</span><span class="p">]</span> <span class="ow">and</span> <span class="n">toggle_selector</span><span class="o">.</span><span class="n">ES</span><span class="o">.</span><span class="n">active</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' EllipseSelector deactivated.'</span><span class="p">)</span>
<span class="n">toggle_selector</span><span class="o">.</span><span class="n">RS</span><span class="o">.</span><span class="n">set_active</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">key</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'A'</span><span class="p">,</span> <span class="s1">'a'</span><span class="p">]</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">toggle_selector</span><span class="o">.</span><span class="n">ES</span><span class="o">.</span><span class="n">active</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' EllipseSelector activated.'</span><span class="p">)</span>
<span class="n">toggle_selector</span><span class="o">.</span><span class="n">ES</span><span class="o">.</span><span class="n">set_active</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">arange</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span><span class="o">/</span><span class="p">(</span><span class="mf">99.0</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">sin</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="n">fig</span> <span class="o">=</span> <span class="n">figure</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="n">y</span><span class="p">)</span>
<span class="n">toggle_selector</span><span class="o">.</span><span class="n">ES</span> <span class="o">=</span> <span class="n">EllipseSelector</span><span class="p">(</span><span class="n">ax</span><span class="p">,</span> <span class="n">onselect</span><span class="p">,</span> <span class="n">drawtype</span><span class="o">=</span><span class="s1">'line'</span><span class="p">)</span>
<span class="n">connect</span><span class="p">(</span><span class="s1">'key_press_event'</span><span class="p">,</span> <span class="n">toggle_selector</span><span class="p">)</span>
<span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
<p>Create a selector in <em>ax</em>. When a selection is made, clear
the span and call onselect with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">onselect</span><span class="p">(</span><span class="n">pos_1</span><span class="p">,</span> <span class="n">pos_2</span><span class="p">)</span>
</pre></div>
</div>
<p>and clear the drawn box/line. The <code class="docutils literal notranslate"><span class="pre">pos_1</span></code> and <code class="docutils literal notranslate"><span class="pre">pos_2</span></code> are
arrays of length 2 containing the x- and y-coordinate.</p>
<p>If <em>minspanx</em> is not <em>None</em> then events smaller than <em>minspanx</em>
in x direction are ignored (it’s the same for y).</p>
<p>The rectangle is drawn with <em>rectprops</em>; default:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rectprops</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">facecolor</span><span class="o">=</span><span class="s1">'red'</span><span class="p">,</span> <span class="n">edgecolor</span> <span class="o">=</span> <span class="s1">'black'</span><span class="p">,</span>
<span class="n">alpha</span><span class="o">=</span><span class="mf">0.2</span><span class="p">,</span> <span class="n">fill</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>The line is drawn with <em>lineprops</em>; default:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">lineprops</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">color</span><span class="o">=</span><span class="s1">'black'</span><span class="p">,</span> <span class="n">linestyle</span><span class="o">=</span><span class="s1">'-'</span><span class="p">,</span>
<span class="n">linewidth</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span>
</pre></div>
</div>
<p>Use <em>drawtype</em> if you want the mouse to draw a line,
a box or nothing between click and actual position by setting</p>
<p><code class="docutils literal notranslate"><span class="pre">drawtype</span> <span class="pre">=</span> <span class="pre">'line'</span></code>, <code class="docutils literal notranslate"><span class="pre">drawtype='box'</span></code> or <code class="docutils literal notranslate"><span class="pre">drawtype</span> <span class="pre">=</span> <span class="pre">'none'</span></code>.
Drawing a line would result in a line from vertex A to vertex C in
a rectangle ABCD.</p>
<p><em>spancoords</em> is one of ‘data’ or ‘pixels’. If ‘data’, <em>minspanx</em>
and <em>minspanx</em> will be interpreted in the same coordinates as
the x and y axis. If ‘pixels’, they are in pixels.</p>
<p><em>button</em> is a list of integers indicating which mouse buttons should
be used for rectangle selection. You can also specify a single
integer if only a single button is desired. Default is <em>None</em>,
which does not limit which button can be used.</p>
<dl class="docutils">
<dt>Note, typically:</dt>
<dd>1 = left mouse button
2 = center mouse button (scroll wheel)
3 = right mouse button</dd>
</dl>
<p><em>interactive</em> will draw a set of handles and allow you interact
with the widget after it is drawn.</p>
<p><em>state_modifier_keys</em> are keyboard modifiers that affect the behavior
of the widget.</p>
<p>The defaults are:
dict(move=’ ‘, clear=’escape’, square=’shift’, center=’ctrl’)</p>
<p>Keyboard modifiers, which:
‘move’: Move the existing shape.
‘clear’: Clear the current shape.
‘square’: Makes the shape square.
‘center’: Make the initial point the center of the shape.
‘square’ and ‘center’ can be combined.</p>
<dl class="method">
<dt id="matplotlib.widgets.EllipseSelector.draw_shape">
<code class="descname">draw_shape</code><span class="sig-paren">(</span><em>extents</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#EllipseSelector.draw_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.EllipseSelector.draw_shape" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.Lasso">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">Lasso</code><span class="sig-paren">(</span><em>ax</em>, <em>xy</em>, <em>callback=None</em>, <em>useblit=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Lasso"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Lasso" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.widgets.AxesWidget" title="matplotlib.widgets.AxesWidget"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets.AxesWidget</span></code></a></p>
<p>Selection curve of an arbitrary shape.</p>
<p>The selected path can be used in conjunction with
<a class="reference internal" href="path_api.html#matplotlib.path.Path.contains_point" title="matplotlib.path.Path.contains_point"><code class="xref py py-func docutils literal notranslate"><span class="pre">contains_point()</span></code></a> to select data points
from an image.</p>
<p>Unlike <a class="reference internal" href="#matplotlib.widgets.LassoSelector" title="matplotlib.widgets.LassoSelector"><code class="xref py py-class docutils literal notranslate"><span class="pre">LassoSelector</span></code></a>, this must be initialized with a starting
point <code class="xref py py-obj docutils literal notranslate"><span class="pre">xy</span></code>, and the <a class="reference internal" href="#matplotlib.widgets.Lasso" title="matplotlib.widgets.Lasso"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Lasso</span></code></a> events are destroyed upon release.</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>ax</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a></span></dt>
<dd><p class="first last">The parent axes for the widget.</p>
</dd>
<dt><strong>xy</strong> <span class="classifier-delimiter">:</span> <span class="classifier">array</span></dt>
<dd><p class="first last">Coordinates of the start of the lasso.</p>
</dd>
<dt><strong>callback</strong> <span class="classifier-delimiter">:</span> <span class="classifier">callable</span></dt>
<dd><p class="first last">Whenever the lasso is released, the <code class="xref py py-obj docutils literal notranslate"><span class="pre">callback</span></code> function is called and
passed the vertices of the selected path.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.widgets.Lasso.onmove">
<code class="descname">onmove</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Lasso.onmove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Lasso.onmove" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.Lasso.onrelease">
<code class="descname">onrelease</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Lasso.onrelease"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Lasso.onrelease" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.LassoSelector">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">LassoSelector</code><span class="sig-paren">(</span><em>ax</em>, <em>onselect=None</em>, <em>useblit=True</em>, <em>lineprops=None</em>, <em>button=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#LassoSelector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.LassoSelector" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets._SelectorWidget</span></code></p>
<p>Selection curve of an arbitrary shape.</p>
<p>For the selector to remain responsive you must keep a reference to it.</p>
<p>The selected path can be used in conjunction with <a class="reference internal" href="path_api.html#matplotlib.path.Path.contains_point" title="matplotlib.path.Path.contains_point"><code class="xref py py-obj docutils literal notranslate"><span class="pre">contains_point</span></code></a>
to select data points from an image.</p>
<p>In contrast to <a class="reference internal" href="#matplotlib.widgets.Lasso" title="matplotlib.widgets.Lasso"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Lasso</span></code></a>, <a class="reference internal" href="#matplotlib.widgets.LassoSelector" title="matplotlib.widgets.LassoSelector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LassoSelector</span></code></a> is written with an interface
similar to <a class="reference internal" href="#matplotlib.widgets.RectangleSelector" title="matplotlib.widgets.RectangleSelector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RectangleSelector</span></code></a> and <a class="reference internal" href="#matplotlib.widgets.SpanSelector" title="matplotlib.widgets.SpanSelector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SpanSelector</span></code></a>, and will continue to
interact with the axes until disconnected.</p>
<p>Example usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span> <span class="o">=</span> <span class="n">subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="n">y</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">onselect</span><span class="p">(</span><span class="n">verts</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="n">verts</span><span class="p">)</span>
<span class="n">lasso</span> <span class="o">=</span> <span class="n">LassoSelector</span><span class="p">(</span><span class="n">ax</span><span class="p">,</span> <span class="n">onselect</span><span class="p">)</span>
</pre></div>
</div>
<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>ax</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a></span></dt>
<dd><p class="first last">The parent axes for the widget.</p>
</dd>
<dt><strong>onselect</strong> <span class="classifier-delimiter">:</span> <span class="classifier">function</span></dt>
<dd><p class="first last">Whenever the lasso is released, the <em>onselect</em> function is called and
passed the vertices of the selected path.</p>
</dd>
<dt><strong>button</strong> <span class="classifier-delimiter">:</span> <span class="classifier">List[Int], optional</span></dt>
<dd><p class="first">A list of integers indicating which mouse buttons should be used for
rectangle selection. You can also specify a single integer if only a
single button is desired. Default is <code class="docutils literal notranslate"><span class="pre">None</span></code>, which does not limit
which button can be used.</p>
<p>Note, typically:</p>
<ul class="last simple">
<li>1 = left mouse button</li>
<li>2 = center mouse button (scroll wheel)</li>
<li>3 = right mouse button</li>
</ul>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.widgets.LassoSelector.onpress">
<code class="descname">onpress</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#LassoSelector.onpress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.LassoSelector.onpress" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.LassoSelector.onrelease">
<code class="descname">onrelease</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#LassoSelector.onrelease"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.LassoSelector.onrelease" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.LockDraw">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">LockDraw</code><a class="reference internal" href="../_modules/matplotlib/widgets.html#LockDraw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.LockDraw" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Some widgets, like the cursor, draw onto the canvas, and this is not
desirable under all circumstances, like when the toolbar is in
zoom-to-rect mode and drawing a rectangle. The module level “lock”
allows someone to grab the lock and prevent other widgets from
drawing. Use <code class="docutils literal notranslate"><span class="pre">matplotlib.widgets.lock(someobj)</span></code> to prevent
other widgets from drawing while you’re interacting with the canvas.</p>
<dl class="method">
<dt id="matplotlib.widgets.LockDraw.available">
<code class="descname">available</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#LockDraw.available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.LockDraw.available" title="Permalink to this definition">¶</a></dt>
<dd><p>drawing is available to <em>o</em></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.LockDraw.isowner">
<code class="descname">isowner</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#LockDraw.isowner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.LockDraw.isowner" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True if <em>o</em> owns this lock</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.LockDraw.locked">
<code class="descname">locked</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#LockDraw.locked"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.LockDraw.locked" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True if the lock is currently held by an owner</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.LockDraw.release">
<code class="descname">release</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#LockDraw.release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.LockDraw.release" title="Permalink to this definition">¶</a></dt>
<dd><p>release the lock</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.MultiCursor">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">MultiCursor</code><span class="sig-paren">(</span><em>canvas</em>, <em>axes</em>, <em>useblit=True</em>, <em>horizOn=False</em>, <em>vertOn=True</em>, <em>**lineprops</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#MultiCursor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.MultiCursor" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.widgets.Widget" title="matplotlib.widgets.Widget"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets.Widget</span></code></a></p>
<p>Provide a vertical (default) and/or horizontal line cursor shared between
multiple axes.</p>
<p>For the cursor to remain responsive you must keep a reference to
it.</p>
<p>Example usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib.widgets</span> <span class="k">import</span> <span class="n">MultiCursor</span>
<span class="kn">from</span> <span class="nn">pylab</span> <span class="k">import</span> <span class="n">figure</span><span class="p">,</span> <span class="n">show</span><span class="p">,</span> <span class="n">np</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="mf">0.01</span><span class="p">)</span>
<span class="n">s1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="mi">2</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="o">*</span><span class="n">t</span><span class="p">)</span>
<span class="n">s2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="mi">4</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="o">*</span><span class="n">t</span><span class="p">)</span>
<span class="n">fig</span> <span class="o">=</span> <span class="n">figure</span><span class="p">()</span>
<span class="n">ax1</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">211</span><span class="p">)</span>
<span class="n">ax1</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">s1</span><span class="p">)</span>
<span class="n">ax2</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">212</span><span class="p">,</span> <span class="n">sharex</span><span class="o">=</span><span class="n">ax1</span><span class="p">)</span>
<span class="n">ax2</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">s2</span><span class="p">)</span>
<span class="n">multi</span> <span class="o">=</span> <span class="n">MultiCursor</span><span class="p">(</span><span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="p">,</span> <span class="p">(</span><span class="n">ax1</span><span class="p">,</span> <span class="n">ax2</span><span class="p">),</span> <span class="n">color</span><span class="o">=</span><span class="s1">'r'</span><span class="p">,</span> <span class="n">lw</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">horizOn</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">vertOn</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
<dl class="method">
<dt id="matplotlib.widgets.MultiCursor.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#MultiCursor.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.MultiCursor.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>clear the cursor</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.MultiCursor.connect">
<code class="descname">connect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#MultiCursor.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.MultiCursor.connect" title="Permalink to this definition">¶</a></dt>
<dd><p>connect events</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.MultiCursor.disconnect">
<code class="descname">disconnect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#MultiCursor.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.MultiCursor.disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>disconnect events</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.MultiCursor.onmove">
<code class="descname">onmove</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#MultiCursor.onmove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.MultiCursor.onmove" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.PolygonSelector">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">PolygonSelector</code><span class="sig-paren">(</span><em>ax</em>, <em>onselect</em>, <em>useblit=False</em>, <em>lineprops=None</em>, <em>markerprops=None</em>, <em>vertex_select_radius=15</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#PolygonSelector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.PolygonSelector" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets._SelectorWidget</span></code></p>
<p>Select a polygon region of an axes.</p>
<p>Place vertices with each mouse click, and make the selection by completing
the polygon (clicking on the first vertex). Hold the <em>ctrl</em> key and click
and drag a vertex to reposition it (the <em>ctrl</em> key is not necessary if the
polygon has already been completed). Hold the <em>shift</em> key and click and
drag anywhere in the axes to move all vertices. Press the <em>esc</em> key to
start a new polygon.</p>
<p>For the selector to remain responsive you must keep a reference to
it.</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>ax</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a></span></dt>
<dd><p class="first last">The parent axes for the widget.</p>
</dd>
<dt><strong>onselect</strong> <span class="classifier-delimiter">:</span> <span class="classifier">function</span></dt>
<dd><p class="first last">When a polygon is completed or modified after completion,
the <code class="xref py py-obj docutils literal notranslate"><span class="pre">onselect</span></code> function is called and passed a list of the vertices as
<code class="docutils literal notranslate"><span class="pre">(xdata,</span> <span class="pre">ydata)</span></code> tuples.</p>
</dd>
<dt><strong>useblit</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
<dd></dd>
<dt><strong>lineprops</strong> <span class="classifier-delimiter">:</span> <span class="classifier">dict, optional</span></dt>
<dd><p class="first last">The line for the sides of the polygon is drawn with the properties
given by <code class="xref py py-obj docutils literal notranslate"><span class="pre">lineprops</span></code>. The default is <code class="docutils literal notranslate"><span class="pre">dict(color='k',</span> <span class="pre">linestyle='-',</span>
<span class="pre">linewidth=2,</span> <span class="pre">alpha=0.5)</span></code>.</p>
</dd>
<dt><strong>markerprops</strong> <span class="classifier-delimiter">:</span> <span class="classifier">dict, optional</span></dt>
<dd><p class="first last">The markers for the vertices of the polygon are drawn with the
properties given by <code class="xref py py-obj docutils literal notranslate"><span class="pre">markerprops</span></code>. The default is <code class="docutils literal notranslate"><span class="pre">dict(marker='o',</span>
<span class="pre">markersize=7,</span> <span class="pre">mec='k',</span> <span class="pre">mfc='k',</span> <span class="pre">alpha=0.5)</span></code>.</p>
</dd>
<dt><strong>vertex_select_radius</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional</span></dt>
<dd><p class="first last">A vertex is selected (to complete the polygon or to move a vertex)
if the mouse click is within <code class="xref py py-obj docutils literal notranslate"><span class="pre">vertex_select_radius</span></code> pixels of the
vertex. The default radius is 15 pixels.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="../gallery/widgets/polygon_selector_demo.html#sphx-glr-gallery-widgets-polygon-selector-demo-py"><span class="std std-ref">Polygon Selector Demo</span></a></p>
</div>
<dl class="method">
<dt id="matplotlib.widgets.PolygonSelector.onmove">
<code class="descname">onmove</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#PolygonSelector.onmove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.PolygonSelector.onmove" title="Permalink to this definition">¶</a></dt>
<dd><p>Cursor move event handler and validator</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.widgets.PolygonSelector.verts">
<code class="descname">verts</code><a class="headerlink" href="#matplotlib.widgets.PolygonSelector.verts" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the polygon vertices.</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">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>list</strong></dt>
<dd><p class="first last">A list of the vertices of the polygon as <code class="docutils literal notranslate"><span class="pre">(xdata,</span> <span class="pre">ydata)</span></code> tuples.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.RadioButtons">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">RadioButtons</code><span class="sig-paren">(</span><em>ax</em>, <em>labels</em>, <em>active=0</em>, <em>activecolor='blue'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#RadioButtons"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.RadioButtons" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.widgets.AxesWidget" title="matplotlib.widgets.AxesWidget"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets.AxesWidget</span></code></a></p>
<p>A GUI neutral radio button.</p>
<p>For the buttons to remain responsive
you must keep a reference to this object.</p>
<p>The following attributes are exposed:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>ax</em></dt>
<dd>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a> instance the buttons are in</dd>
<dt><em>activecolor</em></dt>
<dd>The color of the button when clicked</dd>
<dt><em>labels</em></dt>
<dd>A list of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.text.Text</span></code></a> instances</dd>
<dt><em>circles</em></dt>
<dd>A list of <a class="reference internal" href="_as_gen/matplotlib.patches.Circle.html#matplotlib.patches.Circle" title="matplotlib.patches.Circle"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.patches.Circle</span></code></a> instances</dd>
<dt><em>value_selected</em></dt>
<dd>A string listing the current value selected</dd>
</dl>
</div></blockquote>
<p>Connect to the RadioButtons with the <a class="reference internal" href="#matplotlib.widgets.RadioButtons.on_clicked" title="matplotlib.widgets.RadioButtons.on_clicked"><code class="xref py py-meth docutils literal notranslate"><span class="pre">on_clicked()</span></code></a> method</p>
<p>Add radio buttons to <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a> instance <em>ax</em></p>
<dl class="docutils">
<dt><em>labels</em></dt>
<dd>A len(buttons) list of labels as strings</dd>
<dt><em>active</em></dt>
<dd>The index into labels for the button that is active</dd>
<dt><em>activecolor</em></dt>
<dd>The color of the button when clicked</dd>
</dl>
<dl class="method">
<dt id="matplotlib.widgets.RadioButtons.disconnect">
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>cid</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#RadioButtons.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.RadioButtons.disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>remove the observer with connection id <em>cid</em></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.RadioButtons.on_clicked">
<code class="descname">on_clicked</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#RadioButtons.on_clicked"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.RadioButtons.on_clicked" title="Permalink to this definition">¶</a></dt>
<dd><p>When the button is clicked, call <em>func</em> with button label</p>
<p>A connection id is returned which can be used to disconnect</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.RadioButtons.set_active">
<code class="descname">set_active</code><span class="sig-paren">(</span><em>index</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#RadioButtons.set_active"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.RadioButtons.set_active" title="Permalink to this definition">¶</a></dt>
<dd><p>Trigger which radio button to make active.</p>
<dl class="docutils">
<dt><em>index</em> is an index into the original label list</dt>
<dd>that this object was constructed with.
Raise ValueError if the index is invalid.</dd>
</dl>
<p>Callbacks will be triggered if <code class="xref py py-attr docutils literal notranslate"><span class="pre">eventson</span></code> is True.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.RectangleSelector">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">RectangleSelector</code><span class="sig-paren">(</span><em>ax</em>, <em>onselect</em>, <em>drawtype='box'</em>, <em>minspanx=None</em>, <em>minspany=None</em>, <em>useblit=False</em>, <em>lineprops=None</em>, <em>rectprops=None</em>, <em>spancoords='data'</em>, <em>button=None</em>, <em>maxdist=10</em>, <em>marker_props=None</em>, <em>interactive=False</em>, <em>state_modifier_keys=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#RectangleSelector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.RectangleSelector" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets._SelectorWidget</span></code></p>
<p>Select a rectangular region of an axes.</p>
<p>For the cursor to remain responsive you must keep a reference to
it.</p>
<p>Example usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib.widgets</span> <span class="k">import</span> <span class="n">RectangleSelector</span>
<span class="kn">from</span> <span class="nn">pylab</span> <span class="k">import</span> <span class="o">*</span>
<span class="k">def</span> <span class="nf">onselect</span><span class="p">(</span><span class="n">eclick</span><span class="p">,</span> <span class="n">erelease</span><span class="p">):</span>
<span class="s1">'eclick and erelease are matplotlib events at press and release'</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' startposition : (</span><span class="si">%f</span><span class="s1">, </span><span class="si">%f</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">eclick</span><span class="o">.</span><span class="n">xdata</span><span class="p">,</span> <span class="n">eclick</span><span class="o">.</span><span class="n">ydata</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' endposition : (</span><span class="si">%f</span><span class="s1">, </span><span class="si">%f</span><span class="s1">)'</span> <span class="o">%</span> <span class="p">(</span><span class="n">erelease</span><span class="o">.</span><span class="n">xdata</span><span class="p">,</span> <span class="n">erelease</span><span class="o">.</span><span class="n">ydata</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' used button : '</span><span class="p">,</span> <span class="n">eclick</span><span class="o">.</span><span class="n">button</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">toggle_selector</span><span class="p">(</span><span class="n">event</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' Key pressed.'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">key</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'Q'</span><span class="p">,</span> <span class="s1">'q'</span><span class="p">]</span> <span class="ow">and</span> <span class="n">toggle_selector</span><span class="o">.</span><span class="n">RS</span><span class="o">.</span><span class="n">active</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' RectangleSelector deactivated.'</span><span class="p">)</span>
<span class="n">toggle_selector</span><span class="o">.</span><span class="n">RS</span><span class="o">.</span><span class="n">set_active</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">key</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'A'</span><span class="p">,</span> <span class="s1">'a'</span><span class="p">]</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">toggle_selector</span><span class="o">.</span><span class="n">RS</span><span class="o">.</span><span class="n">active</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">' RectangleSelector activated.'</span><span class="p">)</span>
<span class="n">toggle_selector</span><span class="o">.</span><span class="n">RS</span><span class="o">.</span><span class="n">set_active</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">arange</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span><span class="o">/</span><span class="p">(</span><span class="mf">99.0</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">sin</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="n">fig</span> <span class="o">=</span> <span class="n">figure</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="n">y</span><span class="p">)</span>
<span class="n">toggle_selector</span><span class="o">.</span><span class="n">RS</span> <span class="o">=</span> <span class="n">RectangleSelector</span><span class="p">(</span><span class="n">ax</span><span class="p">,</span> <span class="n">onselect</span><span class="p">,</span> <span class="n">drawtype</span><span class="o">=</span><span class="s1">'line'</span><span class="p">)</span>
<span class="n">connect</span><span class="p">(</span><span class="s1">'key_press_event'</span><span class="p">,</span> <span class="n">toggle_selector</span><span class="p">)</span>
<span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
<p>Create a selector in <em>ax</em>. When a selection is made, clear
the span and call onselect with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">onselect</span><span class="p">(</span><span class="n">pos_1</span><span class="p">,</span> <span class="n">pos_2</span><span class="p">)</span>
</pre></div>
</div>
<p>and clear the drawn box/line. The <code class="docutils literal notranslate"><span class="pre">pos_1</span></code> and <code class="docutils literal notranslate"><span class="pre">pos_2</span></code> are
arrays of length 2 containing the x- and y-coordinate.</p>
<p>If <em>minspanx</em> is not <em>None</em> then events smaller than <em>minspanx</em>
in x direction are ignored (it’s the same for y).</p>
<p>The rectangle is drawn with <em>rectprops</em>; default:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rectprops</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">facecolor</span><span class="o">=</span><span class="s1">'red'</span><span class="p">,</span> <span class="n">edgecolor</span> <span class="o">=</span> <span class="s1">'black'</span><span class="p">,</span>
<span class="n">alpha</span><span class="o">=</span><span class="mf">0.2</span><span class="p">,</span> <span class="n">fill</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>The line is drawn with <em>lineprops</em>; default:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">lineprops</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">color</span><span class="o">=</span><span class="s1">'black'</span><span class="p">,</span> <span class="n">linestyle</span><span class="o">=</span><span class="s1">'-'</span><span class="p">,</span>
<span class="n">linewidth</span> <span class="o">=</span> <span class="mi">2</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span>
</pre></div>
</div>
<p>Use <em>drawtype</em> if you want the mouse to draw a line,
a box or nothing between click and actual position by setting</p>
<p><code class="docutils literal notranslate"><span class="pre">drawtype</span> <span class="pre">=</span> <span class="pre">'line'</span></code>, <code class="docutils literal notranslate"><span class="pre">drawtype='box'</span></code> or <code class="docutils literal notranslate"><span class="pre">drawtype</span> <span class="pre">=</span> <span class="pre">'none'</span></code>.
Drawing a line would result in a line from vertex A to vertex C in
a rectangle ABCD.</p>
<p><em>spancoords</em> is one of ‘data’ or ‘pixels’. If ‘data’, <em>minspanx</em>
and <em>minspanx</em> will be interpreted in the same coordinates as
the x and y axis. If ‘pixels’, they are in pixels.</p>
<p><em>button</em> is a list of integers indicating which mouse buttons should
be used for rectangle selection. You can also specify a single
integer if only a single button is desired. Default is <em>None</em>,
which does not limit which button can be used.</p>
<dl class="docutils">
<dt>Note, typically:</dt>
<dd>1 = left mouse button
2 = center mouse button (scroll wheel)
3 = right mouse button</dd>
</dl>
<p><em>interactive</em> will draw a set of handles and allow you interact
with the widget after it is drawn.</p>
<p><em>state_modifier_keys</em> are keyboard modifiers that affect the behavior
of the widget.</p>
<p>The defaults are:
dict(move=’ ‘, clear=’escape’, square=’shift’, center=’ctrl’)</p>
<p>Keyboard modifiers, which:
‘move’: Move the existing shape.
‘clear’: Clear the current shape.
‘square’: Makes the shape square.
‘center’: Make the initial point the center of the shape.
‘square’ and ‘center’ can be combined.</p>
<dl class="attribute">
<dt id="matplotlib.widgets.RectangleSelector.center">
<code class="descname">center</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.center" title="Permalink to this definition">¶</a></dt>
<dd><p>Center of rectangle</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.widgets.RectangleSelector.corners">
<code class="descname">corners</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.corners" title="Permalink to this definition">¶</a></dt>
<dd><p>Corners of rectangle from lower left, moving clockwise.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.widgets.RectangleSelector.draw_shape">
<code class="descname">draw_shape</code><span class="sig-paren">(</span><em>extents</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#RectangleSelector.draw_shape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.draw_shape" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.widgets.RectangleSelector.edge_centers">
<code class="descname">edge_centers</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.edge_centers" title="Permalink to this definition">¶</a></dt>
<dd><p>Midpoint of rectangle edges from left, moving clockwise.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.widgets.RectangleSelector.extents">
<code class="descname">extents</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.extents" title="Permalink to this definition">¶</a></dt>
<dd><p>Return (xmin, xmax, ymin, ymax).</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.widgets.RectangleSelector.geometry">
<code class="descname">geometry</code><a class="headerlink" href="#matplotlib.widgets.RectangleSelector.geometry" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns numpy.ndarray of shape (2,5) containing
x (<code class="docutils literal notranslate"><span class="pre">RectangleSelector.geometry[1,:]</span></code>) and
y (<code class="docutils literal notranslate"><span class="pre">RectangleSelector.geometry[0,:]</span></code>)
coordinates of the four corners of the rectangle starting
and ending in the top left corner.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.widgets.Slider">
<em class="property">class </em><code class="descclassname">matplotlib.widgets.</code><code class="descname">Slider</code><span class="sig-paren">(</span><em>ax</em>, <em>label</em>, <em>valmin</em>, <em>valmax</em>, <em>valinit=0.5</em>, <em>valfmt='%1.2f'</em>, <em>closedmin=True</em>, <em>closedmax=True</em>, <em>slidermin=None</em>, <em>slidermax=None</em>, <em>dragging=True</em>, <em>valstep=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Slider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Slider" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.widgets.AxesWidget" title="matplotlib.widgets.AxesWidget"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.widgets.AxesWidget</span></code></a></p>
<p>A slider representing a floating point range.</p>
<p>Create a slider from <em>valmin</em> to <em>valmax</em> in axes <em>ax</em>. For the slider to
remain responsive you must maintain a reference to it. Call
<a class="reference internal" href="#matplotlib.widgets.Slider.on_changed" title="matplotlib.widgets.Slider.on_changed"><code class="xref py py-meth docutils literal notranslate"><span class="pre">on_changed()</span></code></a> to connect to the slider event.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>val</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd><p class="first last">Slider value.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<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>ax</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Axes</span></dt>
<dd><p class="first last">The Axes to put the slider in.</p>
</dd>
<dt><strong>label</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">Slider label.</p>
</dd>
<dt><strong>valmin</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd><p class="first last">The minimum value of the slider.</p>
</dd>
<dt><strong>valmax</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd><p class="first last">The maximum value of the slider.</p>
</dd>
<dt><strong>valinit</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional, default: 0.5</span></dt>
<dd><p class="first last">The slider initial position.</p>
</dd>
<dt><strong>valfmt</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str, optional, default: “%1.2f”</span></dt>
<dd><p class="first last">Used to format the slider value, fprint format string.</p>
</dd>
<dt><strong>closedmin</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional, default: True</span></dt>
<dd><p class="first last">Indicate whether the slider interval is closed on the bottom.</p>
</dd>
<dt><strong>closedmax</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional, default: True</span></dt>
<dd><p class="first last">Indicate whether the slider interval is closed on the top.</p>
</dd>
<dt><strong>slidermin</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Slider, optional, default: None</span></dt>
<dd><p class="first last">Do not allow the current slider to have a value less than
the value of the Slider <code class="xref py py-obj docutils literal notranslate"><span class="pre">slidermin</span></code>.</p>
</dd>
<dt><strong>slidermax</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Slider, optional, default: None</span></dt>
<dd><p class="first last">Do not allow the current slider to have a value greater than
the value of the Slider <code class="xref py py-obj docutils literal notranslate"><span class="pre">slidermax</span></code>.</p>
</dd>
<dt><strong>dragging</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional, default: True</span></dt>
<dd><p class="first last">If True the slider can be dragged by the mouse.</p>
</dd>
<dt><strong>valstep</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional, default: None</span></dt>
<dd><p class="first last">If given, the slider will snap to multiples of <code class="xref py py-obj docutils literal notranslate"><span class="pre">valstep</span></code>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>Additional kwargs are passed on to <code class="docutils literal notranslate"><span class="pre">self.poly</span></code> which is the
<a class="reference internal" href="_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">Rectangle</span></code></a> that draws the slider
knob. See the <a class="reference internal" href="_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">Rectangle</span></code></a> documentation for
valid property names (e.g., <code class="xref py py-obj docutils literal notranslate"><span class="pre">facecolor</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">edgecolor</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">alpha</span></code>).</p>
<dl class="method">
<dt id="matplotlib.widgets.Slider.disconnect">
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>cid</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/widgets.html#Slider.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.widgets.Slider.disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the observer with connection id <em>cid</em></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>cid</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
<dd><p class="first last">Connection id of the observer to be removed</p>
</dd>
</dl>
</td>
</tr>