-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathbackend_tools_api.html
More file actions
1238 lines (1083 loc) · 112 KB
/
backend_tools_api.html
File metadata and controls
1238 lines (1083 loc) · 112 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="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.backend_tools — Matplotlib 3.3.4 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.4" 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" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-rendered-html.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/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.4 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.backends" href="index_backend_api.html" />
<link rel="prev" title="matplotlib.backend_managers" href="backend_managers_api.html" />
<link rel="top" title="Matplotlib 3.3.4 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/backend_tools_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" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.4). For the latest version see <a href="https://matplotlib.org/stable/api/backend_tools_api.html">https://matplotlib.org/stable/api/backend_tools_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.4</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="index_backend_api.html" title="matplotlib.backends"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="backend_managers_api.html" title="matplotlib.backend_managers"
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="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backend_tools</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="backend_managers_api.html" title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backend_managers</span></code></a></li>
<li>Next: <a href="index_backend_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.backends</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/backend_tools_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.backend_tools">
<span id="matplotlib-backend-tools"></span><h1><a class="reference internal" href="#module-matplotlib.backend_tools" title="matplotlib.backend_tools"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backend_tools</span></code></a><a class="headerlink" href="#module-matplotlib.backend_tools" title="Permalink to this headline">¶</a></h1>
<p>Abstract base classes define the primitives for Tools.
These tools are used by <a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager</span></code></a></p>
<dl class="docutils">
<dt><a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">ToolBase</span></code></a></dt><dd>Simple stateless tool</dd>
<dt><a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase" title="matplotlib.backend_tools.ToolToggleBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">ToolToggleBase</span></code></a></dt><dd>Tool that has two states, only one Toggle tool can be
active at any given time for the same
<a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager</span></code></a></dd>
</dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.AxisScaleBase">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">AxisScaleBase</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#AxisScaleBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.AxisScaleBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase" title="matplotlib.backend_tools.ToolToggleBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolToggleBase</span></code></a></p>
<p>Base Tool to toggle between linear and logarithmic.</p>
<dl class="py method">
<dt id="matplotlib.backend_tools.AxisScaleBase.disable">
<code class="descname">disable</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/backend_tools.html#AxisScaleBase.disable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.AxisScaleBase.disable" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable the toggle tool.</p>
<p><a class="reference internal" href="#matplotlib.backend_tools.AxisScaleBase.trigger" title="matplotlib.backend_tools.AxisScaleBase.trigger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trigger</span></code></a> call this method when <code class="xref py py-obj docutils literal notranslate"><span class="pre">toggled</span></code> is True.</p>
<p>This can happen in different circumstances.</p>
<ul class="simple">
<li>Click on the toolbar tool button.</li>
<li>Call to <a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a>.</li>
<li>Another <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase" title="matplotlib.backend_tools.ToolToggleBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolToggleBase</span></code></a> derived tool is triggered
(from the same <a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolManager</span></code></a>).</li>
</ul>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.AxisScaleBase.enable">
<code class="descname">enable</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/backend_tools.html#AxisScaleBase.enable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.AxisScaleBase.enable" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable the toggle tool.</p>
<p><a class="reference internal" href="#matplotlib.backend_tools.AxisScaleBase.trigger" title="matplotlib.backend_tools.AxisScaleBase.trigger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trigger</span></code></a> calls this method when <code class="xref py py-obj docutils literal notranslate"><span class="pre">toggled</span></code> is False.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.AxisScaleBase.trigger">
<code class="descname">trigger</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">sender</span></em>, <em><span class="n">event</span></em>, <em><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#AxisScaleBase.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.AxisScaleBase.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Calls <a class="reference internal" href="#matplotlib.backend_tools.AxisScaleBase.enable" title="matplotlib.backend_tools.AxisScaleBase.enable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enable</span></code></a> or <a class="reference internal" href="#matplotlib.backend_tools.AxisScaleBase.disable" title="matplotlib.backend_tools.AxisScaleBase.disable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disable</span></code></a> based on <code class="xref py py-obj docutils literal notranslate"><span class="pre">toggled</span></code> value.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ConfigureSubplotsBase">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ConfigureSubplotsBase</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ConfigureSubplotsBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ConfigureSubplotsBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Base tool for the configuration of subplots.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ConfigureSubplotsBase.description">
<code class="descname">description</code><em class="property"> = 'Configure subplots'</em><a class="headerlink" href="#matplotlib.backend_tools.ConfigureSubplotsBase.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ConfigureSubplotsBase.image">
<code class="descname">image</code><em class="property"> = 'subplots'</em><a class="headerlink" href="#matplotlib.backend_tools.ConfigureSubplotsBase.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.Cursors">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">Cursors</code><span class="sig-paren">(</span><em><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#Cursors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.Cursors" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.IntEnum" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.IntEnum</span></code></a></p>
<p>Backend-independent cursor types.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.Cursors.HAND">
<code class="descname">HAND</code><em class="property"> = 0</em><a class="headerlink" href="#matplotlib.backend_tools.Cursors.HAND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.Cursors.MOVE">
<code class="descname">MOVE</code><em class="property"> = 3</em><a class="headerlink" href="#matplotlib.backend_tools.Cursors.MOVE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.Cursors.POINTER">
<code class="descname">POINTER</code><em class="property"> = 1</em><a class="headerlink" href="#matplotlib.backend_tools.Cursors.POINTER" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.Cursors.SELECT_REGION">
<code class="descname">SELECT_REGION</code><em class="property"> = 2</em><a class="headerlink" href="#matplotlib.backend_tools.Cursors.SELECT_REGION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.Cursors.WAIT">
<code class="descname">WAIT</code><em class="property"> = 4</em><a class="headerlink" href="#matplotlib.backend_tools.Cursors.WAIT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.RubberbandBase">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">RubberbandBase</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#RubberbandBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.RubberbandBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Draw and remove a rubberband.</p>
<dl class="py method">
<dt id="matplotlib.backend_tools.RubberbandBase.draw_rubberband">
<code class="descname">draw_rubberband</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="o">*</span><span class="n">data</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#RubberbandBase.draw_rubberband"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.RubberbandBase.draw_rubberband" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw rubberband.</p>
<p>This method must get implemented per backend.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.RubberbandBase.remove_rubberband">
<code class="descname">remove_rubberband</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/backend_tools.html#RubberbandBase.remove_rubberband"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.RubberbandBase.remove_rubberband" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove rubberband.</p>
<p>This method should get implemented per backend.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.RubberbandBase.trigger">
<code class="descname">trigger</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">sender</span></em>, <em><span class="n">event</span></em>, <em><span class="n">data</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#RubberbandBase.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.RubberbandBase.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Call <a class="reference internal" href="#matplotlib.backend_tools.RubberbandBase.draw_rubberband" title="matplotlib.backend_tools.RubberbandBase.draw_rubberband"><code class="xref py py-obj docutils literal notranslate"><span class="pre">draw_rubberband</span></code></a> or <a class="reference internal" href="#matplotlib.backend_tools.RubberbandBase.remove_rubberband" title="matplotlib.backend_tools.RubberbandBase.remove_rubberband"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_rubberband</span></code></a> based on data.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.SaveFigureBase">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">SaveFigureBase</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#SaveFigureBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.SaveFigureBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Base tool for figure saving.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.SaveFigureBase.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['s', 'ctrl+s']</em><a class="headerlink" href="#matplotlib.backend_tools.SaveFigureBase.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.SaveFigureBase.description">
<code class="descname">description</code><em class="property"> = 'Save the figure'</em><a class="headerlink" href="#matplotlib.backend_tools.SaveFigureBase.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.SaveFigureBase.image">
<code class="descname">image</code><em class="property"> = 'filesave'</em><a class="headerlink" href="#matplotlib.backend_tools.SaveFigureBase.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.SetCursorBase">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">SetCursorBase</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#SetCursorBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.SetCursorBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Change to the current cursor while inaxes.</p>
<p>This tool, keeps track of all <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase" title="matplotlib.backend_tools.ToolToggleBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolToggleBase</span></code></a> derived tools, and calls
<a class="reference internal" href="#matplotlib.backend_tools.SetCursorBase.set_cursor" title="matplotlib.backend_tools.SetCursorBase.set_cursor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_cursor</span></code></a> when a tool gets triggered.</p>
<dl class="py method">
<dt id="matplotlib.backend_tools.SetCursorBase.set_cursor">
<code class="descname">set_cursor</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">cursor</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#SetCursorBase.set_cursor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.SetCursorBase.set_cursor" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the cursor.</p>
<p>This method has to be implemented per backend.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.SetCursorBase.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">figure</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#SetCursorBase.set_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.SetCursorBase.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Assign a figure to the tool.</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>figure</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolBack">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolBack</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolBack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolBack" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ViewsPositionsBase" title="matplotlib.backend_tools.ViewsPositionsBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ViewsPositionsBase</span></code></a></p>
<p>Move back up the view limits stack.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolBack.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['left', 'c', 'backspace', 'MouseButton.BACK']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolBack.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolBack.description">
<code class="descname">description</code><em class="property"> = 'Back to previous view'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolBack.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolBack.image">
<code class="descname">image</code><em class="property"> = 'back'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolBack.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolBase">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolBase</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolBase" 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>Base tool class.</p>
<p>A base tool, only implements <a class="reference internal" href="#matplotlib.backend_tools.ToolBase.trigger" title="matplotlib.backend_tools.ToolBase.trigger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trigger</span></code></a> method or not method at all.
The tool is instantiated by <a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager</span></code></a>.</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>toolmanager</strong><span class="classifier"><a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager</span></code></a></span></dt><dd><p>ToolManager that controls this Tool.</p>
</dd>
<dt><strong>figure</strong><span class="classifier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FigureCanvas</span></code></span></dt><dd><p>Figure instance that is affected by this Tool.</p>
</dd>
<dt><a class="reference internal" href="#matplotlib.backend_tools.ToolBase.name" title="matplotlib.backend_tools.ToolBase.name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">name</span></code></a><span class="classifier">str</span></dt><dd><p>Tool Id.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolBase.canvas">
<em class="property">property </em><code class="descname">canvas</code><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.canvas" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolBase.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd><p>Keymap to associate with this tool.</p>
<p><strong>String</strong>: List of comma separated keys that will be used to call this
tool when the keypress event of <code class="docutils literal notranslate"><span class="pre">self.figure.canvas</span></code> is emitted.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolBase.description">
<code class="descname">description</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.description" title="Permalink to this definition">¶</a></dt>
<dd><p>Description of the Tool.</p>
<p><strong>String</strong>: If the Tool is included in the Toolbar this text is used
as a Tooltip.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolBase.destroy">
<code class="descname">destroy</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/backend_tools.html#ToolBase.destroy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.destroy" title="Permalink to this definition">¶</a></dt>
<dd><p>Destroy the tool.</p>
<p>This method is called when the tool is removed by
<a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.remove_tool" title="matplotlib.backend_managers.ToolManager.remove_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.remove_tool</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolBase.figure">
<em class="property">property </em><code class="descname">figure</code><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.figure" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolBase.image">
<code class="descname">image</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.image" title="Permalink to this definition">¶</a></dt>
<dd><p>Filename of the image.</p>
<p><strong>String</strong>: Filename of the image to use in the toolbar. If None, the
<em>name</em> is used as a label in the toolbar button.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolBase.name">
<em class="property">property </em><code class="descname">name</code><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.name" title="Permalink to this definition">¶</a></dt>
<dd><p>Tool Id.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolBase.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">figure</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolBase.set_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Assign a figure to the tool.</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>figure</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolBase.toolmanager">
<em class="property">property </em><code class="descname">toolmanager</code><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.toolmanager" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolBase.trigger">
<code class="descname">trigger</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">sender</span></em>, <em><span class="n">event</span></em>, <em><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolBase.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolBase.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when this tool gets used.</p>
<p>This method is called by
<a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a>.</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.Event" title="matplotlib.backend_bases.Event"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Event</span></code></a></span></dt><dd><p>The canvas event that caused this tool to be called.</p>
</dd>
<dt><strong>sender</strong><span class="classifier">object</span></dt><dd><p>Object that requested the tool to be triggered.</p>
</dd>
<dt><strong>data</strong><span class="classifier">object</span></dt><dd><p>Extra data.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolCopyToClipboard">
<code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolCopyToClipboard</code><a class="headerlink" href="#matplotlib.backend_tools.ToolCopyToClipboard" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.backend_tools.ToolCopyToClipboardBase" title="matplotlib.backend_tools.ToolCopyToClipboardBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolCopyToClipboardBase</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolCopyToClipboardBase">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolCopyToClipboardBase</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolCopyToClipboardBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolCopyToClipboardBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Tool to copy the figure to the clipboard.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolCopyToClipboardBase.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['ctrl+c', 'cmd+c']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolCopyToClipboardBase.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolCopyToClipboardBase.description">
<code class="descname">description</code><em class="property"> = 'Copy the canvas figure to clipboard'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolCopyToClipboardBase.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolCopyToClipboardBase.trigger">
<code class="descname">trigger</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolCopyToClipboardBase.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolCopyToClipboardBase.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when this tool gets used.</p>
<p>This method is called by
<a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a>.</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.Event" title="matplotlib.backend_bases.Event"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Event</span></code></a></span></dt><dd><p>The canvas event that caused this tool to be called.</p>
</dd>
<dt><strong>sender</strong><span class="classifier">object</span></dt><dd><p>Object that requested the tool to be triggered.</p>
</dd>
<dt><strong>data</strong><span class="classifier">object</span></dt><dd><p>Extra data.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolCursorPosition">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolCursorPosition</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolCursorPosition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolCursorPosition" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Send message with the current pointer position.</p>
<p>This tool runs in the background reporting the position of the cursor.</p>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolCursorPosition.send_message">
<code class="descname">send_message</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/backend_tools.html#ToolCursorPosition.send_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolCursorPosition.send_message" title="Permalink to this definition">¶</a></dt>
<dd><p>Call <a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.message_event" title="matplotlib.backend_managers.ToolManager.message_event"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.message_event</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolCursorPosition.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">figure</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolCursorPosition.set_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolCursorPosition.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Assign a figure to the tool.</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>figure</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolEnableAllNavigation">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolEnableAllNavigation</code><span class="sig-paren">(</span><em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolEnableAllNavigation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolEnableAllNavigation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools._ToolEnableAllNavigation</span></code></p>
<p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3: </span></p>
</div>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolEnableNavigation">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolEnableNavigation</code><span class="sig-paren">(</span><em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolEnableNavigation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolEnableNavigation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools._ToolEnableNavigation</span></code></p>
<p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3: </span></p>
</div>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolForward">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolForward</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolForward"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolForward" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ViewsPositionsBase" title="matplotlib.backend_tools.ViewsPositionsBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ViewsPositionsBase</span></code></a></p>
<p>Move forward in the view lim stack.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolForward.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['right', 'v', 'MouseButton.FORWARD']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolForward.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolForward.description">
<code class="descname">description</code><em class="property"> = 'Forward to next view'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolForward.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolForward.image">
<code class="descname">image</code><em class="property"> = 'forward'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolForward.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolFullScreen">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolFullScreen</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolFullScreen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolFullScreen" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase" title="matplotlib.backend_tools.ToolToggleBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolToggleBase</span></code></a></p>
<p>Tool to toggle full screen.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolFullScreen.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['f', 'ctrl+f']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolFullScreen.description">
<code class="descname">description</code><em class="property"> = 'Toggle fullscreen mode'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolFullScreen.disable">
<code class="descname">disable</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/backend_tools.html#ToolFullScreen.disable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.disable" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable the toggle tool.</p>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">trigger</span></code> call this method when <code class="xref py py-obj docutils literal notranslate"><span class="pre">toggled</span></code> is True.</p>
<p>This can happen in different circumstances.</p>
<ul class="simple">
<li>Click on the toolbar tool button.</li>
<li>Call to <a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a>.</li>
<li>Another <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase" title="matplotlib.backend_tools.ToolToggleBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolToggleBase</span></code></a> derived tool is triggered
(from the same <a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolManager</span></code></a>).</li>
</ul>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolFullScreen.enable">
<code class="descname">enable</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/backend_tools.html#ToolFullScreen.enable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.enable" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable the toggle tool.</p>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">trigger</span></code> calls this method when <code class="xref py py-obj docutils literal notranslate"><span class="pre">toggled</span></code> is False.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolGrid">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolGrid</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolGrid" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Tool to toggle the major grids of the figure.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolGrid.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['g']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolGrid.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolGrid.description">
<code class="descname">description</code><em class="property"> = 'Toggle major grids'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolGrid.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolGrid.trigger">
<code class="descname">trigger</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">sender</span></em>, <em><span class="n">event</span></em>, <em><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolGrid.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolGrid.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when this tool gets used.</p>
<p>This method is called by
<a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a>.</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.Event" title="matplotlib.backend_bases.Event"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Event</span></code></a></span></dt><dd><p>The canvas event that caused this tool to be called.</p>
</dd>
<dt><strong>sender</strong><span class="classifier">object</span></dt><dd><p>Object that requested the tool to be triggered.</p>
</dd>
<dt><strong>data</strong><span class="classifier">object</span></dt><dd><p>Extra data.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolHelpBase">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolHelpBase</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolHelpBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolHelpBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolHelpBase.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['f1']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolHelpBase.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolHelpBase.description">
<code class="descname">description</code><em class="property"> = 'Print tool list, shortcuts and description'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolHelpBase.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolHelpBase.format_shortcut">
<em class="property">static </em><code class="descname">format_shortcut</code><span class="sig-paren">(</span><em><span class="n">key_sequence</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolHelpBase.format_shortcut"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolHelpBase.format_shortcut" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts a shortcut string from the notation used in rc config to the
standard notation for displaying shortcuts, e.g. 'ctrl+a' -> 'Ctrl+A'.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolHelpBase.image">
<code class="descname">image</code><em class="property"> = 'help'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolHelpBase.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolHome">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolHome</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolHome"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolHome" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ViewsPositionsBase" title="matplotlib.backend_tools.ViewsPositionsBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ViewsPositionsBase</span></code></a></p>
<p>Restore the original view limits.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolHome.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['h', 'r', 'home']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolHome.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolHome.description">
<code class="descname">description</code><em class="property"> = 'Reset original view'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolHome.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolHome.image">
<code class="descname">image</code><em class="property"> = 'home'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolHome.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolMinorGrid">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolMinorGrid</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolMinorGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolMinorGrid" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Tool to toggle the major and minor grids of the figure.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolMinorGrid.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['G']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolMinorGrid.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolMinorGrid.description">
<code class="descname">description</code><em class="property"> = 'Toggle major and minor grids'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolMinorGrid.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolMinorGrid.trigger">
<code class="descname">trigger</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">sender</span></em>, <em><span class="n">event</span></em>, <em><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolMinorGrid.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolMinorGrid.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when this tool gets used.</p>
<p>This method is called by
<a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a>.</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.Event" title="matplotlib.backend_bases.Event"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Event</span></code></a></span></dt><dd><p>The canvas event that caused this tool to be called.</p>
</dd>
<dt><strong>sender</strong><span class="classifier">object</span></dt><dd><p>Object that requested the tool to be triggered.</p>
</dd>
<dt><strong>data</strong><span class="classifier">object</span></dt><dd><p>Extra data.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolPan">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolPan</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolPan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolPan" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ZoomPanBase" title="matplotlib.backend_tools.ZoomPanBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ZoomPanBase</span></code></a></p>
<p>Pan axes with left mouse, zoom with right.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolPan.cursor">
<code class="descname">cursor</code><em class="property"> = 3</em><a class="headerlink" href="#matplotlib.backend_tools.ToolPan.cursor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolPan.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['p']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolPan.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolPan.description">
<code class="descname">description</code><em class="property"> = 'Pan axes with left mouse, zoom with right'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolPan.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolPan.image">
<code class="descname">image</code><em class="property"> = 'move'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolPan.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolPan.radio_group">
<code class="descname">radio_group</code><em class="property"> = 'default'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolPan.radio_group" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolQuit">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolQuit</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolQuit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolQuit" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Tool to call the figure manager destroy method.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolQuit.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = ['ctrl+w', 'cmd+w', 'q']</em><a class="headerlink" href="#matplotlib.backend_tools.ToolQuit.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolQuit.description">
<code class="descname">description</code><em class="property"> = 'Quit the figure'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolQuit.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolQuit.trigger">
<code class="descname">trigger</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">sender</span></em>, <em><span class="n">event</span></em>, <em><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolQuit.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolQuit.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when this tool gets used.</p>
<p>This method is called by
<a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a>.</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.Event" title="matplotlib.backend_bases.Event"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Event</span></code></a></span></dt><dd><p>The canvas event that caused this tool to be called.</p>
</dd>
<dt><strong>sender</strong><span class="classifier">object</span></dt><dd><p>Object that requested the tool to be triggered.</p>
</dd>
<dt><strong>data</strong><span class="classifier">object</span></dt><dd><p>Extra data.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolQuitAll">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolQuitAll</code><span class="sig-paren">(</span><em><span class="n">toolmanager</span></em>, <em><span class="n">name</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolQuitAll"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolQuitAll" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Tool to call the figure manager destroy method.</p>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolQuitAll.default_keymap">
<code class="descname">default_keymap</code><em class="property"> = []</em><a class="headerlink" href="#matplotlib.backend_tools.ToolQuitAll.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolQuitAll.description">
<code class="descname">description</code><em class="property"> = 'Quit all figures'</em><a class="headerlink" href="#matplotlib.backend_tools.ToolQuitAll.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolQuitAll.trigger">
<code class="descname">trigger</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">sender</span></em>, <em><span class="n">event</span></em>, <em><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolQuitAll.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolQuitAll.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when this tool gets used.</p>
<p>This method is called by
<a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a>.</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.Event" title="matplotlib.backend_bases.Event"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Event</span></code></a></span></dt><dd><p>The canvas event that caused this tool to be called.</p>
</dd>
<dt><strong>sender</strong><span class="classifier">object</span></dt><dd><p>Object that requested the tool to be triggered.</p>
</dd>
<dt><strong>data</strong><span class="classifier">object</span></dt><dd><p>Extra data.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolToggleBase">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolToggleBase</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolToggleBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolToggleBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Toggleable tool.</p>
<p>Every time it is triggered, it switches between enable and disable.</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>``*args``</strong></dt><dd><p>Variable length argument to be used by the Tool.</p>
</dd>
<dt><strong>``**kwargs``</strong></dt><dd><p><a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="matplotlib.backend_tools.ToolToggleBase.toggled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toggled</span></code></a> if present and True, sets the initial state of the Tool
Arbitrary keyword arguments to be consumed by the Tool</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolToggleBase.cursor">
<code class="descname">cursor</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.cursor" title="Permalink to this definition">¶</a></dt>
<dd><p>Cursor to use when the tool is active.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolToggleBase.default_toggled">
<code class="descname">default_toggled</code><em class="property"> = False</em><a class="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.default_toggled" title="Permalink to this definition">¶</a></dt>
<dd><p>Default of toggled state.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolToggleBase.disable">
<code class="descname">disable</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/backend_tools.html#ToolToggleBase.disable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.disable" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable the toggle tool.</p>
<p><a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.trigger" title="matplotlib.backend_tools.ToolToggleBase.trigger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trigger</span></code></a> call this method when <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="matplotlib.backend_tools.ToolToggleBase.toggled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toggled</span></code></a> is True.</p>
<p>This can happen in different circumstances.</p>
<ul class="simple">
<li>Click on the toolbar tool button.</li>
<li>Call to <a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a>.</li>
<li>Another <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase" title="matplotlib.backend_tools.ToolToggleBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolToggleBase</span></code></a> derived tool is triggered
(from the same <a class="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolManager</span></code></a>).</li>
</ul>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolToggleBase.enable">
<code class="descname">enable</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/backend_tools.html#ToolToggleBase.enable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.enable" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable the toggle tool.</p>
<p><a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.trigger" title="matplotlib.backend_tools.ToolToggleBase.trigger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trigger</span></code></a> calls this method when <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="matplotlib.backend_tools.ToolToggleBase.toggled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toggled</span></code></a> is False.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.backend_tools.ToolToggleBase.radio_group">
<code class="descname">radio_group</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.radio_group" title="Permalink to this definition">¶</a></dt>
<dd><p>Attribute to group 'radio' like tools (mutually exclusive).</p>
<p><strong>String</strong> that identifies the group or <strong>None</strong> if not belonging to a
group.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolToggleBase.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">figure</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolToggleBase.set_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Assign a figure to the tool.</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>figure</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolToggleBase.toggled">
<em class="property">property </em><code class="descname">toggled</code><a class="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="Permalink to this definition">¶</a></dt>
<dd><p>State of the toggled tool.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolToggleBase.trigger">
<code class="descname">trigger</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">sender</span></em>, <em><span class="n">event</span></em>, <em><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolToggleBase.trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Calls <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.enable" title="matplotlib.backend_tools.ToolToggleBase.enable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">enable</span></code></a> or <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.disable" title="matplotlib.backend_tools.ToolToggleBase.disable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">disable</span></code></a> based on <a class="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="matplotlib.backend_tools.ToolToggleBase.toggled"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toggled</span></code></a> value.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.backend_tools.ToolViewsPositions">
<em class="property">class </em><code class="descclassname">matplotlib.backend_tools.</code><code class="descname">ToolViewsPositions</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_tools.ToolBase</span></code></a></p>
<p>Auxiliary Tool to handle changes in views and positions.</p>
<p>Runs in the background and should get used by all the tools that
need to access the figure's history of views and positions, e.g.</p>
<ul class="simple">
<li><a class="reference internal" href="#matplotlib.backend_tools.ToolZoom" title="matplotlib.backend_tools.ToolZoom"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolZoom</span></code></a></li>
<li><a class="reference internal" href="#matplotlib.backend_tools.ToolPan" title="matplotlib.backend_tools.ToolPan"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolPan</span></code></a></li>
<li><a class="reference internal" href="#matplotlib.backend_tools.ToolHome" title="matplotlib.backend_tools.ToolHome"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolHome</span></code></a></li>
<li><a class="reference internal" href="#matplotlib.backend_tools.ToolBack" title="matplotlib.backend_tools.ToolBack"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolBack</span></code></a></li>
<li><a class="reference internal" href="#matplotlib.backend_tools.ToolForward" title="matplotlib.backend_tools.ToolForward"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolForward</span></code></a></li>
</ul>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolViewsPositions.add_figure">
<code class="descname">add_figure</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">figure</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.add_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.add_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the current figure to the stack of views and positions.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolViewsPositions.back">
<code class="descname">back</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/backend_tools.html#ToolViewsPositions.back"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.back" title="Permalink to this definition">¶</a></dt>
<dd><p>Back one step in the stack of views and positions.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolViewsPositions.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">figure</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Reset the axes stack.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolViewsPositions.forward">
<code class="descname">forward</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/backend_tools.html#ToolViewsPositions.forward"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Forward one step in the stack of views and positions.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolViewsPositions.home">
<code class="descname">home</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/backend_tools.html#ToolViewsPositions.home"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.home" title="Permalink to this definition">¶</a></dt>
<dd><p>Recall the first view and position from the stack.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolViewsPositions.push_current">
<code class="descname">push_current</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">figure</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.push_current"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.push_current" title="Permalink to this definition">¶</a></dt>
<dd><p>Push the current view limits and position onto their respective stacks.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.backend_tools.ToolViewsPositions.refresh_locators">
<code class="descname">refresh_locators</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/backend_tools.html#ToolViewsPositions.refresh_locators"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.refresh_locators" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>] Redraw the canvases, update the locators.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3.</span></p>
</div>
</dd></dl>