-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathapi_changes.html
More file actions
3322 lines (3117 loc) · 356 KB
/
api_changes.html
File metadata and controls
3322 lines (3117 loc) · 356 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.0.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.0.1',
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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.0.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.0.1 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="Plotting commands summary" href="pyplot_summary.html" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/api/api_changes.html" />
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.0.1). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
</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="Plotting commands summary"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</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">
<a href="http://depsy.org/package/python/matplotlib">
<img src="../_static/depsy_badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<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-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"><span class="pre">matplotlib.backend_bases.GraphicsContextBase</span></code></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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><span class="pre">matplotlib.cbook.ls_mapper</span></code>, added <code class="docutils literal"><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"><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"><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"><span class="pre">args</span></code> and <code class="docutils literal"><span class="pre">kwargs</span></code> from <code class="docutils literal"><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"><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"><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"><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"><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"><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"><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"><span class="pre">'faceted'</span></code> as a valid value for <code class="docutils literal"><span class="pre">shading</span></code> in <code class="docutils literal"><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"><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"><span class="pre">set_colorbar</span></code> method from <code class="docutils literal"><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"><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"><span class="pre">mlab.FIFOBuffer</span></code></a></li>
<li><a class="reference internal" href="#remove-mlab-prepca">Remove <code class="docutils literal"><span class="pre">mlab.prepca</span></code></a></li>
<li><a class="reference internal" href="#remove-navigationtoolbar2qtagg">Remove <code class="docutils literal"><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="#id1">Code changes</a></li>
<li><a class="reference internal" href="#code-removal">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="#id2">Code removal</a></li>
<li><a class="reference internal" href="#code-deprecation">Code deprecation</a></li>
<li><a class="reference internal" href="#id3">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"><span class="pre">matplotlib.transforms</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-axes"><code class="docutils literal"><span class="pre">matplotlib.axes</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-artist"><code class="docutils literal"><span class="pre">matplotlib.artist</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-collections"><code class="docutils literal"><span class="pre">matplotlib.collections</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-colors"><code class="docutils literal"><span class="pre">matplotlib.colors</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-contour"><code class="docutils literal"><span class="pre">matplotlib.contour</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-figure"><code class="docutils literal"><span class="pre">matplotlib.figure</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-patches"><code class="docutils literal"><span class="pre">matplotlib.patches</span></code></a></li>
<li><a class="reference internal" href="#matplotlib-backend-bases"><code class="docutils literal"><span class="pre">matplotlib.backend_bases</span></code></a></li>
<li><a class="reference internal" href="#rendererbase"><code class="docutils literal"><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">Plotting commands summary</a></li>
<li>Next: <a href="matplotlib_configuration_api.html" title="next chapter">The top level <code class="docutils literal"><span class="pre">matplotlib</span></code> module</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/api_changes.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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-0-1">
<h2>API Changes in 2.0.1<a class="headerlink" href="#api-changes-in-2-0-1" title="Permalink to this headline">¶</a></h2>
<div class="section" id="extensions-to-matplotlib-backend-bases-graphicscontextbase">
<h3>Extensions to <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase" title="matplotlib.backend_bases.GraphicsContextBase"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.backend_bases.GraphicsContextBase</span></code></a><a class="headerlink" href="#extensions-to-matplotlib-backend-bases-graphicscontextbase" title="Permalink to this headline">¶</a></h3>
<p>To better support controlling the color of hatches, the method
<a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase.set_hatch_color" title="matplotlib.backend_bases.GraphicsContextBase.set_hatch_color"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.backend_bases.GraphicsContextBase.set_hatch_color</span></code></a> was
added to the expected API of <code class="docutils literal"><span class="pre">GraphicsContext</span></code> classes. Calls to
this method are currently wrapped with a <code class="docutils literal"><span class="pre">try:...except</span> <span class="pre">Attribute:</span></code>
block to preserve back-compatibility with any third-party backends
which do not extend <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase" title="matplotlib.backend_bases.GraphicsContextBase"><code class="xref py py-obj docutils literal"><span class="pre">GraphicsContextBase</span></code></a>.</p>
<p>This value can be accessed in the backends via
<a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase.get_hatch_color" title="matplotlib.backend_bases.GraphicsContextBase.get_hatch_color"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.backend_bases.GraphicsContextBase.get_hatch_color</span></code></a> (which
was added in 2.0 see <a class="reference internal" href="../users/whats_new.html#gc-get-hatch-color-wn"><span class="std std-ref">Extension to matplotlib.backend_bases.GraphicsContextBase</span></a>) and should be used
to color the hatches.</p>
<p>In the future there may also be <code class="docutils literal"><span class="pre">hatch_linewidth</span></code> and
<code class="docutils literal"><span class="pre">hatch_density</span></code> related methods added. It is encouraged, but not
required that third-party backends extend
<a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.GraphicsContextBase" title="matplotlib.backend_bases.GraphicsContextBase"><code class="xref py py-obj docutils literal"><span class="pre">GraphicsContextBase</span></code></a> to make adapting to
these changes easier.</p>
</div>
</div>
<div class="section" id="api-changes-in-2-0-0">
<h2>API Changes in 2.0.0<a class="headerlink" href="#api-changes-in-2-0-0" title="Permalink to this headline">¶</a></h2>
<div class="section" id="deprecation-and-removal">
<h3>Deprecation and removal<a class="headerlink" href="#deprecation-and-removal" title="Permalink to this headline">¶</a></h3>
<div class="section" id="color-of-axes">
<h4>Color of Axes<a class="headerlink" href="#color-of-axes" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal"><span class="pre">axisbg</span></code> and <code class="docutils literal"><span class="pre">axis_bgcolor</span></code> properties on <code class="docutils literal"><span class="pre">Axes</span></code> have been
deprecated in favor of <code class="docutils literal"><span class="pre">facecolor</span></code>.</p>
</div>
<div class="section" id="gtk-and-gdk-backends-deprecated">
<h4>GTK and GDK backends deprecated<a class="headerlink" href="#gtk-and-gdk-backends-deprecated" title="Permalink to this headline">¶</a></h4>
<p>The GDK and GTK backends have been deprecated. These obsolete backends
allow figures to be rendered via the GDK API to files and GTK2 figures.
They are untested and known to be broken, and their use has been
discouraged for some time. Instead, use the <code class="xref py py-obj docutils literal"><span class="pre">GTKAgg</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">GTKCairo</span></code>
backends for rendering to GTK2 windows.</p>
</div>
<div class="section" id="wx-backend-deprecated">
<h4>WX backend deprecated<a class="headerlink" href="#wx-backend-deprecated" title="Permalink to this headline">¶</a></h4>
<p>The WX backend has been deprecated. It is untested, and its
use has been discouraged for some time. Instead, use the <code class="xref py py-obj docutils literal"><span class="pre">WXAgg</span></code>
backend for rendering figures to WX windows.</p>
</div>
<div class="section" id="cocoaagg-backend-removed">
<h4>CocoaAgg backend removed<a class="headerlink" href="#cocoaagg-backend-removed" title="Permalink to this headline">¶</a></h4>
<p>The deprecated and not fully functional CocoaAgg backend has been removed.</p>
</div>
<div class="section" id="round-removed-from-tkagg-backend">
<h4><code class="xref py py-obj docutils literal"><span class="pre">round</span></code> removed from TkAgg Backend<a class="headerlink" href="#round-removed-from-tkagg-backend" title="Permalink to this headline">¶</a></h4>
<p>The TkAgg backend had its own implementation of the <code class="xref py py-obj docutils literal"><span class="pre">round</span></code> function. This
was unused internally and has been removed. Instead, use either the
<code class="xref py py-obj docutils literal"><span class="pre">round</span></code> builtin function or <code class="xref py py-obj docutils literal"><span class="pre">numpy.round</span></code>.</p>
</div>
<div class="section" id="hold-functionality-deprecated">
<h4>‘hold’ functionality deprecated<a class="headerlink" href="#hold-functionality-deprecated" title="Permalink to this headline">¶</a></h4>
<p>The ‘hold’ keyword argument and all functions and methods related
to it are deprecated, along with the ‘axes.hold’ <code class="xref py py-obj docutils literal"><span class="pre">rcParams</span></code> entry.
The behavior will remain consistent with the default <code class="docutils literal"><span class="pre">hold=True</span></code>
state that has long been in place. Instead of using a function
or keyword argument (<code class="docutils literal"><span class="pre">hold=False</span></code>) to change that behavior,
explicitly clear the axes or figure as needed prior to subsequent
plotting commands.</p>
</div>
</div>
<div class="section" id="artist-update-has-return-value">
<h3><code class="xref py py-obj docutils literal"><span class="pre">Artist.update</span></code> has return value<a class="headerlink" href="#artist-update-has-return-value" title="Permalink to this headline">¶</a></h3>
<p>The methods <a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set.html#matplotlib.artist.Artist.set" title="matplotlib.artist.Artist.set"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.artist.Artist.set</span></code></a>,
<code class="xref py py-obj docutils literal"><span class="pre">matplotlib.Artist.update</span></code>, and the function <a class="reference internal" href="_as_gen/matplotlib.artist.setp.html#matplotlib.artist.setp" title="matplotlib.artist.setp"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.artist.setp</span></code></a>
now use a common codepath to look up how to update the given artist
properties (either using the setter methods or an attribute/property).</p>
<p>The behavior of <code class="xref py py-obj docutils literal"><span class="pre">matplotlib.Artist.update</span></code> is slightly changed to
return a list of the values returned from the setter methods to avoid
changing the API of <code class="xref py py-obj docutils literal"><span class="pre">matplotlib.Artist.set</span></code> and
<a class="reference internal" href="_as_gen/matplotlib.artist.setp.html#matplotlib.artist.setp" title="matplotlib.artist.setp"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.artist.setp</span></code></a>.</p>
<p>The keys passed into <code class="xref py py-obj docutils literal"><span class="pre">matplotlib.Artist.update</span></code> are now converted to
lower case before being processed, to match the behavior of
<code class="xref py py-obj docutils literal"><span class="pre">matplotlib.Artist.set</span></code> and <a class="reference internal" href="_as_gen/matplotlib.artist.setp.html#matplotlib.artist.setp" title="matplotlib.artist.setp"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.artist.setp</span></code></a>. This should not
break any user code because there are no set methods with capitals in
their names, but this puts a constraint on naming properties in the future.</p>
</div>
<div class="section" id="legend-initializers-gain-edgecolor-and-facecolor-kwargs">
<h3><code class="xref py py-obj docutils literal"><span class="pre">Legend</span></code> initializers gain edgecolor and facecolor kwargs<a class="headerlink" href="#legend-initializers-gain-edgecolor-and-facecolor-kwargs" title="Permalink to this headline">¶</a></h3>
<p>The <a class="reference internal" href="legend_api.html#matplotlib.legend.Legend" title="matplotlib.legend.Legend"><code class="xref py py-class docutils literal"><span class="pre">Legend</span></code></a> background patch (or ‘frame’)
can have its <code class="docutils literal"><span class="pre">edgecolor</span></code> and <code class="docutils literal"><span class="pre">facecolor</span></code> determined by the
corresponding keyword arguments to the <a class="reference internal" href="legend_api.html#matplotlib.legend.Legend" title="matplotlib.legend.Legend"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.legend.Legend</span></code></a>
initializer, or to any of the methods or functions that call that
initializer. If left to their default values of <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, their values
will be taken from <code class="docutils literal"><span class="pre">matplotlib.rcParams</span></code>. The previously-existing
<code class="docutils literal"><span class="pre">framealpha</span></code> kwarg still controls the alpha transparency of the
patch.</p>
</div>
<div class="section" id="qualitative-colormaps">
<h3>Qualitative colormaps<a class="headerlink" href="#qualitative-colormaps" title="Permalink to this headline">¶</a></h3>
<p>Colorbrewer’s qualitative/discrete colormaps (“Accent”, “Dark2”, “Paired”,
“Pastel1”, “Pastel2”, “Set1”, “Set2”, “Set3”) are now implemented as
<code class="docutils literal"><span class="pre">ListedColormap</span></code> instead of <code class="docutils literal"><span class="pre">LinearSegmentedColormap</span></code>.</p>
<p>To use these for images where categories are specified as integers, for
instance, use:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">imshow</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="s1">'Dark2'</span><span class="p">,</span> <span class="n">norm</span><span class="o">=</span><span class="n">colors</span><span class="o">.</span><span class="n">NoNorm</span><span class="p">())</span>
</pre></div>
</div>
</div>
<div class="section" id="change-in-the-draw-image-backend-api">
<h3>Change in the <code class="docutils literal"><span class="pre">draw_image</span></code> backend API<a class="headerlink" href="#change-in-the-draw-image-backend-api" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal"><span class="pre">draw_image</span></code> method implemented by backends has changed its interface.</p>
<p>This change is only relevant if the backend declares that it is able
to transform images by returning <code class="docutils literal"><span class="pre">True</span></code> from <code class="docutils literal"><span class="pre">option_scale_image</span></code>.
See the <code class="docutils literal"><span class="pre">draw_image</span></code> docstring for more information.</p>
</div>
<div class="section" id="matplotlib-ticker-linearlocator-algorithm-update">
<h3><a class="reference internal" href="ticker_api.html#matplotlib.ticker.LinearLocator" title="matplotlib.ticker.LinearLocator"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.ticker.LinearLocator</span></code></a> algorithm update<a class="headerlink" href="#matplotlib-ticker-linearlocator-algorithm-update" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal"><span class="pre">matplotlib.ticker.LinearLocator</span></code> is used to define the range and
location of axis ticks when the user wants an exact number of ticks.
<code class="docutils literal"><span class="pre">LinearLocator</span></code> thus differs from the default locator <code class="docutils literal"><span class="pre">MaxNLocator</span></code>,
for which the user specifies a maximum number of intervals rather than
a precise number of ticks.</p>
<p>The view range algorithm in <code class="docutils literal"><span class="pre">matplotlib.ticker.LinearLocator</span></code> has been
changed so that more convenient tick locations are chosen. The new algorithm
returns a plot view range that is a multiple of the user-requested number of
ticks. This ensures tick marks will be located at whole integers more
consistently. For example, when both y-axes of a``twinx`` plot use
<code class="docutils literal"><span class="pre">matplotlib.ticker.LinearLocator</span></code> with the same number of ticks,
their y-tick locations and grid lines will coincide.</p>
</div>
<div class="section" id="matplotlib-ticker-loglocator-gains-numticks-kwarg">
<h3><a class="reference internal" href="ticker_api.html#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.ticker.LogLocator</span></code></a> gains numticks kwarg<a class="headerlink" href="#matplotlib-ticker-loglocator-gains-numticks-kwarg" title="Permalink to this headline">¶</a></h3>
<p>The maximum number of ticks generated by the
<a class="reference internal" href="ticker_api.html#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-obj docutils literal"><span class="pre">LogLocator</span></code></a> can now be controlled explicitly
via setting the new ‘numticks’ kwarg to an integer. By default
the kwarg is None which internally sets it to the ‘auto’ string,
triggering a new algorithm for adjusting the maximum according
to the axis length relative to the ticklabel font size.</p>
</div>
<div class="section" id="matplotlib-ticker-logformatter-two-new-kwargs">
<h3><a class="reference internal" href="ticker_api.html#matplotlib.ticker.LogFormatter" title="matplotlib.ticker.LogFormatter"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.ticker.LogFormatter</span></code></a>: two new kwargs<a class="headerlink" href="#matplotlib-ticker-logformatter-two-new-kwargs" title="Permalink to this headline">¶</a></h3>
<p>Previously, minor ticks on log-scaled axes were not labeled by
default. An algorithm has been added to the
<a class="reference internal" href="ticker_api.html#matplotlib.ticker.LogFormatter" title="matplotlib.ticker.LogFormatter"><code class="xref py py-obj docutils literal"><span class="pre">LogFormatter</span></code></a> to control the labeling of
ticks between integer powers of the base. The algorithm uses
two parameters supplied in a kwarg tuple named ‘minor_thresholds’.
See the docstring for further explanation.</p>
<p>To improve support for axes using <code class="xref py py-obj docutils literal"><span class="pre">SymmetricLogLocator</span></code>,
a ‘linthresh’ kwarg was added.</p>
</div>
<div class="section" id="new-defaults-for-3d-quiver-function-in-mpl-toolkits-mplot3d-axes3d-py">
<h3>New defaults for 3D quiver function in mpl_toolkits.mplot3d.axes3d.py<a class="headerlink" href="#new-defaults-for-3d-quiver-function-in-mpl-toolkits-mplot3d-axes3d-py" title="Permalink to this headline">¶</a></h3>
<p>Matplotlib has both a 2D and a 3D <code class="docutils literal"><span class="pre">quiver</span></code> function. These changes
affect only the 3D function and make the default behavior of the 3D
function match the 2D version. There are two changes:</p>
<ol class="arabic simple">
<li>The 3D quiver function previously normalized the arrows to be the
same length, which makes it unusable for situations where the
arrows should be different lengths and does not match the behavior
of the 2D function. This normalization behavior is now controlled
with the <code class="docutils literal"><span class="pre">normalize</span></code> keyword, which defaults to False.</li>
<li>The <code class="docutils literal"><span class="pre">pivot</span></code> keyword now defaults to <code class="docutils literal"><span class="pre">tail</span></code> instead of
<code class="docutils literal"><span class="pre">tip</span></code>. This was done in order to match the default behavior of
the 2D quiver function.</li>
</ol>
<p>To obtain the previous behavior with the 3D quiver function, one can
call the function with</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">quiver</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span><span class="p">,</span> <span class="n">u</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">w</span><span class="p">,</span> <span class="n">normalize</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">pivot</span><span class="o">=</span><span class="s1">'tip'</span><span class="p">)</span>
</pre></div>
</div>
<p>where “ax” is an <code class="docutils literal"><span class="pre">Axes3d</span></code> object created with something like</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">mpl_toolkits.mplot3d.axes3d</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">sublot</span><span class="p">(</span><span class="mi">111</span><span class="p">,</span> <span class="n">projection</span><span class="o">=</span><span class="s1">'3d'</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="stale-figure-behavior">
<h3>Stale figure behavior<a class="headerlink" href="#stale-figure-behavior" title="Permalink to this headline">¶</a></h3>
<p>Attempting to draw the figure will now mark it as not stale (independent if
the draw succeeds). This change is to prevent repeatedly trying to re-draw a
figure which is raising an error on draw. The previous behavior would only mark
a figure as not stale after a full re-draw succeeded.</p>
</div>
<div class="section" id="the-spectral-colormap-is-now-nipy-spectral">
<h3>The spectral colormap is now nipy_spectral<a class="headerlink" href="#the-spectral-colormap-is-now-nipy-spectral" title="Permalink to this headline">¶</a></h3>
<p>The colormaps formerly known as <code class="docutils literal"><span class="pre">spectral</span></code> and <code class="docutils literal"><span class="pre">spectral_r</span></code> have been
replaced by <code class="docutils literal"><span class="pre">nipy_spectral</span></code> and <code class="docutils literal"><span class="pre">nipy_spectral_r</span></code> since Matplotlib
1.3.0. Even though the colormap was deprecated in Matplotlib 1.3.0, it never
raised a warning. As of Matplotlib 2.0.0, using the old names raises a
deprecation warning. In the future, using the old names will raise an error.</p>
</div>
<div class="section" id="default-install-no-longer-includes-test-images">
<h3>Default install no longer includes test images<a class="headerlink" href="#default-install-no-longer-includes-test-images" title="Permalink to this headline">¶</a></h3>
<p>To reduce the size of wheels and source installs, the tests and
baseline images are no longer included by default.</p>
<p>To restore installing the tests and images, use a <code class="xref py py-obj docutils literal"><span class="pre">setup.cfg</span></code> with</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">packages</span><span class="p">]</span>
<span class="n">tests</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">toolkits_tests</span> <span class="o">=</span> <span class="kc">True</span>
</pre></div>
</div>
<p>in the source directory at build/install time.</p>
</div>
</div>
<div class="section" id="changes-in-1-5-3">
<h2>Changes in 1.5.3<a class="headerlink" href="#changes-in-1-5-3" title="Permalink to this headline">¶</a></h2>
<div class="section" id="ax-plot-marker-none-gives-default-marker">
<h3><code class="docutils literal"><span class="pre">ax.plot(...,</span> <span class="pre">marker=None)</span></code> gives default marker<a class="headerlink" href="#ax-plot-marker-none-gives-default-marker" title="Permalink to this headline">¶</a></h3>
<p>Prior to 1.5.3 kwargs passed to <code class="xref py py-obj docutils literal"><span class="pre">plot</span></code> were handled
in two parts – default kwargs generated internal to
<code class="xref py py-obj docutils literal"><span class="pre">plot</span></code> (such as the cycled styles) and user supplied
kwargs. The internally generated kwargs were passed to the
<code class="xref py py-obj docutils literal"><span class="pre">matplotlib.lines.Line2D.__init__</span></code> and the user kwargs were passed to
<code class="docutils literal"><span class="pre">ln.set(**kwargs)</span></code> to update the artist after it was created. Now
both sets of kwargs are merged and passed to
<code class="xref py py-obj docutils literal"><span class="pre">__init__</span></code>. This change was made to allow <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>
to be passed in via the user kwargs to mean ‘do the default thing’ as
is the convention through out mpl rather than raising an exception.</p>
<p>Unlike most <a class="reference internal" href="lines_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-obj docutils literal"><span class="pre">Line2D</span></code></a> setter methods
<a class="reference internal" href="lines_api.html#matplotlib.lines.Line2D.set_marker" title="matplotlib.lines.Line2D.set_marker"><code class="xref py py-obj docutils literal"><span class="pre">set_marker</span></code></a> did accept <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> as a valid
input which was mapped to ‘no marker’. Thus, by routing this
<code class="docutils literal"><span class="pre">marker=None</span></code> through <code class="docutils literal"><span class="pre">__init__</span></code> rather than <code class="docutils literal"><span class="pre">set(...)</span></code> the meaning
of <code class="docutils literal"><span class="pre">ax.plot(...,</span> <span class="pre">marker=None)</span></code> changed from ‘no markers’ to ‘default markers
from rcparams’.</p>
<p>This is change is only evident if <code class="docutils literal"><span class="pre">mpl.rcParams['lines.marker']</span></code> has a value
other than <code class="docutils literal"><span class="pre">'None'</span></code> (which is string <code class="docutils literal"><span class="pre">'None'</span></code> which means ‘no marker’).</p>
</div>
</div>
<div class="section" id="changes-in-1-5-2">
<h2>Changes in 1.5.2<a class="headerlink" href="#changes-in-1-5-2" title="Permalink to this headline">¶</a></h2>
<div class="section" id="default-behavior-changes">
<h3>Default Behavior Changes<a class="headerlink" href="#default-behavior-changes" title="Permalink to this headline">¶</a></h3>
<div class="section" id="changed-default-autorange-behavior-in-boxplots">
<h4>Changed default <code class="docutils literal"><span class="pre">autorange</span></code> behavior in boxplots<a class="headerlink" href="#changed-default-autorange-behavior-in-boxplots" title="Permalink to this headline">¶</a></h4>
<p>Prior to v1.5.2, the whiskers of boxplots would extend to the mininum
and maximum values if the quartiles were all equal (i.e., Q1 = median
= Q3). This behavior has been disabled by default to restore consistency
with other plotting packages.</p>
<p>To restore the old behavior, simply set <code class="docutils literal"><span class="pre">autorange=True</span></code> when
calling <code class="docutils literal"><span class="pre">plt.boxplot</span></code>.</p>
</div>
</div>
</div>
<div class="section" id="changes-in-1-5-0">
<h2>Changes in 1.5.0<a class="headerlink" href="#changes-in-1-5-0" title="Permalink to this headline">¶</a></h2>
<div class="section" id="code-changes">
<h3>Code Changes<a class="headerlink" href="#code-changes" title="Permalink to this headline">¶</a></h3>
<div class="section" id="reversed-matplotlib-cbook-ls-mapper-added-ls-mapper-r">
<h4>Reversed <code class="xref py py-obj docutils literal"><span class="pre">matplotlib.cbook.ls_mapper</span></code>, added <code class="xref py py-obj docutils literal"><span class="pre">ls_mapper_r</span></code><a class="headerlink" href="#reversed-matplotlib-cbook-ls-mapper-added-ls-mapper-r" title="Permalink to this headline">¶</a></h4>
<p>Formerly, <code class="xref py py-obj docutils literal"><span class="pre">matplotlib.cbook.ls_mapper</span></code> was a dictionary with
the long-form line-style names (<code class="xref py py-obj docutils literal"><span class="pre">"solid"</span></code>) as keys and the short
forms (<code class="xref py py-obj docutils literal"><span class="pre">"-"</span></code>) as values. This long-to-short mapping is now done
by <code class="xref py py-obj docutils literal"><span class="pre">ls_mapper_r</span></code>, and the short-to-long mapping is done by the
<code class="xref py py-obj docutils literal"><span class="pre">ls_mapper</span></code>.</p>
</div>
<div class="section" id="prevent-moving-artists-between-axes-property-ify-artist-axes-deprecate-artist-get-set-axes">
<h4>Prevent moving artists between Axes, Property-ify Artist.axes, deprecate Artist.{get,set}_axes<a class="headerlink" href="#prevent-moving-artists-between-axes-property-ify-artist-axes-deprecate-artist-get-set-axes" title="Permalink to this headline">¶</a></h4>
<p>This was done to prevent an Artist that is
already associated with an Axes from being moved/added to a different Axes.
This was never supported as it causes havoc with the transform stack.
The apparent support for this (as it did not raise an exception) was
the source of multiple bug reports and questions on SO.</p>
<p>For almost all use-cases, the assignment of the axes to an artist should be
taken care of by the axes as part of the <code class="docutils literal"><span class="pre">Axes.add_*</span></code> method, hence the
deprecation of {get,set}_axes.</p>
<p>Removing the <code class="docutils literal"><span class="pre">set_axes</span></code> method will also remove the ‘axes’ line from
the ACCEPTS kwarg tables (assuming that the removal date gets here
before that gets overhauled).</p>
</div>
<div class="section" id="tightened-input-validation-on-pivot-kwarg-to-quiver">
<h4>Tightened input validation on ‘pivot’ kwarg to quiver<a class="headerlink" href="#tightened-input-validation-on-pivot-kwarg-to-quiver" title="Permalink to this headline">¶</a></h4>
<p>Tightened validation so that only {‘tip’, ‘tail’, ‘mid’, and ‘middle’}
(but any capitalization) are valid values for the ‘pivot’ kwarg in
the <code class="xref py py-obj docutils literal"><span class="pre">Quiver.__init__</span></code> (and hence <code class="xref py py-obj docutils literal"><span class="pre">Axes.quiver</span></code> and
<code class="xref py py-obj docutils literal"><span class="pre">plt.quiver</span></code> which both fully delegate to <code class="xref py py-obj docutils literal"><span class="pre">Quiver</span></code>). Previously any
input matching ‘mid.*’ would be interpreted as ‘middle’, ‘tip.*’ as
‘tip’ and any string not matching one of those patterns as ‘tail’.</p>
<p>The value of <code class="xref py py-obj docutils literal"><span class="pre">Quiver.pivot</span></code> is normalized to be in the set {‘tip’,
‘tail’, ‘middle’} in <code class="xref py py-obj docutils literal"><span class="pre">Quiver.__init__</span></code>.</p>
</div>
<div class="section" id="reordered-axes-get-children">
<h4>Reordered <code class="xref py py-obj docutils literal"><span class="pre">Axes.get_children</span></code><a class="headerlink" href="#reordered-axes-get-children" title="Permalink to this headline">¶</a></h4>
<p>The artist order returned by <code class="xref py py-obj docutils literal"><span class="pre">Axes.get_children</span></code> did not
match the one used by <code class="xref py py-obj docutils literal"><span class="pre">Axes.draw</span></code>. They now use the same
order, as <code class="xref py py-obj docutils literal"><span class="pre">Axes.draw</span></code> now calls <code class="xref py py-obj docutils literal"><span class="pre">Axes.get_children</span></code>.</p>
</div>
<div class="section" id="changed-behaviour-of-contour-plots">
<h4>Changed behaviour of contour plots<a class="headerlink" href="#changed-behaviour-of-contour-plots" title="Permalink to this headline">¶</a></h4>
<p>The default behaviour of <a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.contour" title="matplotlib.pyplot.contour"><code class="xref py py-func docutils literal"><span class="pre">contour()</span></code></a> and
<a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.contourf" title="matplotlib.pyplot.contourf"><code class="xref py py-func docutils literal"><span class="pre">contourf()</span></code></a> when using a masked array is now determined
by the new keyword argument <code class="xref py py-obj docutils literal"><span class="pre">corner_mask</span></code>, or if this is not specified then
the new rcParam <code class="xref py py-obj docutils literal"><span class="pre">contour.corner_mask</span></code> instead. The new default behaviour is
equivalent to using <code class="xref py py-obj docutils literal"><span class="pre">corner_mask=True</span></code>; the previous behaviour can be obtained
using <code class="xref py py-obj docutils literal"><span class="pre">corner_mask=False</span></code> or by changing the rcParam. The example
<a class="reference external" href="http://matplotlib.org/examples/pylab_examples/contour_corner_mask.html">http://matplotlib.org/examples/pylab_examples/contour_corner_mask.html</a>
demonstrates the difference. Use of the old contouring algorithm, which is
obtained with <code class="xref py py-obj docutils literal"><span class="pre">corner_mask='legacy'</span></code>, is now deprecated.</p>
<p>Contour labels may now appear in different places than in earlier versions of
Matplotlib.</p>
<p>In addition, the keyword argument <code class="xref py py-obj docutils literal"><span class="pre">nchunk</span></code> now applies to
<a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.contour" title="matplotlib.pyplot.contour"><code class="xref py py-func docutils literal"><span class="pre">contour()</span></code></a> as well as
<a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.contourf" title="matplotlib.pyplot.contourf"><code class="xref py py-func docutils literal"><span class="pre">contourf()</span></code></a>, and it subdivides the domain into
subdomains of exactly <code class="xref py py-obj docutils literal"><span class="pre">nchunk</span></code> by <code class="xref py py-obj docutils literal"><span class="pre">nchunk</span></code> quads, whereas previously it was
only roughly <code class="xref py py-obj docutils literal"><span class="pre">nchunk</span></code> by <code class="xref py py-obj docutils literal"><span class="pre">nchunk</span></code> quads.</p>
<p>The C/C++ object that performs contour calculations used to be stored in the
public attribute QuadContourSet.Cntr, but is now stored in a private attribute
and should not be accessed by end users.</p>
</div>
<div class="section" id="added-set-params-function-to-all-locator-types">
<h4>Added set_params function to all Locator types<a class="headerlink" href="#added-set-params-function-to-all-locator-types" title="Permalink to this headline">¶</a></h4>
<p>This was a bug fix targeted at making the api for Locators more consistent.</p>
<p>In the old behavior, only locators of type MaxNLocator have set_params()
defined, causing its use on any other Locator to raise an AttributeError <em>(
aside: set_params(args) is a function that sets the parameters of a Locator
instance to be as specified within args)</em>. The fix involves moving set_params()
to the Locator class such that all subtypes will have this function defined.</p>
<p>Since each of the Locator subtypes have their own modifiable parameters, a
universal set_params() in Locator isn’t ideal. Instead, a default no-operation
function that raises a warning is implemented in Locator. Subtypes extending
Locator will then override with their own implementations. Subtypes that do
not have a need for set_params() will fall back onto their parent’s
implementation, which raises a warning as intended.</p>
<p>In the new behavior, Locator instances will not raise an AttributeError
when set_params() is called. For Locators that do not implement set_params(),
the default implementation in Locator is used.</p>
</div>
<div class="section" id="disallow-none-as-x-or-y-value-in-ax-plot">
<h4>Disallow <code class="docutils literal"><span class="pre">None</span></code> as x or y value in ax.plot<a class="headerlink" href="#disallow-none-as-x-or-y-value-in-ax-plot" title="Permalink to this headline">¶</a></h4>
<p>Do not allow <code class="docutils literal"><span class="pre">None</span></code> as a valid input for the <code class="docutils literal"><span class="pre">x</span></code> or <code class="docutils literal"><span class="pre">y</span></code> args in
<code class="xref py py-obj docutils literal"><span class="pre">ax.plot</span></code>. This may break some user code, but this was never officially
supported (ex documented) and allowing <code class="docutils literal"><span class="pre">None</span></code> objects through can lead
to confusing exceptions downstream.</p>
<p>To create an empty line use</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ln1</span><span class="p">,</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">([],</span> <span class="p">[],</span> <span class="o">...</span><span class="p">)</span>
<span class="n">ln2</span><span class="p">,</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">([],</span> <span class="o">...</span><span class="p">)</span>
</pre></div>
</div>
<p>In either case to update the data in the <code class="xref py py-obj docutils literal"><span class="pre">Line2D</span></code> object you must update
both the <code class="docutils literal"><span class="pre">x</span></code> and <code class="docutils literal"><span class="pre">y</span></code> data.</p>
</div>
<div class="section" id="removed-args-and-kwargs-from-microsecondlocator-call">
<h4>Removed <code class="xref py py-obj docutils literal"><span class="pre">args</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">kwargs</span></code> from <code class="xref py py-obj docutils literal"><span class="pre">MicrosecondLocator.__call__</span></code><a class="headerlink" href="#removed-args-and-kwargs-from-microsecondlocator-call" title="Permalink to this headline">¶</a></h4>
<p>The call signature of <code class="xref py py-meth docutils literal"><span class="pre">__call__()</span></code>
has changed from <code class="xref py py-obj docutils literal"><span class="pre">__call__(self,</span> <span class="pre">*args,</span> <span class="pre">**kwargs)</span></code> to <code class="xref py py-obj docutils literal"><span class="pre">__call__(self)</span></code>.
This is consistent with the superclass <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">Locator</span></code></a>
and also all the other Locators derived from this superclass.</p>
</div>
<div class="section" id="no-valueerror-for-the-microsecondlocator-and-yearlocator">
<h4>No <code class="xref py py-obj docutils literal"><span class="pre">ValueError</span></code> for the MicrosecondLocator and YearLocator<a class="headerlink" href="#no-valueerror-for-the-microsecondlocator-and-yearlocator" title="Permalink to this headline">¶</a></h4>
<p>The <a class="reference internal" href="dates_api.html#matplotlib.dates.MicrosecondLocator" title="matplotlib.dates.MicrosecondLocator"><code class="xref py py-class docutils literal"><span class="pre">MicrosecondLocator</span></code></a> and
<a class="reference internal" href="dates_api.html#matplotlib.dates.YearLocator" title="matplotlib.dates.YearLocator"><code class="xref py py-class docutils literal"><span class="pre">YearLocator</span></code></a> objects when called will return
an empty list if the axes have no data or the view has no interval.
Previously, they raised a <code class="xref py py-obj docutils literal"><span class="pre">ValueError</span></code>. This is consistent with all
the Date Locators.</p>
</div>
<div class="section" id="offsetbox-drawingarea-respects-the-clip-keyword-argument">
<h4>‘OffsetBox.DrawingArea’ respects the ‘clip’ keyword argument<a class="headerlink" href="#offsetbox-drawingarea-respects-the-clip-keyword-argument" title="Permalink to this headline">¶</a></h4>
<p>The call signature was <code class="xref py py-obj docutils literal"><span class="pre">OffsetBox.DrawingArea(...,</span> <span class="pre">clip=True)</span></code> but nothing
was done with the <code class="xref py py-obj docutils literal"><span class="pre">clip</span></code> argument. The object did not do any clipping
regardless of that parameter. Now the object can and does clip the
child <code class="xref py py-obj docutils literal"><span class="pre">Artists</span></code> if they are set to be clipped.</p>
<p>You can turn off the clipping on a per-child basis using
<code class="xref py py-obj docutils literal"><span class="pre">child.set_clip_on(False)</span></code>.</p>
</div>
<div class="section" id="add-salt-to-clippath-id">
<h4>Add salt to clipPath id<a class="headerlink" href="#add-salt-to-clippath-id" title="Permalink to this headline">¶</a></h4>
<p>Add salt to the hash used to determine the id of the <code class="docutils literal"><span class="pre">clipPath</span></code>
nodes. This is to avoid conflicts when two svg documents with the same
clip path are included in the same document (see
<a class="reference external" href="https://github.com/ipython/ipython/issues/8133">https://github.com/ipython/ipython/issues/8133</a> and
<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues/4349">https://github.com/matplotlib/matplotlib/issues/4349</a> ), however this
means that the svg output is no longer deterministic if the same
figure is saved twice. It is not expected that this will affect any
users as the current ids are generated from an md5 hash of properties
of the clip path and any user would have a very difficult time
anticipating the value of the id.</p>
</div>
<div class="section" id="changed-snap-threshold-for-circle-markers-to-inf">
<h4>Changed snap threshold for circle markers to inf<a class="headerlink" href="#changed-snap-threshold-for-circle-markers-to-inf" title="Permalink to this headline">¶</a></h4>
<p>When drawing circle markers above some marker size (previously 6.0)
the path used to generate the marker was snapped to pixel centers. However,
this ends up distorting the marker away from a circle. By setting the
snap threshold to inf snapping is never done on circles.</p>
<p>This change broke several tests, but is an improvement.</p>
</div>
<div class="section" id="preserve-units-with-text-position">
<h4>Preserve units with Text position<a class="headerlink" href="#preserve-units-with-text-position" title="Permalink to this headline">¶</a></h4>
<p>Previously the ‘get_position’ method on Text would strip away unit information
even though the units were still present. There was no inherent need to do
this, so it has been changed so that unit data (if present) will be preserved.
Essentially a call to ‘get_position’ will return the exact value from a call to
‘set_position’.</p>
<p>If you wish to get the old behaviour, then you can use the new method called
‘get_unitless_position’.</p>
</div>
<div class="section" id="new-api-for-custom-axes-view-changes">
<h4>New API for custom Axes view changes<a class="headerlink" href="#new-api-for-custom-axes-view-changes" title="Permalink to this headline">¶</a></h4>
<p>Interactive pan and zoom were previously implemented using a Cartesian-specific
algorithm that was not necessarily applicable to custom Axes. Three new private
methods, <code class="xref py py-meth docutils literal"><span class="pre">_get_view()</span></code>,
<code class="xref py py-meth docutils literal"><span class="pre">_set_view()</span></code>, and
<code class="xref py py-meth docutils literal"><span class="pre">_set_view_from_bbox()</span></code>, allow for custom
<code class="docutils literal"><span class="pre">Axes</span></code> classes to override the pan and zoom algorithms. Implementors of
custom <code class="docutils literal"><span class="pre">Axes</span></code> who override these methods may provide suitable behaviour for
both pan and zoom as well as the view navigation buttons on the interactive
toolbars.</p>
</div>
</div>
<div class="section" id="mathtex-visual-changes">
<h3>MathTex visual changes<a class="headerlink" href="#mathtex-visual-changes" title="Permalink to this headline">¶</a></h3>
<p>The spacing commands in mathtext have been changed to more closely
match vanilla TeX.</p>
<div class="section" id="improved-spacing-in-mathtext">
<h4>Improved spacing in mathtext<a class="headerlink" href="#improved-spacing-in-mathtext" title="Permalink to this headline">¶</a></h4>
<p>The extra space that appeared after subscripts and superscripts has
been removed.</p>
</div>
<div class="section" id="no-annotation-coordinates-wrap">
<h4>No annotation coordinates wrap<a class="headerlink" href="#no-annotation-coordinates-wrap" title="Permalink to this headline">¶</a></h4>
<p>In #2351 for 1.4.0 the behavior of [‘axes points’, ‘axes pixel’,
‘figure points’, ‘figure pixel’] as coordinates was change to
no longer wrap for negative values. In 1.4.3 this change was
reverted for ‘axes points’ and ‘axes pixel’ and in addition caused
‘axes fraction’ to wrap. For 1.5 the behavior has been reverted to
as it was in 1.4.0-1.4.2, no wrapping for any type of coordinate.</p>
</div>
</div>
<div class="section" id="deprecation">
<h3>Deprecation<a class="headerlink" href="#deprecation" title="Permalink to this headline">¶</a></h3>
<div class="section" id="deprecated-graphicscontextbase-set-graylevel">
<h4>Deprecated <code class="xref py py-obj docutils literal"><span class="pre">GraphicsContextBase.set_graylevel</span></code><a class="headerlink" href="#deprecated-graphicscontextbase-set-graylevel" title="Permalink to this headline">¶</a></h4>
<p>The <code class="xref py py-obj docutils literal"><span class="pre">GraphicsContextBase.set_graylevel</span></code> function has been deprecated in 1.5 and
will be removed in 1.6. It has been unused. The
<code class="xref py py-obj docutils literal"><span class="pre">GraphicsContextBase.set_foreground</span></code> could be used instead.</p>
</div>
<div class="section" id="deprecated-idle-event">
<h4>deprecated idle_event<a class="headerlink" href="#deprecated-idle-event" title="Permalink to this headline">¶</a></h4>
<p>The <code class="xref py py-obj docutils literal"><span class="pre">idle_event</span></code> was broken or missing in most backends and causes spurious
warnings in some cases, and its use in creating animations is now obsolete due
to the animations module. Therefore code involving it has been removed from all
but the wx backend (where it partially works), and its use is deprecated. The
animations module may be used instead to create animations.</p>
</div>
<div class="section" id="color-cycle-deprecated">
<h4><code class="xref py py-obj docutils literal"><span class="pre">color_cycle</span></code> deprecated<a class="headerlink" href="#color-cycle-deprecated" title="Permalink to this headline">¶</a></h4>
<p>In light of the new property cycling feature,
the Axes method <em>set_color_cycle</em> is now deprecated.
Calling this method will replace the current property cycle with
one that cycles just the given colors.</p>
<p>Similarly, the rc parameter <em>axes.color_cycle</em> is also deprecated in
lieu of the new <em>axes.prop_cycle</em> parameter. Having both parameters in
the same rc file is not recommended as the result cannot be
predicted. For compatibility, setting <em>axes.color_cycle</em> will
replace the cycler in <em>axes.prop_cycle</em> with a color cycle.
Accessing <em>axes.color_cycle</em> will return just the color portion
of the property cycle, if it exists.</p>
<p>Timeline for removal has not been set.</p>
</div>
</div>
<div class="section" id="bundled-jquery">
<h3>Bundled jquery<a class="headerlink" href="#bundled-jquery" title="Permalink to this headline">¶</a></h3>
<p>The version of jquery bundled with the webagg backend has been upgraded
from 1.7.1 to 1.11.3. If you are using the version of jquery bundled
with webagg you will need to update your html files as such</p>
<div class="highlight-diff"><div class="highlight"><pre><span></span><span class="gd">- <script src="_static/jquery/js/jquery-1.7.1.min.js"></script></span>
<span class="gi">+ <script src="_static/jquery/js/jquery-1.11.3.min.js"></script></span>
</pre></div>
</div>
</div>
<div class="section" id="code-removed">
<h3>Code Removed<a class="headerlink" href="#code-removed" title="Permalink to this headline">¶</a></h3>
<div class="section" id="removed-image-from-main-namespace">
<h4>Removed <code class="xref py py-obj docutils literal"><span class="pre">Image</span></code> from main namespace<a class="headerlink" href="#removed-image-from-main-namespace" title="Permalink to this headline">¶</a></h4>
<p><code class="xref py py-obj docutils literal"><span class="pre">Image</span></code> was imported from PIL/pillow to test if PIL is available, but
there is no reason to keep <code class="xref py py-obj docutils literal"><span class="pre">Image</span></code> in the namespace once the availability
has been determined.</p>
</div>
<div class="section" id="removed-lod-from-artist">
<h4>Removed <code class="xref py py-obj docutils literal"><span class="pre">lod</span></code> from Artist<a class="headerlink" href="#removed-lod-from-artist" title="Permalink to this headline">¶</a></h4>
<p>Removed the method <em>set_lod</em> and all references to
the attribute <em>_lod</em> as the are not used anywhere else in the
code base. It appears to be a feature stub that was never built
out.</p>
</div>
<div class="section" id="removed-threading-related-classes-from-cbook">
<h4>Removed threading related classes from cbook<a class="headerlink" href="#removed-threading-related-classes-from-cbook" title="Permalink to this headline">¶</a></h4>
<p>The classes <code class="docutils literal"><span class="pre">Scheduler</span></code>, <code class="docutils literal"><span class="pre">Timeout</span></code>, and <code class="docutils literal"><span class="pre">Idle</span></code> were in cbook, but
are not used internally. They appear to be a prototype for the idle event
system which was not working and has recently been pulled out.</p>
</div>
<div class="section" id="removed-lena-images-from-sample-data">
<h4>Removed <code class="xref py py-obj docutils literal"><span class="pre">Lena</span></code> images from sample_data<a class="headerlink" href="#removed-lena-images-from-sample-data" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal"><span class="pre">lena.png</span></code> and <code class="docutils literal"><span class="pre">lena.jpg</span></code> images have been removed from
Matplotlib’s sample_data directory. The images are also no longer
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"><span class="pre">matplotlib.cbook.get_sample_data</span></code></a>. We suggest using
<code class="xref py py-obj docutils literal"><span class="pre">matplotlib.cbook.get_sample_data('grace_hopper.png')</span></code> or
<code class="xref py py-obj docutils literal"><span class="pre">matplotlib.cbook.get_sample_data('grace_hopper.jpg')</span></code> instead.</p>
</div>
<div class="section" id="legend">
<h4>Legend<a class="headerlink" href="#legend" title="Permalink to this headline">¶</a></h4>
<p>Removed handling of <code class="xref py py-obj docutils literal"><span class="pre">loc</span></code> as a positional argument to <code class="xref py py-obj docutils literal"><span class="pre">Legend</span></code></p>
</div>
<div class="section" id="legend-handlers">
<h4>Legend handlers<a class="headerlink" href="#legend-handlers" title="Permalink to this headline">¶</a></h4>
<p>Remove code to allow legend handlers to be callable. They must now
implement a method <code class="docutils literal"><span class="pre">legend_artist</span></code>.</p>
</div>
<div class="section" id="axis">
<h4>Axis<a class="headerlink" href="#axis" title="Permalink to this headline">¶</a></h4>
<p>Removed method <code class="docutils literal"><span class="pre">set_scale</span></code>. This is now handled via a private method which
should not be used directly by users. It is called via <code class="docutils literal"><span class="pre">Axes.set_{x,y}scale</span></code>
which takes care of ensuring the related changes are also made to the Axes
object.</p>
</div>
<div class="section" id="finance-py">
<h4>finance.py<a class="headerlink" href="#finance-py" title="Permalink to this headline">¶</a></h4>
<p>Removed functions with ambiguous argument order from finance.py</p>
</div>
<div class="section" id="annotation">
<h4>Annotation<a class="headerlink" href="#annotation" title="Permalink to this headline">¶</a></h4>
<p>Removed <code class="docutils literal"><span class="pre">textcoords</span></code> and <code class="docutils literal"><span class="pre">xytext</span></code> proprieties from Annotation objects.</p>
</div>
<div class="section" id="spinxext-ipython-py">
<h4>spinxext.ipython_*.py<a class="headerlink" href="#spinxext-ipython-py" title="Permalink to this headline">¶</a></h4>
<p>Both <code class="docutils literal"><span class="pre">ipython_console_highlighting</span></code> and <code class="docutils literal"><span class="pre">ipython_directive</span></code> have been
moved to <code class="xref py py-obj docutils literal"><span class="pre">IPython</span></code>.</p>
<p>Change your import from ‘matplotlib.sphinxext.ipython_directive’ to
‘IPython.sphinxext.ipython_directive’ and from
‘matplotlib.sphinxext.ipython_directive’ to
‘IPython.sphinxext.ipython_directive’</p>
</div>
<div class="section" id="linecollection-color">
<h4>LineCollection.color<a class="headerlink" href="#linecollection-color" title="Permalink to this headline">¶</a></h4>
<p>Deprecated in 2005, use <code class="docutils literal"><span class="pre">set_color</span></code></p>
</div>
<div class="section" id="remove-faceted-as-a-valid-value-for-shading-in-tri-tripcolor">
<h4>remove <code class="docutils literal"><span class="pre">'faceted'</span></code> as a valid value for <code class="xref py py-obj docutils literal"><span class="pre">shading</span></code> in <code class="docutils literal"><span class="pre">tri.tripcolor</span></code><a class="headerlink" href="#remove-faceted-as-a-valid-value-for-shading-in-tri-tripcolor" title="Permalink to this headline">¶</a></h4>
<p>Use <code class="xref py py-obj docutils literal"><span class="pre">edgecolor</span></code> instead. Added validation on <code class="docutils literal"><span class="pre">shading</span></code> to
only be valid values.</p>
</div>
<div class="section" id="remove-faceted-kwarg-from-scatter">
<h4>Remove <code class="docutils literal"><span class="pre">faceted</span></code> kwarg from scatter<a class="headerlink" href="#remove-faceted-kwarg-from-scatter" title="Permalink to this headline">¶</a></h4>
<p>Remove support for the <code class="docutils literal"><span class="pre">faceted</span></code> kwarg. This was deprecated in
d48b34288e9651ff95c3b8a071ef5ac5cf50bae7 (2008-04-18!) and replaced by
<code class="docutils literal"><span class="pre">edgecolor</span></code>.</p>
</div>
<div class="section" id="remove-set-colorbar-method-from-scalarmappable">
<h4>Remove <code class="docutils literal"><span class="pre">set_colorbar</span></code> method from <code class="docutils literal"><span class="pre">ScalarMappable</span></code><a class="headerlink" href="#remove-set-colorbar-method-from-scalarmappable" title="Permalink to this headline">¶</a></h4>
<p>Remove <code class="docutils literal"><span class="pre">set_colorbar</span></code> method, use <code class="xref py py-obj docutils literal"><span class="pre">colorbar</span></code> attribute directly.</p>
</div>
<div class="section" id="patheffects-svg">
<h4>patheffects.svg<a class="headerlink" href="#patheffects-svg" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><ul class="simple">
<li>remove <code class="docutils literal"><span class="pre">get_proxy_renderer</span></code> method from <code class="docutils literal"><span class="pre">AbstarctPathEffect</span></code> class</li>
<li>remove <code class="docutils literal"><span class="pre">patch_alpha</span></code> and <code class="docutils literal"><span class="pre">offset_xy</span></code> from <code class="docutils literal"><span class="pre">SimplePatchShadow</span></code></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="remove-testing-image-util-py">
<h4>Remove <code class="docutils literal"><span class="pre">testing.image_util.py</span></code><a class="headerlink" href="#remove-testing-image-util-py" title="Permalink to this headline">¶</a></h4>
<p>Contained only a no-longer used port of functionality from PIL</p>
</div>
<div class="section" id="remove-mlab-fifobuffer">
<h4>Remove <code class="docutils literal"><span class="pre">mlab.FIFOBuffer</span></code><a class="headerlink" href="#remove-mlab-fifobuffer" title="Permalink to this headline">¶</a></h4>
<p>Not used internally and not part of core mission of mpl.</p>
</div>
<div class="section" id="remove-mlab-prepca">
<h4>Remove <code class="docutils literal"><span class="pre">mlab.prepca</span></code><a class="headerlink" href="#remove-mlab-prepca" title="Permalink to this headline">¶</a></h4>
<p>Deprecated in 2009.</p>
</div>
<div class="section" id="remove-navigationtoolbar2qtagg">
<h4>Remove <code class="docutils literal"><span class="pre">NavigationToolbar2QTAgg</span></code><a class="headerlink" href="#remove-navigationtoolbar2qtagg" title="Permalink to this headline">¶</a></h4>
<p>Added no functionality over the base <code class="docutils literal"><span class="pre">NavigationToolbar2Qt</span></code></p>
</div>
<div class="section" id="mpl-py">
<h4>mpl.py<a class="headerlink" href="#mpl-py" title="Permalink to this headline">¶</a></h4>
<p>Remove the module <code class="xref py py-obj docutils literal"><span class="pre">matplotlib.mpl</span></code>. Deprecated in 1.3 by
PR #1670 and commit 78ce67d161625833cacff23cfe5d74920248c5b2</p>
</div>
</div>
</div>
<div class="section" id="changes-in-1-4-x">
<h2>Changes in 1.4.x<a class="headerlink" href="#changes-in-1-4-x" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id1">
<h3>Code changes<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<ul>
<li><p class="first">A major refactoring of the axes module was made. The axes module has been
split into smaller modules:</p>
<blockquote>
<div><ul class="simple">
<li>the <code class="xref py py-obj docutils literal"><span class="pre">_base</span></code> module, which contains a new private _AxesBase class. This
class contains all methods except plotting and labelling methods.</li>
<li>the <code class="xref py py-obj docutils literal"><span class="pre">axes</span></code> module, which contains the Axes class. This class inherits
from _AxesBase, and contains all plotting and labelling methods.</li>
<li>the <code class="xref py py-obj docutils literal"><span class="pre">_subplot</span></code> module, with all the classes concerning subplotting.</li>
</ul>
</div></blockquote>
</li>
</ul>
<p>There are a couple of things that do not exists in the <code class="xref py py-obj docutils literal"><span class="pre">axes</span></code> module’s
namespace anymore. If you use them, you need to import them from their
original location:</p>
<blockquote>
<div><ul class="simple">
<li>math -> <code class="xref py py-obj docutils literal"><span class="pre">import</span> <span class="pre">math</span></code></li>
<li>ma -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">numpy</span> <span class="pre">import</span> <span class="pre">ma</span></code></li>
<li>cbook -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">cbook</span></code></li>
<li>docstring -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">docstring</span></code></li>
<li>is_sequence_of_strings -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib.cbook</span> <span class="pre">import</span> <span class="pre">is_sequence_of_strings</span></code></li>
<li>is_string_like -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib.cbook</span> <span class="pre">import</span> <span class="pre">is_string_like</span></code></li>
<li>iterable -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib.cbook</span> <span class="pre">import</span> <span class="pre">iterable</span></code></li>
<li>itertools -> <code class="xref py py-obj docutils literal"><span class="pre">import</span> <span class="pre">itertools</span></code></li>
<li>martist -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">artist</span> <span class="pre">as</span> <span class="pre">martist</span></code></li>
<li>matplotlib -> <code class="xref py py-obj docutils literal"><span class="pre">import</span> <span class="pre">matplotlib</span></code></li>
<li>mcoll -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">collections</span> <span class="pre">as</span> <span class="pre">mcoll</span></code></li>
<li>mcolors -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">colors</span> <span class="pre">as</span> <span class="pre">mcolors</span></code></li>
<li>mcontour -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">contour</span> <span class="pre">as</span> <span class="pre">mcontour</span></code></li>
<li>mpatches -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">patches</span> <span class="pre">as</span> <span class="pre">mpatches</span></code></li>
<li>mpath -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">path</span> <span class="pre">as</span> <span class="pre">mpath</span></code></li>
<li>mquiver -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">quiver</span> <span class="pre">as</span> <span class="pre">mquiver</span></code></li>
<li>mstack -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">stack</span> <span class="pre">as</span> <span class="pre">mstack</span></code></li>
<li>mstream -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">stream</span> <span class="pre">as</span> <span class="pre">mstream</span></code></li>
<li>mtable -> <code class="xref py py-obj docutils literal"><span class="pre">from</span> <span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">table</span> <span class="pre">as</span> <span class="pre">mtable</span></code></li>
</ul>
</div></blockquote>
<ul>
<li><p class="first">As part of the refactoring to enable Qt5 support, the module
<code class="xref py py-obj docutils literal"><span class="pre">matplotlib.backends.qt4_compat</span></code> was renamed to
<code class="xref py py-obj docutils literal"><span class="pre">matplotlib.qt_compat</span></code>. <code class="xref py py-obj docutils literal"><span class="pre">qt4_compat</span></code> is deprecated in 1.4 and
will be removed in 1.5.</p>
</li>
<li><p class="first">The <a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.errorbar" title="matplotlib.pyplot.errorbar"><code class="xref py py-func docutils literal"><span class="pre">errorbar()</span></code></a> method has been changed such that
the upper and lower limits (<em>lolims</em>, <em>uplims</em>, <em>xlolims</em>, <em>xuplims</em>) now
point in the correct direction.</p>
</li>
<li><p class="first">The <em>fmt</em> kwarg for <code class="xref py py-func docutils literal"><span class="pre">plot()</span></code> defaults.</p>
</li>
<li><p class="first">A bug has been fixed in the path effects rendering of fonts, which now means
that the font size is consistent with non-path effect fonts. See
<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues/2889">https://github.com/matplotlib/matplotlib/issues/2889</a> for more detail.</p>
</li>
<li><p class="first">The Sphinx extensions <code class="xref py py-obj docutils literal"><span class="pre">ipython_directive</span></code> and
<code class="xref py py-obj docutils literal"><span class="pre">ipython_console_highlighting</span></code> have been moved to the IPython
project itself. While they remain in Matplotlib for this release,
they have been deprecated. Update your extensions in <code class="xref py py-obj docutils literal"><span class="pre">conf.py</span></code> to
point to <code class="xref py py-obj docutils literal"><span class="pre">IPython.sphinxext.ipython_directive</span></code> instead of
<code class="xref py py-obj docutils literal"><span class="pre">matplotlib.sphinxext.ipython_directive</span></code>.</p>
</li>
<li><p class="first">In <a class="reference internal" href="finance_api.html#module-matplotlib.finance" title="matplotlib.finance"><code class="xref py py-obj docutils literal"><span class="pre">finance</span></code></a>, almost all functions have been deprecated
and replaced with a pair of functions name <code class="xref py py-obj docutils literal"><span class="pre">*_ochl</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">*_ohlc</span></code>.
The former is the ‘open-close-high-low’ order of quotes used
previously in this module, and the latter is the
‘open-high-low-close’ order that is standard in finance.</p>
</li>
<li><p class="first">For consistency the <code class="docutils literal"><span class="pre">face_alpha</span></code> keyword to
<a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.SimplePatchShadow" title="matplotlib.patheffects.SimplePatchShadow"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.SimplePatchShadow</span></code></a> has been deprecated in
favour of the <code class="docutils literal"><span class="pre">alpha</span></code> keyword. Similarly, the keyword <code class="docutils literal"><span class="pre">offset_xy</span></code> is now
named <code class="docutils literal"><span class="pre">offset</span></code> across all <code class="xref py py-class docutils literal"><span class="pre">_Base`</span></code> has
been renamed to <a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.AbstractPathEffect</span></code></a>.
<code class="docutils literal"><span class="pre">matplotlib.patheffect.ProxyRenderer</span></code> has been renamed to
<a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.PathEffectRenderer" title="matplotlib.patheffects.PathEffectRenderer"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patheffects.PathEffectRenderer</span></code></a> and is now a full
RendererBase subclass.</p>
</li>
<li><p class="first">The artist used to draw the outline of a <code class="xref py py-obj docutils literal"><span class="pre">colorbar</span></code> has been changed
from a <a class="reference internal" href="lines_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.lines.Line2D</span></code></a> to <a class="reference internal" href="patches_api.html#matplotlib.patches.Polygon" title="matplotlib.patches.Polygon"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.patches.Polygon</span></code></a>,
thus <code class="xref py py-obj docutils literal"><span class="pre">colorbar.ColorbarBase.outline</span></code> is now a
<a class="reference internal" href="patches_api.html#matplotlib.patches.Polygon" title="matplotlib.patches.Polygon"><code class="xref py py-obj docutils literal"><span class="pre">matplotlib.patches.Polygon</span></code></a> object.</p>
</li>
<li><p class="first">The legend handler interface has changed from a callable, to any object
which implements the <code class="docutils literal"><span class="pre">legend_artists</span></code> method (a deprecation phase will
see this interface be maintained for v1.4). See
<a class="reference internal" href="../users/legend_guide.html#plotting-guide-legend"><span class="std std-ref">Legend guide</span></a> for further details. Further legend changes
include:</p>
<blockquote>
<div><ul class="simple">
<li><code class="xref py py-func docutils literal"><span class="pre">matplotlib.axes.Axes._get_legend_handles()</span></code> now returns a generator
of handles, rather than a list.</li>
<li>The <a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.legend" title="matplotlib.pyplot.legend"><code class="xref py py-func docutils literal"><span class="pre">legend()</span></code></a> function’s “loc” positional
argument has been deprecated. Use the “loc” keyword instead.</li>
</ul>
</div></blockquote>
</li>
<li><p class="first">The rcParams <code class="xref py py-obj docutils literal"><span class="pre">savefig.transparent</span></code> has been added to control