-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathapi_changes_3.4.0.html
More file actions
2301 lines (2111 loc) · 180 KB
/
api_changes_3.4.0.html
File metadata and controls
2301 lines (2111 loc) · 180 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>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>API Changes for 3.4.0 — Matplotlib 3.7.2 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?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/css/style.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../../_static/mpl.css?v3.7.2-2-g4915f574b8" />
<!-- 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 data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v3.7.2-2-g4915f574b8"></script>
<script src="../../_static/jquery.js?v3.7.2-2-g4915f574b8"></script>
<script src="../../_static/underscore.js?v3.7.2-2-g4915f574b8"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v3.7.2-2-g4915f574b8"></script>
<script src="../../_static/doctools.js?v3.7.2-2-g4915f574b8"></script>
<script src="../../_static/sphinx_highlight.js?v3.7.2-2-g4915f574b8"></script>
<script src="../../_static/clipboard.min.js?v3.7.2-2-g4915f574b8"></script>
<script src="../../_static/copybutton.js?v3.7.2-2-g4915f574b8"></script>
<script src="../../_static/design-tabs.js?v3.7.2-2-g4915f574b8"></script>
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'api/prev_api_changes/api_changes_3.4.0';</script>
<script>
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.7.2-2-g4915f574b8';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.7.2';
</script>
<link rel="canonical" href="https://matplotlib.org/stable/api/prev_api_changes/api_changes_3.4.0.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.7.2 documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="What's new in Matplotlib 3.3.0 (Jul 16, 2020)" href="../../users/prev_whats_new/whats_new_3.3.0.html" />
<link rel="prev" title="API Changes for 3.4.2" href="api_changes_3.4.2.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="../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="../../devel/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/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="../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="../../devel/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/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="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/prev_whats_new/whats_new_3.7.0.html">What's new in Matplotlib 3.7.0 (Feb 13, 2023)</a><input 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="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.7.0.html">API Changes for 3.7.0</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/github_stats.html">GitHub statistics for 3.7.2 (Jul 05, 2023)</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.7.1.html">GitHub statistics for 3.7.1 (Mar 03, 2023)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.7.0.html">GitHub statistics for 3.7.0 (Feb 13, 2023)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.6.3.html">GitHub statistics for 3.6.3 (Jan 11, 2023)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.6.2.html">GitHub statistics for 3.6.2 (Nov 02, 2022)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.6.1.html">GitHub statistics for 3.6.1 (Oct 08, 2022)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.6.0.html">GitHub statistics for 3.6.0 (Sep 15, 2022)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.5.3.html">GitHub statistics for 3.5.3 (Aug 10, 2022)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.5.2.html">GitHub statistics for 3.5.2 (May 02, 2022)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.5.1.html">GitHub statistics for 3.5.1 (Dec 11, 2021)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.5.0.html">GitHub statistics for 3.5.0 (Nov 15, 2021)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.4.3.html">GitHub statistics for 3.4.3 (August 21, 2021)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.4.2.html">GitHub statistics for 3.4.2 (May 08, 2021)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.4.1.html">GitHub statistics for 3.4.1 (Mar 31, 2021)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.4.0.html">GitHub statistics for 3.4.0 (Mar 26, 2021)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.4.html">GitHub statistics for 3.3.4 (Jan 28, 2021)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.3.html">GitHub statistics for 3.3.3 (Nov 11, 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.2.html">GitHub statistics for 3.3.2 (Sep 15, 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.1.html">GitHub statistics for 3.3.1 (Aug 13, 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.0.html">GitHub statistics for 3.3.0 (Jul 16, 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.2.2.html">GitHub statistics for 3.2.2 (Jun 17, 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.2.1.html">GitHub statistics for 3.2.1 (Mar 18, 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.2.0.html">GitHub statistics for 3.2.0 (Mar 04, 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.1.3.html">GitHub statistics for 3.1.3 (Feb 03, 2020)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.1.2.html">GitHub statistics for 3.1.2 (Nov 21, 2019)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.1.1.html">GitHub statistics for 3.1.1 (Jul 02, 2019)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.1.0.html">GitHub statistics for 3.1.0 (May 18, 2019)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.0.3.html">GitHub statistics for 3.0.3 (Feb 28, 2019)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.0.2.html">GitHub statistics for 3.0.2 (Nov 10, 2018)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.0.1.html">GitHub statistics for 3.0.1 (Oct 25, 2018)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.0.0.html">GitHub statistics for 3.0.0 (Sep 18, 2018)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.7.1.html">GitHub statistics for 3.7.1 (Mar 03, 2023)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.7.0.html">GitHub statistics for 3.7.0 (Feb 13, 2023)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/prev_whats_new/whats_new_3.6.0.html">What's new in Matplotlib 3.6.0 (Sep 15, 2022)</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.6.1.html">API Changes for 3.6.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.6.0.html">API Changes for 3.6.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.6.3.html">GitHub statistics for 3.6.3 (Jan 11, 2023)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.6.2.html">GitHub statistics for 3.6.2 (Nov 02, 2022)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.6.1.html">GitHub statistics for 3.6.1 (Oct 08, 2022)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.6.0.html">GitHub statistics for 3.6.0 (Sep 15, 2022)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/prev_whats_new/whats_new_3.5.2.html">What's new in Matplotlib 3.5.2 (May 02, 2022)</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/prev_whats_new/whats_new_3.5.0.html">What's new in Matplotlib 3.5.0 (Nov 15, 2021)</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.5.3.html">API Changes for 3.5.3</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.5.2.html">API Changes for 3.5.2</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.5.0.html">API Changes for 3.5.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.5.3.html">GitHub statistics for 3.5.3 (Aug 10, 2022)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.5.2.html">GitHub statistics for 3.5.2 (May 02, 2022)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.5.1.html">GitHub statistics for 3.5.1 (Dec 11, 2021)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.5.0.html">GitHub statistics for 3.5.0 (Nov 15, 2021)</a></li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/prev_whats_new/whats_new_3.4.0.html">What's new in Matplotlib 3.4.0 (Mar 26, 2021)</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.4.2.html">API Changes for 3.4.2</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">API Changes for 3.4.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.4.1.html">GitHub statistics for 3.4.1 (Mar 31, 2021)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.4.0.html">GitHub statistics for 3.4.0 (Mar 26, 2021)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/prev_whats_new/whats_new_3.3.0.html">What's new in Matplotlib 3.3.0 (Jul 16, 2020)</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-7"><i class="fa-solid fa-chevron-down"></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.3.1.html">API Changes for 3.3.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.3.0.html">API Changes for 3.3.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.4.html">GitHub statistics for 3.3.4 (Jan 28, 2021)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.3.html">GitHub statistics for 3.3.3 (Nov 11, 2020)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.2.html">GitHub statistics for 3.3.2 (Sep 15, 2020)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.1.html">GitHub statistics for 3.3.1 (Aug 13, 2020)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.3.0.html">GitHub statistics for 3.3.0 (Jul 16, 2020)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/prev_whats_new/whats_new_3.2.0.html">What's new in Matplotlib 3.2 (Mar 04, 2020)</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-8"><i class="fa-solid fa-chevron-down"></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.2.0.html">API Changes for 3.2.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.2.2.html">GitHub statistics for 3.2.2 (Jun 17, 2020)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.2.1.html">GitHub statistics for 3.2.1 (Mar 18, 2020)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.2.0.html">GitHub statistics for 3.2.0 (Mar 04, 2020)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/prev_whats_new/whats_new_3.1.0.html">What's new in Matplotlib 3.1 (May 18, 2019)</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-9"><i class="fa-solid fa-chevron-down"></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.1.1.html">API Changes for 3.1.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.1.0.html">API Changes for 3.1.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.1.3.html">GitHub statistics for 3.1.3 (Feb 03, 2020)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.1.2.html">GitHub statistics for 3.1.2 (Nov 21, 2019)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.1.1.html">GitHub statistics for 3.1.1 (Jul 02, 2019)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.1.0.html">GitHub statistics for 3.1.0 (May 18, 2019)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_3.0.html">What's new in Matplotlib 3.0 (Sep 18, 2018)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.0.1.html">API Changes for 3.0.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_3.0.0.html">API Changes for 3.0.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.0.3.html">GitHub statistics for 3.0.3 (Feb 28, 2019)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.0.2.html">GitHub statistics for 3.0.2 (Nov 10, 2018)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.0.1.html">GitHub statistics for 3.0.1 (Oct 25, 2018)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/github_stats_3.0.0.html">GitHub statistics for 3.0.0 (Sep 18, 2018)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_2.2.html">What's new in Matplotlib 2.2 (Mar 06, 2018)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_2.2.0.html">API Changes in 2.2.0</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_2.1.0.html">What's new in Matplotlib 2.1.0 (Oct 7, 2017)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_2.1.2.html">API Changes in 2.1.2</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_2.1.1.html">API Changes in 2.1.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_2.1.0.html">API Changes in 2.1.0</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../../users/prev_whats_new/whats_new_2.0.0.html">What's new in Matplotlib 2.0 (Jan 17, 2017)</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-10"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../users/prev_whats_new/dflt_style_changes.html">Changes to the default style</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_2.0.1.html">API Changes in 2.0.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_2.0.0.html">API Changes in 2.0.0</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_1.5.html">What's new in Matplotlib 1.5 (Oct 29, 2015)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_1.5.3.html">API Changes in 1.5.3</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_1.5.2.html">API Changes in 1.5.2</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_1.5.0.html">API Changes in 1.5.0</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_1.4.html">What's new in Matplotlib 1.4 (Aug 25, 2014)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_1.4.x.html">API Changes in 1.4.x</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_1.3.html">What's new in Matplotlib 1.3 (Aug 01, 2013)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_1.3.x.html">API Changes in 1.3.x</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_1.2.2.html">What's new in Matplotlib 1.2.2</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_1.2.html">What's new in Matplotlib 1.2 (Nov 9, 2012)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_1.2.x.html">API Changes in 1.2.x</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_1.1.html">What's new in Matplotlib 1.1 (Nov 02, 2011)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_1.1.x.html">API Changes in 1.1.x</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_1.0.html">What's new in Matplotlib 1.0 (Jul 06, 2010)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/changelog.html">List of changes to Matplotlib prior to 2015</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_0.99.html">What's new in Matplotlib 0.99 (Aug 29, 2009)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.99.x.html">Changes beyond 0.99.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.99.html">Changes in 0.99</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../users/prev_whats_new/whats_new_0.98.4.html">What's new in Matplotlib 0.98.4</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.98.x.html">Changes for 0.98.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.98.1.html">Changes for 0.98.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.98.0.html">Changes for 0.98.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.91.2.html">Changes for 0.91.2</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.91.0.html">Changes for 0.91.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.90.1.html">Changes for 0.90.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.90.0.html">Changes for 0.90.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.87.7.html">Changes for 0.87.7</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.86.html">Changes for 0.86</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.85.html">Changes for 0.85</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.84.html">Changes for 0.84</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.83.html">Changes for 0.83</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.82.html">Changes for 0.82</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.81.html">Changes for 0.81</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.80.html">Changes for 0.80</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.73.html">Changes for 0.73</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.72.html">Changes for 0.72</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.71.html">Changes for 0.71</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.70.html">Changes for 0.70</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.65.1.html">Changes for 0.65.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.65.html">Changes for 0.65</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.63.html">Changes for 0.63</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.61.html">Changes for 0.61</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.60.html">Changes for 0.60</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.54.3.html">Changes for 0.54.3</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.54.html">Changes for 0.54</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.50.html">Changes for 0.50</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.42.html">Changes for 0.42</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_changes_0.40.html">Changes for 0.40</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="api-changes-for-3-4-0">
<h1>API Changes for 3.4.0<a class="headerlink" href="#api-changes-for-3-4-0" title="Permalink to this heading">#</a></h1>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#behaviour-changes" id="id2">Behaviour changes</a></p></li>
<li><p><a class="reference internal" href="#deprecations" id="id3">Deprecations</a></p></li>
<li><p><a class="reference internal" href="#removals" id="id4">Removals</a></p></li>
<li><p><a class="reference internal" href="#development-changes" id="id5">Development changes</a></p></li>
</ul>
</nav>
<section id="behaviour-changes">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Behaviour changes</a><a class="headerlink" href="#behaviour-changes" title="Permalink to this heading">#</a></h2>
<section id="constrained-layout-rewrite">
<h3>Constrained layout rewrite<a class="headerlink" href="#constrained-layout-rewrite" title="Permalink to this heading">#</a></h3>
<p>The layout manager <code class="docutils literal notranslate"><span class="pre">constrained_layout</span></code> was re-written with different outer
constraints that should be more robust to complicated subplot layouts.
User-facing changes are:</p>
<ul class="simple">
<li><p>some poorly constrained layouts will have different width/height plots than
before.</p></li>
<li><p>colorbars now respect the <code class="docutils literal notranslate"><span class="pre">anchor</span></code> keyword argument of
<a class="reference internal" href="../colorbar_api.html#matplotlib.colorbar.make_axes" title="matplotlib.colorbar.make_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.colorbar.make_axes</span></code></a></p></li>
<li><p>colorbars are wider.</p></li>
<li><p>colorbars in different rows or columns line up more robustly.</p></li>
<li><p><em>hspace</em> and <em>wspace</em> options to <a class="reference internal" href="../figure_api.html#matplotlib.figure.Figure.set_constrained_layout_pads" title="matplotlib.figure.Figure.set_constrained_layout_pads"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_constrained_layout_pads</span></code></a> were
twice as wide as the docs said they should be. So these now follow the docs.</p></li>
</ul>
<p>This feature will remain "experimental" until the new changes have been used
enough by users, so we anticipate version 3.5 or 3.6. On the other hand,
<code class="docutils literal notranslate"><span class="pre">constrained_layout</span></code> is extensively tested and used in examples in the
library, so using it should be safe, but layouts may not be exactly the same as
more development takes place.</p>
<p>Details of using <code class="docutils literal notranslate"><span class="pre">constrained_layout</span></code>, and its algorithm are available at
<a class="reference internal" href="../../tutorials/intermediate/constrainedlayout_guide.html"><span class="doc">Constrained Layout Guide</span></a></p>
</section>
<section id="plt-subplot-re-selection-without-keyword-arguments">
<h3><code class="docutils literal notranslate"><span class="pre">plt.subplot</span></code> re-selection without keyword arguments<a class="headerlink" href="#plt-subplot-re-selection-without-keyword-arguments" title="Permalink to this heading">#</a></h3>
<p>The purpose of <a class="reference internal" href="../_as_gen/matplotlib.pyplot.subplot.html#matplotlib.pyplot.subplot" title="matplotlib.pyplot.subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplot</span></code></a> is to facilitate creating and re-selecting
Axes in a Figure when working strictly in the implicit pyplot API. When
creating new Axes it is possible to select the projection (e.g. polar, 3D, or
various cartographic projections) as well as to pass additional keyword
arguments through to the Axes-subclass that is created.</p>
<p>The first time <a class="reference internal" href="../_as_gen/matplotlib.pyplot.subplot.html#matplotlib.pyplot.subplot" title="matplotlib.pyplot.subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplot</span></code></a> is called for a given position in the Axes
grid it always creates and returns a new Axes with the passed arguments and
projection (defaulting to rectilinear). On subsequent calls to
<a class="reference internal" href="../_as_gen/matplotlib.pyplot.subplot.html#matplotlib.pyplot.subplot" title="matplotlib.pyplot.subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplot</span></code></a> we have to determine if an existing Axes has a) equivalent
parameters, in which case it should be selected as the current Axes and
returned, or b) different parameters, in which case a new Axes is created and
the existing Axes is removed. This leaves the question of what is "equivalent
parameters".</p>
<p>Previously it was the case that an existing Axes subclass, except for Axes3D,
would be considered equivalent to a 2D rectilinear Axes, despite having
different projections, if the keyword arguments (other than <em>projection</em>)
matched. Thus:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax1</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">projection</span><span class="o">=</span><span class="s1">'polar'</span><span class="p">)</span>
<span class="n">ax2</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">ax1</span> <span class="ow">is</span> <span class="n">ax2</span>
</pre></div>
</div>
<p>We are embracing this long standing behavior to ensure that in the case when no
keyword arguments (of any sort) are passed to <a class="reference internal" href="../_as_gen/matplotlib.pyplot.subplot.html#matplotlib.pyplot.subplot" title="matplotlib.pyplot.subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplot</span></code></a> any existing
Axes is returned, without consideration for keywords or projection used to
initially create it. This will cause a change in behavior when additional
keywords were passed to the original Axes:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax1</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">,</span> <span class="n">projection</span><span class="o">=</span><span class="s1">'polar'</span><span class="p">,</span> <span class="n">theta_offset</span><span class="o">=</span><span class="mf">.75</span><span class="p">)</span>
<span class="n">ax2</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">ax1</span> <span class="ow">is</span> <span class="n">ax2</span> <span class="c1"># new behavior</span>
<span class="c1"># ax1 is not ax2 # old behavior, made a new axes</span>
<span class="n">ax1</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s1">'test'</span><span class="p">)</span>
<span class="n">ax2</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">ax1</span> <span class="ow">is</span> <span class="n">ax2</span> <span class="c1"># new behavior</span>
<span class="c1"># ax1 is not ax2 # old behavior, made a new axes</span>
</pre></div>
</div>
<p>For the same reason, if there was an existing Axes that was not rectilinear,
passing <code class="docutils literal notranslate"><span class="pre">projection='rectilinear'</span></code> would reuse the existing Axes</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax1</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="s1">'polar'</span><span class="p">)</span>
<span class="n">ax2</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="s1">'rectilinear'</span><span class="p">)</span>
<span class="n">ax1</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">ax2</span> <span class="c1"># new behavior, makes new Axes</span>
<span class="c1"># ax1 is ax2 # old behavior</span>
</pre></div>
</div>
<p>contrary to the user's request.</p>
<p>Previously Axes3D could not be re-selected with <a class="reference internal" href="../_as_gen/matplotlib.pyplot.subplot.html#matplotlib.pyplot.subplot" title="matplotlib.pyplot.subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplot</span></code></a> due to an
unrelated bug (also fixed in Matplotlib 3.4). While Axes3D are now consistent
with all other projections there is a change in behavior for</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="s1">'3d'</span><span class="p">)</span> <span class="c1"># create a 3D Axes</span>
<span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">()</span> <span class="c1"># now returns existing 3D Axes, but</span>
<span class="c1"># previously created new 2D Axes</span>
<span class="n">plt</span><span class="o">.</span><span class="n">subplot</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="s1">'rectilinear'</span><span class="p">)</span> <span class="c1"># to get a new 2D Axes</span>
</pre></div>
</div>
</section>
<section id="ioff-and-ion-can-be-used-as-context-managers">
<h3><code class="docutils literal notranslate"><span class="pre">ioff</span></code> and <code class="docutils literal notranslate"><span class="pre">ion</span></code> can be used as context managers<a class="headerlink" href="#ioff-and-ion-can-be-used-as-context-managers" title="Permalink to this heading">#</a></h3>
<p><a class="reference internal" href="../_as_gen/matplotlib.pyplot.ion.html#matplotlib.pyplot.ion" title="matplotlib.pyplot.ion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ion</span></code></a> and <a class="reference internal" href="../_as_gen/matplotlib.pyplot.ioff.html#matplotlib.pyplot.ioff" title="matplotlib.pyplot.ioff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ioff</span></code></a> may now be used as context managers to create
a context with interactive mode on or off, respectively. The old behavior of
calling these functions is maintained. To use the new functionality call as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">plt</span><span class="o">.</span><span class="n">ioff</span><span class="p">():</span>
<span class="c1"># non-interactive code</span>
</pre></div>
</div>
</section>
<section id="locators-and-formatters-must-be-in-the-class-hierarchy">
<h3>Locators and formatters must be in the class hierarchy<a class="headerlink" href="#locators-and-formatters-must-be-in-the-class-hierarchy" title="Permalink to this heading">#</a></h3>
<p>Axis locators and formatters must now be subclasses of
<a class="reference internal" href="../ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Locator</span></code></a> and <a class="reference internal" href="../ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Formatter</span></code></a> respectively.</p>
</section>
<section id="date-locator-for-daily-interval-now-returns-middle-of-month">
<h3>Date locator for DAILY interval now returns middle of month<a class="headerlink" href="#date-locator-for-daily-interval-now-returns-middle-of-month" title="Permalink to this heading">#</a></h3>
<p>The <a class="reference internal" href="../dates_api.html#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.dates.AutoDateLocator</span></code></a> has a default of
<code class="docutils literal notranslate"><span class="pre">interval_multiples=True</span></code> that attempts to align ticks with the start of
meaningful intervals like the start of the month, or start of the day, etc.
That lead to approximately 140-day intervals being mapped to the first and 22nd
of the month. This has now been changed so that it chooses the first and 15th
of the month, which is probably what most people want.</p>
</section>
<section id="scalarformatter-uselocale-option-obeys-grouping">
<h3><code class="docutils literal notranslate"><span class="pre">ScalarFormatter</span></code> <em>useLocale</em> option obeys grouping<a class="headerlink" href="#scalarformatter-uselocale-option-obeys-grouping" title="Permalink to this heading">#</a></h3>
<p>When the <a class="reference internal" href="../ticker_api.html#matplotlib.ticker.ScalarFormatter" title="matplotlib.ticker.ScalarFormatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ScalarFormatter</span></code></a> option <em>useLocale</em> is enabled (or
<code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=axes.formatter.use_locale#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["axes.formatter.use_locale"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>) is <em>True</em>) and the configured locale uses
grouping, a separator will be added as described in <a class="reference external" href="https://docs.python.org/3/library/locale.html#locale.format_string" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">locale.format_string</span></code></a>.</p>
</section>
<section id="axes-errorbar-cycles-non-color-properties-correctly">
<h3><code class="docutils literal notranslate"><span class="pre">Axes.errorbar</span></code> cycles non-color properties correctly<a class="headerlink" href="#axes-errorbar-cycles-non-color-properties-correctly" title="Permalink to this heading">#</a></h3>
<p>Formerly, <a class="reference internal" href="../_as_gen/matplotlib.axes.Axes.errorbar.html#matplotlib.axes.Axes.errorbar" title="matplotlib.axes.Axes.errorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.errorbar</span></code></a> incorrectly skipped the Axes property cycle if a
color was explicitly specified, even if the property cycler was for other
properties (such as line style). Now, <a class="reference internal" href="../_as_gen/matplotlib.axes.Axes.errorbar.html#matplotlib.axes.Axes.errorbar" title="matplotlib.axes.Axes.errorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.errorbar</span></code></a> will advance the Axes
property cycle as done for <a class="reference internal" href="../_as_gen/matplotlib.axes.Axes.plot.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.plot</span></code></a>, i.e., as long as all properties in the
cycler are not explicitly passed.</p>
</section>
<section id="pyplot-specgram-always-uses-origin-upper">
<h3>pyplot.specgram always uses origin='upper'<a class="headerlink" href="#pyplot-specgram-always-uses-origin-upper" title="Permalink to this heading">#</a></h3>
<p>Previously if <code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=image.origin#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["image.origin"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'upper'</span></code>) was set to something other than <code class="docutils literal notranslate"><span class="pre">'upper'</span></code> or
if the <em>origin</em> keyword argument was passed with a value other than
<code class="docutils literal notranslate"><span class="pre">'upper'</span></code>, the spectrogram itself would flip, but the Axes would remain
oriented for an origin value of <code class="docutils literal notranslate"><span class="pre">'upper'</span></code>, so that the resulting plot was
incorrectly labelled.</p>
<p>Now, the <em>origin</em> keyword argument is not supported and the <code class="docutils literal notranslate"><span class="pre">image.origin</span></code>
rcParam is ignored. The function <a class="reference internal" href="../_as_gen/matplotlib.pyplot.specgram.html#matplotlib.pyplot.specgram" title="matplotlib.pyplot.specgram"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pyplot.specgram</span></code></a> is forced to use
<code class="docutils literal notranslate"><span class="pre">origin='upper'</span></code>, so that the Axes are correct for the plotted spectrogram.</p>
</section>
<section id="xunits-none-and-yunits-none-passed-as-keyword-arguments-are-treated-as-no-action">
<h3>xunits=None and yunits=None passed as keyword arguments are treated as "no action"<a class="headerlink" href="#xunits-none-and-yunits-none-passed-as-keyword-arguments-are-treated-as-no-action" title="Permalink to this heading">#</a></h3>
<p>Many (but not all) of the methods on <a class="reference internal" href="../_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> take the (undocumented)
keyword arguments <em>xunits</em> and <em>yunits</em> that will update the units on the given
Axis by calling <a class="reference internal" href="../_as_gen/matplotlib.axis.Axis.set_units.html#matplotlib.axis.Axis.set_units" title="matplotlib.axis.Axis.set_units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.set_units</span></code></a> and <a class="reference internal" href="../_as_gen/matplotlib.axis.Axis.update_units.html#matplotlib.axis.Axis.update_units" title="matplotlib.axis.Axis.update_units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.update_units</span></code></a>.</p>
<p>Previously if <em>None</em> was passed it would clear the value stored in
<code class="docutils literal notranslate"><span class="pre">.Axis.units</span></code> which will in turn break converters which rely on the value in
<code class="docutils literal notranslate"><span class="pre">.Axis.units</span></code> to work properly (notably <a class="reference internal" href="../category_api.html#matplotlib.category.StrCategoryConverter" title="matplotlib.category.StrCategoryConverter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StrCategoryConverter</span></code></a>).</p>
<p>This changes the semantics of <code class="docutils literal notranslate"><span class="pre">ax.meth(...,</span> <span class="pre">xunits=None,</span> <span class="pre">yunits=None)</span></code> from
"please clear the units" to "do the default thing as if they had not been
passed" which is consistent with the standard behavior of Matplotlib keyword
arguments.</p>
<p>If you were relying on passing <code class="docutils literal notranslate"><span class="pre">xunits=None</span></code> to plotting methods to clear the
<code class="docutils literal notranslate"><span class="pre">.Axes.units</span></code> attribute, directly call <a class="reference internal" href="../_as_gen/matplotlib.axis.Axis.set_units.html#matplotlib.axis.Axis.set_units" title="matplotlib.axis.Axis.set_units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.set_units</span></code></a> (and
<a class="reference internal" href="../_as_gen/matplotlib.axis.Axis.update_units.html#matplotlib.axis.Axis.update_units" title="matplotlib.axis.Axis.update_units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.update_units</span></code></a> if you also require the converter to be updated).</p>
</section>
<section id="annotations-with-annotation-clip-no-longer-affect-tight-layout">
<h3>Annotations with <code class="docutils literal notranslate"><span class="pre">annotation_clip</span></code> no longer affect <code class="docutils literal notranslate"><span class="pre">tight_layout</span></code><a class="headerlink" href="#annotations-with-annotation-clip-no-longer-affect-tight-layout" title="Permalink to this heading">#</a></h3>
<p>Previously, <a class="reference internal" href="../text_api.html#matplotlib.text.Annotation.get_tightbbox" title="matplotlib.text.Annotation.get_tightbbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">text.Annotation.get_tightbbox</span></code></a> always returned the full
<a class="reference internal" href="../text_api.html#matplotlib.text.Annotation.get_window_extent" title="matplotlib.text.Annotation.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">text.Annotation.get_window_extent</span></code></a> of the object, independent of the value of
<code class="docutils literal notranslate"><span class="pre">annotation_clip</span></code>. <a class="reference internal" href="../text_api.html#matplotlib.text.Annotation.get_tightbbox" title="matplotlib.text.Annotation.get_tightbbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">text.Annotation.get_tightbbox</span></code></a> now correctly takes this
extra clipping box into account, meaning that <a class="reference internal" href="../text_api.html#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Annotation</span></code></a>s that are
not drawn because of <code class="docutils literal notranslate"><span class="pre">annotation_clip</span></code> will not count towards the Axes
bounding box calculations, such as those done by <a class="reference internal" href="../_as_gen/matplotlib.pyplot.tight_layout.html#matplotlib.pyplot.tight_layout" title="matplotlib.pyplot.tight_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tight_layout</span></code></a>.</p>
<p>This is now consistent with the API described in <a class="reference internal" href="../artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a>, which
specifies that <code class="docutils literal notranslate"><span class="pre">get_window_extent</span></code> should return the full extents and
<code class="docutils literal notranslate"><span class="pre">get_tightbbox</span></code> should "account for any clipping".</p>
</section>
<section id="parasite-axes-pcolor-and-pcolormesh-now-defaults-to-placing-grid-edges-at-integers-not-half-integers">
<h3>Parasite Axes pcolor and pcolormesh now defaults to placing grid edges at integers, not half-integers<a class="headerlink" href="#parasite-axes-pcolor-and-pcolormesh-now-defaults-to-placing-grid-edges-at-integers-not-half-integers" title="Permalink to this heading">#</a></h3>
<p>This is consistent with <a class="reference internal" href="../_as_gen/matplotlib.axes.Axes.pcolor.html#matplotlib.axes.Axes.pcolor" title="matplotlib.axes.Axes.pcolor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pcolor</span></code></a> and <a class="reference internal" href="../_as_gen/matplotlib.axes.Axes.pcolormesh.html#matplotlib.axes.Axes.pcolormesh" title="matplotlib.axes.Axes.pcolormesh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pcolormesh</span></code></a>.</p>
</section>
<section id="colorbar-outline-is-now-a-spine">
<h3><code class="docutils literal notranslate"><span class="pre">Colorbar</span></code> outline is now a <code class="docutils literal notranslate"><span class="pre">Spine</span></code><a class="headerlink" href="#colorbar-outline-is-now-a-spine" title="Permalink to this heading">#</a></h3>
<p>The outline of <a class="reference internal" href="../colorbar_api.html#matplotlib.colorbar.Colorbar" title="matplotlib.colorbar.Colorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Colorbar</span></code></a> is now a <a class="reference internal" href="../spines_api.html#matplotlib.spines.Spine" title="matplotlib.spines.Spine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Spine</span></code></a> and drawn as
one, instead of a <a class="reference internal" href="../_as_gen/matplotlib.patches.Polygon.html#matplotlib.patches.Polygon" title="matplotlib.patches.Polygon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Polygon</span></code></a> drawn as an artist. This ensures it will always be
drawn after (i.e., on top of) all artists, consistent with Spines on normal
Axes.</p>
</section>
<section id="colorbar-dividers-changes">
<h3><code class="docutils literal notranslate"><span class="pre">Colorbar.dividers</span></code> changes<a class="headerlink" href="#colorbar-dividers-changes" title="Permalink to this heading">#</a></h3>
<p>This attribute is now always a <a class="reference internal" href="../collections_api.html#matplotlib.collections.LineCollection" title="matplotlib.collections.LineCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LineCollection</span></code></a> -- an empty one if
<code class="docutils literal notranslate"><span class="pre">drawedges</span></code> is <em>False</em>. Its default colors and linewidth
(<code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=axes.edgecolor#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["axes.edgecolor"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'black'</span></code>), <code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=axes.linewidth#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["axes.linewidth"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">0.8</span></code>)) are now resolved at instantiation
time, not at draw time.</p>
</section>
<section id="raise-or-warn-on-registering-a-colormap-twice">
<h3>Raise or warn on registering a colormap twice<a class="headerlink" href="#raise-or-warn-on-registering-a-colormap-twice" title="Permalink to this heading">#</a></h3>
<p>When using <a class="reference internal" href="../cm_api.html#matplotlib.cm.register_cmap" title="matplotlib.cm.register_cmap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.cm.register_cmap</span></code></a> to register a user provided or
third-party colormap it will now raise a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a> if trying to over-write
one of the built in colormaps and warn if trying to over write a user
registered colormap. This may raise for user-registered colormaps in the
future.</p>
</section>
<section id="consecutive-rasterized-draws-now-merged">
<h3>Consecutive rasterized draws now merged<a class="headerlink" href="#consecutive-rasterized-draws-now-merged" title="Permalink to this heading">#</a></h3>
<p>Tracking of depth of raster draws has moved from
<a class="reference internal" href="../backend_mixed_api.html#matplotlib.backends.backend_mixed.MixedModeRenderer.start_rasterizing" title="matplotlib.backends.backend_mixed.MixedModeRenderer.start_rasterizing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_mixed.MixedModeRenderer.start_rasterizing</span></code></a> and
<a class="reference internal" href="../backend_mixed_api.html#matplotlib.backends.backend_mixed.MixedModeRenderer.stop_rasterizing" title="matplotlib.backends.backend_mixed.MixedModeRenderer.stop_rasterizing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_mixed.MixedModeRenderer.stop_rasterizing</span></code></a> into
<a class="reference internal" href="../_as_gen/matplotlib.artist.allow_rasterization.html#matplotlib.artist.allow_rasterization" title="matplotlib.artist.allow_rasterization"><code class="xref py py-obj docutils literal notranslate"><span class="pre">artist.allow_rasterization</span></code></a>. This means the start and stop functions are only
called when the rasterization actually needs to be started and stopped.</p>
<p>The output of vector backends will change in the case that rasterized elements
are merged. This should not change the appearance of outputs.</p>
<p>The renders in 3rd party backends are now expected to have
<code class="docutils literal notranslate"><span class="pre">self._raster_depth</span></code> and <code class="docutils literal notranslate"><span class="pre">self._rasterizing</span></code> initialized to <code class="docutils literal notranslate"><span class="pre">0</span></code> and
<em>False</em> respectively.</p>
</section>
<section id="consistent-behavior-of-draw-if-interactive-across-backends">
<h3>Consistent behavior of <code class="docutils literal notranslate"><span class="pre">draw_if_interactive()</span></code> across backends<a class="headerlink" href="#consistent-behavior-of-draw-if-interactive-across-backends" title="Permalink to this heading">#</a></h3>
<p><a class="reference internal" href="../_as_gen/matplotlib.pyplot.draw_if_interactive.html#matplotlib.pyplot.draw_if_interactive" title="matplotlib.pyplot.draw_if_interactive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.draw_if_interactive</span></code></a> no longer shows the window (if it was previously
unshown) on the Tk and nbAgg backends, consistently with all other backends.</p>
</section>
<section id="the-artist-property-rasterized-cannot-be-none-anymore">
<h3>The Artist property <em>rasterized</em> cannot be <em>None</em> anymore<a class="headerlink" href="#the-artist-property-rasterized-cannot-be-none-anymore" title="Permalink to this heading">#</a></h3>
<p>It is now a boolean only. Before the default was <em>None</em> and
<a class="reference internal" href="../_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist.set_rasterized</span></code></a> was documented to accept <em>None</em>. However, <em>None</em> did
not have a special meaning and was treated as <em>False</em>.</p>
</section>
<section id="canvas-s-callback-registry-now-stored-on-figure">
<h3>Canvas's callback registry now stored on Figure<a class="headerlink" href="#canvas-s-callback-registry-now-stored-on-figure" title="Permalink to this heading">#</a></h3>
<p>The canonical location of the <a class="reference internal" href="../cbook_api.html#matplotlib.cbook.CallbackRegistry" title="matplotlib.cbook.CallbackRegistry"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CallbackRegistry</span></code></a> used to handle
Figure/Canvas events has been moved from the Canvas to the Figure. This change
should be transparent to almost all users, however if you are swapping
switching the Figure out from on top of a Canvas or visa versa you may see a
change in behavior.</p>
</section>
<section id="harmonized-key-event-data-across-backends">
<h3>Harmonized key event data across backends<a class="headerlink" href="#harmonized-key-event-data-across-backends" title="Permalink to this heading">#</a></h3>
<p>The different backends with key translation support, now handle "Shift" as a
sometimes modifier, where the <code class="docutils literal notranslate"><span class="pre">'shift+'</span></code> prefix won't be added if a key
translation was made.</p>
<p>In the Qt5 backend, the <code class="docutils literal notranslate"><span class="pre">matplotlib.backends.backend_qt5.SPECIAL_KEYS</span></code>
dictionary contains keys that do <em>not</em> return their unicode name instead they
have manually specified names. The name for <code class="docutils literal notranslate"><span class="pre">QtCore.Qt.Key_Meta</span></code> has changed
to <code class="docutils literal notranslate"><span class="pre">'meta'</span></code> to be consistent with the other GUI backends.</p>
<p>The WebAgg backend now handles key translations correctly on non-US keyboard
layouts.</p>
<p>In the GTK and Tk backends, the handling of non-ASCII keypresses (as reported
in the KeyEvent passed to <code class="docutils literal notranslate"><span class="pre">key_press_event</span></code>-handlers) now correctly reports
Unicode characters (e.g., €), and better respects NumLock on the numpad.</p>
<p>In the GTK and Tk backends, the following key names have changed; the new names
are consistent with those reported by the Qt backends:</p>
<ul class="simple">
<li><p>The "Break/Pause" key (keysym 0xff13) is now reported as <code class="docutils literal notranslate"><span class="pre">"pause"</span></code> instead
of <code class="docutils literal notranslate"><span class="pre">"break"</span></code> (this is also consistent with the X key name).</p></li>
<li><p>The numpad "delete" key is now reported as <code class="docutils literal notranslate"><span class="pre">"delete"</span></code> instead of <code class="docutils literal notranslate"><span class="pre">"dec"</span></code>.</p></li>
</ul>
</section>
<section id="webagg-backend-no-longer-reports-a-middle-click-as-a-right-click">
<h3>WebAgg backend no longer reports a middle click as a right click<a class="headerlink" href="#webagg-backend-no-longer-reports-a-middle-click-as-a-right-click" title="Permalink to this heading">#</a></h3>
<p>Previously when using the WebAgg backend the event passed to a callback by
<code class="docutils literal notranslate"><span class="pre">fig.canvas.mpl_connect('mouse_button_event',</span> <span class="pre">callback)</span></code> on a middle click
would report <a class="reference internal" href="../backend_bases_api.html#matplotlib.backend_bases.MouseButton.RIGHT" title="matplotlib.backend_bases.MouseButton.RIGHT"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseButton.RIGHT</span></code></a> instead of <a class="reference internal" href="../backend_bases_api.html#matplotlib.backend_bases.MouseButton.MIDDLE" title="matplotlib.backend_bases.MouseButton.MIDDLE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MouseButton.MIDDLE</span></code></a>.</p>
</section>
<section id="id-attribute-of-xml-tags-in-svg-files-now-based-on-sha256-rather-than-md5">
<h3>ID attribute of XML tags in SVG files now based on SHA256 rather than MD5<a class="headerlink" href="#id-attribute-of-xml-tags-in-svg-files-now-based-on-sha256-rather-than-md5" title="Permalink to this heading">#</a></h3>
<p>Matplotlib generates unique ID attributes for various tags in SVG files.
Matplotlib previously generated these unique IDs using the first 10 characters
of an MD5 hash. The MD5 hashing algorithm is not available in Python on systems
with Federal Information Processing Standards (FIPS) enabled. Matplotlib now
uses the first 10 characters of an SHA256 hash instead. SVG files that would
otherwise match those saved with earlier versions of matplotlib, will have
different ID attributes.</p>
</section>
<section id="rendererps-set-font-is-no-longer-a-no-op-in-afm-mode">
<h3><code class="docutils literal notranslate"><span class="pre">RendererPS.set_font</span></code> is no longer a no-op in AFM mode<a class="headerlink" href="#rendererps-set-font-is-no-longer-a-no-op-in-afm-mode" title="Permalink to this heading">#</a></h3>
<p><a class="reference internal" href="../backend_ps_api.html#matplotlib.backends.backend_ps.RendererPS.set_font" title="matplotlib.backends.backend_ps.RendererPS.set_font"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RendererPS.set_font</span></code></a> now sets the current PostScript font in all cases.</p>
</section>
<section id="autoscaling-in-axes3d">
<h3>Autoscaling in Axes3D<a class="headerlink" href="#autoscaling-in-axes3d" title="Permalink to this heading">#</a></h3>
<p>In Matplotlib 3.2.0, autoscaling was made lazier for 2D Axes, i.e., limits
would only be recomputed when actually rendering the canvas, or when the user
queries the Axes limits. This performance improvement is now extended to
<a class="reference internal" href="../toolkits/mplot3d/axes3d.html#mpl_toolkits.mplot3d.axes3d.Axes3D" title="mpl_toolkits.mplot3d.axes3d.Axes3D"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes3D</span></code></a>. This also fixes some issues with autoscaling being triggered
unexpectedly in Axes3D.</p>
<p>Please see <a class="reference internal" href="api_changes_3.2.0.html#api-changes-3-2-0-autoscaling"><span class="std std-ref">the API change for 2D Axes</span></a>
for further details.</p>
</section>
<section id="axes3d-automatically-adding-itself-to-figure-is-deprecated">
<h3>Axes3D automatically adding itself to Figure is deprecated<a class="headerlink" href="#axes3d-automatically-adding-itself-to-figure-is-deprecated" title="Permalink to this heading">#</a></h3>
<p>New <a class="reference internal" href="../toolkits/mplot3d/axes3d.html#mpl_toolkits.mplot3d.axes3d.Axes3D" title="mpl_toolkits.mplot3d.axes3d.Axes3D"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes3D</span></code></a> objects previously added themselves to figures when they were
created, unlike all other Axes classes, which lead to them being added twice if
<code class="docutils literal notranslate"><span class="pre">fig.add_subplot(111,</span> <span class="pre">projection='3d')</span></code> was called.</p>
<p>This behavior is now deprecated and will warn. The new keyword argument
<em>auto_add_to_figure</em> controls the behavior and can be used to suppress the
warning. The default value will change to <em>False</em> in Matplotlib 3.5, and any
non-<em>False</em> value will be an error in Matplotlib 3.6.</p>
<p>In the future, <a class="reference internal" href="../toolkits/mplot3d/axes3d.html#mpl_toolkits.mplot3d.axes3d.Axes3D" title="mpl_toolkits.mplot3d.axes3d.Axes3D"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes3D</span></code></a> will need to be explicitly added to the figure</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">fig</span> <span class="o">=</span> <span class="n">Figure</span><span class="p">()</span>
<span class="c1"># create Axes3D</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">Axes3d</span><span class="p">(</span><span class="n">fig</span><span class="p">)</span>
<span class="c1"># add to Figure</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">ax</span><span class="p">)</span>
</pre></div>
</div>
<p>as needs to be done for other <a class="reference internal" href="../_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes.Axes</span></code></a> sub-classes. Or, a 3D projection can
be made via:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="s1">'3d'</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="mplot3d-art3d-get-dir-vector-always-returns-numpy-arrays">
<h3><code class="docutils literal notranslate"><span class="pre">mplot3d.art3d.get_dir_vector</span></code> always returns NumPy arrays<a class="headerlink" href="#mplot3d-art3d-get-dir-vector-always-returns-numpy-arrays" title="Permalink to this heading">#</a></h3>
<p>For consistency, <a class="reference internal" href="../_as_gen/mpl_toolkits.mplot3d.art3d.get_dir_vector.html#mpl_toolkits.mplot3d.art3d.get_dir_vector" title="mpl_toolkits.mplot3d.art3d.get_dir_vector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_dir_vector</span></code></a> now always returns NumPy
arrays, even if the input is a 3-element iterable.</p>
</section>
<section id="changed-cursive-and-fantasy-font-definitions">
<h3>Changed cursive and fantasy font definitions<a class="headerlink" href="#changed-cursive-and-fantasy-font-definitions" title="Permalink to this heading">#</a></h3>
<p>The Comic Sans and Comic Neue fonts were moved from the default
<code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=font.fantasy#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["font.fantasy"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['Chicago',</span> <span class="pre">'Charcoal',</span> <span class="pre">'Impact',</span> <span class="pre">'Western',</span> <span class="pre">'Humor</span> <span class="pre">Sans',</span> <span class="pre">'xkcd',</span> <span class="pre">'fantasy']</span></code>) list to the default <code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=font.cursive#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["font.cursive"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['Apple</span> <span class="pre">Chancery',</span> <span class="pre">'Textile',</span> <span class="pre">'Zapf</span> <span class="pre">Chancery',</span> <span class="pre">'Sand',</span> <span class="pre">'Script</span> <span class="pre">MT',</span> <span class="pre">'Felipa',</span> <span class="pre">'Comic</span> <span class="pre">Neue',</span> <span class="pre">'Comic</span> <span class="pre">Sans</span> <span class="pre">MS',</span> <span class="pre">'cursive']</span></code>) setting, in
accordance with the CSS font families <a class="reference external" href="https://www.w3.org/Style/Examples/007/fonts.en.html">example</a> and in order to provide a
cursive font present in Microsoft's Core Fonts set.</p>
</section>
<section id="docstring-substitution-now-always-dedents-docstrings-before-string-interpolation">
<h3>docstring.Substitution now always dedents docstrings before string interpolation<a class="headerlink" href="#docstring-substitution-now-always-dedents-docstrings-before-string-interpolation" title="Permalink to this heading">#</a></h3>
</section>
</section>
<section id="deprecations">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Deprecations</a><a class="headerlink" href="#deprecations" title="Permalink to this heading">#</a></h2>
<section id="extra-parameters-to-axes-constructor">
<h3>Extra parameters to Axes constructor<a class="headerlink" href="#extra-parameters-to-axes-constructor" title="Permalink to this heading">#</a></h3>
<p>Parameters of the Axes constructor other than <em>fig</em> and <em>rect</em> will become
keyword-only in a future version.</p>
</section>
<section id="pyplot-gca-and-figure-gca-keyword-arguments">
<h3><code class="docutils literal notranslate"><span class="pre">pyplot.gca</span></code> and <code class="docutils literal notranslate"><span class="pre">Figure.gca</span></code> keyword arguments<a class="headerlink" href="#pyplot-gca-and-figure-gca-keyword-arguments" title="Permalink to this heading">#</a></h3>
<p>Passing keyword arguments to <a class="reference internal" href="../_as_gen/matplotlib.pyplot.gca.html#matplotlib.pyplot.gca" title="matplotlib.pyplot.gca"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.gca</span></code></a> or <a class="reference internal" href="../figure_api.html#matplotlib.figure.Figure.gca" title="matplotlib.figure.Figure.gca"><code class="xref py py-obj docutils literal notranslate"><span class="pre">figure.Figure.gca</span></code></a> will not be
supported in a future release.</p>
</section>
<section id="axis-cla-radialaxis-cla-thetaaxis-cla-and-spine-cla">
<h3><code class="docutils literal notranslate"><span class="pre">Axis.cla</span></code>, <code class="docutils literal notranslate"><span class="pre">RadialAxis.cla</span></code>, <code class="docutils literal notranslate"><span class="pre">ThetaAxis.cla</span></code> and <code class="docutils literal notranslate"><span class="pre">Spine.cla</span></code><a class="headerlink" href="#axis-cla-radialaxis-cla-thetaaxis-cla-and-spine-cla" title="Permalink to this heading">#</a></h3>
<p>These methods are deprecated in favor of the respective <code class="docutils literal notranslate"><span class="pre">clear()</span></code> methods.</p>
</section>
<section id="invalid-hatch-pattern-characters-are-no-longer-ignored">
<h3>Invalid hatch pattern characters are no longer ignored<a class="headerlink" href="#invalid-hatch-pattern-characters-are-no-longer-ignored" title="Permalink to this heading">#</a></h3>
<p>When specifying hatching patterns, characters that are not recognized will
raise a deprecation warning. In the future, this will become a hard error.</p>
</section>
<section id="imread-reading-from-urls">
<h3><code class="docutils literal notranslate"><span class="pre">imread</span></code> reading from URLs<a class="headerlink" href="#imread-reading-from-urls" title="Permalink to this heading">#</a></h3>
<p>Passing a URL to <a class="reference internal" href="../_as_gen/matplotlib.pyplot.imread.html#matplotlib.pyplot.imread" title="matplotlib.pyplot.imread"><code class="xref py py-obj docutils literal notranslate"><span class="pre">imread()</span></code></a> is deprecated. Please open the URL for
reading and directly use the Pillow API
(<code class="docutils literal notranslate"><span class="pre">PIL.Image.open(urllib.request.urlopen(url))</span></code>, or
<code class="docutils literal notranslate"><span class="pre">PIL.Image.open(io.BytesIO(requests.get(url).content))</span></code>) instead.</p>
</section>
<section id="subplot-related-attributes-and-methods">
<h3>Subplot-related attributes and methods<a class="headerlink" href="#subplot-related-attributes-and-methods" title="Permalink to this heading">#</a></h3>
<p>Some <code class="docutils literal notranslate"><span class="pre">SubplotBase</span></code> methods and attributes have been deprecated and/or moved
to <a class="reference internal" href="../_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec" title="matplotlib.gridspec.SubplotSpec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubplotSpec</span></code></a>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">get_geometry</span></code> (use <code class="docutils literal notranslate"><span class="pre">SubplotBase.get_subplotspec</span></code> instead),</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">change_geometry</span></code> (use <code class="docutils literal notranslate"><span class="pre">SubplotBase.set_subplotspec</span></code> instead),</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">is_first_row</span></code>, <code class="docutils literal notranslate"><span class="pre">is_last_row</span></code>, <code class="docutils literal notranslate"><span class="pre">is_first_col</span></code>, <code class="docutils literal notranslate"><span class="pre">is_last_col</span></code> (use the
corresponding methods on the <a class="reference internal" href="../_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec" title="matplotlib.gridspec.SubplotSpec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubplotSpec</span></code></a> instance instead),</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">update_params</span></code> (now a no-op),</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">figbox</span></code> (use <code class="docutils literal notranslate"><span class="pre">ax.get_subplotspec().get_geometry(ax.figure)</span></code> instead to
recompute the geometry, or <code class="docutils literal notranslate"><span class="pre">ax.get_position()</span></code> to read its current value),</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">numRows</span></code>, <code class="docutils literal notranslate"><span class="pre">numCols</span></code> (use the <code class="docutils literal notranslate"><span class="pre">nrows</span></code> and <code class="docutils literal notranslate"><span class="pre">ncols</span></code> attribute on the
<a class="reference internal" href="../_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec" title="matplotlib.gridspec.GridSpec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GridSpec</span></code></a> instead).</p></li>
</ul>
<p>Likewise, the <code class="docutils literal notranslate"><span class="pre">get_geometry</span></code>, <code class="docutils literal notranslate"><span class="pre">change_geometry</span></code>, <code class="docutils literal notranslate"><span class="pre">update_params</span></code>, and
<code class="docutils literal notranslate"><span class="pre">figbox</span></code> methods/attributes of <a class="reference internal" href="../_as_gen/mpl_toolkits.axes_grid1.axes_divider.SubplotDivider.html#mpl_toolkits.axes_grid1.axes_divider.SubplotDivider" title="mpl_toolkits.axes_grid1.axes_divider.SubplotDivider"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubplotDivider</span></code></a> have been deprecated, with
similar replacements.</p>
</section>
<section id="is-url-and-url-regex">
<h3><code class="docutils literal notranslate"><span class="pre">is_url</span></code> and <code class="docutils literal notranslate"><span class="pre">URL_REGEX</span></code><a class="headerlink" href="#is-url-and-url-regex" title="Permalink to this heading">#</a></h3>
<p>... are deprecated. (They were previously defined in the toplevel
<a class="reference internal" href="../../index.html#module-matplotlib" title="matplotlib"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib</span></code></a> module.)</p>
</section>
<section id="matplotlib-style-core-deprecations">
<h3><code class="docutils literal notranslate"><span class="pre">matplotlib.style.core</span></code> deprecations<a class="headerlink" href="#matplotlib-style-core-deprecations" title="Permalink to this heading">#</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">STYLE_FILE_PATTERN</span></code>, <code class="docutils literal notranslate"><span class="pre">load_base_library</span></code>, and <code class="docutils literal notranslate"><span class="pre">iter_user_libraries</span></code> are
deprecated.</p>
</section>
<section id="dpi-cor-property-of-fancyarrowpatch">
<h3><code class="docutils literal notranslate"><span class="pre">dpi_cor</span></code> property of <a class="reference internal" href="../_as_gen/matplotlib.patches.FancyArrowPatch.html#matplotlib.patches.FancyArrowPatch" title="matplotlib.patches.FancyArrowPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FancyArrowPatch</span></code></a><a class="headerlink" href="#dpi-cor-property-of-fancyarrowpatch" title="Permalink to this heading">#</a></h3>
<p>This parameter is considered internal and deprecated.</p>
</section>
<section id="passing-boxstyle-custom-bbox-transmuter-to-fancybboxpatch">
<h3>Passing <code class="docutils literal notranslate"><span class="pre">boxstyle="custom",</span> <span class="pre">bbox_transmuter=...</span></code> to <code class="docutils literal notranslate"><span class="pre">FancyBboxPatch</span></code><a class="headerlink" href="#passing-boxstyle-custom-bbox-transmuter-to-fancybboxpatch" title="Permalink to this heading">#</a></h3>
<p>In order to use a custom boxstyle, directly pass it as the <em>boxstyle</em> argument