forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi_changes.html
More file actions
1439 lines (1407 loc) · 172 KB
/
Copy pathapi_changes.html
File metadata and controls
1439 lines (1407 loc) · 172 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>API Changes — Matplotlib 3.1.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v1"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.1.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 3.1.1 documentation" href="../index.html" />
<link rel="up" title="API Overview" href="index.html" />
<link rel="next" title="Old API Changes" href="api_changes_old.html" />
<link rel="prev" title="API Overview" href="index.html" />
<link rel="canonical" href="https://matplotlib.org/3.1.1/api/api_changes.html" />
</head>
<body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.1.1</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
</ul>
</nav>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="api_changes_old.html" title="Old API Changes"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="API Overview"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li><a href="index.html" accesskey="U">API Overview</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">API Changes</a><ul>
<li><a class="reference internal" href="#api-changes-for-3-1-1">API Changes for 3.1.1</a><ul>
<li><a class="reference internal" href="#behavior-changes">Behavior changes</a><ul>
<li><a class="reference internal" href="#locator-nonsingular-return-order">Locator.nonsingular return order</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#api-changes-for-3-1-0">API Changes for 3.1.0</a><ul>
<li><a class="reference internal" href="#id2">Behavior changes</a><ul>
<li><a class="reference internal" href="#matplotlib-use">Matplotlib.use</a></li>
<li><a class="reference internal" href="#mplot3d-auto-registration">mplot3d auto-registration</a></li>
<li><a class="reference internal" href="#invalid-points-in-pathcollections">Invalid points in PathCollections</a></li>
<li><a class="reference internal" href="#alpha-blending-in-imshow-of-rbga-input">Alpha blending in imshow of RBGA input</a></li>
<li><a class="reference internal" href="#autoscaling">Autoscaling</a></li>
<li><a class="reference internal" href="#log-scaled-axes">Log-scaled axes</a></li>
<li><a class="reference internal" href="#figure-add-subplot-with-no-arguments"><code class="docutils literal notranslate"><span class="pre">Figure.add_subplot</span></code> with no arguments</a></li>
<li><a class="reference internal" href="#bxp-and-rcparams"><code class="docutils literal notranslate"><span class="pre">bxp</span></code> and rcparams</a></li>
<li><a class="reference internal" href="#major-minor-tick-collisions">Major/minor tick collisions</a></li>
<li><a class="reference internal" href="#usetex-support">usetex support</a></li>
<li><a class="reference internal" href="#get-window-extents">get_window_extents</a></li>
<li><a class="reference internal" href="#sankey">Sankey</a></li>
<li><a class="reference internal" href="#fontmanager-scores"><code class="docutils literal notranslate"><span class="pre">FontManager</span></code> scores</a></li>
<li><a class="reference internal" href="#text-alignment">Text alignment</a></li>
<li><a class="reference internal" href="#upper-case-color-strings">Upper case color strings</a></li>
<li><a class="reference internal" href="#degenerate-limits">Degenerate limits</a></li>
<li><a class="reference internal" href="#plot-format-string-parsing"><code class="docutils literal notranslate"><span class="pre">plot</span></code> format string parsing</a></li>
<li><a class="reference internal" href="#htmlwriter">HTMLWriter</a></li>
<li><a class="reference internal" href="#afm-parsing">AFM parsing</a></li>
<li><a class="reference internal" href="#artist-set-keyword-normalisation"><code class="docutils literal notranslate"><span class="pre">Artist.set</span></code> keyword normalisation</a></li>
<li><a class="reference internal" href="#axes-tick-params-argument-checking"><code class="docutils literal notranslate"><span class="pre">Axes.tick_params</span></code> argument checking</a></li>
<li><a class="reference internal" href="#axes-hist-output"><code class="docutils literal notranslate"><span class="pre">Axes.hist</span></code> output</a></li>
<li><a class="reference internal" href="#backend-bases-timer-remove-callback-future-signature-change"><code class="docutils literal notranslate"><span class="pre">backend_bases.Timer.remove_callback</span></code> future signature change</a></li>
<li><a class="reference internal" href="#stemcontainer-performance-increase"><code class="docutils literal notranslate"><span class="pre">StemContainer</span></code> performance increase</a></li>
<li><a class="reference internal" href="#colorbarbase-inheritance"><code class="docutils literal notranslate"><span class="pre">ColorbarBase</span></code> inheritance</a></li>
<li><a class="reference internal" href="#freetype-and-libpng-search-paths">FreeType and libpng search paths</a></li>
<li><a class="reference internal" href="#setting-artist-properties-twice-or-more-in-the-same-call">Setting artist properties twice or more in the same call</a></li>
<li><a class="reference internal" href="#path-code-types">Path code types</a></li>
<li><a class="reference internal" href="#latex-code-in-matplotlibrc-file">LaTeX code in matplotlibrc file</a></li>
<li><a class="reference internal" href="#axes-spy"><code class="docutils literal notranslate"><span class="pre">Axes.spy</span></code></a></li>
<li><a class="reference internal" href="#boxplot-tick-methods">Boxplot tick methods</a></li>
<li><a class="reference internal" href="#mouseevents">MouseEvents</a></li>
<li><a class="reference internal" href="#rgba-buffer-return-type">RGBA buffer return type</a></li>
<li><a class="reference internal" href="#matplotlib-font-manager-win32installedfonts-return-type"><code class="docutils literal notranslate"><span class="pre">matplotlib.font_manager.win32InstalledFonts</span></code> return type</a></li>
<li><a class="reference internal" href="#axes-fmt-xdata-and-axes-fmt-ydata-error-handling"><code class="docutils literal notranslate"><span class="pre">Axes.fmt_xdata</span></code> and <code class="docutils literal notranslate"><span class="pre">Axes.fmt_ydata</span></code> error handling</a></li>
<li><a class="reference internal" href="#deprecation-of-redundant-tick-attributes">Deprecation of redundant <code class="docutils literal notranslate"><span class="pre">Tick</span></code> attributes</a></li>
<li><a class="reference internal" href="#passing-a-line2d-s-drawstyle-together-with-the-linestyle-is-deprecated">Passing a Line2D's drawstyle together with the linestyle is deprecated</a></li>
</ul>
</li>
<li><a class="reference internal" href="#pgi-support-dropped"><code class="docutils literal notranslate"><span class="pre">pgi</span></code> support dropped</a></li>
<li><a class="reference internal" href="#rcparam-changes">rcParam changes</a><ul>
<li><a class="reference internal" href="#removed">Removed</a></li>
<li><a class="reference internal" href="#deprecated">Deprecated</a></li>
</ul>
</li>
<li><a class="reference internal" href="#exception-changes">Exception changes</a></li>
<li><a class="reference internal" href="#removals">Removals</a><ul>
<li><a class="reference internal" href="#classes-and-methods">Classes and methods</a></li>
<li><a class="reference internal" href="#arguments">Arguments</a></li>
<li><a class="reference internal" href="#other">Other</a></li>
</ul>
</li>
<li><a class="reference internal" href="#matplotlib-mlab-removals"><code class="docutils literal notranslate"><span class="pre">matplotlib.mlab</span></code> removals</a></li>
<li><a class="reference internal" href="#matplotlib-pylab-removals"><code class="docutils literal notranslate"><span class="pre">matplotlib.pylab</span></code> removals</a></li>
<li><a class="reference internal" href="#mplot3d-changes">mplot3d changes</a><ul>
<li><a class="reference internal" href="#voxel-shading">Voxel shading</a></li>
<li><a class="reference internal" href="#equal-aspect-axes-disabled">Equal aspect axes disabled</a></li>
<li><a class="reference internal" href="#poly3dcollection-set-zsort"><code class="docutils literal notranslate"><span class="pre">Poly3DCollection.set_zsort</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#testing">Testing</a></li>
<li><a class="reference internal" href="#dependency-changes">Dependency changes</a><ul>
<li><a class="reference internal" href="#numpy">numpy</a></li>
<li><a class="reference internal" href="#ghostscript">ghostscript</a></li>
</ul>
</li>
<li><a class="reference internal" href="#mathtext-changes">Mathtext changes</a><ul>
<li><a class="reference internal" href="#deprecations">Deprecations</a></li>
</ul>
</li>
<li><a class="reference internal" href="#signature-deprecations">Signature deprecations</a></li>
<li><a class="reference internal" href="#changes-in-parameter-names">Changes in parameter names</a></li>
<li><a class="reference internal" href="#class-method-attribute-deprecations">Class/method/attribute deprecations</a><ul>
<li><a class="reference internal" href="#internal-helper-functions">Internal Helper Functions</a></li>
<li><a class="reference internal" href="#font-handling">Font Handling</a></li>
<li><a class="reference internal" href="#date-related-functions">Date related functions</a></li>
<li><a class="reference internal" href="#axes3d">Axes3D</a></li>
<li><a class="reference internal" href="#id3">Testing</a></li>
<li><a class="reference internal" href="#quiver">Quiver</a></li>
<li><a class="reference internal" href="#gui-backend-details">GUI / backend details</a></li>
<li><a class="reference internal" href="#transforms-scales">Transforms / scales</a></li>
<li><a class="reference internal" href="#locators-formatters">Locators / Formatters</a></li>
<li><a class="reference internal" href="#path-tools">Path tools</a></li>
<li><a class="reference internal" href="#text">Text</a></li>
<li><a class="reference internal" href="#unused-attributes">Unused attributes</a></li>
<li><a class="reference internal" href="#sphinx-extensions">Sphinx extensions</a></li>
<li><a class="reference internal" href="#environmental-variables">Environmental Variables</a></li>
<li><a class="reference internal" href="#axis">Axis</a></li>
</ul>
</li>
<li><a class="reference internal" href="#undeprecations">Undeprecations</a></li>
<li><a class="reference internal" href="#new-features">New features</a><ul>
<li><a class="reference internal" href="#text-now-has-a-c-alias-for-the-color-property"><code class="docutils literal notranslate"><span class="pre">Text</span></code> now has a <code class="docutils literal notranslate"><span class="pre">c</span></code> alias for the <code class="docutils literal notranslate"><span class="pre">color</span></code> property</a></li>
<li><a class="reference internal" href="#cn-colors-now-support-n-10"><code class="docutils literal notranslate"><span class="pre">Cn</span></code> colors now support <code class="docutils literal notranslate"><span class="pre">n>=10</span></code></a></li>
<li><a class="reference internal" href="#new-formatter-format-ticks-method">New <code class="docutils literal notranslate"><span class="pre">Formatter.format_ticks</span></code> method</a></li>
<li><a class="reference internal" href="#added-support-for-rgb-a-images-in-pcolorfast">Added support for RGB(A) images in pcolorfast</a></li>
</ul>
</li>
<li><a class="reference internal" href="#invalid-inputs">Invalid inputs</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">API Overview</a></li>
<li>Next: <a href="api_changes_old.html" title="next chapter">Old API Changes</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/api_changes.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="api-changes">
<h1>API Changes<a class="headerlink" href="#api-changes" title="Permalink to this headline">¶</a></h1>
<p>If updating Matplotlib breaks your scripts, this list may help you figure out
what caused the breakage and how to fix it by updating your code.</p>
<p>For API changes in older versions see</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_changes_old.html">Old API Changes</a></li>
</ul>
</div>
<p>Changes for the latest version are listed below. For new features that were
added to Matplotlib, see <a class="reference internal" href="../users/whats_new.html#whats-new"><span class="std std-ref">Whats New</span></a>.</p>
<div class="section" id="api-changes-for-3-1-1">
<h2>API Changes for 3.1.1<a class="headerlink" href="#api-changes-for-3-1-1" title="Permalink to this headline">¶</a></h2>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#behavior-changes" id="id4">Behavior changes</a></li>
</ul>
</div>
<div class="section" id="behavior-changes">
<h3><a class="toc-backref" href="#id4">Behavior changes</a><a class="headerlink" href="#behavior-changes" title="Permalink to this headline">¶</a></h3>
<div class="section" id="locator-nonsingular-return-order">
<h4>Locator.nonsingular return order<a class="headerlink" href="#locator-nonsingular-return-order" title="Permalink to this headline">¶</a></h4>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Locator.nonsingular</span></code> (introduced in mpl 3.1) now returns a range <code class="docutils literal notranslate"><span class="pre">v0,</span> <span class="pre">v1</span></code>
with <code class="docutils literal notranslate"><span class="pre">v0</span> <span class="pre"><=</span> <span class="pre">v1</span></code>. This behavior is consistent with the implementation of
<code class="docutils literal notranslate"><span class="pre">nonsingular</span></code> by the <code class="xref py py-obj docutils literal notranslate"><span class="pre">LogLocator</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">LogitLocator</span></code> subclasses.</p>
</div>
</div>
</div>
<div class="section" id="api-changes-for-3-1-0">
<h2>API Changes for 3.1.0<a class="headerlink" href="#api-changes-for-3-1-0" title="Permalink to this headline">¶</a></h2>
<div class="contents local topic" id="id1">
<ul class="simple">
<li><a class="reference internal" href="#id2" id="id5">Behavior changes</a></li>
<li><a class="reference internal" href="#pgi-support-dropped" id="id6"><code class="docutils literal notranslate"><span class="pre">pgi</span></code> support dropped</a></li>
<li><a class="reference internal" href="#rcparam-changes" id="id7">rcParam changes</a></li>
<li><a class="reference internal" href="#exception-changes" id="id8">Exception changes</a></li>
<li><a class="reference internal" href="#removals" id="id9">Removals</a></li>
<li><a class="reference internal" href="#matplotlib-mlab-removals" id="id10"><a class="reference internal" href="mlab_api.html#module-matplotlib.mlab" title="matplotlib.mlab"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.mlab</span></code></a> removals</a></li>
<li><a class="reference internal" href="#matplotlib-pylab-removals" id="id11"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.pylab</span></code> removals</a></li>
<li><a class="reference internal" href="#mplot3d-changes" id="id12">mplot3d changes</a></li>
<li><a class="reference internal" href="#testing" id="id13">Testing</a></li>
<li><a class="reference internal" href="#dependency-changes" id="id14">Dependency changes</a></li>
<li><a class="reference internal" href="#mathtext-changes" id="id15">Mathtext changes</a></li>
<li><a class="reference internal" href="#signature-deprecations" id="id16">Signature deprecations</a></li>
<li><a class="reference internal" href="#changes-in-parameter-names" id="id17">Changes in parameter names</a></li>
<li><a class="reference internal" href="#class-method-attribute-deprecations" id="id18">Class/method/attribute deprecations</a></li>
<li><a class="reference internal" href="#undeprecations" id="id19">Undeprecations</a></li>
<li><a class="reference internal" href="#new-features" id="id20">New features</a></li>
<li><a class="reference internal" href="#invalid-inputs" id="id21">Invalid inputs</a></li>
</ul>
</div>
<div class="section" id="id2">
<h3><a class="toc-backref" href="#id5">Behavior changes</a><a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<div class="section" id="matplotlib-use">
<h4>Matplotlib.use<a class="headerlink" href="#matplotlib-use" title="Permalink to this headline">¶</a></h4>
<p>Switching backends via <a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.use" title="matplotlib.use"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.use</span></code></a> is now allowed by default,
regardless of whether <a class="reference internal" href="_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pyplot</span></code></a> has been imported. If the user
tries to switch from an already-started interactive backend to a different
interactive backend, an <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ImportError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ImportError</span></code></a> will be raised.</p>
</div>
<div class="section" id="mplot3d-auto-registration">
<h4>mplot3d auto-registration<a class="headerlink" href="#mplot3d-auto-registration" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="toolkits/mplot3d.html#module-mpl_toolkits.mplot3d" title="mpl_toolkits.mplot3d"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d</span></code></a> is always registered by default now. It is no
longer necessary to import mplot3d to create 3d axes with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">,</span> <span class="n">projection</span><span class="o">=</span><span class="s2">"3d"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="invalid-points-in-pathcollections">
<h4>Invalid points in PathCollections<a class="headerlink" href="#invalid-points-in-pathcollections" title="Permalink to this headline">¶</a></h4>
<p>PathCollections created with <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.scatter.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scatter</span></code></a> now keep track of invalid points.
Previously, points with nonfinite (infinite or nan) coordinates would not be
included in the offsets (as returned by <code class="xref py py-obj docutils literal notranslate"><span class="pre">PathCollection.get_offsets</span></code>) of a
<code class="xref py py-obj docutils literal notranslate"><span class="pre">PathCollection</span></code> created by <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.scatter.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scatter</span></code></a>, and points with nonfinite values
(as specified by the <em>c</em> kwarg) would not be included in the array (as returned
by <code class="xref py py-obj docutils literal notranslate"><span class="pre">PathCollection.get_array</span></code>)</p>
<p>Such points are now included, but masked out by returning a masked array.</p>
<p>If the <em>plotnonfinite</em> kwarg to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.scatter.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scatter</span></code></a> is set, then points
with nonfinite values are plotted using the bad color of the
<a class="reference internal" href="collections_api.html#matplotlib.collections.PathCollection" title="matplotlib.collections.PathCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">collections.PathCollection</span></code></a>'s colormap (as set by
<a class="reference internal" href="_as_gen/matplotlib.colors.Colormap.html#matplotlib.colors.Colormap.set_bad" title="matplotlib.colors.Colormap.set_bad"><code class="xref py py-meth docutils literal notranslate"><span class="pre">colors.Colormap.set_bad()</span></code></a>).</p>
</div>
<div class="section" id="alpha-blending-in-imshow-of-rbga-input">
<h4>Alpha blending in imshow of RBGA input<a class="headerlink" href="#alpha-blending-in-imshow-of-rbga-input" title="Permalink to this headline">¶</a></h4>
<p>The alpha-channel of RBGA images is now re-sampled independently of
RGB channels. While this is a bug fix, it does change the output and
may result in some down-stream image comparison tests to fail.</p>
</div>
<div class="section" id="autoscaling">
<h4>Autoscaling<a class="headerlink" href="#autoscaling" title="Permalink to this headline">¶</a></h4>
<p>On log-axes where a single value is plotted at a "full" decade (1, 10, 100,
etc.), the autoscaling now expands the axis symmetrically around that point,
instead of adding a decade only to the right.</p>
</div>
<div class="section" id="log-scaled-axes">
<h4>Log-scaled axes<a class="headerlink" href="#log-scaled-axes" title="Permalink to this headline">¶</a></h4>
<p>When the default <code class="xref py py-obj docutils literal notranslate"><span class="pre">LogLocator</span></code> would generate no ticks for an axis (e.g., an
axis with limits from 0.31 to 0.39) or only a single tick, it now instead falls
back on the linear <code class="xref py py-obj docutils literal notranslate"><span class="pre">AutoLocator</span></code> to pick reasonable tick positions.</p>
</div>
<div class="section" id="figure-add-subplot-with-no-arguments">
<h4><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.add_subplot" title="matplotlib.figure.Figure.add_subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_subplot</span></code></a> with no arguments<a class="headerlink" href="#figure-add-subplot-with-no-arguments" title="Permalink to this headline">¶</a></h4>
<p>Calling <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.add_subplot" title="matplotlib.figure.Figure.add_subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_subplot()</span></code></a> with no positional arguments used to do
nothing; this now is equivalent to calling <code class="docutils literal notranslate"><span class="pre">add_subplot(111)</span></code> instead.</p>
</div>
<div class="section" id="bxp-and-rcparams">
<h4><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bxp.html#matplotlib.axes.Axes.bxp" title="matplotlib.axes.Axes.bxp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bxp</span></code></a> and rcparams<a class="headerlink" href="#bxp-and-rcparams" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bxp.html#matplotlib.axes.Axes.bxp" title="matplotlib.axes.Axes.bxp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bxp</span></code></a> now respects <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=boxplot.boxprops.linewidth#a-sample-matplotlibrc-file"><span class="pre">rcParams["boxplot.boxprops.linewidth"]</span> <span class="pre">=</span> <span class="pre">1.0</span></a></code> even when
<em>patch_artist</em> is set.
Previously, when the <em>patch_artist</em> parameter was set, <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bxp.html#matplotlib.axes.Axes.bxp" title="matplotlib.axes.Axes.bxp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bxp</span></code></a> would ignore
<code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=boxplot.boxprops.linewidth#a-sample-matplotlibrc-file"><span class="pre">rcParams["boxplot.boxprops.linewidth"]</span> <span class="pre">=</span> <span class="pre">1.0</span></a></code>. This was an oversight -- in particular,
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.boxplot.html#matplotlib.axes.Axes.boxplot" title="matplotlib.axes.Axes.boxplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">boxplot</span></code></a> did not ignore it.</p>
</div>
<div class="section" id="major-minor-tick-collisions">
<h4>Major/minor tick collisions<a class="headerlink" href="#major-minor-tick-collisions" title="Permalink to this headline">¶</a></h4>
<p>Minor ticks that collide with major ticks are now hidden by default.
Previously, certain locator classes (<a class="reference internal" href="ticker_api.html#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LogLocator</span></code></a>,
<a class="reference internal" href="ticker_api.html#matplotlib.ticker.AutoMinorLocator" title="matplotlib.ticker.AutoMinorLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AutoMinorLocator</span></code></a>) contained custom logic to avoid emitting
tick locations that collided with major ticks when they were used as
minor locators. This logic has now moved to the <a class="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a> class,
and is used regardless of the locator class. You can control this
behavior via the <code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_overlaping_locs</span></code> attribute on
<a class="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a>.</p>
<p>If you were relying on both the major and minor tick labels to appear
on the same tick, you may need to update your code. For example, the
following snippet</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">matplotlib.dates</span> <span class="k">as</span> <span class="nn">mdates</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="s2">"2018-11-03"</span><span class="p">,</span> <span class="s2">"2018-11-06"</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="s2">"datetime64"</span><span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">))</span>
<span class="n">fig</span><span class="p">,</span> <span class="n">ax</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="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set</span><span class="p">(</span>
<span class="n">major_locator</span><span class="o">=</span><span class="n">mdates</span><span class="o">.</span><span class="n">DayLocator</span><span class="p">(),</span>
<span class="n">major_formatter</span><span class="o">=</span><span class="n">mdates</span><span class="o">.</span><span class="n">DateFormatter</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="si">%a</span><span class="s2">"</span><span class="p">),</span>
<span class="n">minor_locator</span><span class="o">=</span><span class="n">mdates</span><span class="o">.</span><span class="n">HourLocator</span><span class="p">((</span><span class="mi">0</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">18</span><span class="p">)),</span>
<span class="n">minor_formatter</span><span class="o">=</span><span class="n">mdates</span><span class="o">.</span><span class="n">DateFormatter</span><span class="p">(</span><span class="s2">"%H:%M"</span><span class="p">),</span>
<span class="p">)</span>
<span class="c1"># disable removing overlapping locations</span>
<span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">remove_overlapping_locs</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
<p>labeled days using major ticks, and hours and minutes using minor
ticks and added a newline to the major ticks labels to avoid them
crashing into the minor tick labels. Setting the
<a class="reference internal" href="_as_gen/matplotlib.axis.Axis.remove_overlapping_locs.html#matplotlib.axis.Axis.remove_overlapping_locs" title="matplotlib.axis.Axis.remove_overlapping_locs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_overlapping_locs</span></code></a> property (also accessible via
<a class="reference internal" href="_as_gen/matplotlib.axis.Axis.set_remove_overlapping_locs.html#matplotlib.axis.Axis.set_remove_overlapping_locs" title="matplotlib.axis.Axis.set_remove_overlapping_locs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_remove_overlapping_locs</span></code></a> /
<a class="reference internal" href="_as_gen/matplotlib.axis.Axis.get_remove_overlapping_locs.html#matplotlib.axis.Axis.get_remove_overlapping_locs" title="matplotlib.axis.Axis.get_remove_overlapping_locs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_remove_overlapping_locs</span></code></a> and <a class="reference internal" href="_as_gen/matplotlib.pyplot.setp.html#matplotlib.pyplot.setp" title="matplotlib.pyplot.setp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setp</span></code></a>) disables
removing overlapping tick locations.</p>
<p>The major tick labels could also be adjusted include hours and
minutes, as the minor ticks are gone, so the <code class="docutils literal notranslate"><span class="pre">major_formatter</span></code>
would be:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mdates</span><span class="o">.</span><span class="n">DateFormatter</span><span class="p">(</span><span class="s2">"%H:%M</span><span class="se">\n</span><span class="si">%a</span><span class="s2">"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="usetex-support">
<h4>usetex support<a class="headerlink" href="#usetex-support" title="Permalink to this headline">¶</a></h4>
<p>Previously, if <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=text.usetex#a-sample-matplotlibrc-file"><span class="pre">rcParams["text.usetex"]</span> <span class="pre">=</span> <span class="pre">False</span></a></code> was True, then constructing a <code class="xref py py-obj docutils literal notranslate"><span class="pre">TextPath</span></code> on
a non-mathtext string with <code class="docutils literal notranslate"><span class="pre">usetex=False</span></code> would rely on the mathtext parser
(but not on usetex support!) to parse the string. The mathtext parser is not
invoked anymore, which may cause slight changes in glyph positioning.</p>
</div>
<div class="section" id="get-window-extents">
<h4>get_window_extents<a class="headerlink" href="#get-window-extents" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.get_window_extent.html#matplotlib.axes.Axes.get_window_extent" title="matplotlib.axes.Axes.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.get_window_extent</span></code></a> used to return a bounding box
that was slightly larger than the axes, presumably to take into account
the ticks that may be on a spine. However, it was not scaling the tick sizes
according to the dpi of the canvas, and it did not check if the ticks were
visible, or on the spine.</p>
<p>Now <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.get_window_extent.html#matplotlib.axes.Axes.get_window_extent" title="matplotlib.axes.Axes.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.get_window_extent</span></code></a> just returns the axes extent
with no padding for ticks.</p>
<p>This affects <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.get_tightbbox.html#matplotlib.axes.Axes.get_tightbbox" title="matplotlib.axes.Axes.get_tightbbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.get_tightbbox</span></code></a> in cases where there are
outward ticks with no tick labels, and it also removes the (small) pad around
axes in that case.</p>
<p><a class="reference internal" href="spines_api.html#matplotlib.spines.Spine.get_window_extent" title="matplotlib.spines.Spine.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spines.Spine.get_window_extent</span></code></a> now takes into account ticks that are on the
spine.</p>
</div>
<div class="section" id="sankey">
<h4>Sankey<a class="headerlink" href="#sankey" title="Permalink to this headline">¶</a></h4>
<p>Previously, <a class="reference internal" href="sankey_api.html#matplotlib.sankey.Sankey.add" title="matplotlib.sankey.Sankey.add"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Sankey.add</span></code></a> would only accept a single string as the <em>labels</em>
argument if its length is equal to the number of flows, in which case it would
use one character of the string for each flow.</p>
<p>The behavior has been changed to match the documented one: when a single string
is passed, it is used to label all the flows.</p>
</div>
<div class="section" id="fontmanager-scores">
<h4><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontManager" title="matplotlib.font_manager.FontManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontManager</span></code></a> scores<a class="headerlink" href="#fontmanager-scores" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontManager.score_weight" title="matplotlib.font_manager.FontManager.score_weight"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontManager.score_weight</span></code></a> is now more strict with its
inputs. Previously, when a weight string was passed to
<a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontManager.score_weight" title="matplotlib.font_manager.FontManager.score_weight"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontManager.score_weight</span></code></a>,</p>
<ul class="simple">
<li>if the weight was the string representation of an integer, it would be
converted to that integer,</li>
<li>otherwise, if the weight was not a standard weight name, it would be silently
replaced by a value of 500 ("normal" weight).</li>
</ul>
<p><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontManager.score_weight" title="matplotlib.font_manager.FontManager.score_weight"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontManager.score_weight</span></code></a> now raises an exception on such inputs.</p>
</div>
<div class="section" id="text-alignment">
<h4>Text alignment<a class="headerlink" href="#text-alignment" title="Permalink to this headline">¶</a></h4>
<p>Text alignment was previously incorrect, in particular for multiline text
objects with large descenders (i.e. subscripts) and rotated text. These have
been fixed and made more consistent, but could make old code that has
compensated for this no longer have the correct alignment.</p>
</div>
<div class="section" id="upper-case-color-strings">
<h4>Upper case color strings<a class="headerlink" href="#upper-case-color-strings" title="Permalink to this headline">¶</a></h4>
<p>Support for passing single-letter colors (one of "rgbcmykw") as UPPERCASE
characters is deprecated; these colors will become case-sensitive (lowercase)
after the deprecation period has passed.</p>
<p>The goal is to decrease the number of ambiguous cases when using the <code class="docutils literal notranslate"><span class="pre">data</span></code>
keyword to plotting methods; e.g. <code class="docutils literal notranslate"><span class="pre">plot("X",</span> <span class="pre">"Y",</span> <span class="pre">data={"X":</span> <span class="pre">...,</span> <span class="pre">"Y":</span> <span class="pre">...})</span></code>
will not warn about "Y" possibly being a color anymore after the deprecation
period has passed.</p>
</div>
<div class="section" id="degenerate-limits">
<h4>Degenerate limits<a class="headerlink" href="#degenerate-limits" title="Permalink to this headline">¶</a></h4>
<p>When bounds passed to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_xlim.html#matplotlib.axes.Axes.set_xlim" title="matplotlib.axes.Axes.set_xlim"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_xlim</span></code></a> are degenerate (i.e. the
lower and upper value are equal), the method used to "expand" the
bounds now matches the expansion behavior of autoscaling when the plot
contains a single x-value, and should in particular produce nicer
limits for non-linear scales.</p>
</div>
<div class="section" id="plot-format-string-parsing">
<h4><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">plot</span></code></a> format string parsing<a class="headerlink" href="#plot-format-string-parsing" title="Permalink to this headline">¶</a></h4>
<p>In certain cases, <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">plot</span></code></a> would previously accept format strings
specifying more than one linestyle (e.g. <code class="docutils literal notranslate"><span class="pre">"---."</span></code> which specifies both
<code class="docutils literal notranslate"><span class="pre">"--"</span></code> and <code class="docutils literal notranslate"><span class="pre">"-."</span></code>); only use one of them would be used. This now raises a
<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a> instead.</p>
</div>
<div class="section" id="htmlwriter">
<h4>HTMLWriter<a class="headerlink" href="#htmlwriter" title="Permalink to this headline">¶</a></h4>
<p>The HTMLWriter constructor is more strict: it no longer normalizes unknown
values of <em>default_mode</em> to 'loop', but errors out instead.</p>
</div>
<div class="section" id="afm-parsing">
<h4>AFM parsing<a class="headerlink" href="#afm-parsing" title="Permalink to this headline">¶</a></h4>
<p>In accordance with the AFM spec, the AFM parser no longer truncates the
<code class="docutils literal notranslate"><span class="pre">UnderlinePosition</span></code> and <code class="docutils literal notranslate"><span class="pre">UnderlineThickness</span></code> fields to integers.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Notice</span></code> field (which can only be publicly accessed by the deprecated
<code class="docutils literal notranslate"><span class="pre">afm.parse_afm</span></code> API) is no longer decoded to a <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, but instead kept as
<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bytes</span></code></a>, to support non-conformant AFM files that use non-ASCII characters in
that field.</p>
</div>
<div class="section" id="artist-set-keyword-normalisation">
<h4><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set.html#matplotlib.artist.Artist.set" title="matplotlib.artist.Artist.set"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist.set</span></code></a> keyword normalisation<a class="headerlink" href="#artist-set-keyword-normalisation" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set.html#matplotlib.artist.Artist.set" title="matplotlib.artist.Artist.set"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist.set</span></code></a> now normalizes keywords before sorting them. Previously it sorted
its keyword arguments in reverse alphabetical order (with a special-case to
put <code class="docutils literal notranslate"><span class="pre">color</span></code> at the end) before applying them.</p>
<p>It now normalizes aliases (and, as above, emits a warning on duplicate
properties) before doing the sorting (so <code class="docutils literal notranslate"><span class="pre">c</span></code> goes to the end too).</p>
</div>
<div class="section" id="axes-tick-params-argument-checking">
<h4><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.tick_params.html#matplotlib.axes.Axes.tick_params" title="matplotlib.axes.Axes.tick_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.tick_params</span></code></a> argument checking<a class="headerlink" href="#axes-tick-params-argument-checking" title="Permalink to this headline">¶</a></h4>
<p>Previously <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.tick_params.html#matplotlib.axes.Axes.tick_params" title="matplotlib.axes.Axes.tick_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.tick_params</span></code></a> silently did nothing when an invalid <em>axis</em>
parameter was supplied. This behavior has been changed to raise a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a>
instead.</p>
</div>
<div class="section" id="axes-hist-output">
<h4><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.hist.html#matplotlib.axes.Axes.hist" title="matplotlib.axes.Axes.hist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.hist</span></code></a> output<a class="headerlink" href="#axes-hist-output" title="Permalink to this headline">¶</a></h4>
<p>Input that consists of multiple empty lists will now return a list of histogram
values for each one of the lists. For example, an input of <code class="docutils literal notranslate"><span class="pre">[[],[]]</span></code> will
return 2 lists of histogram values. Previously, a single list was returned.</p>
</div>
<div class="section" id="backend-bases-timer-remove-callback-future-signature-change">
<h4><code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_bases.Timer.remove_callback</span></code> future signature change<a class="headerlink" href="#backend-bases-timer-remove-callback-future-signature-change" title="Permalink to this headline">¶</a></h4>
<p>Currently, <code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_bases.Timer.remove_callback(func,</span> <span class="pre">*args,</span>
<span class="pre">**kwargs)</span></code> removes a callback previously added by
<code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_bases.Timer.add_callback(func,</span> <span class="pre">*args,</span> <span class="pre">**kwargs)</span></code>, but if
<code class="docutils literal notranslate"><span class="pre">*args,</span> <span class="pre">**kwargs</span></code> is not passed in (ex,
<code class="docutils literal notranslate"><span class="pre">Timer.remove_callback(func)</span></code>), then the first callback with a
matching <code class="docutils literal notranslate"><span class="pre">func</span></code> is removed, regardless of whether it was added with
or without <code class="docutils literal notranslate"><span class="pre">*args,</span> <span class="pre">**kwargs</span></code>.</p>
<p>In a future version, <code class="docutils literal notranslate"><span class="pre">Timer.remove_callback</span></code> will always use the latter
behavior (not consider <code class="docutils literal notranslate"><span class="pre">*args,</span> <span class="pre">**kwargs</span></code>); to specifically consider them, add
the callback as a <a class="reference external" href="https://docs.python.org/3/library/functools.html#functools.partial" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">functools.partial</span></code></a> object</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cb</span> <span class="o">=</span> <span class="n">timer</span><span class="o">.</span><span class="n">add_callback</span><span class="p">(</span><span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">))</span>
<span class="c1"># ...</span>
<span class="c1"># later</span>
<span class="n">timer</span><span class="o">.</span><span class="n">remove_callback</span><span class="p">(</span><span class="n">cb</span><span class="p">)</span>
</pre></div>
</div>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_bases.Timer.add_callback</span></code> was modified to return <em>func</em> to
simplify the above usage (previously it returned None); this also
allows using it as a decorator.</p>
<p>The new API is modelled after <a class="reference external" href="https://docs.python.org/3/library/atexit.html#atexit.register" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atexit.register</span></code></a> / <a class="reference external" href="https://docs.python.org/3/library/atexit.html#atexit.unregister" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atexit.unregister</span></code></a>.</p>
</div>
<div class="section" id="stemcontainer-performance-increase">
<h4><code class="xref py py-obj docutils literal notranslate"><span class="pre">StemContainer</span></code> performance increase<a class="headerlink" href="#stemcontainer-performance-increase" title="Permalink to this headline">¶</a></h4>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">StemContainer</span></code> objects can now store 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> object instead of a list of
<a class="reference internal" href="_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Line2D</span></code></a> objects for stem lines plotted using
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.stem.html#matplotlib.axes.Axes.stem" title="matplotlib.axes.Axes.stem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stem</span></code></a>. This gives a very large performance boost to displaying
and moving <code class="xref py py-obj docutils literal notranslate"><span class="pre">stem</span></code> plots.</p>
<p>This will become the default behaviour in Matplotlib 3.3. To use it
now, the <em>use_line_collection</em> keyword argument to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.stem.html#matplotlib.axes.Axes.stem" title="matplotlib.axes.Axes.stem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stem</span></code></a> can
be set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">stem</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">use_line_collection</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>Individual line segments can be extracted from the
<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> using
<code class="xref py py-obj docutils literal notranslate"><span class="pre">get_segements()</span></code>. See the
<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> documentation for other methods to
retrieve the collection properties.</p>
</div>
<div class="section" id="colorbarbase-inheritance">
<h4><a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.ColorbarBase" title="matplotlib.colorbar.ColorbarBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ColorbarBase</span></code></a> inheritance<a class="headerlink" href="#colorbarbase-inheritance" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.ColorbarBase" title="matplotlib.colorbar.ColorbarBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.colorbar.ColorbarBase</span></code></a> is no longer a subclass of
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cm.ScalarMappable</span></code></a>. This inheritance lead to a confusing situation
where the <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cm.ScalarMappable</span></code></a> passed to <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">matplotlib.colorbar.Colorbar</span></code></a>
(<a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.colorbar" title="matplotlib.figure.Figure.colorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">colorbar</span></code></a>) had a <code class="docutils literal notranslate"><span class="pre">set_norm</span></code> method, as did the colorbar.
The colorbar is now purely a follower to the <code class="xref py py-obj docutils literal notranslate"><span class="pre">ScalarMappable</span></code> norm and
colormap, and the old inherited methods
<code class="xref py py-obj docutils literal notranslate"><span class="pre">set_norm</span></code>,
<code class="xref py py-obj docutils literal notranslate"><span class="pre">set_cmap</span></code>,
<code class="xref py py-obj docutils literal notranslate"><span class="pre">set_clim</span></code> are deprecated, as are
the getter versions of those calls. To set the norm associated with a
colorbar do <code class="docutils literal notranslate"><span class="pre">colorbar.mappable.set_norm()</span></code> etc.</p>
</div>
<div class="section" id="freetype-and-libpng-search-paths">
<h4>FreeType and libpng search paths<a class="headerlink" href="#freetype-and-libpng-search-paths" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">MPLBASEDIRLIST</span></code> environment variables and <code class="docutils literal notranslate"><span class="pre">basedirlist</span></code> entry in
<code class="docutils literal notranslate"><span class="pre">setup.cfg</span></code> have no effect anymore. Instead, if building in situations where
FreeType or libpng are not in the compiler or linker's default path, set the
standard environment variables <code class="docutils literal notranslate"><span class="pre">CFLAGS</span></code>/<code class="docutils literal notranslate"><span class="pre">LDFLAGS</span></code> on Linux or OSX, or
<code class="docutils literal notranslate"><span class="pre">CL</span></code>/<code class="docutils literal notranslate"><span class="pre">LINK</span></code> on Windows, to indicate the relevant paths.</p>
<p>See details in <code class="xref py py-obj docutils literal notranslate"><span class="pre">Installing</span></code>.</p>
</div>
<div class="section" id="setting-artist-properties-twice-or-more-in-the-same-call">
<h4>Setting artist properties twice or more in the same call<a class="headerlink" href="#setting-artist-properties-twice-or-more-in-the-same-call" title="Permalink to this headline">¶</a></h4>
<p>Setting the same artist property multiple time via aliases is deprecated.
Previously, code such as</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">c</span><span class="o">=</span><span class="s2">"red"</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s2">"blue"</span><span class="p">)</span>
</pre></div>
</div>
<p>would emit a warning indicating that <code class="docutils literal notranslate"><span class="pre">c</span></code> and <code class="docutils literal notranslate"><span class="pre">color</span></code> are aliases
of one another, and only keep the <code class="docutils literal notranslate"><span class="pre">color</span></code> kwarg. This behavior has
been deprecated; in a future version, this will raise a TypeError,
similar to Python's behavior when a keyword argument is passed twice</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">c</span><span class="o">=</span><span class="s2">"red"</span><span class="p">,</span> <span class="n">c</span><span class="o">=</span><span class="s2">"blue"</span><span class="p">)</span>
</pre></div>
</div>
<p>This warning is raised by <a class="reference internal" href="cbook_api.html#matplotlib.cbook.normalize_kwargs" title="matplotlib.cbook.normalize_kwargs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">normalize_kwargs</span></code></a>.</p>
</div>
<div class="section" id="path-code-types">
<h4>Path code types<a class="headerlink" href="#path-code-types" title="Permalink to this headline">¶</a></h4>
<p>Path code types like <code class="docutils literal notranslate"><span class="pre">Path.MOVETO</span></code> are now <code class="docutils literal notranslate"><span class="pre">np.uint8</span></code> instead of <code class="docutils literal notranslate"><span class="pre">int</span></code>
<code class="docutils literal notranslate"><span class="pre">Path.STOP</span></code>, <code class="docutils literal notranslate"><span class="pre">Path.MOVETO</span></code>, <code class="docutils literal notranslate"><span class="pre">Path.LINETO</span></code>, <code class="docutils literal notranslate"><span class="pre">Path.CURVE3</span></code>,
<code class="docutils literal notranslate"><span class="pre">Path.CURVE4</span></code> and <code class="docutils literal notranslate"><span class="pre">Path.CLOSEPOLY</span></code> are now of the type <code class="docutils literal notranslate"><span class="pre">Path.code_type</span></code>
(<code class="docutils literal notranslate"><span class="pre">np.uint8</span></code> by default) instead of plain <code class="docutils literal notranslate"><span class="pre">int</span></code>. This makes their type
match the array value type of the <code class="docutils literal notranslate"><span class="pre">Path.codes</span></code> array.</p>
</div>
<div class="section" id="latex-code-in-matplotlibrc-file">
<h4>LaTeX code in matplotlibrc file<a class="headerlink" href="#latex-code-in-matplotlibrc-file" title="Permalink to this headline">¶</a></h4>
<p>Previously, the rc file keys <code class="docutils literal notranslate"><span class="pre">pgf.preamble</span></code> and <code class="docutils literal notranslate"><span class="pre">text.latex.preamble</span></code> were
parsed using commmas as separators. This would break valid LaTeX code, such as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>\<span class="n">usepackage</span><span class="p">[</span><span class="n">protrusion</span><span class="o">=</span><span class="n">true</span><span class="p">,</span> <span class="n">expansion</span><span class="o">=</span><span class="n">false</span><span class="p">]{</span><span class="n">microtype</span><span class="p">}</span>
</pre></div>
</div>
<p>The parsing has been modified to pass the complete line to the LaTeX system,
keeping all commas. Passing a list of strings from within a Python script still
works as it used to. Passing a list containing non-strings now fails, instead
of coercing the results to strings.</p>
</div>
<div class="section" id="axes-spy">
<h4><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.spy.html#matplotlib.axes.Axes.spy" title="matplotlib.axes.Axes.spy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.spy</span></code></a><a class="headerlink" href="#axes-spy" title="Permalink to this headline">¶</a></h4>
<p>The method <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.spy.html#matplotlib.axes.Axes.spy" title="matplotlib.axes.Axes.spy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.spy</span></code></a> now raises a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TypeError</span></code></a> for the keyword
arguments <em>interpolation</em> and <em>linestyle</em> instead of silently ignoring
them.</p>
<p>Furthermore, <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.spy.html#matplotlib.axes.Axes.spy" title="matplotlib.axes.Axes.spy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.spy</span></code></a> spy does now allow for an <em>extent</em> argument
(was silently ignored so far).</p>
<p>A bug with <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.spy(...,</span> <span class="pre">origin='lower')</span></code> is fixed. Previously this
flipped the data but not the y-axis resulting in a mismatch between
axes labels and actual data indices. Now, <em>origin='lower'</em> flips both
the data and the y-axis labels.</p>
</div>
<div class="section" id="boxplot-tick-methods">
<h4>Boxplot tick methods<a class="headerlink" href="#boxplot-tick-methods" title="Permalink to this headline">¶</a></h4>
<p>The <em>manage_xticks</em> parameter of <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.boxplot.html#matplotlib.axes.Axes.boxplot" title="matplotlib.axes.Axes.boxplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">boxplot</span></code></a> and <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bxp.html#matplotlib.axes.Axes.bxp" title="matplotlib.axes.Axes.bxp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bxp</span></code></a> has
been renamed (with a deprecation period) to <em>manage_ticks</em>, to take
into account the fact that it manages either x or y ticks depending on
the <em>vert</em> parameter.</p>
<p>When <code class="docutils literal notranslate"><span class="pre">manage_ticks=True</span></code> (the default), these methods now attempt to
take previously drawn boxplots into account when setting the axis
limits, ticks, and tick labels.</p>
</div>
<div class="section" id="mouseevents">
<h4>MouseEvents<a class="headerlink" href="#mouseevents" title="Permalink to this headline">¶</a></h4>
<p>MouseEvents now include the event name in their <code class="xref py py-obj docutils literal notranslate"><span class="pre">str()</span></code>.
Previously they contained the prefix "MPL MouseEvent".</p>
</div>
<div class="section" id="rgba-buffer-return-type">
<h4>RGBA buffer return type<a class="headerlink" href="#rgba-buffer-return-type" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="backend_agg_api.html#matplotlib.backends.backend_agg.FigureCanvasAgg.buffer_rgba" title="matplotlib.backends.backend_agg.FigureCanvasAgg.buffer_rgba"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FigureCanvasAgg.buffer_rgba</span></code></a> and <a class="reference internal" href="backend_agg_api.html#matplotlib.backends.backend_agg.RendererAgg.buffer_rgba" title="matplotlib.backends.backend_agg.RendererAgg.buffer_rgba"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RendererAgg.buffer_rgba</span></code></a> now
return a memoryview The <code class="docutils literal notranslate"><span class="pre">buffer_rgba</span></code> method now allows direct
access to the renderer's underlying buffer (as a <code class="docutils literal notranslate"><span class="pre">(m,</span> <span class="pre">n,</span> <span class="pre">4)</span></code>-shape
memoryview) rather than copying the data to a new bytestring. This is
consistent with the behavior on Py2, where a buffer object was
returned.</p>
</div>
<div class="section" id="matplotlib-font-manager-win32installedfonts-return-type">
<h4><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.win32InstalledFonts" title="matplotlib.font_manager.win32InstalledFonts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.font_manager.win32InstalledFonts</span></code></a> return type<a class="headerlink" href="#matplotlib-font-manager-win32installedfonts-return-type" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.win32InstalledFonts" title="matplotlib.font_manager.win32InstalledFonts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.font_manager.win32InstalledFonts</span></code></a> returns an empty list instead
of None if no fonts are found.</p>
</div>
<div class="section" id="axes-fmt-xdata-and-axes-fmt-ydata-error-handling">
<h4><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.fmt_xdata</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.fmt_ydata</span></code> error handling<a class="headerlink" href="#axes-fmt-xdata-and-axes-fmt-ydata-error-handling" title="Permalink to this headline">¶</a></h4>
<p>Previously, if the user provided a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.fmt_xdata</span></code> or
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.fmt_ydata</span></code> function that raised a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TypeError</span></code></a> (or set them to a
non-callable), the exception would be silently ignored and the default
formatter be used instead. This is no longer the case; the exception
is now propagated out.</p>
</div>
<div class="section" id="deprecation-of-redundant-tick-attributes">
<h4>Deprecation of redundant <code class="xref py py-obj docutils literal notranslate"><span class="pre">Tick</span></code> attributes<a class="headerlink" href="#deprecation-of-redundant-tick-attributes" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">gridOn</span></code>, <code class="docutils literal notranslate"><span class="pre">tick1On</span></code>, <code class="docutils literal notranslate"><span class="pre">tick2On</span></code>, <code class="docutils literal notranslate"><span class="pre">label1On</span></code>, and <code class="docutils literal notranslate"><span class="pre">label2On</span></code>
<a class="reference internal" href="axis_api.html#matplotlib.axis.Tick" title="matplotlib.axis.Tick"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Tick</span></code></a> attributes have been deprecated. Directly get and set the visibility
on the underlying artists, available as the <code class="docutils literal notranslate"><span class="pre">gridline</span></code>, <code class="docutils literal notranslate"><span class="pre">tick1line</span></code>,
<code class="docutils literal notranslate"><span class="pre">tick2line</span></code>, <code class="docutils literal notranslate"><span class="pre">label1</span></code>, and <code class="docutils literal notranslate"><span class="pre">label2</span></code> attributes.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">label</span></code> attribute, which was an alias for <code class="docutils literal notranslate"><span class="pre">label1</span></code>, has been
deprecated.</p>
<p>Subclasses that relied on setting the above visibility attributes needs to be
updated; see e.g. <code class="file docutils literal notranslate"><span class="pre">examples/api/skewt.py</span></code>.</p>
</div>
<div class="section" id="passing-a-line2d-s-drawstyle-together-with-the-linestyle-is-deprecated">
<h4>Passing a Line2D's drawstyle together with the linestyle is deprecated<a class="headerlink" href="#passing-a-line2d-s-drawstyle-together-with-the-linestyle-is-deprecated" title="Permalink to this headline">¶</a></h4>
<p>Instead of <code class="docutils literal notranslate"><span class="pre">plt.plot(...,</span> <span class="pre">linestyle="steps--")</span></code>, use <code class="docutils literal notranslate"><span class="pre">plt.plot(...,</span>
<span class="pre">linestyle="--",</span> <span class="pre">drawstyle="steps")</span></code>. <code class="docutils literal notranslate"><span class="pre">ds</span></code> is now an alias for <code class="docutils literal notranslate"><span class="pre">drawstyle</span></code>.</p>
</div>
</div>
<div class="section" id="pgi-support-dropped">
<h3><a class="toc-backref" href="#id6"><code class="docutils literal notranslate"><span class="pre">pgi</span></code> support dropped</a><a class="headerlink" href="#pgi-support-dropped" title="Permalink to this headline">¶</a></h3>
<p>Support for <code class="docutils literal notranslate"><span class="pre">pgi</span></code> in the GTK3 backends has been dropped. <code class="docutils literal notranslate"><span class="pre">pgi</span></code> is
an alternative implementation to <code class="docutils literal notranslate"><span class="pre">PyGObject</span></code>. <code class="docutils literal notranslate"><span class="pre">PyGObject</span></code> should
be used instead.</p>
</div>
<div class="section" id="rcparam-changes">
<h3><a class="toc-backref" href="#id7">rcParam changes</a><a class="headerlink" href="#rcparam-changes" title="Permalink to this headline">¶</a></h3>
<div class="section" id="removed">
<h4>Removed<a class="headerlink" href="#removed" title="Permalink to this headline">¶</a></h4>
<p>The following deprecated rcParams have been removed:</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">text.dvipnghack</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">nbagg.transparent</span></code> (use <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=figure.facecolor#a-sample-matplotlibrc-file"><span class="pre">rcParams["figure.facecolor"]</span> <span class="pre">=</span> <span class="pre">'white'</span></a></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">plugins.directory</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">axes.hold</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">backend.qt4</span></code> and <code class="docutils literal notranslate"><span class="pre">backend.qt5</span></code> (set the <span class="target" id="index-0"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">QT_API</span></code> environment
variable instead)</li>
</ul>
</div>
<div class="section" id="deprecated">
<h4>Deprecated<a class="headerlink" href="#deprecated" title="Permalink to this headline">¶</a></h4>
<p>The associated validator functions <code class="docutils literal notranslate"><span class="pre">rcsetup.validate_qt4</span></code> and
<code class="docutils literal notranslate"><span class="pre">validate_qt5</span></code> are deprecated.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">verbose.fileo</span></code> and <code class="docutils literal notranslate"><span class="pre">verbose.level</span></code> rcParams have been deprecated.
These have had no effect since the switch from Matplotlib's old custom Verbose
logging to the stdlib's <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging</span></code></a> module. In addition the
<code class="docutils literal notranslate"><span class="pre">rcsetup.validate_verbose</span></code> function is deprecated.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">text.latex.unicode</span></code> rcParam now defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code> and is
deprecated (i.e., in future versions
of Matplotlib, unicode input will always be supported).
Moreover, the underlying implementation now uses <code class="docutils literal notranslate"><span class="pre">\usepackage[utf8]{inputenc}</span></code>
instead of <code class="docutils literal notranslate"><span class="pre">\usepackage{ucs}\usepackage[utf8x]{inputenc}</span></code>.</p>
</div>
</div>
<div class="section" id="exception-changes">
<h3><a class="toc-backref" href="#id8">Exception changes</a><a class="headerlink" href="#exception-changes" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><a class="reference internal" href="_as_gen/mpl_toolkits.axes_grid1.axes_size.GetExtentHelper.html#mpl_toolkits.axes_grid1.axes_size.GetExtentHelper" title="mpl_toolkits.axes_grid1.axes_size.GetExtentHelper"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid1.axes_size.GetExtentHelper</span></code></a> now raises <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a>
for invalid directions instead of <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#KeyError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">KeyError</span></code></a>.</li>
<li>Previously, subprocess failures in the animation framework would raise either
in a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> or a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a> depending on when the error occurred.
They now raise a <a class="reference external" href="https://docs.python.org/3/library/subprocess.html#subprocess.CalledProcessError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subprocess.CalledProcessError</span></code></a> with attributes set as
documented by the exception class.</li>
<li>In certain cases, Axes methods (and pyplot functions) used to raise
a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> if they were called with a <code class="docutils literal notranslate"><span class="pre">data</span></code> kwarg and
otherwise mismatched arguments. They now raise a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TypeError</span></code></a>
instead.</li>
<li><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.streamplot.html#matplotlib.axes.Axes.streamplot" title="matplotlib.axes.Axes.streamplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.streamplot</span></code></a> does not support irregularly gridded <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">y</span></code> values.
So far, it used to silently plot an incorrect result. This has been changed to
raise a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a> instead.</li>
<li>The <code class="xref py py-obj docutils literal notranslate"><span class="pre">streamplot.Grid</span></code> class, which is internally used by streamplot
code, also throws a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a> when irregularly gridded values are
passed in.</li>
</ul>
</div>
<div class="section" id="removals">
<h3><a class="toc-backref" href="#id9">Removals</a><a class="headerlink" href="#removals" title="Permalink to this headline">¶</a></h3>
<p>The following deprecated APIs have been removed:</p>
<div class="section" id="classes-and-methods">
<h4>Classes and methods<a class="headerlink" href="#classes-and-methods" title="Permalink to this headline">¶</a></h4>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">Verbose</span></code> (replaced by python logging library)</li>
<li><code class="docutils literal notranslate"><span class="pre">artist.Artist.hitlist</span></code> (no replacement)</li>
<li><code class="docutils literal notranslate"><span class="pre">artist.Artist.is_figure_set</span></code> (use <code class="docutils literal notranslate"><span class="pre">artist.figure</span> <span class="pre">is</span> <span class="pre">not</span> <span class="pre">None</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">axis.Axis.unit_data</span></code> (use <code class="docutils literal notranslate"><span class="pre">axis.Axis.units</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">backend_bases.FigureCanvasBase.onRemove</span></code> (no replacement)
<code class="docutils literal notranslate"><span class="pre">backend_bases.FigureManagerBase.show_popup</span></code> (this never did anything)</li>
<li><code class="docutils literal notranslate"><span class="pre">backend_wx.SubplotToolWx</span></code> (no replacement)</li>
<li><code class="docutils literal notranslate"><span class="pre">backend_wx.Toolbar</span></code> (use <code class="docutils literal notranslate"><span class="pre">backend_wx.NavigationToolbar2Wx</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">cbook.align_iterators</span></code> (no replacment)</li>
<li><code class="docutils literal notranslate"><span class="pre">contour.ContourLabeler.get_real_label_width</span></code> (no replacement)</li>
<li><code class="docutils literal notranslate"><span class="pre">legend.Legend.draggable</span></code> (use <code class="xref py py-obj docutils literal notranslate"><span class="pre">legend.Legend.set_draggable()</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">texmanager.TexManager.postscriptd</span></code>, <code class="docutils literal notranslate"><span class="pre">texmanager.TexManager.pscnt</span></code>,
<code class="docutils literal notranslate"><span class="pre">texmanager.TexManager.make_ps</span></code>, <code class="docutils literal notranslate"><span class="pre">texmanager.TexManager.get_ps_bbox</span></code>
(no replacements)</li>
</ul>
</div>
<div class="section" id="arguments">
<h4>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h4>
<ul class="simple">
<li>The <em>fig</em> kwarg to <a class="reference internal" href="_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec.get_subplot_params" title="matplotlib.gridspec.GridSpec.get_subplot_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GridSpec.get_subplot_params</span></code></a> and
<a class="reference internal" href="_as_gen/matplotlib.gridspec.GridSpecFromSubplotSpec.html#matplotlib.gridspec.GridSpecFromSubplotSpec.get_subplot_params" title="matplotlib.gridspec.GridSpecFromSubplotSpec.get_subplot_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GridSpecFromSubplotSpec.get_subplot_params</span></code></a> (use the argument
<em>figure</em> instead)</li>
<li>Passing 'box-forced' to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_adjustable.html#matplotlib.axes.Axes.set_adjustable" title="matplotlib.axes.Axes.set_adjustable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.set_adjustable</span></code></a> (use 'box' instead)</li>
<li>Support for the strings 'on'/'true'/'off'/'false' to mean
<a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> / <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">False</span></code></a> (directly use <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> / <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">False</span></code></a> instead).
The following functions are affected:<ul>
<li><a class="reference internal" href="_as_gen/matplotlib.axes.Axes.grid.html#matplotlib.axes.Axes.grid" title="matplotlib.axes.Axes.grid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes.Axes.grid</span></code></a></li>
<li><a class="reference internal" href="_as_gen/mpl_toolkits.mplot3d.axes3d.Axes3D.html#mpl_toolkits.mplot3d.axes3d.Axes3D.grid" title="mpl_toolkits.mplot3d.axes3d.Axes3D.grid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes3D.grid</span></code></a></li>
<li><a class="reference internal" href="_as_gen/matplotlib.axis.Axis.set_tick_params.html#matplotlib.axis.Axis.set_tick_params" title="matplotlib.axis.Axis.set_tick_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.set_tick_params</span></code></a></li>
<li><a class="reference internal" href="_as_gen/matplotlib.pyplot.box.html#matplotlib.pyplot.box" title="matplotlib.pyplot.box"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.box</span></code></a></li>
</ul>
</li>
<li>Using <a class="reference internal" href="_as_gen/matplotlib.pyplot.axes.html#matplotlib.pyplot.axes" title="matplotlib.pyplot.axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.axes</span></code></a> with an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes.Axes</span></code></a> type argument
(use <a class="reference internal" href="_as_gen/matplotlib.pyplot.sca.html#matplotlib.pyplot.sca" title="matplotlib.pyplot.sca"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.sca</span></code></a> instead)</li>
</ul>
</div>
<div class="section" id="other">
<h4>Other<a class="headerlink" href="#other" title="Permalink to this headline">¶</a></h4>
<p>The following miscellaneous API elements have been removed</p>
<ul>
<li><p class="first">svgfont support (in <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=svg.fonttype#a-sample-matplotlibrc-file"><span class="pre">rcParams["svg.fonttype"]</span> <span class="pre">=</span> <span class="pre">'path'</span></a></code>)</p>
</li>
<li><p class="first">Logging is now done with the standard python <code class="docutils literal notranslate"><span class="pre">logging</span></code> library.
<code class="docutils literal notranslate"><span class="pre">matplotlib.verbose</span></code> and the command line switches <code class="docutils literal notranslate"><span class="pre">--verbose-LEVEL</span></code> have
been removed.</p>
<p>To control the logging output use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">logging</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">'matplotlib'</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">set_level</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first"><code class="docutils literal notranslate"><span class="pre">__version__numpy__</span></code></p>
</li>
<li><p class="first"><code class="docutils literal notranslate"><span class="pre">collections.CIRCLE_AREA_FACTOR</span></code></p>
</li>
<li><p class="first"><code class="docutils literal notranslate"><span class="pre">font_manager.USE_FONTCONFIG</span></code></p>
</li>
<li><p class="first"><code class="docutils literal notranslate"><span class="pre">font_manager.cachedir</span></code></p>
</li>
</ul>
</div>
</div>
<div class="section" id="matplotlib-mlab-removals">
<h3><a class="toc-backref" href="#id10"><a class="reference internal" href="mlab_api.html#module-matplotlib.mlab" title="matplotlib.mlab"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.mlab</span></code></a> removals</a><a class="headerlink" href="#matplotlib-mlab-removals" title="Permalink to this headline">¶</a></h3>
<p>Lots of code inside the <a class="reference internal" href="mlab_api.html#module-matplotlib.mlab" title="matplotlib.mlab"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.mlab</span></code></a> module which was deprecated
in Matplotlib 2.2 has been removed. See below for a list:</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">mlab.exp_safe</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.exp.html#numpy.exp" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.exp</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.amap</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.logspace</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.logspace.html#numpy.logspace" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.logspace</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rms_flat</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.l1norm</span></code> (use <code class="docutils literal notranslate"><span class="pre">numpy.linalg.norm(a,</span> <span class="pre">ord=1)</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.l2norm</span></code> (use <code class="docutils literal notranslate"><span class="pre">numpy.linalg.norm(a,</span> <span class="pre">ord=2)</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.norm_flat</span></code> (use <code class="docutils literal notranslate"><span class="pre">numpy.linalg.norm(a.flat,</span> <span class="pre">ord=2)</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.frange</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.arange.html#numpy.arange" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.arange</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.identity</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.identity.html#numpy.identity" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.identity</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.base_repr</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.binary_repr</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.ispower2</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.log2</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.log2.html#numpy.log2" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.log2</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.isvector</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.movavg</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.safe_isinf</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.isinf.html#numpy.isinf" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.isinf</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.safe_isnan</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.isnan.html#numpy.isnan" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.isnan</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.cohere_pairs</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.coherence.html#scipy.signal.coherence" title="(in SciPy v1.3.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.signal.coherence</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.entropy</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.entropy.html#scipy.stats.entropy" title="(in SciPy v1.3.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.stats.entropy</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.normpdf</span></code> (use <code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.stats.norm.pdf</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.find</span></code> (use <code class="docutils literal notranslate"><span class="pre">np.nonzero(np.ravel(condition))</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.longest_contiguous_ones</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.longest_ones</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.PCA</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.prctile</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.percentile.html#numpy.percentile" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.percentile</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.prctile_rank</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.center_matrix</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rk4</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.ode.html#scipy.integrate.ode" title="(in SciPy v1.3.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.integrate.ode</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.bivariate_normal</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.get_xyz_where</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.get_sparse_matrix</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.dist</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.hypot.html#numpy.hypot" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.hypot</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.dist_point_to_segment</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.griddata</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.interpolate.griddata.html#scipy.interpolate.griddata" title="(in SciPy v1.3.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.interpolate.griddata</span></code></a>)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.less_simple_linear_interpolation</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.interp.html#numpy.interp" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.interp</span></code></a>)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.slopes</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.stineman_interp</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.segments_intersect</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.fftsurr</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.offset_line</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.quad2cubic</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.vector_lengths</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.distances_along_curve</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.path_length</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.cross_from_above</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.cross_from_below</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.contiguous_regions</span></code> (use <a class="reference internal" href="cbook_api.html#matplotlib.cbook.contiguous_regions" title="matplotlib.cbook.contiguous_regions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cbook.contiguous_regions</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.is_closed_polygon</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.poly_between</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.poly_below</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.inside_poly</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.csv2rec</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rec2csv</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.recarray.tofile.html#numpy.recarray.tofile" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.recarray.tofile</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rec2text</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.recarray.tofile.html#numpy.recarray.tofile" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.recarray.tofile</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rec_summarize</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rec_join</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.recs_join</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rec_groupby</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rec_keep_fields</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rec_drop_fields</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.rec_append_fields</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.csvformat_factory</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.get_formatd</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.FormatDatetime</span></code> (use <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime.strftime" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.datetime.strftime</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.FormatDate</span></code> (use <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.date.strftime" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.date.strftime</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.FormatMillions</span></code>, <code class="docutils literal notranslate"><span class="pre">mlab.FormatThousands</span></code>, <code class="docutils literal notranslate"><span class="pre">mlab.FormatPercent</span></code>,
<code class="docutils literal notranslate"><span class="pre">mlab.FormatBool</span></code>, <code class="docutils literal notranslate"><span class="pre">mlab.FormatInt</span></code>, <code class="docutils literal notranslate"><span class="pre">mlab.FormatFloat</span></code>,
<code class="docutils literal notranslate"><span class="pre">mlab.FormatFormatStr</span></code>, <code class="docutils literal notranslate"><span class="pre">mlab.FormatString</span></code>, <code class="docutils literal notranslate"><span class="pre">mlab.FormatObj</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mlab.donothing_callback</span></code></li>
</ul>
</div>
<div class="section" id="matplotlib-pylab-removals">
<h3><a class="toc-backref" href="#id11"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.pylab</span></code> removals</a><a class="headerlink" href="#matplotlib-pylab-removals" title="Permalink to this headline">¶</a></h3>
<p>Lots of code inside the <a class="reference internal" href="mlab_api.html#module-matplotlib.mlab" title="matplotlib.mlab"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.mlab</span></code></a> module which was deprecated
in Matplotlib 2.2 has been removed. This means the following functions are
no longer available in the <code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pylab</span></code> module:</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">amap</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">base_repr</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">binary_repr</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">bivariate_normal</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">center_matrix</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">csv2rec</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.recarray.tofile.html#numpy.recarray.tofile" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.recarray.tofile</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">dist</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.hypot.html#numpy.hypot" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.hypot</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">dist_point_to_segment</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">distances_along_curve</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">entropy</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.entropy.html#scipy.stats.entropy" title="(in SciPy v1.3.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.stats.entropy</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">exp_safe</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.exp.html#numpy.exp" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.exp</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">fftsurr</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">find</span></code> (use <code class="docutils literal notranslate"><span class="pre">np.nonzero(np.ravel(condition))</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">frange</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.arange.html#numpy.arange" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.arange</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">get_sparse_matrix</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">get_xyz_where</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">griddata</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.interpolate.griddata.html#scipy.interpolate.griddata" title="(in SciPy v1.3.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.interpolate.griddata</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">identity</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.identity.html#numpy.identity" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.identity</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">inside_poly</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">is_closed_polygon</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">ispower2</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">isvector</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">l1norm</span></code> (use <code class="docutils literal notranslate"><span class="pre">numpy.linalg.norm(a,</span> <span class="pre">ord=1)</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">l2norm</span></code> (use <code class="docutils literal notranslate"><span class="pre">numpy.linalg.norm(a,</span> <span class="pre">ord=2)</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">log2</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.log2.html#numpy.log2" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.log2</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">longest_contiguous_ones</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">longest_ones</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">movavg</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">norm_flat</span></code> (use <code class="docutils literal notranslate"><span class="pre">numpy.linalg.norm(a.flat,</span> <span class="pre">ord=2)</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">normpdf</span></code> (use <code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.stats.norm.pdf</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">path_length</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">poly_below</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">poly_between</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">prctile</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.percentile.html#numpy.percentile" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.percentile</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">prctile_rank</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">rec2csv</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.recarray.tofile.html#numpy.recarray.tofile" title="(in NumPy v1.17)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.recarray.tofile</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">rec_append_fields</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">rec_drop_fields</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">rec_join</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">rk4</span></code> (use <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.ode.html#scipy.integrate.ode" title="(in SciPy v1.3.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.integrate.ode</span></code></a> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">rms_flat</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">segments_intersect</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">slopes</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">stineman_interp</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">vector_lengths</span></code></li>
</ul>
</div>
<div class="section" id="mplot3d-changes">
<h3><a class="toc-backref" href="#id12">mplot3d changes</a><a class="headerlink" href="#mplot3d-changes" title="Permalink to this headline">¶</a></h3>
<div class="section" id="voxel-shading">
<h4>Voxel shading<a class="headerlink" href="#voxel-shading" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="_as_gen/mpl_toolkits.mplot3d.axes3d.Axes3D.html#mpl_toolkits.mplot3d.axes3d.Axes3D.voxels" title="mpl_toolkits.mplot3d.axes3d.Axes3D.voxels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes3D.voxels</span></code></a> now shades the resulting voxels; for more details see
What's new. The previous behavior can be achieved by passing</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">voxels</span><span class="p">(</span><span class="o">..</span><span class="p">,</span> <span class="n">shade</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="equal-aspect-axes-disabled">
<h4>Equal aspect axes disabled<a class="headerlink" href="#equal-aspect-axes-disabled" title="Permalink to this headline">¶</a></h4>
<p>Setting the aspect on 3D axes previously returned non-sensical results
(e.g. see <a class="reference external" href="https://github.com/matplotlib/matplotlib/issues/1077/">#1077</a>). Calling <code class="docutils literal notranslate"><span class="pre">ax.set_aspect('equal')</span></code> or
<code class="docutils literal notranslate"><span class="pre">ax.set_aspect(num)</span></code> on a 3D axes now raises a
<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NotImplementedError</span></code></a>.</p>
</div>
<div class="section" id="poly3dcollection-set-zsort">
<h4><a class="reference internal" href="_as_gen/mpl_toolkits.mplot3d.art3d.Poly3DCollection.html#mpl_toolkits.mplot3d.art3d.Poly3DCollection.set_zsort" title="mpl_toolkits.mplot3d.art3d.Poly3DCollection.set_zsort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Poly3DCollection.set_zsort</span></code></a><a class="headerlink" href="#poly3dcollection-set-zsort" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="_as_gen/mpl_toolkits.mplot3d.art3d.Poly3DCollection.html#mpl_toolkits.mplot3d.art3d.Poly3DCollection.set_zsort" title="mpl_toolkits.mplot3d.art3d.Poly3DCollection.set_zsort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Poly3DCollection.set_zsort</span></code></a> no longer silently ignores invalid
inputs, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">False</span></code></a> (which was always broken). Passing <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> to mean
<code class="docutils literal notranslate"><span class="pre">"average"</span></code> is deprecated.</p>
</div>
</div>
<div class="section" id="testing">
<h3><a class="toc-backref" href="#id13">Testing</a><a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">--no-network</span></code> flag to <code class="docutils literal notranslate"><span class="pre">tests.py</span></code> has been removed (no test requires
internet access anymore). If it is desired to disable internet access both for
old and new versions of Matplotlib, use <code class="docutils literal notranslate"><span class="pre">tests.py</span> <span class="pre">-m</span> <span class="pre">'not</span> <span class="pre">network'</span></code> (which is
now a no-op).</p>
<p>The image comparison test decorators now skip (rather than xfail) the test for
uncomparable formats. The affected decorators are <a class="reference internal" href="testing_api.html#matplotlib.testing.decorators.image_comparison" title="matplotlib.testing.decorators.image_comparison"><code class="xref py py-obj docutils literal notranslate"><span class="pre">image_comparison</span></code></a> and
<a class="reference internal" href="testing_api.html#matplotlib.testing.decorators.check_figures_equal" title="matplotlib.testing.decorators.check_figures_equal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">check_figures_equal</span></code></a>. The deprecated <a class="reference internal" href="testing_api.html#matplotlib.testing.decorators.ImageComparisonTest" title="matplotlib.testing.decorators.ImageComparisonTest"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ImageComparisonTest</span></code></a> class is
likewise changed.</p>
</div>
<div class="section" id="dependency-changes">
<h3><a class="toc-backref" href="#id14">Dependency changes</a><a class="headerlink" href="#dependency-changes" title="Permalink to this headline">¶</a></h3>
<div class="section" id="numpy">
<h4>numpy<a class="headerlink" href="#numpy" title="Permalink to this headline">¶</a></h4>
<p>Matplotlib 3.1 now requires numpy>=1.11.</p>
</div>
<div class="section" id="ghostscript">
<h4>ghostscript<a class="headerlink" href="#ghostscript" title="Permalink to this headline">¶</a></h4>
<p>Support for ghostscript 8.60 (released in 2007) has been removed. The oldest
supported version of ghostscript is now 9.0 (released in 2010).</p>
</div>
</div>
<div class="section" id="mathtext-changes">
<h3><a class="toc-backref" href="#id15">Mathtext changes</a><a class="headerlink" href="#mathtext-changes" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>In constructs such as <code class="docutils literal notranslate"><span class="pre">"$1~2$"</span></code>, mathtext now interprets the tilde as a
space, consistently with TeX (this was previously a parse error).</li>
</ul>
<div class="section" id="deprecations">
<h4>Deprecations<a class="headerlink" href="#deprecations" title="Permalink to this headline">¶</a></h4>
<ul class="simple">
<li>The <code class="docutils literal notranslate"><span class="pre">\stackrel</span></code> mathtext command hsa been deprecated (it behaved differently
from LaTeX's <code class="docutils literal notranslate"><span class="pre">\stackrel</span></code>. To stack two mathtext expressions, use
<code class="docutils literal notranslate"><span class="pre">\genfrac{left-delim}{right-delim}{fraction-bar-thickness}{}{top}{bottom}</span></code>.</li>
<li>The <code class="xref py py-obj docutils literal notranslate"><span class="pre">mathcircled</span></code> mathtext command (which is not a real TeX command)
is deprecated. Directly use unicode characters (e.g.