-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathMEP22.html
More file actions
853 lines (667 loc) · 40.6 KB
/
MEP22.html
File metadata and controls
853 lines (667 loc) · 40.6 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
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>MEP22: Toolbar rewrite — Matplotlib 3.7.4 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="../../_static/styles/theme.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link href="../../_static/styles/bootstrap.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link href="../../_static/styles/pydata-sphinx-theme.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link href="../../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2">
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/style.css?v=86e00652" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css?v=7f9a90b1" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="stylesheet" type="text/css" href="../../_static/mpl.css?v=ee6d1e4d" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=796348d33e8b1d947c94">
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=796348d33e8b1d947c94">
<script src="../../_static/documentation_options.js?v=46bf15d4"></script>
<script src="../../_static/jquery.js?v3.7.4"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=ccdb6887"></script>
<script src="../../_static/design-tabs.js?v=36754332"></script>
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'devel/MEP/MEP22';</script>
<script>
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.7.4-2-g03947d07cf';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.7.4';
</script>
<link rel="canonical" href="https://matplotlib.org/stable/devel/MEP/MEP22.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.7.4 documentation"
href="../../_static/opensearch.xml"/>
<link rel="icon" href="../../_static/favicon.ico"/>
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="MEP23: Multiple Figures per GUI window" href="MEP23.html" />
<link rel="prev" title="MEP21: color and cm refactor" href="MEP21.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180" data-default-mode="">
<a class="skip-link" href="#main-content">Skip to main content</a>
<input type="checkbox" class="sidebar-toggle" name="__primary" id="__primary">
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox" class="sidebar-toggle" name="__secondary" id="__secondary">
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center" action="../../search.html" method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false">
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar" id="navbar-main"><div class="bd-header__inner bd-page-width">
<label class="sidebar-toggle primary-toggle" for="__primary">
<span class="fa-solid fa-bars"></span>
</label>
<div id="navbar-start">
<a class="navbar-brand logo" href="../../index.html">
<img src="../../_static/images/logo2.svg" class="logo__image only-light" alt="Logo image">
<img src="../../_static/images/logo_dark.svg" class="logo__image only-dark" alt="Logo image">
</a>
</div>
<div class="col-lg-9 navbar-header-items">
<div id="navbar-center" class="mr-auto">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../index.html">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../users/release_notes.html">Releases</a>
</li>
</ul>
</div>
</div>
<div id="navbar-end">
<div class="navbar-end-item navbar-persistent--container">
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
</div>
<div class="navbar-end-item">
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
</div>
<div class="navbar-end-item">
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul>
</div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
</div>
<label class="sidebar-toggle secondary-toggle" for="__secondary">
<span class="fa-solid fa-outdent"></span>
</label>
</div>
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../index.html">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../../users/release_notes.html">Releases</a>
</li>
</ul>
</div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-end-item">
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
</div>
<div class="navbar-end-item">
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul>
</div>
</div>
</div>
<div class="sidebar-start-items sidebar-primary__section">
<div class="sidebar-start-items__item"><nav class="bd-links" id="bd-docs-nav" aria-label="Section navigation">
<p class="bd-links__title" role="heading" aria-level="1">
Section Navigation
</p>
<div class="bd-toc-item navbar-nav">
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../triage.html">Bug triaging and issue curation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../development_setup.html">Setting up Matplotlib for development</a></li>
<li class="toctree-l1"><a class="reference internal" href="../development_workflow.html">Development workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="../testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documenting_mpl.html">Writing documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../style_guide.html">Documentation style guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../coding_guide.html">Pull request guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_guide.html">Release guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../min_dep_policy.html">Minimum version of dependencies policy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintainer_workflow.html">Maintainer workflow</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Matplotlib Enhancement Proposals</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="template.html">MEP Template</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP08.html">MEP8: PEP8</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP09.html">MEP9: Global interaction manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP10.html">MEP10: Docstring consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP11.html">MEP11: Third-party dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP12.html">MEP12: Improve Gallery and Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP13.html">MEP13: Use properties for Artists</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP14.html">MEP14: Text handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP15.html">MEP15: Fix axis autoscaling when limits are specified for one axis only</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP19.html">MEP19: Continuous Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP21.html">MEP21: color and cm refactor</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">MEP22: Toolbar rewrite</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP23.html">MEP23: Multiple Figures per GUI window</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP24.html">MEP24: Negative radius in polar plots</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP25.html">MEP25: Serialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP26.html">MEP26: Artist styling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP27.html">MEP27: Decouple pyplot from backends</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP28.html">MEP28: Remove Complexity from Axes.boxplot</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP29.html">MEP29: Text light markup</a></li>
</ul>
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../license.html">Licenses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../color_changes.html">Default color changes</a></li>
</ul>
</div>
</nav>
</div>
</div>
<div class="sidebar-end-items sidebar-primary__section">
<div class="sidebar-end-items__item">
</div>
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
</div>
<article class="bd-article" role="main">
<section id="mep22-toolbar-rewrite">
<h1>MEP22: Toolbar rewrite<a class="headerlink" href="#mep22-toolbar-rewrite" title="Link to this heading">#</a></h1>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#status" id="id3">Status</a></p></li>
<li><p><a class="reference internal" href="#branches-and-pull-requests" id="id4">Branches and Pull requests</a></p></li>
<li><p><a class="reference internal" href="#abstract" id="id5">Abstract</a></p></li>
<li><p><a class="reference internal" href="#detailed-description" id="id6">Detailed description</a></p></li>
<li><p><a class="reference internal" href="#implementation" id="id7">Implementation</a></p>
<ul>
<li><p><a class="reference internal" href="#toolbase-object" id="id8">ToolBase(object)</a></p>
<ul>
<li><p><a class="reference internal" href="#methods" id="id9">Methods</a></p></li>
<li><p><a class="reference internal" href="#available-tools" id="id10">Available Tools</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#tooltogglebase-toolbase" id="id11">ToolToggleBase(ToolBase)</a></p>
<ul>
<li><p><a class="reference internal" href="#id1" id="id12">Methods</a></p></li>
<li><p><a class="reference internal" href="#id2" id="id13">Available Tools</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#navigationbase" id="id14">NavigationBase</a></p>
<ul>
<li><p><a class="reference internal" href="#methods-intended-for-the-end-user" id="id15">Methods (intended for the end user)</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#toolbarbase" id="id16">ToolbarBase</a></p>
<ul>
<li><p><a class="reference internal" href="#methods-for-backend-implementation" id="id17">Methods (for backend implementation)</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#backward-compatibility" id="id18">Backward compatibility</a></p></li>
</ul>
</nav>
<section id="status">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Status</a><a class="headerlink" href="#status" title="Link to this heading">#</a></h2>
<p><strong>Progress</strong></p>
</section>
<section id="branches-and-pull-requests">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Branches and Pull requests</a><a class="headerlink" href="#branches-and-pull-requests" title="Link to this heading">#</a></h2>
<p>Previous work:</p>
<ul class="simple">
<li><p><a class="github reference external" href="https://github.com/matplotlib/matplotlib/pull/1849">matplotlib/matplotlib#1849</a></p></li>
<li><p><a class="github reference external" href="https://github.com/matplotlib/matplotlib/pull/2557">matplotlib/matplotlib#2557</a></p></li>
<li><p><a class="github reference external" href="https://github.com/matplotlib/matplotlib/pull/2465">matplotlib/matplotlib#2465</a></p></li>
</ul>
<p>Pull Requests:</p>
<ul class="simple">
<li><p>Removing the NavigationToolbar classes
<a class="github reference external" href="https://github.com/matplotlib/matplotlib/pull/2740">matplotlib/matplotlib#2740</a> <strong>CLOSED</strong></p></li>
<li><p>Keeping the NavigationToolbar classes <a class="github reference external" href="https://github.com/matplotlib/matplotlib/pull/2759">matplotlib/matplotlib#2759</a> <strong>CLOSED</strong></p></li>
<li><p>Navigation by events: <a class="github reference external" href="https://github.com/matplotlib/matplotlib/pull/3652">matplotlib/matplotlib#3652</a></p></li>
</ul>
</section>
<section id="abstract">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Abstract</a><a class="headerlink" href="#abstract" title="Link to this heading">#</a></h2>
<p>The main goal of this MEP is to make it easier to modify (add, change,
remove) the way the user interacts with the figures.</p>
<p>The user interaction with the figure is deeply integrated within the
Canvas and Toolbar. Making extremely difficult to do any modification.</p>
<p>This MEP proposes the separation of this interaction into Toolbar,
Navigation and Tools to provide independent access and
reconfiguration.</p>
<p>This approach will make easier to create and share tools among
users. In the far future, we can even foresee a kind of Marketplace
for <code class="docutils literal notranslate"><span class="pre">Tool</span></code>s where the most popular can be added into the main
distribution.</p>
</section>
<section id="detailed-description">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Detailed description</a><a class="headerlink" href="#detailed-description" title="Link to this heading">#</a></h2>
<p>The reconfiguration of the Toolbar is complex, most of the time it
requires a custom backend.</p>
<p>The creation of custom Tools sometimes interferes with the Toolbar, as
example see <a class="github reference external" href="https://github.com/matplotlib/matplotlib/issues/2694">matplotlib/matplotlib#2694</a> also
the shortcuts are hardcoded and again not easily modifiable
<a class="github reference external" href="https://github.com/matplotlib/matplotlib/issues/2699">matplotlib/matplotlib#2699</a></p>
<p>The proposed solution is to take the actions out of the <code class="docutils literal notranslate"><span class="pre">Toolbar</span></code> and the
shortcuts out of the <code class="docutils literal notranslate"><span class="pre">Canvas</span></code>. The actions and shortcuts will be in the form
of <code class="docutils literal notranslate"><span class="pre">Tool</span></code>s.</p>
<p>A new class <code class="docutils literal notranslate"><span class="pre">Navigation</span></code> will be the bridge between the events from the
<code class="docutils literal notranslate"><span class="pre">Canvas</span></code> and <code class="docutils literal notranslate"><span class="pre">Toolbar</span></code> and redirect them to the appropriate <code class="docutils literal notranslate"><span class="pre">Tool</span></code>.</p>
<p>At the end the user interaction will be divided into three classes:</p>
<ul class="simple">
<li><p>NavigationBase: This class is instantiated for each FigureManager
and connect the all user interactions with the Tools</p></li>
<li><p>ToolbarBase: This existing class is relegated only as a GUI access
to Tools.</p></li>
<li><p>ToolBase: Is the basic definition of Tools.</p></li>
</ul>
</section>
<section id="implementation">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Implementation</a><a class="headerlink" href="#implementation" title="Link to this heading">#</a></h2>
<section id="toolbase-object">
<h3><a class="toc-backref" href="#id8" role="doc-backlink">ToolBase(object)</a><a class="headerlink" href="#toolbase-object" title="Link to this heading">#</a></h3>
<p>Tools can have a graphical representation as the <code class="docutils literal notranslate"><span class="pre">SubplotTool</span></code> or not even be
present in the Toolbar as <code class="docutils literal notranslate"><span class="pre">Quit</span></code>.</p>
<p>The <a class="reference internal" href="../../api/backend_tools_api.html#matplotlib.backend_tools.ToolBase" title="matplotlib.backend_tools.ToolBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolBase</span></code></a> has the following class attributes for configuration at definition time</p>
<ul class="simple">
<li><p>keymap = None: Key(s) to be used to trigger the tool</p></li>
<li><p>description = '': Small description of the tool</p></li>
<li><p>image = None: Image that is used in the toolbar</p></li>
</ul>
<p>The following instance attributes are set at instantiation:</p>
<ul class="simple">
<li><p>name</p></li>
<li><p>navigation</p></li>
</ul>
<section id="methods">
<h4><a class="toc-backref" href="#id9" role="doc-backlink">Methods</a><a class="headerlink" href="#methods" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">trigger(self,</span> <span class="pre">event)</span></code>: This is the main method of the Tool, it is called
when the Tool is triggered by:</p>
<ul>
<li><p>Toolbar button click</p></li>
<li><p>keypress associated with the Tool Keymap</p></li>
<li><p>Call to navigation.trigger_tool(name)</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">set_figure(self,</span> <span class="pre">figure)</span></code>: Set the figure and navigation attributes</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">destroy(self,</span> <span class="pre">*args)</span></code>: Destroy the <code class="docutils literal notranslate"><span class="pre">Tool</span></code> graphical interface (if
exists)</p></li>
</ul>
</section>
<section id="available-tools">
<h4><a class="toc-backref" href="#id10" role="doc-backlink">Available Tools</a><a class="headerlink" href="#available-tools" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p>ToolQuit</p></li>
<li><p>ToolEnableAllNavigation</p></li>
<li><p>ToolEnableNavigation</p></li>
<li><p>ToolToggleGrid</p></li>
<li><p>ToolToggleFullScreen</p></li>
<li><p>ToolToggleYScale</p></li>
<li><p>ToolToggleXScale</p></li>
<li><p>ToolHome</p></li>
<li><p>ToolBack</p></li>
<li><p>ToolForward</p></li>
<li><p>SaveFigureBase</p></li>
<li><p>ConfigureSubplotsBase</p></li>
</ul>
</section>
</section>
<section id="tooltogglebase-toolbase">
<h3><a class="toc-backref" href="#id11" role="doc-backlink">ToolToggleBase(ToolBase)</a><a class="headerlink" href="#tooltogglebase-toolbase" title="Link to this heading">#</a></h3>
<p>The <a class="reference internal" href="../../api/backend_tools_api.html#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> has the following class attributes for
configuration at definition time</p>
<ul class="simple">
<li><p>radio_group = None: Attribute to group 'radio' like tools (mutually
exclusive)</p></li>
<li><p>cursor = None: Cursor to use when the tool is active</p></li>
</ul>
<p>The <strong>Toggleable</strong> Tools, can capture keypress, mouse moves, and mouse
button press</p>
<section id="id1">
<h4><a class="toc-backref" href="#id12" role="doc-backlink">Methods</a><a class="headerlink" href="#id1" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">enable(self,</span> <span class="pre">event)</span></code>: Called by <a class="reference internal" href="../../api/backend_tools_api.html#matplotlib.backend_tools.ToolToggleBase.trigger" title="matplotlib.backend_tools.ToolToggleBase.trigger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ToolToggleBase.trigger</span></code></a> method</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">disable(self,</span> <span class="pre">event)</span></code>: Called when the tool is untoggled</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">toggled</span></code>: <strong>Property</strong> True or False</p></li>
</ul>
</section>
<section id="id2">
<h4><a class="toc-backref" href="#id13" role="doc-backlink">Available Tools</a><a class="headerlink" href="#id2" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p>ToolZoom</p></li>
<li><p>ToolPan</p></li>
</ul>
</section>
</section>
<section id="navigationbase">
<h3><a class="toc-backref" href="#id14" role="doc-backlink">NavigationBase</a><a class="headerlink" href="#navigationbase" title="Link to this heading">#</a></h3>
<p>Defines the following attributes:</p>
<ul class="simple">
<li><p>canvas:</p></li>
<li><p>keypresslock: Lock to know if the <code class="docutils literal notranslate"><span class="pre">canvas</span></code> <code class="docutils literal notranslate"><span class="pre">key_press_event</span></code> is
available and process it</p></li>
<li><p>messagelock: Lock to know if the message is available to write</p></li>
</ul>
<section id="methods-intended-for-the-end-user">
<h4><a class="toc-backref" href="#id15" role="doc-backlink">Methods (intended for the end user)</a><a class="headerlink" href="#methods-intended-for-the-end-user" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">nav_connect(self,</span> <span class="pre">s,</span> <span class="pre">func)</span></code>: Connect to navigation for events</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">nav_disconnect(self,</span> <span class="pre">cid)</span></code>: Disconnect from navigation event</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">message_event(self,</span> <span class="pre">message,</span> <span class="pre">sender=None)</span></code>: Emit a
tool_message_event event</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">active_toggle(self)</span></code>: <strong>Property</strong> The currently toggled tools or
None</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_tool_keymap(self,</span> <span class="pre">name)</span></code>: Return a list of keys that are
associated with the tool</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">set_tool_keymap(self,</span> <span class="pre">name,</span> <span class="pre">``*keys</span></code>)``: Set the keys for the given tool</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remove_tool(self,</span> <span class="pre">name)</span></code>: Removes tool from the navigation control.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">add_tools(self,</span> <span class="pre">tools)</span></code>: Add multiple tools to <code class="docutils literal notranslate"><span class="pre">Navigation</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">add_tool(self,</span> <span class="pre">name,</span> <span class="pre">tool,</span> <span class="pre">group=None,</span> <span class="pre">position=None)</span></code>: Add a tool
to the <code class="docutils literal notranslate"><span class="pre">Navigation</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">tool_trigger_event(self,</span> <span class="pre">name,</span> <span class="pre">sender=None,</span> <span class="pre">canvasevent=None,</span>
<span class="pre">data=None)</span></code>: Trigger a tool and fire the event</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">tools</span></code>: <strong>Property</strong> A dict with available tools with
corresponding keymaps, descriptions and objects</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_tool(self,</span> <span class="pre">name)</span></code>: Return the tool object</p></li>
</ul>
</section>
</section>
<section id="toolbarbase">
<h3><a class="toc-backref" href="#id16" role="doc-backlink">ToolbarBase</a><a class="headerlink" href="#toolbarbase" title="Link to this heading">#</a></h3>
<section id="methods-for-backend-implementation">
<h4><a class="toc-backref" href="#id17" role="doc-backlink">Methods (for backend implementation)</a><a class="headerlink" href="#methods-for-backend-implementation" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">add_toolitem(self,</span> <span class="pre">name,</span> <span class="pre">group,</span> <span class="pre">position,</span> <span class="pre">image,</span> <span class="pre">description,</span> <span class="pre">toggle)</span></code>:
Add a toolitem to the toolbar. This method is a callback from
<code class="docutils literal notranslate"><span class="pre">tool_added_event</span></code> (emitted by navigation)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">set_message(self,</span> <span class="pre">s)</span></code>: Display a message on toolbar or in status bar</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">toggle_toolitem(self,</span> <span class="pre">name)</span></code>: Toggle the toolitem without firing event.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">remove_toolitem(self,</span> <span class="pre">name)</span></code>: Remove a toolitem from the <code class="docutils literal notranslate"><span class="pre">Toolbar</span></code></p></li>
</ul>
</section>
</section>
</section>
<section id="backward-compatibility">
<h2><a class="toc-backref" href="#id18" role="doc-backlink">Backward compatibility</a><a class="headerlink" href="#backward-compatibility" title="Link to this heading">#</a></h2>
<p>For backward compatibility added 'navigation' to the list of values
supported by <code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=toolbar#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["toolbar"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'toolbar2'</span></code>), that is used for <code class="docutils literal notranslate"><span class="pre">Navigation</span></code> classes
instantiation instead of the NavigationToolbar classes</p>
<p>With this parameter, it makes it transparent to anyone using the
existing backends.</p>
<p>[@pelson comment: This also gives us an opportunity to avoid needing
to implement all of this in the same PR - some backends can
potentially exist without the new functionality for a short while (but
it must be done at some point).]</p>
</section>
</section>
</article>
</div>
<div class="bd-sidebar-secondary bd-toc">
<div class="toc-item">
<div class="tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav id="bd-toc-nav" class="page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#status">
Status
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#branches-and-pull-requests">
Branches and Pull requests
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#abstract">
Abstract
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#detailed-description">
Detailed description
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#implementation">
Implementation
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#toolbase-object">
ToolBase(object)
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
<a class="reference internal nav-link" href="#methods">
Methods
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
<a class="reference internal nav-link" href="#available-tools">
Available Tools
</a>
</li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#tooltogglebase-toolbase">
ToolToggleBase(ToolBase)
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
<a class="reference internal nav-link" href="#id1">
Methods
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
<a class="reference internal nav-link" href="#id2">
Available Tools
</a>
</li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#navigationbase">
NavigationBase
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
<a class="reference internal nav-link" href="#methods-intended-for-the-end-user">
Methods (intended for the end user)
</a>
</li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#toolbarbase">
ToolbarBase
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
<a class="reference internal nav-link" href="#methods-for-backend-implementation">
Methods (for backend implementation)
</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#backward-compatibility">
Backward compatibility
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner">
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../../_static/scripts/bootstrap.js?digest=796348d33e8b1d947c94"></script>
<script src="../../_static/scripts/pydata-sphinx-theme.js?digest=796348d33e8b1d947c94"></script>
<footer class="bd-footer"><div class="bd-footer__inner container">
<div class="footer-item">
<p class="copyright">
© Copyright 2002–2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012–2023 The Matplotlib development team.<br>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Built from v3.7.4-2-g03947d07cf.
<br/>
</p>
</div>
</div>
</footer>
</body>
</html>