-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathapi_changes.html
More file actions
4033 lines (3827 loc) · 438 KB
/
api_changes.html
File metadata and controls
4033 lines (3827 loc) · 438 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 2.2.4 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script 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 2.2.4 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.2.4 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="The top level matplotlib module" href="matplotlib_configuration_api.html" />
<link rel="prev" title="The Pyplot API" href="pyplot_summary.html" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/api/api_changes.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.4). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.4</span></div>
<img src="../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="matplotlib_configuration_api.html" title="The top level matplotlib module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pyplot_summary.html" title="The Pyplot API"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">API Changes</a><ul>
<li><a class="reference internal" href="#api-changes-in-2-2-0">API Changes in 2.2.0</a><ul>
<li><a class="reference internal" href="#new-dependency">New dependency</a></li>
<li><a class="reference internal" href="#deprecations">Deprecations</a><ul>
<li><a class="reference internal" href="#classes-functions-and-methods">Classes, functions, and methods</a></li>
<li><a class="reference internal" href="#changed-function-signatures">Changed function signatures</a></li>
<li><a class="reference internal" href="#rcparams">rcparams</a></li>
<li><a class="reference internal" href="#deprecated-axis-unit-data">Deprecated <code class="docutils literal notranslate"><span class="pre">Axis.unit_data</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#removals">Removals</a><ul>
<li><a class="reference internal" href="#function-signatures">Function Signatures</a></li>
<li><a class="reference internal" href="#modules-methods-and-functions">Modules, methods, and functions</a></li>
<li><a class="reference internal" href="#color-maps">color maps</a></li>
<li><a class="reference internal" href="#id1">rcparams</a></li>
</ul>
</li>
<li><a class="reference internal" href="#only-accept-string-like-for-categorical-input">Only accept string-like for Categorical input</a></li>
<li><a class="reference internal" href="#removal-of-unused-imports">Removal of unused imports</a></li>
<li><a class="reference internal" href="#axes3d-get-xlim-get-ylim-and-get-zlim-now-return-a-tuple"><code class="docutils literal notranslate"><span class="pre">Axes3D.get_xlim</span></code>, <code class="docutils literal notranslate"><span class="pre">get_ylim</span></code> and <code class="docutils literal notranslate"><span class="pre">get_zlim</span></code> now return a tuple</a></li>
<li><a class="reference internal" href="#exception-type-changes">Exception type changes</a></li>
<li><a class="reference internal" href="#figure-set-figwidth-and-figure-set-figheight-default-forward-to-true"><code class="docutils literal notranslate"><span class="pre">Figure.set_figwidth</span></code> and <code class="docutils literal notranslate"><span class="pre">Figure.set_figheight</span></code> default forward to True</a></li>
<li><a class="reference internal" href="#do-not-truncate-svg-sizes-to-nearest-point">Do not truncate svg sizes to nearest point</a></li>
<li><a class="reference internal" href="#fontsizes-less-than-1-pt-are-clipped-to-be-1-pt">Fontsizes less than 1 pt are clipped to be 1 pt.</a></li>
<li><a class="reference internal" href="#changes-to-qt-backend-class-mro">Changes to Qt backend class MRO</a></li>
<li><a class="reference internal" href="#axes-imshow-clips-rgb-values-to-the-valid-range"><code class="docutils literal notranslate"><span class="pre">Axes.imshow</span></code> clips RGB values to the valid range</a></li>
<li><a class="reference internal" href="#gtkagg-and-gtkcairo-backends-deprecated">GTKAgg and GTKCairo backends deprecated</a></li>
</ul>
</li>
<li><a class="reference internal" href="#api-changes-in-2-1-2">API Changes in 2.1.2</a><ul>
<li><a class="reference internal" href="#figure-legend-no-longer-checks-for-repeated-lines-to-ignore"><code class="docutils literal notranslate"><span class="pre">Figure.legend</span></code> no longer checks for repeated lines to ignore</a></li>
</ul>
</li>
<li><a class="reference internal" href="#api-changes-in-2-1-1">API Changes in 2.1.1</a><ul>
<li><a class="reference internal" href="#default-behavior-of-log-scales-reverted-to-clip-0-values">Default behavior of log scales reverted to clip <= 0 values</a></li>
</ul>
</li>
<li><a class="reference internal" href="#api-changes-in-2-1-0">API Changes in 2.1.0</a><ul>
<li><a class="reference internal" href="#default-behavior-of-log-scales-changed-to-mask-0-values">Default behavior of log scales changed to mask <= 0 values</a></li>
<li><a class="reference internal" href="#matplotlib-cbook-callbackregistry-process-suppresses-exceptions-by-default"><code class="docutils literal notranslate"><span class="pre">matplotlib.cbook.CallbackRegistry.process()</span></code> suppresses exceptions by default</a></li>
<li><a class="reference internal" href="#improved-toggling-of-the-axes-grids">Improved toggling of the axes grids</a></li>
<li><a class="reference internal" href="#ticklabels-are-turned-off-instead-of-being-invisible">Ticklabels are turned off instead of being invisible</a></li>
<li><a class="reference internal" href="#removal-of-warning-on-empty-legends">Removal of warning on empty legends</a></li>
<li><a class="reference internal" href="#more-accurate-legend-autopositioning">More accurate legend autopositioning</a></li>
<li><a class="reference internal" href="#cleanup-of-stock-sample-data">Cleanup of stock sample data</a></li>
<li><a class="reference internal" href="#updated-qhull-to-2015-2">Updated qhull to 2015.2</a></li>
<li><a class="reference internal" href="#improved-delaunay-triangulations-with-large-offsets">Improved Delaunay triangulations with large offsets</a></li>
<li><a class="reference internal" href="#use-backports-functools-lru-cache-instead-of-functools32">Use <code class="docutils literal notranslate"><span class="pre">backports.functools_lru_cache</span></code> instead of <code class="docutils literal notranslate"><span class="pre">functools32</span></code></a></li>
<li><a class="reference internal" href="#cbook-is-numlike-only-performs-an-instance-check"><code class="docutils literal notranslate"><span class="pre">cbook.is_numlike</span></code> only performs an instance check</a></li>
<li><a class="reference internal" href="#elliptical-arcs-now-drawn-between-correct-angles">Elliptical arcs now drawn between correct angles</a></li>
<li><a class="reference internal" href="#d-backend-no-longer-sets-the-backend"><code class="docutils literal notranslate"><span class="pre">-d$backend</span></code> no longer sets the backend</a></li>
<li><a class="reference internal" href="#path-intersects-bbox-always-treats-the-bounding-box-as-filled">Path.intersects_bbox always treats the bounding box as filled</a></li>
<li><a class="reference internal" href="#wx-no-longer-calls-generates-idleevent-events-or-calls-idle-event">WX no longer calls generates <code class="docutils literal notranslate"><span class="pre">IdleEvent</span></code> events or calls <code class="docutils literal notranslate"><span class="pre">idle_event</span></code></a></li>
<li><a class="reference internal" href="#correct-scaling-of-magnitude-spectrum">Correct scaling of <code class="docutils literal notranslate"><span class="pre">magnitude_spectrum()</span></code></a></li>
<li><a class="reference internal" href="#change-to-signatures-of-bar-barh">Change to signatures of <code class="docutils literal notranslate"><span class="pre">bar()</span></code> & <code class="docutils literal notranslate"><span class="pre">barh()</span></code></a></li>
<li><a class="reference internal" href="#font-cache-as-json">Font cache as json</a></li>
<li><a class="reference internal" href="#invalid-non-finite-axis-limit-error">Invalid (Non-finite) Axis Limit Error</a></li>
<li><a class="reference internal" href="#scatter-and-collection-offsets-are-no-longer-implicitly-flattened"><code class="docutils literal notranslate"><span class="pre">scatter</span></code> and <code class="docutils literal notranslate"><span class="pre">Collection</span></code> offsets are no longer implicitly flattened</a></li>
<li><a class="reference internal" href="#id2">Deprecations</a><ul>
<li><a class="reference internal" href="#graphicscontextbase-s-linestyle-property"><code class="docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code>'s <code class="docutils literal notranslate"><span class="pre">linestyle</span></code> property.</a></li>
<li><a class="reference internal" href="#navigationtoolbar2-dynamic-update"><code class="docutils literal notranslate"><span class="pre">NavigationToolbar2.dynamic_update</span></code></a></li>
<li><a class="reference internal" href="#testing">Testing</a></li>
<li><a class="reference internal" href="#engformatter-num-arg-as-string"><code class="docutils literal notranslate"><span class="pre">EngFormatter</span></code> <em>num</em> arg as string</a></li>
<li><a class="reference internal" href="#mpl-toolkits-axes-grid-module"><code class="docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid</span></code> module</a></li>
<li><a class="reference internal" href="#axes-collision-in-figure-add-axes"><code class="docutils literal notranslate"><span class="pre">Axes</span></code> collision in <code class="docutils literal notranslate"><span class="pre">Figure.add_axes</span></code></a></li>
<li><a class="reference internal" href="#former-validators-for-contour-negative-linestyle">Former validators for <code class="docutils literal notranslate"><span class="pre">contour.negative_linestyle</span></code></a></li>
<li><a class="reference internal" href="#cbook"><code class="docutils literal notranslate"><span class="pre">cbook</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#code-removal">Code Removal</a><ul>
<li><a class="reference internal" href="#qt4-compat-py">qt4_compat.py</a></li>
<li><a class="reference internal" href="#previously-deprecated-methods">Previously Deprecated methods</a></li>
<li><a class="reference internal" href="#axes-set-aspect-normal"><code class="docutils literal notranslate"><span class="pre">Axes.set_aspect("normal")</span></code></a></li>
<li><a class="reference internal" href="#shading-kwarg-to-pcolor"><code class="docutils literal notranslate"><span class="pre">shading</span></code> kwarg to <code class="docutils literal notranslate"><span class="pre">pcolor</span></code></a></li>
<li><a class="reference internal" href="#functions-removed-from-the-lines-module">Functions removed from the <code class="docutils literal notranslate"><span class="pre">lines</span></code> module</a></li>
<li><a class="reference internal" href="#pdf-backend-functions">PDF backend functions</a></li>
<li><a class="reference internal" href="#matplotlib-delaunay">matplotlib.delaunay</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#api-changes-in-2-0-1">API Changes in 2.0.1</a><ul>
<li><a class="reference internal" href="#extensions-to-matplotlib-backend-bases-graphicscontextbase">Extensions to <code class="docutils literal notranslate"><span class="pre">matplotlib.backend_bases.GraphicsContextBase</span></code></a></li>
<li><a class="reference internal" href="#afm-get-fontconfig-fonts-returns-a-list-of-paths-and-does-not-check-for-existence"><code class="docutils literal notranslate"><span class="pre">afm.get_fontconfig_fonts</span></code> returns a list of paths and does not check for existence</a></li>
<li><a class="reference internal" href="#bar-now-returns-rectangles-of-negative-height-or-width-if-the-corresponding-input-is-negative"><code class="docutils literal notranslate"><span class="pre">bar</span></code> now returns rectangles of negative height or width if the corresponding input is negative</a></li>
<li><a class="reference internal" href="#do-not-clip-line-width-when-scaling-dashes">Do not clip line width when scaling dashes</a></li>
<li><a class="reference internal" href="#deprecate-vega-color-maps">Deprecate 'Vega' color maps</a></li>
</ul>
</li>
<li><a class="reference internal" href="#api-changes-in-2-0-0">API Changes in 2.0.0</a><ul>
<li><a class="reference internal" href="#deprecation-and-removal">Deprecation and removal</a><ul>
<li><a class="reference internal" href="#color-of-axes">Color of Axes</a></li>
<li><a class="reference internal" href="#gtk-and-gdk-backends-deprecated">GTK and GDK backends deprecated</a></li>
<li><a class="reference internal" href="#wx-backend-deprecated">WX backend deprecated</a></li>
<li><a class="reference internal" href="#cocoaagg-backend-removed">CocoaAgg backend removed</a></li>
<li><a class="reference internal" href="#round-removed-from-tkagg-backend"><code class="docutils literal notranslate"><span class="pre">round</span></code> removed from TkAgg Backend</a></li>
<li><a class="reference internal" href="#hold-functionality-deprecated">'hold' functionality deprecated</a></li>
</ul>
</li>
<li><a class="reference internal" href="#artist-update-has-return-value"><code class="docutils literal notranslate"><span class="pre">Artist.update</span></code> has return value</a></li>
<li><a class="reference internal" href="#legend-initializers-gain-edgecolor-and-facecolor-kwargs"><code class="docutils literal notranslate"><span class="pre">Legend</span></code> initializers gain edgecolor and facecolor kwargs</a></li>
<li><a class="reference internal" href="#qualitative-colormaps">Qualitative colormaps</a></li>
<li><a class="reference internal" href="#change-in-the-draw-image-backend-api">Change in the <code class="docutils literal notranslate"><span class="pre">draw_image</span></code> backend API</a></li>
<li><a class="reference internal" href="#matplotlib-ticker-linearlocator-algorithm-update"><code class="docutils literal notranslate"><span class="pre">matplotlib.ticker.LinearLocator</span></code> algorithm update</a></li>
<li><a class="reference internal" href="#matplotlib-ticker-loglocator-gains-numticks-kwarg"><code class="docutils literal notranslate"><span class="pre">matplotlib.ticker.LogLocator</span></code> gains numticks kwarg</a></li>
<li><a class="reference internal" href="#matplotlib-ticker-logformatter-two-new-kwargs"><code class="docutils literal notranslate"><span class="pre">matplotlib.ticker.LogFormatter</span></code>: two new kwargs</a></li>
<li><a class="reference internal" href="#new-defaults-for-3d-quiver-function-in-mpl-toolkits-mplot3d-axes3d-py">New defaults for 3D quiver function in mpl_toolkits.mplot3d.axes3d.py</a></li>
<li><a class="reference internal" href="#stale-figure-behavior">Stale figure behavior</a></li>
<li><a class="reference internal" href="#the-spectral-colormap-is-now-nipy-spectral">The spectral colormap is now nipy_spectral</a></li>
<li><a class="reference internal" href="#default-install-no-longer-includes-test-images">Default install no longer includes test images</a></li>
</ul>
</li>
<li><a class="reference internal" href="#changes-in-1-5-3">Changes in 1.5.3</a><ul>
<li><a class="reference internal" href="#ax-plot-marker-none-gives-default-marker"><code class="docutils literal notranslate"><span class="pre">ax.plot(...,</span> <span class="pre">marker=None)</span></code> gives default marker</a></li>
</ul>
</li>
<li><a class="reference internal" href="#changes-in-1-5-2">Changes in 1.5.2</a><ul>
<li><a class="reference internal" href="#default-behavior-changes">Default Behavior Changes</a><ul>
<li><a class="reference internal" href="#changed-default-autorange-behavior-in-boxplots">Changed default <code class="docutils literal notranslate"><span class="pre">autorange</span></code> behavior in boxplots</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#changes-in-1-5-0">Changes in 1.5.0</a><ul>
<li><a class="reference internal" href="#code-changes">Code Changes</a><ul>
<li><a class="reference internal" href="#reversed-matplotlib-cbook-ls-mapper-added-ls-mapper-r">Reversed <code class="docutils literal notranslate"><span class="pre">matplotlib.cbook.ls_mapper</span></code>, added <code class="docutils literal notranslate"><span class="pre">ls_mapper_r</span></code></a></li>
<li><a class="reference internal" href="#prevent-moving-artists-between-axes-property-ify-artist-axes-deprecate-artist-get-set-axes">Prevent moving artists between Axes, Property-ify Artist.axes, deprecate Artist.{get,set}_axes</a></li>
<li><a class="reference internal" href="#tightened-input-validation-on-pivot-kwarg-to-quiver">Tightened input validation on 'pivot' kwarg to quiver</a></li>
<li><a class="reference internal" href="#reordered-axes-get-children">Reordered <code class="docutils literal notranslate"><span class="pre">Axes.get_children</span></code></a></li>
<li><a class="reference internal" href="#changed-behaviour-of-contour-plots">Changed behaviour of contour plots</a></li>
<li><a class="reference internal" href="#added-set-params-function-to-all-locator-types">Added set_params function to all Locator types</a></li>
<li><a class="reference internal" href="#disallow-none-as-x-or-y-value-in-ax-plot">Disallow <code class="docutils literal notranslate"><span class="pre">None</span></code> as x or y value in ax.plot</a></li>
<li><a class="reference internal" href="#removed-args-and-kwargs-from-microsecondlocator-call">Removed <code class="docutils literal notranslate"><span class="pre">args</span></code> and <code class="docutils literal notranslate"><span class="pre">kwargs</span></code> from <code class="docutils literal notranslate"><span class="pre">MicrosecondLocator.__call__</span></code></a></li>
<li><a class="reference internal" href="#no-valueerror-for-the-microsecondlocator-and-yearlocator">No <code class="docutils literal notranslate"><span class="pre">ValueError</span></code> for the MicrosecondLocator and YearLocator</a></li>
<li><a class="reference internal" href="#offsetbox-drawingarea-respects-the-clip-keyword-argument">'OffsetBox.DrawingArea' respects the 'clip' keyword argument</a></li>
<li><a class="reference internal" href="#add-salt-to-clippath-id">Add salt to clipPath id</a></li>
<li><a class="reference internal" href="#changed-snap-threshold-for-circle-markers-to-inf">Changed snap threshold for circle markers to inf</a></li>
<li><a class="reference internal" href="#preserve-units-with-text-position">Preserve units with Text position</a></li>
<li><a class="reference internal" href="#new-api-for-custom-axes-view-changes">New API for custom Axes view changes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#mathtex-visual-changes">MathTex visual changes</a><ul>
<li><a class="reference internal" href="#improved-spacing-in-mathtext">Improved spacing in mathtext</a></li>
<li><a class="reference internal" href="#no-annotation-coordinates-wrap">No annotation coordinates wrap</a></li>
</ul>
</li>
<li><a class="reference internal" href="#deprecation">Deprecation</a><ul>
<li><a class="reference internal" href="#deprecated-graphicscontextbase-set-graylevel">Deprecated <code class="docutils literal notranslate"><span class="pre">GraphicsContextBase.set_graylevel</span></code></a></li>
<li><a class="reference internal" href="#deprecated-idle-event">deprecated idle_event</a></li>
<li><a class="reference internal" href="#color-cycle-deprecated"><code class="docutils literal notranslate"><span class="pre">color_cycle</span></code> deprecated</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bundled-jquery">Bundled jquery</a></li>
<li><a class="reference internal" href="#code-removed">Code Removed</a><ul>
<li><a class="reference internal" href="#removed-image-from-main-namespace">Removed <code class="docutils literal notranslate"><span class="pre">Image</span></code> from main namespace</a></li>
<li><a class="reference internal" href="#removed-lod-from-artist">Removed <code class="docutils literal notranslate"><span class="pre">lod</span></code> from Artist</a></li>
<li><a class="reference internal" href="#removed-threading-related-classes-from-cbook">Removed threading related classes from cbook</a></li>
<li><a class="reference internal" href="#removed-lena-images-from-sample-data">Removed <code class="docutils literal notranslate"><span class="pre">Lena</span></code> images from sample_data</a></li>
<li><a class="reference internal" href="#legend">Legend</a></li>
<li><a class="reference internal" href="#legend-handlers">Legend handlers</a></li>
<li><a class="reference internal" href="#axis">Axis</a></li>
<li><a class="reference internal" href="#finance-py">finance.py</a></li>
<li><a class="reference internal" href="#annotation">Annotation</a></li>
<li><a class="reference internal" href="#spinxext-ipython-py">spinxext.ipython_*.py</a></li>
<li><a class="reference internal" href="#linecollection-color">LineCollection.color</a></li>
<li><a class="reference internal" href="#remove-faceted-as-a-valid-value-for-shading-in-tri-tripcolor">remove <code class="docutils literal notranslate"><span class="pre">'faceted'</span></code> as a valid value for <code class="docutils literal notranslate"><span class="pre">shading</span></code> in <code class="docutils literal notranslate"><span class="pre">tri.tripcolor</span></code></a></li>
<li><a class="reference internal" href="#remove-faceted-kwarg-from-scatter">Remove <code class="docutils literal notranslate"><span class="pre">faceted</span></code> kwarg from scatter</a></li>
<li><a class="reference internal" href="#remove-set-colorbar-method-from-scalarmappable">Remove <code class="docutils literal notranslate"><span class="pre">set_colorbar</span></code> method from <code class="docutils literal notranslate"><span class="pre">ScalarMappable</span></code></a></li>
<li><a class="reference internal" href="#patheffects-svg">patheffects.svg</a></li>
<li><a class="reference internal" href="#remove-testing-image-util-py">Remove <code class="docutils literal notranslate"><span class="pre">testing.image_util.py</span></code></a></li>
<li><a class="reference internal" href="#remove-mlab-fifobuffer">Remove <code class="docutils literal notranslate"><span class="pre">mlab.FIFOBuffer</span></code></a></li>
<li><a class="reference internal" href="#remove-mlab-prepca">Remove <code class="docutils literal notranslate"><span class="pre">mlab.prepca</span></code></a></li>
<li><a class="reference internal" href="#remove-navigationtoolbar2qtagg">Remove <code class="docutils literal notranslate"><span class="pre">NavigationToolbar2QTAgg</span></code></a></li>
<li><a class="reference internal" href="#mpl-py">mpl.py</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#changes-in-1-4-x">Changes in 1.4.x</a><ul>
<li><a class="reference internal" href="#id3">Code changes</a></li>
<li><a class="reference internal" href="#id4">Code removal</a></li>
</ul>
</li>
<li><a class="reference internal" href="#changes-in-1-3-x">Changes in 1.3.x</a><ul>
<li><a class="reference internal" href="#changes-in-1-3-1">Changes in 1.3.1</a></li>
<li><a class="reference internal" href="#id5">Code removal</a></li>
<li><a class="reference internal" href="#code-deprecation">Code deprecation</a></li>
<li><a class="reference internal" href="#id6">Code changes</a></li>
<li><a class="reference internal" href="#configuration-and-rcparams">Configuration and rcParams</a></li>
</ul>
</li>
<li><a class="reference internal" href="#changes-in-1-2-x">Changes in 1.2.x</a></li>
<li><a class="reference internal" href="#changes-in-1-1-x">Changes in 1.1.x</a></li>
<li><a class="reference internal" href="#changes-beyond-0-99-x">Changes beyond 0.99.x</a></li>
<li><a class="reference internal" href="#changes-in-0-99">Changes in 0.99</a></li>
<li><a class="reference internal" href="#changes-for-0-98-x">Changes for 0.98.x</a></li>
<li><a class="reference internal" href="#changes-for-0-98-1">Changes for 0.98.1</a></li>
<li><a class="reference internal" href="#changes-for-0-98-0">Changes for 0.98.0</a><ul>
<li><a class="reference internal" href="#notes-about-the-transforms-refactoring">Notes about the transforms refactoring</a><ul>
<li><a class="reference internal" href="#matplotlib-transforms"><code class="docutils literal notranslate"><span class="pre">matplotlib.transforms</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-axes"><code class="docutils literal notranslate"><span class="pre">matplotlib.axes</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-artist"><code class="docutils literal notranslate"><span class="pre">matplotlib.artist</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-collections"><code class="docutils literal notranslate"><span class="pre">matplotlib.collections</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-colors"><code class="docutils literal notranslate"><span class="pre">matplotlib.colors</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-contour"><code class="docutils literal notranslate"><span class="pre">matplotlib.contour</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-figure"><code class="docutils literal notranslate"><span class="pre">matplotlib.figure</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-patches"><code class="docutils literal notranslate"><span class="pre">matplotlib.patches</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-backend-bases"><code class="docutils literal notranslate"><span class="pre">matplotlib.backend_bases</span></code></a></li>
<li><a class="reference internal" href="#rendererbase"><code class="docutils literal notranslate"><span class="pre">RendererBase</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#changes-for-0-91-2">Changes for 0.91.2</a></li>
<li><a class="reference internal" href="#changes-for-0-91-1">Changes for 0.91.1</a></li>
<li><a class="reference internal" href="#changes-for-0-91-0">Changes for 0.91.0</a></li>
<li><a class="reference internal" href="#changes-for-0-90-1">Changes for 0.90.1</a></li>
<li><a class="reference internal" href="#changes-for-0-90-0">Changes for 0.90.0</a></li>
<li><a class="reference internal" href="#changes-for-0-87-7">Changes for 0.87.7</a></li>
<li><a class="reference internal" href="#changes-for-0-86">Changes for 0.86</a></li>
<li><a class="reference internal" href="#changes-for-0-85">Changes for 0.85</a></li>
<li><a class="reference internal" href="#changes-for-0-84">Changes for 0.84</a></li>
<li><a class="reference internal" href="#changes-for-0-83">Changes for 0.83</a></li>
<li><a class="reference internal" href="#changes-for-0-82">Changes for 0.82</a></li>
<li><a class="reference internal" href="#changes-for-0-81">Changes for 0.81</a></li>
<li><a class="reference internal" href="#changes-for-0-80">Changes for 0.80</a></li>
<li><a class="reference internal" href="#changes-for-0-73">Changes for 0.73</a></li>
<li><a class="reference internal" href="#changes-for-0-72">Changes for 0.72</a></li>
<li><a class="reference internal" href="#changes-for-0-71">Changes for 0.71</a></li>
<li><a class="reference internal" href="#changes-for-0-70">Changes for 0.70</a></li>
<li><a class="reference internal" href="#changes-for-0-65-1">Changes for 0.65.1</a></li>
<li><a class="reference internal" href="#changes-for-0-65">Changes for 0.65</a></li>
<li><a class="reference internal" href="#changes-for-0-63">Changes for 0.63</a></li>
<li><a class="reference internal" href="#changes-for-0-61">Changes for 0.61</a></li>
<li><a class="reference internal" href="#changes-for-0-60">Changes for 0.60</a></li>
<li><a class="reference internal" href="#changes-for-0-54-3">Changes for 0.54.3</a></li>
<li><a class="reference internal" href="#changes-for-0-54">Changes for 0.54</a><ul>
<li><a class="reference internal" href="#matlab-interface">MATLAB interface</a><ul>
<li><a class="reference internal" href="#dpi">dpi</a></li>
<li><a class="reference internal" href="#pcolor-and-scatter">pcolor and scatter</a></li>
<li><a class="reference internal" href="#mathtext-spacing">mathtext spacing</a></li>
</ul>
</li>
<li><a class="reference internal" href="#object-interface-application-programmers">Object interface - Application programmers</a><ul>
<li><a class="reference internal" href="#autoscaling">Autoscaling</a></li>
<li><a class="reference internal" href="#axes-creation">Axes creation</a></li>
<li><a class="reference internal" href="#artist-methods">Artist methods</a></li>
<li><a class="reference internal" href="#bounding-boxes">Bounding boxes</a></li>
<li><a class="reference internal" href="#object-constructors">Object constructors</a></li>
<li><a class="reference internal" href="#transformations">Transformations</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#changes-for-0-50">Changes for 0.50</a></li>
<li><a class="reference internal" href="#changes-for-0-42">Changes for 0.42</a></li>
<li><a class="reference internal" href="#changes-for-0-40">Changes for 0.40</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li>Previous: <a href="pyplot_summary.html" title="previous chapter">The Pyplot API</a></li>
<li>Next: <a href="matplotlib_configuration_api.html" title="next chapter">The top level <code class="docutils literal notranslate"><span class="pre">matplotlib</span></code> module</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>Log of changes to Matplotlib that affect the outward-facing API. 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 new features that were added to Matplotlib, please see
<a class="reference internal" href="../users/whats_new.html#whats-new"><span class="std std-ref">What's new in Matplotlib</span></a>.</p>
<div class="section" id="api-changes-in-2-2-0">
<h2>API Changes in 2.2.0<a class="headerlink" href="#api-changes-in-2-2-0" title="Permalink to this headline">¶</a></h2>
<div class="section" id="new-dependency">
<h3>New dependency<a class="headerlink" href="#new-dependency" title="Permalink to this headline">¶</a></h3>
<p><a class="reference external" href="https://github.com/nucleic/kiwi">kiwisolver</a> is now a required
dependency to support the new constrained_layout, see
<a class="reference internal" href="../tutorials/intermediate/constrainedlayout_guide.html"><span class="doc">Constrained Layout Guide</span></a> for
more details.</p>
</div>
<div class="section" id="deprecations">
<h3>Deprecations<a class="headerlink" href="#deprecations" title="Permalink to this headline">¶</a></h3>
<div class="section" id="classes-functions-and-methods">
<h4>Classes, functions, and methods<a class="headerlink" href="#classes-functions-and-methods" title="Permalink to this headline">¶</a></h4>
<p>The unused and untested <code class="docutils literal notranslate"><span class="pre">Artist.onRemove</span></code> and <code class="docutils literal notranslate"><span class="pre">Artist.hitlist</span></code> methods have
been deprecated.</p>
<p>The now unused <code class="docutils literal notranslate"><span class="pre">mlab.less_simple_linear_interpolation</span></code> function is
deprecated.</p>
<p>The unused <code class="docutils literal notranslate"><span class="pre">ContourLabeler.get_real_label_width</span></code> method is deprecated.</p>
<p>The unused <code class="docutils literal notranslate"><span class="pre">FigureManagerBase.show_popup</span></code> method is deprecated. This
introduced in e945059b327d42a99938b939a1be867fa023e7ba in 2005 but never built
out into any of the backends.</p>
<p><code class="xref py py-class docutils literal notranslate"><span class="pre">backend_tkagg.AxisMenu</span></code> is deprecated, as it has become
unused since the removal of "classic" toolbars.</p>
</div>
<div class="section" id="changed-function-signatures">
<h4>Changed function signatures<a class="headerlink" href="#changed-function-signatures" title="Permalink to this headline">¶</a></h4>
<p>kwarg <code class="docutils literal notranslate"><span class="pre">fig</span></code> 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> is
deprecated, use <code class="docutils literal notranslate"><span class="pre">figure</span></code> instead.</p>
<p>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</span></code></a> as argument is deprecated. This sets
the current axes, i.e. it has the same effect as <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>. For clarity
<code class="docutils literal notranslate"><span class="pre">plt.sca(ax)</span></code> should be preferred over <code class="docutils literal notranslate"><span class="pre">plt.axes(ax)</span></code>.</p>
<p>Using strings instead of booleans to control grid and tick visibility
is deprecated. Using <code class="docutils literal notranslate"><span class="pre">"on"</span></code>, <code class="docutils literal notranslate"><span class="pre">"off"</span></code>, <code class="docutils literal notranslate"><span class="pre">"true"</span></code>, or <code class="docutils literal notranslate"><span class="pre">"false"</span></code>
to control grid and tick visibility has been deprecated. Instead, use
normal booleans (<code class="docutils literal notranslate"><span class="pre">True</span></code>/<code class="docutils literal notranslate"><span class="pre">False</span></code>) or boolean-likes. In the future,
all non-empty strings may be interpreted as <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
<p>When given 2D inputs with non-matching numbers of columns, <a class="reference internal" href="_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="matplotlib.pyplot.plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot</span></code></a>
currently cycles through the columns of the narrower input, until all the
columns of the wider input have been plotted. This behavior is deprecated; in
the future, only broadcasting (1 column to <em>n</em> columns) will be performed.</p>
</div>
<div class="section" id="rcparams">
<h4>rcparams<a class="headerlink" href="#rcparams" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">rcParams["backend.qt4"]</span></code> and <code class="docutils literal notranslate"><span class="pre">rcParams["backend.qt5"]</span></code> rcParams were deprecated
in version 2.2. In order to force the use of a specific Qt binding,
either import that binding first, or set the <code class="docutils literal notranslate"><span class="pre">QT_API</span></code> environment
variable.</p>
<p>Deprecation of the <code class="docutils literal notranslate"><span class="pre">nbagg.transparent</span></code> rcParam. To control
transparency of figure patches in the nbagg (or any other) backend,
directly set <code class="docutils literal notranslate"><span class="pre">figure.patch.facecolor</span></code>, or the <code class="docutils literal notranslate"><span class="pre">figure.facecolor</span></code>
rcParam.</p>
</div>
<div class="section" id="deprecated-axis-unit-data">
<h4>Deprecated <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.unit_data</span></code><a class="headerlink" href="#deprecated-axis-unit-data" title="Permalink to this headline">¶</a></h4>
<p>Use <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.units</span></code> (which has long existed) instead.</p>
</div>
</div>
<div class="section" id="removals">
<h3>Removals<a class="headerlink" href="#removals" title="Permalink to this headline">¶</a></h3>
<div class="section" id="function-signatures">
<h4>Function Signatures<a class="headerlink" href="#function-signatures" title="Permalink to this headline">¶</a></h4>
<p>Contouring no longer supports <code class="docutils literal notranslate"><span class="pre">legacy</span></code> corner masking. The
deprecated <code class="docutils literal notranslate"><span class="pre">ContourSet.vmin</span></code> and <code class="docutils literal notranslate"><span class="pre">ContourSet.vmax</span></code> properties have
been removed.</p>
<p>Passing <code class="docutils literal notranslate"><span class="pre">None</span></code> instead of <code class="docutils literal notranslate"><span class="pre">"none"</span></code> as format to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.errorbar.html#matplotlib.axes.Axes.errorbar" title="matplotlib.axes.Axes.errorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">errorbar</span></code></a> is no
longer supported.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">bgcolor</span></code> keyword argument to <code class="docutils literal notranslate"><span class="pre">Axes</span></code> has been removed.</p>
</div>
<div class="section" id="modules-methods-and-functions">
<h4>Modules, methods, and functions<a class="headerlink" href="#modules-methods-and-functions" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">matplotlib.finance</span></code>, <code class="docutils literal notranslate"><span class="pre">mpl_toolkits.exceltools</span></code> and
<code class="docutils literal notranslate"><span class="pre">mpl_toolkits.gtktools</span></code> modules have been removed. <code class="docutils literal notranslate"><span class="pre">matplotlib.finance</span></code>
remains available at <a class="reference external" href="https://github.com/matplotlib/mpl_finance">https://github.com/matplotlib/mpl_finance</a>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d.art3d.iscolor</span></code> function has been removed.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Axes.get_axis_bgcolor</span></code>, <code class="docutils literal notranslate"><span class="pre">Axes.set_axis_bgcolor</span></code>,
<code class="docutils literal notranslate"><span class="pre">Bbox.update_from_data</span></code>, <code class="docutils literal notranslate"><span class="pre">Bbox.update_datalim_numerix</span></code>,
<code class="docutils literal notranslate"><span class="pre">MaxNLocator.bin_boundaries</span></code> methods have been removed.</p>
<p><code class="docutils literal notranslate"><span class="pre">mencoder</span></code> can no longer be used to encode animations.</p>
<p>The unused <code class="xref py py-obj docutils literal notranslate"><span class="pre">FONT_SCALE</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">fontd</span></code> attributes of the <code class="xref py py-obj docutils literal notranslate"><span class="pre">RendererSVG</span></code>
class have been removed.</p>
</div>
<div class="section" id="color-maps">
<h4>color maps<a class="headerlink" href="#color-maps" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">spectral</span></code> colormap has been removed. The <code class="docutils literal notranslate"><span class="pre">Vega*</span></code> colormaps, which
were aliases for the <code class="docutils literal notranslate"><span class="pre">tab*</span></code> colormaps, have been removed.</p>
</div>
<div class="section" id="id1">
<h4>rcparams<a class="headerlink" href="#id1" 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">axes.color_cycle</span></code> (see <code class="docutils literal notranslate"><span class="pre">axes.prop_cycle</span></code>),</li>
<li><code class="docutils literal notranslate"><span class="pre">legend.isaxes</span></code>,</li>
<li><code class="docutils literal notranslate"><span class="pre">svg.embed_char_paths</span></code> (see <code class="docutils literal notranslate"><span class="pre">svg.fonttype</span></code>),</li>
<li><code class="docutils literal notranslate"><span class="pre">text.fontstyle</span></code>, <code class="docutils literal notranslate"><span class="pre">text.fontangle</span></code>, <code class="docutils literal notranslate"><span class="pre">text.fontvariant</span></code>,
<code class="docutils literal notranslate"><span class="pre">text.fontweight</span></code>, <code class="docutils literal notranslate"><span class="pre">text.fontsize</span></code> (renamed to <code class="docutils literal notranslate"><span class="pre">text.style</span></code>, etc.),</li>
<li><code class="docutils literal notranslate"><span class="pre">tick.size</span></code> (renamed to <code class="docutils literal notranslate"><span class="pre">tick.major.size</span></code>).</li>
</ul>
</div>
</div>
<div class="section" id="only-accept-string-like-for-categorical-input">
<h3>Only accept string-like for Categorical input<a class="headerlink" href="#only-accept-string-like-for-categorical-input" title="Permalink to this headline">¶</a></h3>
<p>Do not accept mixed string / float / int input, only
strings are valid categoricals.</p>
</div>
<div class="section" id="removal-of-unused-imports">
<h3>Removal of unused imports<a class="headerlink" href="#removal-of-unused-imports" title="Permalink to this headline">¶</a></h3>
<p>Many unused imports were removed from the codebase. As a result,
trying to import certain classes or functions from the "wrong" module
(e.g. <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> from <a class="reference internal" href="backend_agg_api.html#module-matplotlib.backends.backend_agg" title="matplotlib.backends.backend_agg"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.backends.backend_agg</span></code></a> instead of
<a class="reference internal" href="figure_api.html#module-matplotlib.figure" title="matplotlib.figure"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.figure</span></code></a>) will now raise an <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ImportError" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ImportError</span></code></a>.</p>
</div>
<div class="section" id="axes3d-get-xlim-get-ylim-and-get-zlim-now-return-a-tuple">
<h3><code class="docutils literal notranslate"><span class="pre">Axes3D.get_xlim</span></code>, <code class="docutils literal notranslate"><span class="pre">get_ylim</span></code> and <code class="docutils literal notranslate"><span class="pre">get_zlim</span></code> now return a tuple<a class="headerlink" href="#axes3d-get-xlim-get-ylim-and-get-zlim-now-return-a-tuple" title="Permalink to this headline">¶</a></h3>
<p>They previously returned an array. Returning a tuple is consistent with the
behavior for 2D axes.</p>
</div>
<div class="section" id="exception-type-changes">
<h3>Exception type changes<a class="headerlink" href="#exception-type-changes" title="Permalink to this headline">¶</a></h3>
<p>If <code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriterRegistry</span></code> can't find the requested <code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriter</span></code>, a
more helpful <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> message is now raised instead of the
previously raised <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#KeyError" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">KeyError</span></code></a>.</p>
<p><a class="reference internal" href="tight_layout_api.html#matplotlib.tight_layout.auto_adjust_subplotpars" title="matplotlib.tight_layout.auto_adjust_subplotpars"><code class="xref py py-obj docutils literal notranslate"><span class="pre">auto_adjust_subplotpars</span></code></a> now raises <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a>
instead of <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RuntimeError</span></code></a> when sizes of input lists don't match</p>
</div>
<div class="section" id="figure-set-figwidth-and-figure-set-figheight-default-forward-to-true">
<h3><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_figwidth</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_figheight</span></code> default forward to True<a class="headerlink" href="#figure-set-figwidth-and-figure-set-figheight-default-forward-to-true" title="Permalink to this headline">¶</a></h3>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.Figure.set_figwidth</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.Figure.set_figheight</span></code>
had the kwarg <code class="xref py py-obj docutils literal notranslate"><span class="pre">forward=False</span></code>
by default, but <code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_size_inches</span></code> now defaults to <code class="xref py py-obj docutils literal notranslate"><span class="pre">forward=True</span></code>.
This makes these functions conistent.</p>
</div>
<div class="section" id="do-not-truncate-svg-sizes-to-nearest-point">
<h3>Do not truncate svg sizes to nearest point<a class="headerlink" href="#do-not-truncate-svg-sizes-to-nearest-point" title="Permalink to this headline">¶</a></h3>
<p>There is no reason to size the SVG out put in integer points, change
to out putting floats for the <em>height</em>, <em>width</em>, and <em>viewBox</em> attributes
of the <em>svg</em> element.</p>
</div>
<div class="section" id="fontsizes-less-than-1-pt-are-clipped-to-be-1-pt">
<h3>Fontsizes less than 1 pt are clipped to be 1 pt.<a class="headerlink" href="#fontsizes-less-than-1-pt-are-clipped-to-be-1-pt" title="Permalink to this headline">¶</a></h3>
<p>FreeType doesn't allow fonts to get smaller than 1 pt, so all Agg
backends were silently rounding up to 1 pt. PDF (other vector
backends?) were letting us write fonts that were less than 1 pt, but
they could not be placed properly because position information comes from
FreeType. This change makes it so no backends can use fonts smaller than
1 pt, consistent with FreeType and ensuring more consistent results across
backends.</p>
</div>
<div class="section" id="changes-to-qt-backend-class-mro">
<h3>Changes to Qt backend class MRO<a class="headerlink" href="#changes-to-qt-backend-class-mro" title="Permalink to this headline">¶</a></h3>
<p>To support both Agg and cairo rendering for Qt backends all of the
non-Agg specific code previously in
<code class="xref py py-class docutils literal notranslate"><span class="pre">backend_qt5agg.FigureCanvasQTAggBase</span></code> has been moved to
<code class="xref py py-class docutils literal notranslate"><span class="pre">backend_qt5.FigureCanvasQT</span></code> so it can be shared with the cairo
implementation. The <code class="xref py py-meth docutils literal notranslate"><span class="pre">FigureCanvasQTAggBase.paintEvent()</span></code>,
<code class="xref py py-meth docutils literal notranslate"><span class="pre">FigureCanvasQTAggBase.blit()</span></code>, and
<code class="xref py py-meth docutils literal notranslate"><span class="pre">FigureCanvasQTAggBase.print_figure()</span></code> methods have moved to
<code class="xref py py-meth docutils literal notranslate"><span class="pre">FigureCanvasQTAgg.paintEvent()</span></code>, <code class="xref py py-meth docutils literal notranslate"><span class="pre">FigureCanvasQTAgg.blit()</span></code>, and
<code class="xref py py-meth docutils literal notranslate"><span class="pre">FigureCanvasQTAgg.print_figure()</span></code>. The first two methods assume that
the instance is also a <code class="xref py py-class docutils literal notranslate"><span class="pre">QWidget</span></code> so to use
<code class="xref py py-class docutils literal notranslate"><span class="pre">FigureCanvasQTAggBase</span></code> it was required to multiple inherit
from a <code class="xref py py-class docutils literal notranslate"><span class="pre">QWidget</span></code> sub-class.</p>
<p>Having moved all of its methods either up or down the class hierarchy
<code class="xref py py-class docutils literal notranslate"><span class="pre">FigureCanvasQTAggBase</span></code> has been deprecated. To do this with
out warning and to preserve as much API as possible,
<code class="xref py py-class docutils literal notranslate"><span class="pre">backend_qt5.FigureCanvasQTAggBase</span></code> now inherits from
<code class="xref py py-class docutils literal notranslate"><span class="pre">backend_qt5.FigureCanvasQTAgg</span></code>.</p>
<p>The MRO for <code class="xref py py-class docutils literal notranslate"><span class="pre">FigureCanvasQTAgg</span></code> and
<code class="xref py py-class docutils literal notranslate"><span class="pre">FigureCanvasQTAggBase</span></code> used to be</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_qt5agg</span><span class="o">.</span><span class="n">FigureCanvasQTAgg</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_qt5agg</span><span class="o">.</span><span class="n">FigureCanvasQTAggBase</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_agg</span><span class="o">.</span><span class="n">FigureCanvasAgg</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_qt5</span><span class="o">.</span><span class="n">FigureCanvasQT</span><span class="p">,</span>
<span class="n">PyQt5</span><span class="o">.</span><span class="n">QtWidgets</span><span class="o">.</span><span class="n">QWidget</span><span class="p">,</span>
<span class="n">PyQt5</span><span class="o">.</span><span class="n">QtCore</span><span class="o">.</span><span class="n">QObject</span><span class="p">,</span>
<span class="n">sip</span><span class="o">.</span><span class="n">wrapper</span><span class="p">,</span>
<span class="n">PyQt5</span><span class="o">.</span><span class="n">QtGui</span><span class="o">.</span><span class="n">QPaintDevice</span><span class="p">,</span>
<span class="n">sip</span><span class="o">.</span><span class="n">simplewrapper</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backend_bases</span><span class="o">.</span><span class="n">FigureCanvasBase</span><span class="p">,</span>
<span class="nb">object</span><span class="p">]</span>
</pre></div>
</div>
<p>and</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_qt5agg</span><span class="o">.</span><span class="n">FigureCanvasQTAggBase</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_agg</span><span class="o">.</span><span class="n">FigureCanvasAgg</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backend_bases</span><span class="o">.</span><span class="n">FigureCanvasBase</span><span class="p">,</span>
<span class="nb">object</span><span class="p">]</span>
</pre></div>
</div>
<p>respectively. They are now</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_qt5agg</span><span class="o">.</span><span class="n">FigureCanvasQTAgg</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_agg</span><span class="o">.</span><span class="n">FigureCanvasAgg</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_qt5</span><span class="o">.</span><span class="n">FigureCanvasQT</span><span class="p">,</span>
<span class="n">PyQt5</span><span class="o">.</span><span class="n">QtWidgets</span><span class="o">.</span><span class="n">QWidget</span><span class="p">,</span>
<span class="n">PyQt5</span><span class="o">.</span><span class="n">QtCore</span><span class="o">.</span><span class="n">QObject</span><span class="p">,</span>
<span class="n">sip</span><span class="o">.</span><span class="n">wrapper</span><span class="p">,</span>
<span class="n">PyQt5</span><span class="o">.</span><span class="n">QtGui</span><span class="o">.</span><span class="n">QPaintDevice</span><span class="p">,</span>
<span class="n">sip</span><span class="o">.</span><span class="n">simplewrapper</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backend_bases</span><span class="o">.</span><span class="n">FigureCanvasBase</span><span class="p">,</span>
<span class="nb">object</span><span class="p">]</span>
</pre></div>
</div>
<p>and</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_qt5agg</span><span class="o">.</span><span class="n">FigureCanvasQTAggBase</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_qt5agg</span><span class="o">.</span><span class="n">FigureCanvasQTAgg</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_agg</span><span class="o">.</span><span class="n">FigureCanvasAgg</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backends</span><span class="o">.</span><span class="n">backend_qt5</span><span class="o">.</span><span class="n">FigureCanvasQT</span><span class="p">,</span>
<span class="n">PyQt5</span><span class="o">.</span><span class="n">QtWidgets</span><span class="o">.</span><span class="n">QWidget</span><span class="p">,</span>
<span class="n">PyQt5</span><span class="o">.</span><span class="n">QtCore</span><span class="o">.</span><span class="n">QObject</span><span class="p">,</span>
<span class="n">sip</span><span class="o">.</span><span class="n">wrapper</span><span class="p">,</span>
<span class="n">PyQt5</span><span class="o">.</span><span class="n">QtGui</span><span class="o">.</span><span class="n">QPaintDevice</span><span class="p">,</span>
<span class="n">sip</span><span class="o">.</span><span class="n">simplewrapper</span><span class="p">,</span>
<span class="n">matplotlib</span><span class="o">.</span><span class="n">backend_bases</span><span class="o">.</span><span class="n">FigureCanvasBase</span><span class="p">,</span>
<span class="nb">object</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="axes-imshow-clips-rgb-values-to-the-valid-range">
<h3><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.imshow</span></code> clips RGB values to the valid range<a class="headerlink" href="#axes-imshow-clips-rgb-values-to-the-valid-range" title="Permalink to this headline">¶</a></h3>
<p>When <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.imshow</span></code> is passed an RGB or RGBA value with out-of-range
values, it now logs a warning and clips them to the valid range.
The old behaviour, wrapping back in to the range, often hid outliers
and made interpreting RGB images unreliable.</p>
</div>
<div class="section" id="gtkagg-and-gtkcairo-backends-deprecated">
<h3>GTKAgg and GTKCairo backends deprecated<a class="headerlink" href="#gtkagg-and-gtkcairo-backends-deprecated" title="Permalink to this headline">¶</a></h3>
<p>The GTKAgg and GTKCairo backends have been deprecated. These obsolete backends
allow figures to be rendered via the GTK+ 2 toolkit. They are untested, known
to be broken, will not work with Python 3, and their use has been discouraged
for some time. Instead, use the <code class="xref py py-obj docutils literal notranslate"><span class="pre">GTK3Agg</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">GTK3Cairo</span></code> backends for
rendering to GTK+ 3 windows.</p>
</div>
</div>
<div class="section" id="api-changes-in-2-1-2">
<h2>API Changes in 2.1.2<a class="headerlink" href="#api-changes-in-2-1-2" title="Permalink to this headline">¶</a></h2>
<div class="section" id="figure-legend-no-longer-checks-for-repeated-lines-to-ignore">
<h3><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.legend</span></code> no longer checks for repeated lines to ignore<a class="headerlink" href="#figure-legend-no-longer-checks-for-repeated-lines-to-ignore" title="Permalink to this headline">¶</a></h3>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.Figure.legend</span></code> used to check if a line had the
same label as an existing legend entry. If it also had the same line color
or marker color legend didn't add a new entry for that line. However, the
list of conditions was incomplete, didn't handle RGB tuples,
didn't handle linewidths or linestyles etc.</p>
<p>This logic did not exist in <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.legend</span></code>. It was included (erroneously)
in Matplotlib 2.1.1 when the legend argument parsing was unified
[#9324](<a class="reference external" href="https://github.com/matplotlib/matplotlib/pull/9324">https://github.com/matplotlib/matplotlib/pull/9324</a>). This change
removes that check in <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.legend</span></code> again to restore the old behavior.</p>
<p>This logic has also been dropped from <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.legend" title="matplotlib.figure.Figure.legend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.legend</span></code></a>, where it
was previously undocumented. Repeated
lines with the same label will now each have an entry in the legend. If
you do not want the duplicate entries, don't add a label to the line, or
prepend the label with an underscore.</p>
</div>
</div>
<div class="section" id="api-changes-in-2-1-1">
<h2>API Changes in 2.1.1<a class="headerlink" href="#api-changes-in-2-1-1" title="Permalink to this headline">¶</a></h2>
<div class="section" id="default-behavior-of-log-scales-reverted-to-clip-0-values">
<h3>Default behavior of log scales reverted to clip <= 0 values<a class="headerlink" href="#default-behavior-of-log-scales-reverted-to-clip-0-values" title="Permalink to this headline">¶</a></h3>
<p>The change it 2.1.0 to mask in logscale by default had more disruptive
changes than anticipated and has been reverted, however the clipping is now
done in a way that fixes the issues that motivated changing the default behavior
to <code class="docutils literal notranslate"><span class="pre">'mask'</span></code>.</p>
<p>As a side effect of this change, error bars which go negative now work as expected
on log scales.</p>
</div>
</div>
<div class="section" id="api-changes-in-2-1-0">
<h2>API Changes in 2.1.0<a class="headerlink" href="#api-changes-in-2-1-0" title="Permalink to this headline">¶</a></h2>
<div class="section" id="default-behavior-of-log-scales-changed-to-mask-0-values">
<h3>Default behavior of log scales changed to mask <= 0 values<a class="headerlink" href="#default-behavior-of-log-scales-changed-to-mask-0-values" title="Permalink to this headline">¶</a></h3>
<p>Calling <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_xscale.html#matplotlib.axes.Axes.set_xscale" title="matplotlib.axes.Axes.set_xscale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.set_xscale</span></code></a> or <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_yscale.html#matplotlib.axes.Axes.set_yscale" title="matplotlib.axes.Axes.set_yscale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.set_yscale</span></code></a>
now uses 'mask' as the default method to handle invalid values (as opposed to
'clip'). This means that any values <= 0 on a log scale will not be shown.</p>
<p>Previously they were clipped to a very small number and shown.</p>
</div>
<div class="section" id="matplotlib-cbook-callbackregistry-process-suppresses-exceptions-by-default">
<h3><a class="reference internal" href="cbook_api.html#matplotlib.cbook.CallbackRegistry.process" title="matplotlib.cbook.CallbackRegistry.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">matplotlib.cbook.CallbackRegistry.process()</span></code></a> suppresses exceptions by default<a class="headerlink" href="#matplotlib-cbook-callbackregistry-process-suppresses-exceptions-by-default" title="Permalink to this headline">¶</a></h3>
<p>Matplotlib uses instances of <a class="reference internal" href="cbook_api.html#matplotlib.cbook.CallbackRegistry" title="matplotlib.cbook.CallbackRegistry"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CallbackRegistry</span></code></a>
as a bridge between user input event from the GUI and user callbacks.
Previously, any exceptions raised in a user call back would bubble out
of of the <code class="docutils literal notranslate"><span class="pre">process</span></code> method, which is typically in the GUI event
loop. Most GUI frameworks simple print the traceback to the screen
and continue as there is not always a clear method of getting the
exception back to the user. However PyQt5 now exits the process when
it receives an un-handled python exception in the event loop. Thus,
<a class="reference internal" href="cbook_api.html#matplotlib.cbook.CallbackRegistry.process" title="matplotlib.cbook.CallbackRegistry.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> now suppresses and
prints tracebacks to stderr by default.</p>
<p>What <a class="reference internal" href="cbook_api.html#matplotlib.cbook.CallbackRegistry.process" title="matplotlib.cbook.CallbackRegistry.process"><code class="xref py py-meth docutils literal notranslate"><span class="pre">process()</span></code></a> does with exceptions
is now user configurable via the <code class="docutils literal notranslate"><span class="pre">exception_handler</span></code> attribute and kwarg. To
restore the previous behavior pass <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cb</span> <span class="o">=</span> <span class="n">CallbackRegistry</span><span class="p">(</span><span class="n">exception_handler</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
</pre></div>
</div>
<p>A function which take and <code class="docutils literal notranslate"><span class="pre">Exception</span></code> as its only argument may also be passed</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">maybe_reraise</span><span class="p">(</span><span class="n">exc</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="ne">RuntimeError</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="n">cb</span> <span class="o">=</span> <span class="n">CallbackRegistry</span><span class="p">(</span><span class="n">exception_handler</span><span class="o">=</span><span class="n">maybe_reraise</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="improved-toggling-of-the-axes-grids">
<h3>Improved toggling of the axes grids<a class="headerlink" href="#improved-toggling-of-the-axes-grids" title="Permalink to this headline">¶</a></h3>
<p>The <code class="xref py py-obj docutils literal notranslate"><span class="pre">g</span></code> key binding now switches the states of the <code class="xref py py-obj docutils literal notranslate"><span class="pre">x</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">y</span></code> grids
independently (by cycling through all four on/off combinations).</p>
<p>The new <code class="xref py py-obj docutils literal notranslate"><span class="pre">G</span></code> key binding switches the states of the minor grids.</p>
<p>Both bindings are disabled if only a subset of the grid lines (in either
direction) is visible, to avoid making irreversible changes to the figure.</p>
</div>
<div class="section" id="ticklabels-are-turned-off-instead-of-being-invisible">
<h3>Ticklabels are turned off instead of being invisible<a class="headerlink" href="#ticklabels-are-turned-off-instead-of-being-invisible" title="Permalink to this headline">¶</a></h3>
<p>Internally, the <code class="xref py py-obj docutils literal notranslate"><span class="pre">Tick</span></code>'s <code class="xref py py-func docutils literal notranslate"><span class="pre">label1On()</span></code> attribute
is now used to hide tick labels instead of setting the visibility on the tick
label objects.
This improves overall performance and fixes some issues.
As a consequence, in case those labels ought to be shown,
<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-func docutils literal notranslate"><span class="pre">tick_params()</span></code></a>
needs to be used, e.g.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">tick_params</span><span class="p">(</span><span class="n">labelbottom</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="removal-of-warning-on-empty-legends">
<h3>Removal of warning on empty legends<a class="headerlink" href="#removal-of-warning-on-empty-legends" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">plt.legend</span></code> used to issue a warning when no labeled artist could be
found. This warning has been removed.</p>
</div>
<div class="section" id="more-accurate-legend-autopositioning">
<h3>More accurate legend autopositioning<a class="headerlink" href="#more-accurate-legend-autopositioning" title="Permalink to this headline">¶</a></h3>
<p>Automatic positioning of legends now prefers using the area surrounded
by a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Line2D</span></code> rather than placing the legend over the line itself.</p>
</div>
<div class="section" id="cleanup-of-stock-sample-data">
<h3>Cleanup of stock sample data<a class="headerlink" href="#cleanup-of-stock-sample-data" title="Permalink to this headline">¶</a></h3>
<p>The sample data of stocks has been cleaned up to remove redundancies and
increase portability. The <code class="docutils literal notranslate"><span class="pre">AAPL.dat.gz</span></code>, <code class="docutils literal notranslate"><span class="pre">INTC.dat.gz</span></code> and <code class="docutils literal notranslate"><span class="pre">aapl.csv</span></code>
files have been removed entirely and will also no longer be available from
<a class="reference internal" href="cbook_api.html#matplotlib.cbook.get_sample_data" title="matplotlib.cbook.get_sample_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.cbook.get_sample_data</span></code></a>. If a CSV file is required, we suggest using
the <code class="docutils literal notranslate"><span class="pre">msft.csv</span></code> that continues to be shipped in the sample data. If a NumPy
binary file is acceptable, we suggest using one of the following two new files.
The <code class="docutils literal notranslate"><span class="pre">aapl.npy.gz</span></code> and <code class="docutils literal notranslate"><span class="pre">goog.npy</span></code> files have been replaced by <code class="docutils literal notranslate"><span class="pre">aapl.npz</span></code>
and <code class="docutils literal notranslate"><span class="pre">goog.npz</span></code>, wherein the first column's type has changed from
<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.date" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.date</span></code></a> to <code class="xref py py-obj docutils literal notranslate"><span class="pre">np.datetime64</span></code> for better portability across Python
versions. Note that Matplotlib does not fully support <code class="xref py py-obj docutils literal notranslate"><span class="pre">np.datetime64</span></code> as yet.</p>
</div>
<div class="section" id="updated-qhull-to-2015-2">
<h3>Updated qhull to 2015.2<a class="headerlink" href="#updated-qhull-to-2015-2" title="Permalink to this headline">¶</a></h3>
<p>The version of qhull shipped with Matplotlib, which is used for
Delaunay triangulation, has been updated from version 2012.1 to
2015.2.</p>
</div>
<div class="section" id="improved-delaunay-triangulations-with-large-offsets">
<h3>Improved Delaunay triangulations with large offsets<a class="headerlink" href="#improved-delaunay-triangulations-with-large-offsets" title="Permalink to this headline">¶</a></h3>
<p>Delaunay triangulations now deal with large x,y offsets in a better
way. This can cause minor changes to any triangulations calculated
using Matplotlib, i.e. any use of <a class="reference internal" href="tri_api.html#matplotlib.tri.Triangulation" title="matplotlib.tri.Triangulation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.tri.Triangulation</span></code></a> that
requests that a Delaunay triangulation is calculated, which includes
<a class="reference internal" href="_as_gen/matplotlib.pyplot.tricontour.html#matplotlib.pyplot.tricontour" title="matplotlib.pyplot.tricontour"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pyplot.tricontour</span></code></a>, <a class="reference internal" href="_as_gen/matplotlib.pyplot.tricontourf.html#matplotlib.pyplot.tricontourf" title="matplotlib.pyplot.tricontourf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pyplot.tricontourf</span></code></a>,
<a class="reference internal" href="_as_gen/matplotlib.pyplot.tripcolor.html#matplotlib.pyplot.tripcolor" title="matplotlib.pyplot.tripcolor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pyplot.tripcolor</span></code></a>, <a class="reference internal" href="_as_gen/matplotlib.pyplot.triplot.html#matplotlib.pyplot.triplot" title="matplotlib.pyplot.triplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pyplot.triplot</span></code></a>,
<a class="reference internal" href="mlab_api.html#matplotlib.mlab.griddata" title="matplotlib.mlab.griddata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.mlab.griddata</span></code></a> and
<a class="reference internal" href="_as_gen/mpl_toolkits.mplot3d.axes3d.Axes3D.html#mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf" title="mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf</span></code></a>.</p>
</div>
<div class="section" id="use-backports-functools-lru-cache-instead-of-functools32">
<h3>Use <code class="docutils literal notranslate"><span class="pre">backports.functools_lru_cache</span></code> instead of <code class="docutils literal notranslate"><span class="pre">functools32</span></code><a class="headerlink" href="#use-backports-functools-lru-cache-instead-of-functools32" title="Permalink to this headline">¶</a></h3>
<p>It's better maintained and more widely used (by pylint, jaraco, etc).</p>
</div>
<div class="section" id="cbook-is-numlike-only-performs-an-instance-check">
<h3><code class="docutils literal notranslate"><span class="pre">cbook.is_numlike</span></code> only performs an instance check<a class="headerlink" href="#cbook-is-numlike-only-performs-an-instance-check" title="Permalink to this headline">¶</a></h3>
<p><a class="reference internal" href="cbook_api.html#matplotlib.cbook.is_numlike" title="matplotlib.cbook.is_numlike"><code class="xref py py-func docutils literal notranslate"><span class="pre">is_numlike()</span></code></a> now only checks that its argument
is an instance of <code class="docutils literal notranslate"><span class="pre">(numbers.Number,</span> <span class="pre">np.Number)</span></code>. In particular,
this means that arrays are now not num-like.</p>
</div>
<div class="section" id="elliptical-arcs-now-drawn-between-correct-angles">
<h3>Elliptical arcs now drawn between correct angles<a class="headerlink" href="#elliptical-arcs-now-drawn-between-correct-angles" title="Permalink to this headline">¶</a></h3>
<p>The <a class="reference internal" href="_as_gen/matplotlib.patches.Arc.html#matplotlib.patches.Arc" title="matplotlib.patches.Arc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.patches.Arc</span></code></a> patch is now correctly drawn between the given
angles.</p>
<p>Previously a circular arc was drawn and then stretched into an ellipse,
so the resulting arc did not lie between <em>theta1</em> and <em>theta2</em>.</p>
</div>
<div class="section" id="d-backend-no-longer-sets-the-backend">
<h3><code class="docutils literal notranslate"><span class="pre">-d$backend</span></code> no longer sets the backend<a class="headerlink" href="#d-backend-no-longer-sets-the-backend" title="Permalink to this headline">¶</a></h3>
<p>It is no longer possible to set the backend by passing <code class="docutils literal notranslate"><span class="pre">-d$backend</span></code>
at the command line. Use the <code class="docutils literal notranslate"><span class="pre">MPLBACKEND</span></code> environment variable
instead.</p>
</div>
<div class="section" id="path-intersects-bbox-always-treats-the-bounding-box-as-filled">
<h3>Path.intersects_bbox always treats the bounding box as filled<a class="headerlink" href="#path-intersects-bbox-always-treats-the-bounding-box-as-filled" title="Permalink to this headline">¶</a></h3>
<p>Previously, when <code class="docutils literal notranslate"><span class="pre">Path.intersects_bbox</span></code> was called with <code class="docutils literal notranslate"><span class="pre">filled</span></code> set to
<code class="docutils literal notranslate"><span class="pre">False</span></code>, it would treat both the path and the bounding box as unfilled. This
behavior was not well documented and it is usually not the desired behavior,
since bounding boxes are used to represent more complex shapes located inside
the bounding box. This behavior has now been changed: when <code class="docutils literal notranslate"><span class="pre">filled</span></code> is
<code class="docutils literal notranslate"><span class="pre">False</span></code>, the path will be treated as unfilled, but the bounding box is still
treated as filled. The old behavior was arguably an implementation bug.</p>
<p>When <code class="docutils literal notranslate"><span class="pre">Path.intersects_bbox</span></code> is called with <code class="docutils literal notranslate"><span class="pre">filled</span></code> set to <code class="docutils literal notranslate"><span class="pre">True</span></code>
(the default value), there is no change in behavior. For those rare cases where
<code class="docutils literal notranslate"><span class="pre">Path.intersects_bbox</span></code> was called with <code class="docutils literal notranslate"><span class="pre">filled</span></code> set to <code class="docutils literal notranslate"><span class="pre">False</span></code> and where
the old behavior is actually desired, the suggested workaround is to call
<code class="docutils literal notranslate"><span class="pre">Path.intersects_path</span></code> with a rectangle as the path:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib.path</span> <span class="k">import</span> <span class="n">Path</span>
<span class="kn">from</span> <span class="nn">matplotlib.transforms</span> <span class="k">import</span> <span class="n">Bbox</span><span class="p">,</span> <span class="n">BboxTransformTo</span>
<span class="n">rect</span> <span class="o">=</span> <span class="n">Path</span><span class="o">.</span><span class="n">unit_rectangle</span><span class="p">()</span><span class="o">.</span><span class="n">transformed</span><span class="p">(</span><span class="n">BboxTransformTo</span><span class="p">(</span><span class="n">bbox</span><span class="p">))</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">intersects_path</span><span class="p">(</span><span class="n">rect</span><span class="p">,</span> <span class="n">filled</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="wx-no-longer-calls-generates-idleevent-events-or-calls-idle-event">
<h3>WX no longer calls generates <code class="docutils literal notranslate"><span class="pre">IdleEvent</span></code> events or calls <code class="docutils literal notranslate"><span class="pre">idle_event</span></code><a class="headerlink" href="#wx-no-longer-calls-generates-idleevent-events-or-calls-idle-event" title="Permalink to this headline">¶</a></h3>
<p>Removed unused private method <code class="docutils literal notranslate"><span class="pre">_onIdle</span></code> from <code class="docutils literal notranslate"><span class="pre">FigureCanvasWx</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">IdleEvent</span></code> class and <code class="docutils literal notranslate"><span class="pre">FigureCanvasBase.idle_event</span></code> method
will be removed in 2.2</p>
</div>
<div class="section" id="correct-scaling-of-magnitude-spectrum">
<h3>Correct scaling of <code class="xref py py-func docutils literal notranslate"><span class="pre">magnitude_spectrum()</span></code><a class="headerlink" href="#correct-scaling-of-magnitude-spectrum" title="Permalink to this headline">¶</a></h3>
<p>The functions <a class="reference internal" href="mlab_api.html#matplotlib.mlab.magnitude_spectrum" title="matplotlib.mlab.magnitude_spectrum"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.mlab.magnitude_spectrum()</span></code></a> and <a class="reference internal" href="_as_gen/matplotlib.pyplot.magnitude_spectrum.html#matplotlib.pyplot.magnitude_spectrum" title="matplotlib.pyplot.magnitude_spectrum"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.magnitude_spectrum()</span></code></a> implicitly assumed the sum
of windowing function values to be one. In Matplotlib and Numpy the
standard windowing functions are scaled to have maximum value of one,
which usually results in a sum of the order of n/2 for a n-point
signal. Thus the amplitude scaling <code class="xref py py-func docutils literal notranslate"><span class="pre">magnitude_spectrum()</span></code> was
off by that amount when using standard windowing functions (<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues/8417">Bug 8417</a> ). Now the
behavior is consistent with <a class="reference internal" href="_as_gen/matplotlib.pyplot.psd.html#matplotlib.pyplot.psd" title="matplotlib.pyplot.psd"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.psd()</span></code></a> and
<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.welch.html#scipy.signal.welch" title="(in SciPy v1.2.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.signal.welch()</span></code></a>. The following example demonstrates the
new and old scaling:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="n">tau</span><span class="p">,</span> <span class="n">n</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">1024</span> <span class="c1"># 10 second signal with 1024 points</span>
<span class="n">T</span> <span class="o">=</span> <span class="n">tau</span><span class="o">/</span><span class="n">n</span> <span class="c1"># sampling interval</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="n">n</span><span class="p">)</span><span class="o">*</span><span class="n">T</span>
<span class="n">a</span> <span class="o">=</span> <span class="mi">4</span> <span class="c1"># amplitude</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">a</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="mi">40</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="o">*</span><span class="n">t</span><span class="p">)</span> <span class="c1"># 20 Hz sine with amplitude a</span>
<span class="c1"># New correct behavior: Amplitude at 20 Hz is a/2</span>
<span class="n">plt</span><span class="o">.</span><span class="n">magnitude_spectrum</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">Fs</span><span class="o">=</span><span class="mi">1</span><span class="o">/</span><span class="n">T</span><span class="p">,</span> <span class="n">sides</span><span class="o">=</span><span class="s1">'onesided'</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="s1">'linear'</span><span class="p">)</span>
<span class="c1"># Original behavior: Amplitude at 20 Hz is (a/2)*(n/2) for a Hanning window</span>
<span class="n">w</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">hanning</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="c1"># default window is a Hanning window</span>
<span class="n">plt</span><span class="o">.</span><span class="n">magnitude_spectrum</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">sum</span><span class="p">(</span><span class="n">w</span><span class="p">),</span> <span class="n">Fs</span><span class="o">=</span><span class="mi">1</span><span class="o">/</span><span class="n">T</span><span class="p">,</span> <span class="n">sides</span><span class="o">=</span><span class="s1">'onesided'</span><span class="p">,</span> <span class="n">scale</span><span class="o">=</span><span class="s1">'linear'</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="change-to-signatures-of-bar-barh">
<h3>Change to signatures of <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bar()</span></code></a> & <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.barh.html#matplotlib.axes.Axes.barh" title="matplotlib.axes.Axes.barh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">barh()</span></code></a><a class="headerlink" href="#change-to-signatures-of-bar-barh" title="Permalink to this headline">¶</a></h3>
<p>For 2.0 the <a class="reference internal" href="../users/dflt_style_changes.html#barbarh-align"><span class="std std-ref">default value of *align*</span></a> changed to
<code class="docutils literal notranslate"><span class="pre">'center'</span></code>. However this caused the signature of
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bar()</span></code></a> and
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.barh.html#matplotlib.axes.Axes.barh" title="matplotlib.axes.Axes.barh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">barh()</span></code></a> to be misleading as the first parameters were
still <em>left</em> and <em>bottom</em> respectively:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bar</span><span class="p">(</span><span class="n">left</span><span class="p">,</span> <span class="n">height</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">align</span><span class="o">=</span><span class="s1">'center'</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">barh</span><span class="p">(</span><span class="n">bottom</span><span class="p">,</span> <span class="n">width</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">align</span><span class="o">=</span><span class="s1">'center'</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>despite behaving as the center in both cases. The methods now take
<code class="docutils literal notranslate"><span class="pre">*args,</span> <span class="pre">**kwargs</span></code> as input and are documented to have the primary
signatures of:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bar</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">height</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">align</span><span class="o">=</span><span class="s1">'center'</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">barh</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">width</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">align</span><span class="o">=</span><span class="s1">'center'</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>Passing <em>left</em> and <em>bottom</em> as keyword arguments to
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bar()</span></code></a> and
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.barh.html#matplotlib.axes.Axes.barh" title="matplotlib.axes.Axes.barh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">barh()</span></code></a> respectively will warn.
Support will be removed in Matplotlib 3.0.</p>
</div>
<div class="section" id="font-cache-as-json">
<h3>Font cache as json<a class="headerlink" href="#font-cache-as-json" title="Permalink to this headline">¶</a></h3>
<p>The font cache is now saved as json, rather than a pickle.</p>
</div>
<div class="section" id="invalid-non-finite-axis-limit-error">
<h3>Invalid (Non-finite) Axis Limit Error<a class="headerlink" href="#invalid-non-finite-axis-limit-error" title="Permalink to this headline">¶</a></h3>
<p>When using <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-func docutils literal notranslate"><span class="pre">set_xlim()</span></code></a> and
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.set_ylim.html#matplotlib.axes.Axes.set_ylim" title="matplotlib.axes.Axes.set_ylim"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_ylim()</span></code></a>, passing non-finite values now
results in a <code class="docutils literal notranslate"><span class="pre">ValueError</span></code>. The previous behavior resulted in the
limits being erroneously reset to <code class="docutils literal notranslate"><span class="pre">(-0.001,</span> <span class="pre">0.001)</span></code>.</p>
</div>
<div class="section" id="scatter-and-collection-offsets-are-no-longer-implicitly-flattened">
<h3><code class="docutils literal notranslate"><span class="pre">scatter</span></code> and <code class="docutils literal notranslate"><span class="pre">Collection</span></code> offsets are no longer implicitly flattened<a class="headerlink" href="#scatter-and-collection-offsets-are-no-longer-implicitly-flattened" title="Permalink to this headline">¶</a></h3>
<p><a class="reference internal" href="collections_api.html#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Collection</span></code></a> (and thus both 2D
<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 3D
<a class="reference internal" href="_as_gen/mpl_toolkits.mplot3d.axes3d.Axes3D.html#mpl_toolkits.mplot3d.axes3d.Axes3D.scatter" title="mpl_toolkits.mplot3d.axes3d.Axes3D.scatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scatter</span></code></a>) no
longer implicitly flattens its offsets. As a consequence, <code class="docutils literal notranslate"><span class="pre">scatter</span></code>'s <code class="docutils literal notranslate"><span class="pre">x</span></code>
and <code class="docutils literal notranslate"><span class="pre">y</span></code> arguments can no longer be 2+-dimensional arrays.</p>
</div>
<div class="section" id="id2">
<h3>Deprecations<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<div class="section" id="graphicscontextbase-s-linestyle-property">
<h4><code class="docutils literal notranslate"><span class="pre">GraphicsContextBase</span></code>'s <code class="docutils literal notranslate"><span class="pre">linestyle</span></code> property.<a class="headerlink" href="#graphicscontextbase-s-linestyle-property" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">GraphicsContextBase.get_linestyle</span></code> and
<code class="docutils literal notranslate"><span class="pre">GraphicsContextBase.set_linestyle</span></code> methods, which had no effect,
have been deprecated. All of the backends Matplotlib ships use
<code class="docutils literal notranslate"><span class="pre">GraphicsContextBase.get_dashes</span></code> and
<code class="docutils literal notranslate"><span class="pre">GraphicsContextBase.set_dashes</span></code> which are more general.
Third-party backends should also migrate to the <code class="docutils literal notranslate"><span class="pre">*_dashes</span></code> methods.</p>
</div>
<div class="section" id="navigationtoolbar2-dynamic-update">
<h4><code class="docutils literal notranslate"><span class="pre">NavigationToolbar2.dynamic_update</span></code><a class="headerlink" href="#navigationtoolbar2-dynamic-update" title="Permalink to this headline">¶</a></h4>
<p>Use <code class="xref py py-meth docutils literal notranslate"><span class="pre">draw_idle()</span></code> method on the <code class="docutils literal notranslate"><span class="pre">Canvas</span></code> instance instead.</p>
</div>
<div class="section" id="testing">
<h4>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h4>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.testing.noseclasses</span></code> is deprecated and will be removed in 2.3</p>
</div>
<div class="section" id="engformatter-num-arg-as-string">
<h4><code class="docutils literal notranslate"><span class="pre">EngFormatter</span></code> <em>num</em> arg as string<a class="headerlink" href="#engformatter-num-arg-as-string" title="Permalink to this headline">¶</a></h4>
<p>Passing a string as <em>num</em> argument when calling an instance of
<a class="reference internal" href="ticker_api.html#matplotlib.ticker.EngFormatter" title="matplotlib.ticker.EngFormatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.ticker.EngFormatter</span></code></a> is deprecated and will be removed in 2.3.</p>
</div>
<div class="section" id="mpl-toolkits-axes-grid-module">
<h4><code class="docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid</span></code> module<a class="headerlink" href="#mpl-toolkits-axes-grid-module" title="Permalink to this headline">¶</a></h4>
<p>All functionally from <code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid</span></code> can be found in either
<code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid1</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.axisartist</span></code>. Axes classes
from <code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid</span></code> based on <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code> from
<code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.axisartist</span></code> can be found in <code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.axisartist</span></code>.</p>
</div>
<div class="section" id="axes-collision-in-figure-add-axes">
<h4><code class="docutils literal notranslate"><span class="pre">Axes</span></code> collision in <code class="docutils literal notranslate"><span class="pre">Figure.add_axes</span></code><a class="headerlink" href="#axes-collision-in-figure-add-axes" title="Permalink to this headline">¶</a></h4>
<p>Adding an axes instance to a figure by using the same arguments as for
a previous axes instance currently reuses the earlier instance. This
behavior has been deprecated in Matplotlib 2.1. In a future version, a
<em>new</em> instance will always be created and returned. Meanwhile, in such
a situation, a deprecation warning is raised by
<a class="reference internal" href="_as_gen/matplotlib.figure.AxesStack.html#matplotlib.figure.AxesStack" title="matplotlib.figure.AxesStack"><code class="xref py py-class docutils literal notranslate"><span class="pre">AxesStack</span></code></a>.</p>
<p>This warning can be suppressed, and the future behavior ensured, by passing
a <em>unique</em> label to each axes instance. See the docstring of
<a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.add_axes" title="matplotlib.figure.Figure.add_axes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_axes()</span></code></a> for more information.</p>
<p>Additional details on the rationale behind this deprecation can be found
in <a class="reference external" href="https://github.com/matplotlib/matplotlib/issues/7377/">#7377</a> and <a class="reference external" href="https://github.com/matplotlib/matplotlib/issues/9024/">#9024</a>.</p>
</div>
<div class="section" id="former-validators-for-contour-negative-linestyle">
<h4>Former validators for <code class="docutils literal notranslate"><span class="pre">contour.negative_linestyle</span></code><a class="headerlink" href="#former-validators-for-contour-negative-linestyle" title="Permalink to this headline">¶</a></h4>
<p>The former public validation functions <code class="docutils literal notranslate"><span class="pre">validate_negative_linestyle</span></code>
and <code class="docutils literal notranslate"><span class="pre">validate_negative_linestyle_legacy</span></code> will be deprecated in 2.1 and
may be removed in 2.3. There are no public functions to replace them.</p>
</div>
<div class="section" id="cbook">
<h4><code class="docutils literal notranslate"><span class="pre">cbook</span></code><a class="headerlink" href="#cbook" title="Permalink to this headline">¶</a></h4>
<p>Many unused or near-unused <a class="reference internal" href="cbook_api.html#module-matplotlib.cbook" title="matplotlib.cbook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.cbook</span></code></a> functions and
classes have been deprecated: <code class="docutils literal notranslate"><span class="pre">converter</span></code>, <code class="docutils literal notranslate"><span class="pre">tostr</span></code>,
<code class="docutils literal notranslate"><span class="pre">todatetime</span></code>, <code class="docutils literal notranslate"><span class="pre">todate</span></code>, <code class="docutils literal notranslate"><span class="pre">tofloat</span></code>, <code class="docutils literal notranslate"><span class="pre">toint</span></code>, <code class="docutils literal notranslate"><span class="pre">unique</span></code>,
<code class="docutils literal notranslate"><span class="pre">is_string_like</span></code>, <code class="docutils literal notranslate"><span class="pre">is_sequence_of_strings</span></code>, <code class="docutils literal notranslate"><span class="pre">is_scalar</span></code>,
<code class="docutils literal notranslate"><span class="pre">Sorter</span></code>, <code class="docutils literal notranslate"><span class="pre">Xlator</span></code>, <code class="docutils literal notranslate"><span class="pre">soundex</span></code>, <code class="docutils literal notranslate"><span class="pre">Null</span></code>, <code class="docutils literal notranslate"><span class="pre">dict_delall</span></code>,
<code class="docutils literal notranslate"><span class="pre">RingBuffer</span></code>, <code class="docutils literal notranslate"><span class="pre">get_split_ind</span></code>, <code class="docutils literal notranslate"><span class="pre">wrap</span></code>,
<code class="docutils literal notranslate"><span class="pre">get_recursive_filelist</span></code>, <code class="docutils literal notranslate"><span class="pre">pieces</span></code>, <code class="docutils literal notranslate"><span class="pre">exception_to_str</span></code>,
<code class="docutils literal notranslate"><span class="pre">allequal</span></code>, <code class="docutils literal notranslate"><span class="pre">alltrue</span></code>, <code class="docutils literal notranslate"><span class="pre">onetrue</span></code>, <code class="docutils literal notranslate"><span class="pre">allpairs</span></code>, <code class="docutils literal notranslate"><span class="pre">finddir</span></code>,
<code class="docutils literal notranslate"><span class="pre">reverse_dict</span></code>, <code class="docutils literal notranslate"><span class="pre">restrict_dict</span></code>, <code class="docutils literal notranslate"><span class="pre">issubclass_safe</span></code>,
<code class="docutils literal notranslate"><span class="pre">recursive_remove</span></code>, <code class="docutils literal notranslate"><span class="pre">unmasked_index_ranges</span></code>.</p>
</div>
</div>
<div class="section" id="code-removal">
<h3>Code Removal<a class="headerlink" href="#code-removal" title="Permalink to this headline">¶</a></h3>
<div class="section" id="qt4-compat-py">
<h4>qt4_compat.py<a class="headerlink" href="#qt4-compat-py" title="Permalink to this headline">¶</a></h4>
<p>Moved to <code class="docutils literal notranslate"><span class="pre">qt_compat.py</span></code>. Renamed because it now handles Qt5 as well.</p>
</div>
<div class="section" id="previously-deprecated-methods">
<h4>Previously Deprecated methods<a class="headerlink" href="#previously-deprecated-methods" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">GraphicsContextBase.set_graylevel</span></code>, <code class="docutils literal notranslate"><span class="pre">FigureCanvasBase.onHilite</span></code> and
<code class="docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid1.mpl_axes.Axes.toggle_axisline</span></code> methods have been
removed.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">ArtistInspector.findobj</span></code> method, which was never working due to the lack
of a <code class="docutils literal notranslate"><span class="pre">get_children</span></code> method, has been removed.</p>
<p>The deprecated <code class="docutils literal notranslate"><span class="pre">point_in_path</span></code>, <code class="docutils literal notranslate"><span class="pre">get_path_extents</span></code>,
<code class="docutils literal notranslate"><span class="pre">point_in_path_collection</span></code>, <code class="docutils literal notranslate"><span class="pre">path_intersects_path</span></code>,
<code class="docutils literal notranslate"><span class="pre">convert_path_to_polygons</span></code>, <code class="docutils literal notranslate"><span class="pre">cleanup_path</span></code> and <code class="docutils literal notranslate"><span class="pre">clip_path_to_rect</span></code>
functions in the <code class="docutils literal notranslate"><span class="pre">matplotlib.path</span></code> module have been removed. Their
functionality remains exposed as methods on the <code class="docutils literal notranslate"><span class="pre">Path</span></code> class.</p>
<p>The deprecated <code class="docutils literal notranslate"><span class="pre">Artist.get_axes</span></code> and <code class="docutils literal notranslate"><span class="pre">Artist.set_axes</span></code> methods
have been removed</p>
<p>The <code class="docutils literal notranslate"><span class="pre">matplotlib.backends.backend_ps.seq_allequal</span></code> function has been removed.
Use <code class="docutils literal notranslate"><span class="pre">np.array_equal</span></code> instead.</p>
<p>The deprecated <code class="docutils literal notranslate"><span class="pre">matplotlib.rcsetup.validate_maskedarray</span></code>,
<code class="docutils literal notranslate"><span class="pre">matplotlib.rcsetup.deprecate_savefig_extension</span></code> and
<code class="docutils literal notranslate"><span class="pre">matplotlib.rcsetup.validate_tkpythoninspect</span></code> functions, and associated
<code class="docutils literal notranslate"><span class="pre">savefig.extension</span></code> and <code class="docutils literal notranslate"><span class="pre">tk.pythoninspect</span></code> rcparams entries have been
removed.</p>
<p>The kwarg <code class="docutils literal notranslate"><span class="pre">resolution</span></code> of
<a class="reference internal" href="projections_api.html#matplotlib.projections.polar.PolarAxes" title="matplotlib.projections.polar.PolarAxes"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.projections.polar.PolarAxes</span></code></a> has been removed. It
has deprecation with no effect from version <code class="xref py py-obj docutils literal notranslate"><span class="pre">0.98.x</span></code>.</p>
</div>
<div class="section" id="axes-set-aspect-normal">
<h4><code class="docutils literal notranslate"><span class="pre">Axes.set_aspect("normal")</span></code><a class="headerlink" href="#axes-set-aspect-normal" title="Permalink to this headline">¶</a></h4>
<p>Support for setting an <code class="docutils literal notranslate"><span class="pre">Axes</span></code>'s aspect to <code class="docutils literal notranslate"><span class="pre">"normal"</span></code> has been
removed, in favor of the synonym <code class="docutils literal notranslate"><span class="pre">"auto"</span></code>.</p>
</div>
<div class="section" id="shading-kwarg-to-pcolor">
<h4><code class="docutils literal notranslate"><span class="pre">shading</span></code> kwarg to <code class="docutils literal notranslate"><span class="pre">pcolor</span></code><a class="headerlink" href="#shading-kwarg-to-pcolor" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">shading</span></code> kwarg to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.pcolor.html#matplotlib.axes.Axes.pcolor" title="matplotlib.axes.Axes.pcolor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pcolor</span></code></a> has been
removed. Set <code class="docutils literal notranslate"><span class="pre">edgecolors</span></code> appropriately instead.</p>
</div>
<div class="section" id="functions-removed-from-the-lines-module">
<h4>Functions removed from the <code class="xref py py-obj docutils literal notranslate"><span class="pre">lines</span></code> module<a class="headerlink" href="#functions-removed-from-the-lines-module" title="Permalink to this headline">¶</a></h4>
<p>The <a class="reference internal" href="lines_api.html#module-matplotlib.lines" title="matplotlib.lines"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.lines</span></code></a> module no longer imports the
<code class="docutils literal notranslate"><span class="pre">pts_to_prestep</span></code>, <code class="docutils literal notranslate"><span class="pre">pts_to_midstep</span></code> and <code class="docutils literal notranslate"><span class="pre">pts_to_poststep</span></code>
functions from <a class="reference internal" href="cbook_api.html#module-matplotlib.cbook" title="matplotlib.cbook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.cbook</span></code></a>.</p>
</div>
<div class="section" id="pdf-backend-functions">
<h4>PDF backend functions<a class="headerlink" href="#pdf-backend-functions" title="Permalink to this headline">¶</a></h4>
<p>The methods <code class="docutils literal notranslate"><span class="pre">embedTeXFont</span></code> and <code class="docutils literal notranslate"><span class="pre">tex_font_mapping</span></code> of
<code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backqend_pdf.PdfFile</span></code> have been removed. It is