-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathfigure_api.html
More file actions
1930 lines (1839 loc) · 134 KB
/
figure_api.html
File metadata and controls
1930 lines (1839 loc) · 134 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>figure — Matplotlib 1.5.0 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: '1.5.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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 1.5.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.5.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="finance" href="finance_api.html" />
<link rel="prev" title="dviread" href="dviread.html" />
<link href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet" type="text/css">
<link rel="canonical" href="https://matplotlib.org/stable/api/figure_api.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v1.5.0). For the latest version see <a href="https://matplotlib.org/stable/api/figure_api.html">https://matplotlib.org/stable/api/figure_api.html</a></div>
<div class="alert" style="background-color: #FEA46C; padding: 10px 0;
">
<h3>We're updating the default styles for Matplotlib 2.0</h3>
<p>Learn what to expect in the <a href="/style_changes.html" style="font-weight: bold;
color: #11557C;">new updates</a></p>
</div>
<link rel="shortcut icon" href="/_static/favicon.ico">
<!-- 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.png" 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="finance_api.html" title="finance"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dviread.html" title="dviread"
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">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">figure</a><ul>
<li><a class="reference internal" href="#module-matplotlib.figure"><code class="docutils literal"><span class="pre">matplotlib.figure</span></code></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="dviread.html"
title="previous chapter">dviread</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="finance_api.html"
title="next chapter">finance</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/figure_api.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">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</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="figure">
<h1>figure<a class="headerlink" href="#figure" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.figure">
<span id="matplotlib-figure"></span><h2><a class="reference internal" href="#module-matplotlib.figure" title="matplotlib.figure"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.figure</span></code></a><a class="headerlink" href="#module-matplotlib.figure" title="Permalink to this headline">¶</a></h2>
<p>The figure module provides the top-level
<a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">Artist</span></code></a>, the <a class="reference internal" href="#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">Figure</span></code></a>, which
contains all the plot elements. The following classes are defined</p>
<dl class="docutils">
<dt><a class="reference internal" href="#matplotlib.figure.SubplotParams" title="matplotlib.figure.SubplotParams"><code class="xref py py-class docutils literal"><span class="pre">SubplotParams</span></code></a></dt>
<dd>control the default spacing of the subplots</dd>
<dt><a class="reference internal" href="#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">Figure</span></code></a></dt>
<dd>top level container for all plot elements</dd>
</dl>
<dl class="class">
<dt id="matplotlib.figure.AxesStack">
<em class="property">class </em><code class="descclassname">matplotlib.figure.</code><code class="descname">AxesStack</code><a class="headerlink" href="#matplotlib.figure.AxesStack" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="cbook_api.html#matplotlib.cbook.Stack" title="matplotlib.cbook.Stack"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.cbook.Stack</span></code></a></p>
<p>Specialization of the Stack to handle all tracking of Axes in a Figure.
This stack stores <code class="docutils literal"><span class="pre">key,</span> <span class="pre">(ind,</span> <span class="pre">axes)</span></code> pairs, where:</p>
<blockquote>
<div><ul class="simple">
<li><strong>key</strong> should be a hash of the args and kwargs
used in generating the Axes.</li>
<li><strong>ind</strong> is a serial number for tracking the order
in which axes were added.</li>
</ul>
</div></blockquote>
<p>The AxesStack is a callable, where <code class="docutils literal"><span class="pre">ax_stack()</span></code> returns
the current axes. Alternatively the <a class="reference internal" href="#matplotlib.figure.AxesStack.current_key_axes" title="matplotlib.figure.AxesStack.current_key_axes"><code class="xref py py-meth docutils literal"><span class="pre">current_key_axes()</span></code></a> will
return the current key and associated axes.</p>
<dl class="method">
<dt id="matplotlib.figure.AxesStack.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>key</em>, <em>a</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.AxesStack.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Add Axes <em>a</em>, with key <em>key</em>, to the stack, and return the stack.</p>
<p>If <em>a</em> is already on the stack, don’t add it again, but
return <em>None</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.AxesStack.as_list">
<code class="descname">as_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.AxesStack.as_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the Axes instances that have been added to the figure</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.AxesStack.bubble">
<code class="descname">bubble</code><span class="sig-paren">(</span><em>a</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.AxesStack.bubble" title="Permalink to this definition">¶</a></dt>
<dd><p>Move the given axes, which must already exist in the
stack, to the top.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.AxesStack.current_key_axes">
<code class="descname">current_key_axes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.AxesStack.current_key_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a tuple of <code class="docutils literal"><span class="pre">(key,</span> <span class="pre">axes)</span></code> for the active axes.</p>
<p>If no axes exists on the stack, then returns <code class="docutils literal"><span class="pre">(None,</span> <span class="pre">None)</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.AxesStack.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>key</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.AxesStack.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the Axes instance that was added with <em>key</em>.
If it is not present, return None.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.AxesStack.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>a</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.AxesStack.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the axes from the stack.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.figure.Figure">
<em class="property">class </em><code class="descclassname">matplotlib.figure.</code><code class="descname">Figure</code><span class="sig-paren">(</span><em>figsize=None</em>, <em>dpi=None</em>, <em>facecolor=None</em>, <em>edgecolor=None</em>, <em>linewidth=0.0</em>, <em>frameon=None</em>, <em>subplotpars=None</em>, <em>tight_layout=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.artist.Artist</span></code></a></p>
<p>The Figure instance supports callbacks through a <em>callbacks</em>
attribute which is a <a class="reference internal" href="cbook_api.html#matplotlib.cbook.CallbackRegistry" title="matplotlib.cbook.CallbackRegistry"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.cbook.CallbackRegistry</span></code></a>
instance. The events you can connect to are ‘dpi_changed’, and
the callback will be called with <code class="docutils literal"><span class="pre">func(fig)</span></code> where fig is the
<a class="reference internal" href="#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">Figure</span></code></a> instance.</p>
<dl class="docutils">
<dt><em>patch</em></dt>
<dd>The figure patch is drawn by a
<a class="reference internal" href="patches_api.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.patches.Rectangle</span></code></a> instance</dd>
<dt><em>suppressComposite</em></dt>
<dd>For multiple figure images, the figure will make composite
images depending on the renderer option_image_nocomposite
function. If suppressComposite is True|False, this will
override the renderer.</dd>
<dt><em>figsize</em></dt>
<dd>w,h tuple in inches</dd>
<dt><em>dpi</em></dt>
<dd>Dots per inch</dd>
<dt><em>facecolor</em></dt>
<dd>The figure patch facecolor; defaults to rc <code class="docutils literal"><span class="pre">figure.facecolor</span></code></dd>
<dt><em>edgecolor</em></dt>
<dd>The figure patch edge color; defaults to rc <code class="docutils literal"><span class="pre">figure.edgecolor</span></code></dd>
<dt><em>linewidth</em></dt>
<dd>The figure patch edge linewidth; the default linewidth of the frame</dd>
<dt><em>frameon</em></dt>
<dd>If <em>False</em>, suppress drawing the figure frame</dd>
<dt><em>subplotpars</em></dt>
<dd>A <a class="reference internal" href="#matplotlib.figure.SubplotParams" title="matplotlib.figure.SubplotParams"><code class="xref py py-class docutils literal"><span class="pre">SubplotParams</span></code></a> instance, defaults to rc</dd>
<dt><em>tight_layout</em></dt>
<dd>If <em>False</em> use <em>subplotpars</em>; if <em>True</em> adjust subplot
parameters using <a class="reference internal" href="#matplotlib.figure.Figure.tight_layout" title="matplotlib.figure.Figure.tight_layout"><code class="xref py py-meth docutils literal"><span class="pre">tight_layout()</span></code></a> with default padding.
When providing a dict containing the keys <code class="xref py py-obj docutils literal"><span class="pre">pad</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">w_pad</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">h_pad</span></code>
and <code class="xref py py-obj docutils literal"><span class="pre">rect</span></code>, the default <a class="reference internal" href="#matplotlib.figure.Figure.tight_layout" title="matplotlib.figure.Figure.tight_layout"><code class="xref py py-meth docutils literal"><span class="pre">tight_layout()</span></code></a> paddings will be
overridden.
Defaults to rc <code class="docutils literal"><span class="pre">figure.autolayout</span></code>.</dd>
</dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.add_axes">
<code class="descname">add_axes</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.add_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an axes at position <em>rect</em> [<em>left</em>, <em>bottom</em>, <em>width</em>,
<em>height</em>] where all quantities are in fractions of figure
width and height. kwargs are legal
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> kwargs plus <em>projection</em> which
sets the projection type of the axes. (For backward
compatibility, <code class="docutils literal"><span class="pre">polar=True</span></code> may also be provided, which is
equivalent to <code class="docutils literal"><span class="pre">projection='polar'</span></code>). Valid values for
<em>projection</em> are: [‘aitoff’, ‘hammer’, ‘lambert’, ‘mollweide’, ‘polar’, ‘rectilinear’]. Some of these
projections support additional kwargs, which may be provided
to <a class="reference internal" href="#matplotlib.figure.Figure.add_axes" title="matplotlib.figure.Figure.add_axes"><code class="xref py py-meth docutils literal"><span class="pre">add_axes()</span></code></a>. Typical usage:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">rect</span> <span class="o">=</span> <span class="n">l</span><span class="p">,</span><span class="n">b</span><span class="p">,</span><span class="n">w</span><span class="p">,</span><span class="n">h</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">rect</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">rect</span><span class="p">,</span> <span class="n">frameon</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">axisbg</span><span class="o">=</span><span class="s">'g'</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">rect</span><span class="p">,</span> <span class="n">polar</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">rect</span><span class="p">,</span> <span class="n">projection</span><span class="o">=</span><span class="s">'polar'</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">ax</span><span class="p">)</span>
</pre></div>
</div>
<p>If the figure already has an axes with the same parameters,
then it will simply make that axes current and return it. If
you do not want this behavior, e.g., you want to force the
creation of a new Axes, you must use a unique set of args and
kwargs. The axes <code class="xref py py-attr docutils literal"><span class="pre">label</span></code>
attribute has been exposed for this purpose. e.g., if you want
two axes that are otherwise identical to be added to the
figure, make sure you give them unique labels:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">rect</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s">'axes1'</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">rect</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="s">'axes2'</span><span class="p">)</span>
</pre></div>
</div>
<p>In rare circumstances, add_axes may be called with a single
argument, an Axes instance already created in the present
figure but not in the figure’s list of axes. For example,
if an axes has been removed with <a class="reference internal" href="#matplotlib.figure.Figure.delaxes" title="matplotlib.figure.Figure.delaxes"><code class="xref py py-meth docutils literal"><span class="pre">delaxes()</span></code></a>, it can
be restored with:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">ax</span><span class="p">)</span>
</pre></div>
</div>
<p>In all cases, the <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance
will be returned.</p>
<p>In addition to <em>projection</em>, the following kwargs are supported:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="37%" />
<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">adjustable</span></code></td>
<td>[ ‘box’ | ‘datalim’ | ‘box-forced’]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal"><span class="pre">agg_filter</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal"><span class="pre">alpha</span></code></a></td>
<td>float (0.0 transparent through 1.0 opaque)</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">anchor</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal"><span class="pre">animated</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">aspect</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">autoscale_on</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">autoscalex_on</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">autoscaley_on</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_axes" title="matplotlib.artist.Artist.set_axes"><code class="xref py py-meth docutils literal"><span class="pre">axes</span></code></a></td>
<td>an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">axes_locator</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">axis_bgcolor</span></code></td>
<td>any matplotlib color - see <a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.colors" title="matplotlib.pyplot.colors"><code class="xref py py-func docutils literal"><span class="pre">colors()</span></code></a></td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">axisbelow</span></code></td>
<td>[ <em>True</em> | <em>False</em> ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_clip_box" title="matplotlib.artist.Artist.set_clip_box"><code class="xref py py-meth docutils literal"><span class="pre">clip_box</span></code></a></td>
<td>a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Bbox</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_clip_on" title="matplotlib.artist.Artist.set_clip_on"><code class="xref py py-meth docutils literal"><span class="pre">clip_on</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_clip_path" title="matplotlib.artist.Artist.set_clip_path"><code class="xref py py-meth docutils literal"><span class="pre">clip_path</span></code></a></td>
<td>[ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal"><span class="pre">Path</span></code></a>, <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a>) | <a class="reference internal" href="patches_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal"><span class="pre">Patch</span></code></a> | None ]</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">color_cycle</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal"><span class="pre">contains</span></code></a></td>
<td>a callable function</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">figure</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">frame_on</span></code></td>
<td>[ <em>True</em> | <em>False</em> ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal"><span class="pre">gid</span></code></a></td>
<td>an id string</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal"><span class="pre">label</span></code></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">navigate</span></code></td>
<td>[ <em>True</em> | <em>False</em> ]</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">navigate_mode</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal"><span class="pre">path_effects</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal"><span class="pre">picker</span></code></a></td>
<td>[None|float|boolean|callable]</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">position</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">rasterization_zorder</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal"><span class="pre">rasterized</span></code></a></td>
<td>[True | False | None]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal"><span class="pre">sketch_params</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal"><span class="pre">snap</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">title</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal"><span class="pre">url</span></code></a></td>
<td>a url string</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal"><span class="pre">visible</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">xbound</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">xlabel</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">xlim</span></code></td>
<td>length 2 sequence of floats</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">xmargin</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">xscale</span></code></td>
<td>[‘linear’ | ‘log’ | ‘logit’ | ‘symlog’]</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">xticklabels</span></code></td>
<td>sequence of strings</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">xticks</span></code></td>
<td>sequence of floats</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">ybound</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">ylabel</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">ylim</span></code></td>
<td>length 2 sequence of floats</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">ymargin</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">yscale</span></code></td>
<td>[‘linear’ | ‘log’ | ‘logit’ | ‘symlog’]</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">yticklabels</span></code></td>
<td>sequence of strings</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">yticks</span></code></td>
<td>sequence of floats</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal"><span class="pre">zorder</span></code></a></td>
<td>any number</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.add_axobserver">
<code class="descname">add_axobserver</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.add_axobserver" title="Permalink to this definition">¶</a></dt>
<dd><p>whenever the axes state change, <code class="docutils literal"><span class="pre">func(self)</span></code> will be called</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.add_subplot">
<code class="descname">add_subplot</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.add_subplot" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a subplot. Examples:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">)</span>
<span class="c"># equivalent but more general</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
<span class="c"># add subplot with red background</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">212</span><span class="p">,</span> <span class="n">axisbg</span><span class="o">=</span><span class="s">'r'</span><span class="p">)</span>
<span class="c"># add a polar subplot</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">,</span> <span class="n">projection</span><span class="o">=</span><span class="s">'polar'</span><span class="p">)</span>
<span class="c"># add Subplot instance sub</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="n">sub</span><span class="p">)</span>
</pre></div>
</div>
<p><em>kwargs</em> are legal <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> kwargs plus
<em>projection</em>, which chooses a projection type for the axes.
(For backward compatibility, <em>polar=True</em> may also be
provided, which is equivalent to <em>projection=’polar’</em>). Valid
values for <em>projection</em> are: [‘aitoff’, ‘hammer’, ‘lambert’, ‘mollweide’, ‘polar’, ‘rectilinear’]. Some of
these projections
support additional <em>kwargs</em>, which may be provided to
<a class="reference internal" href="#matplotlib.figure.Figure.add_axes" title="matplotlib.figure.Figure.add_axes"><code class="xref py py-meth docutils literal"><span class="pre">add_axes()</span></code></a>.</p>
<p>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance will be returned.</p>
<p>If the figure already has a subplot with key (<em>args</em>,
<em>kwargs</em>) then it will simply make that subplot current and
return it.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.subplot" title="matplotlib.pyplot.subplot"><code class="xref py py-meth docutils literal"><span class="pre">subplot()</span></code></a> for an
explanation of the args.</p>
</div>
<p>The following kwargs are supported:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="37%" />
<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">adjustable</span></code></td>
<td>[ ‘box’ | ‘datalim’ | ‘box-forced’]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal"><span class="pre">agg_filter</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal"><span class="pre">alpha</span></code></a></td>
<td>float (0.0 transparent through 1.0 opaque)</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">anchor</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal"><span class="pre">animated</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">aspect</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">autoscale_on</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">autoscalex_on</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">autoscaley_on</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_axes" title="matplotlib.artist.Artist.set_axes"><code class="xref py py-meth docutils literal"><span class="pre">axes</span></code></a></td>
<td>an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">axes_locator</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">axis_bgcolor</span></code></td>
<td>any matplotlib color - see <a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.colors" title="matplotlib.pyplot.colors"><code class="xref py py-func docutils literal"><span class="pre">colors()</span></code></a></td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">axisbelow</span></code></td>
<td>[ <em>True</em> | <em>False</em> ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_clip_box" title="matplotlib.artist.Artist.set_clip_box"><code class="xref py py-meth docutils literal"><span class="pre">clip_box</span></code></a></td>
<td>a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Bbox</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_clip_on" title="matplotlib.artist.Artist.set_clip_on"><code class="xref py py-meth docutils literal"><span class="pre">clip_on</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_clip_path" title="matplotlib.artist.Artist.set_clip_path"><code class="xref py py-meth docutils literal"><span class="pre">clip_path</span></code></a></td>
<td>[ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal"><span class="pre">Path</span></code></a>, <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a>) | <a class="reference internal" href="patches_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal"><span class="pre">Patch</span></code></a> | None ]</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">color_cycle</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal"><span class="pre">contains</span></code></a></td>
<td>a callable function</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">figure</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">frame_on</span></code></td>
<td>[ <em>True</em> | <em>False</em> ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal"><span class="pre">gid</span></code></a></td>
<td>an id string</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal"><span class="pre">label</span></code></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">navigate</span></code></td>
<td>[ <em>True</em> | <em>False</em> ]</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">navigate_mode</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal"><span class="pre">path_effects</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal"><span class="pre">picker</span></code></a></td>
<td>[None|float|boolean|callable]</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">position</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">rasterization_zorder</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal"><span class="pre">rasterized</span></code></a></td>
<td>[True | False | None]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal"><span class="pre">sketch_params</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal"><span class="pre">snap</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">title</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal"><span class="pre">url</span></code></a></td>
<td>a url string</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal"><span class="pre">visible</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">xbound</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">xlabel</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">xlim</span></code></td>
<td>length 2 sequence of floats</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">xmargin</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">xscale</span></code></td>
<td>[‘linear’ | ‘log’ | ‘logit’ | ‘symlog’]</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">xticklabels</span></code></td>
<td>sequence of strings</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">xticks</span></code></td>
<td>sequence of floats</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">ybound</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">ylabel</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">ylim</span></code></td>
<td>length 2 sequence of floats</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">ymargin</span></code></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">yscale</span></code></td>
<td>[‘linear’ | ‘log’ | ‘logit’ | ‘symlog’]</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-meth docutils literal"><span class="pre">yticklabels</span></code></td>
<td>sequence of strings</td>
</tr>
<tr class="row-even"><td><code class="xref py py-meth docutils literal"><span class="pre">yticks</span></code></td>
<td>sequence of floats</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal"><span class="pre">zorder</span></code></a></td>
<td>any number</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.autofmt_xdate">
<code class="descname">autofmt_xdate</code><span class="sig-paren">(</span><em>bottom=0.2</em>, <em>rotation=30</em>, <em>ha='right'</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.autofmt_xdate" title="Permalink to this definition">¶</a></dt>
<dd><p>Date ticklabels often overlap, so it is useful to rotate them
and right align them. Also, a common use case is a number of
subplots with shared xaxes where the x-axis is date data. The
ticklabels are often long, and it helps to rotate them on the
bottom subplot and turn them off on other subplots, as well as
turn off xlabels.</p>
<dl class="docutils">
<dt><em>bottom</em></dt>
<dd>The bottom of the subplots for <a class="reference internal" href="#matplotlib.figure.Figure.subplots_adjust" title="matplotlib.figure.Figure.subplots_adjust"><code class="xref py py-meth docutils literal"><span class="pre">subplots_adjust()</span></code></a></dd>
<dt><em>rotation</em></dt>
<dd>The rotation of the xtick labels</dd>
<dt><em>ha</em></dt>
<dd>The horizontal alignment of the xticklabels</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.figure.Figure.axes">
<code class="descname">axes</code><a class="headerlink" href="#matplotlib.figure.Figure.axes" title="Permalink to this definition">¶</a></dt>
<dd><p>Read-only: list of axes in Figure</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear the figure – synonym for <a class="reference internal" href="#matplotlib.figure.Figure.clf" title="matplotlib.figure.Figure.clf"><code class="xref py py-meth docutils literal"><span class="pre">clf()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.clf">
<code class="descname">clf</code><span class="sig-paren">(</span><em>keep_observers=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.clf" title="Permalink to this definition">¶</a></dt>
<dd><p>Clear the figure.</p>
<p>Set <em>keep_observers</em> to True if, for example,
a gui widget is tracking the axes in the figure.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.colorbar">
<code class="descname">colorbar</code><span class="sig-paren">(</span><em>mappable</em>, <em>cax=None</em>, <em>ax=None</em>, <em>use_gridspec=True</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.colorbar" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a colorbar for a ScalarMappable instance, <em>mappable</em>.</p>
<p>Documentation for the pylab thin wrapper:</p>
<p>Add a colorbar to a plot.</p>
<p>Function signatures for the <a class="reference internal" href="pyplot_api.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-mod docutils literal"><span class="pre">pyplot</span></code></a> interface; all
but the first are also method signatures for the
<a class="reference internal" href="#matplotlib.figure.Figure.colorbar" title="matplotlib.figure.Figure.colorbar"><code class="xref py py-meth docutils literal"><span class="pre">colorbar()</span></code></a> method:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">colorbar</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">colorbar</span><span class="p">(</span><span class="n">mappable</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">colorbar</span><span class="p">(</span><span class="n">mappable</span><span class="p">,</span> <span class="n">cax</span><span class="o">=</span><span class="n">cax</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">colorbar</span><span class="p">(</span><span class="n">mappable</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>mappable</em></dt>
<dd>the <code class="xref py py-class docutils literal"><span class="pre">Image</span></code>,
<code class="xref py py-class docutils literal"><span class="pre">ContourSet</span></code>, etc. to
which the colorbar applies; this argument is mandatory for the
<a class="reference internal" href="#matplotlib.figure.Figure.colorbar" title="matplotlib.figure.Figure.colorbar"><code class="xref py py-meth docutils literal"><span class="pre">colorbar()</span></code></a> method but optional for the
<a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.colorbar" title="matplotlib.pyplot.colorbar"><code class="xref py py-func docutils literal"><span class="pre">colorbar()</span></code></a> function, which sets the
default to the current image.</dd>
</dl>
</div></blockquote>
<p>keyword arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>cax</em></dt>
<dd>None | axes object into which the colorbar will be drawn</dd>
<dt><em>ax</em></dt>
<dd>None | parent axes object(s) from which space for a new
colorbar axes will be stolen. If a list of axes is given
they will all be resized to make room for the colorbar axes.</dd>
<dt><em>use_gridspec</em></dt>
<dd>False | If <em>cax</em> is None, a new <em>cax</em> is created as an instance of
Axes. If <em>ax</em> is an instance of Subplot and <em>use_gridspec</em> is True,
<em>cax</em> is created as an instance of Subplot using the
grid_spec module.</dd>
</dl>
</div></blockquote>
<p>Additional keyword arguments are of two kinds:</p>
<blockquote>
<div><p>axes properties:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>orientation</em></td>
<td>vertical or horizontal</td>
</tr>
<tr class="row-odd"><td><em>fraction</em></td>
<td>0.15; fraction of original axes to use for colorbar</td>
</tr>
<tr class="row-even"><td><em>pad</em></td>
<td>0.05 if vertical, 0.15 if horizontal; fraction
of original axes between colorbar and new image axes</td>
</tr>
<tr class="row-odd"><td><em>shrink</em></td>
<td>1.0; fraction by which to shrink the colorbar</td>
</tr>
<tr class="row-even"><td><em>aspect</em></td>
<td>20; ratio of long to short dimensions</td>
</tr>
<tr class="row-odd"><td><em>anchor</em></td>
<td>(0.0, 0.5) if vertical; (0.5, 1.0) if horizontal;
the anchor point of the colorbar axes</td>
</tr>
<tr class="row-even"><td><em>panchor</em></td>
<td>(1.0, 0.5) if vertical; (0.5, 0.0) if horizontal;
the anchor point of the colorbar parent axes. If
False, the parent axes’ anchor will be unchanged</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>colorbar properties:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="18%" />
<col width="82%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>extend</em></td>
<td>[ ‘neither’ | ‘both’ | ‘min’ | ‘max’ ]
If not ‘neither’, make pointed end(s) for out-of-
range values. These are set for a given colormap
using the colormap set_under and set_over methods.</td>
</tr>
<tr class="row-odd"><td><em>extendfrac</em></td>
<td>[ <em>None</em> | ‘auto’ | length | lengths ]
If set to <em>None</em>, both the minimum and maximum
triangular colorbar extensions with have a length of
5% of the interior colorbar length (this is the
default setting). If set to ‘auto’, makes the
triangular colorbar extensions the same lengths as
the interior boxes (when <em>spacing</em> is set to
‘uniform’) or the same lengths as the respective
adjacent interior boxes (when <em>spacing</em> is set to
‘proportional’). If a scalar, indicates the length
of both the minimum and maximum triangular colorbar
extensions as a fraction of the interior colorbar
length. A two-element sequence of fractions may also
be given, indicating the lengths of the minimum and
maximum colorbar extensions respectively as a
fraction of the interior colorbar length.</td>
</tr>
<tr class="row-even"><td><em>extendrect</em></td>
<td>[ <em>False</em> | <em>True</em> ]
If <em>False</em> the minimum and maximum colorbar extensions
will be triangular (the default). If <em>True</em> the
extensions will be rectangular.</td>
</tr>
<tr class="row-odd"><td><em>spacing</em></td>
<td>[ ‘uniform’ | ‘proportional’ ]
Uniform spacing gives each discrete color the same
space; proportional makes the space proportional to
the data interval.</td>
</tr>
<tr class="row-even"><td><em>ticks</em></td>
<td>[ None | list of ticks | Locator object ]
If None, ticks are determined automatically from the
input.</td>
</tr>
<tr class="row-odd"><td><em>format</em></td>
<td>[ None | format string | Formatter object ]
If None, the
<a class="reference internal" href="ticker_api.html#matplotlib.ticker.ScalarFormatter" title="matplotlib.ticker.ScalarFormatter"><code class="xref py py-class docutils literal"><span class="pre">ScalarFormatter</span></code></a> is used.
If a format string is given, e.g., ‘%.3f’, that is
used. An alternative
<a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">Formatter</span></code></a> object may be
given instead.</td>
</tr>
<tr class="row-even"><td><em>drawedges</em></td>
<td>[ False | True ] If true, draw lines at color
boundaries.</td>
</tr>
</tbody>
</table>
<p>The following will probably be useful only in the context of
indexed colors (that is, when the mappable has norm=NoNorm()),
or other unusual circumstances.</p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="81%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>boundaries</em></td>
<td>None or a sequence</td>
</tr>
<tr class="row-odd"><td><em>values</em></td>
<td>None or a sequence which must be of length 1 less
than the sequence of <em>boundaries</em>. For each region
delimited by adjacent entries in <em>boundaries</em>, the
color mapped to the corresponding value in values
will be used.</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
<p>If <em>mappable</em> is a <code class="xref py py-class docutils literal"><span class="pre">ContourSet</span></code>, its <em>extend</em>
kwarg is included automatically.</p>
<p>Note that the <em>shrink</em> kwarg provides a simple way to keep a vertical
colorbar, for example, from being taller than the axes of the mappable
to which the colorbar is attached; but it is a manual method requiring
some trial and error. If the colorbar is too tall (or a horizontal
colorbar is too wide) use a smaller value of <em>shrink</em>.</p>
<p>For more precise control, you can manually specify the positions of
the axes objects in which the mappable and the colorbar are drawn. In
this case, do not use any of the axes properties kwargs.</p>
<p>It is known that some vector graphics viewer (svg and pdf) renders white gaps
between segments of the colorbar. This is due to bugs in the viewers not
matplotlib. As a workaround the colorbar can be rendered with overlapping
segments:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">cbar</span> <span class="o">=</span> <span class="n">colorbar</span><span class="p">()</span>
<span class="n">cbar</span><span class="o">.</span><span class="n">solids</span><span class="o">.</span><span class="n">set_edgecolor</span><span class="p">(</span><span class="s">"face"</span><span class="p">)</span>
<span class="n">draw</span><span class="p">()</span>
</pre></div>
</div>
<p>However this has negative consequences in other circumstances. Particularly
with semi transparent images (alpha < 1) and colorbar extensions and is not
enabled by default see (issue #1188).</p>
<dl class="docutils">
<dt>returns:</dt>
<dd><a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.Colorbar" title="matplotlib.colorbar.Colorbar"><code class="xref py py-class docutils literal"><span class="pre">Colorbar</span></code></a> instance; see also its base class,
<a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.ColorbarBase" title="matplotlib.colorbar.ColorbarBase"><code class="xref py py-class docutils literal"><span class="pre">ColorbarBase</span></code></a>. Call the
<a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.ColorbarBase.set_label" title="matplotlib.colorbar.ColorbarBase.set_label"><code class="xref py py-meth docutils literal"><span class="pre">set_label()</span></code></a> method
to label the colorbar.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em>mouseevent</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the mouse event occurred on the figure.</p>
<p>Returns True,{}</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.delaxes">
<code class="descname">delaxes</code><span class="sig-paren">(</span><em>a</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.delaxes" title="Permalink to this definition">¶</a></dt>
<dd><p>remove a from the figure and update the current axes</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.figure.Figure.dpi">
<code class="descname">dpi</code><a class="headerlink" href="#matplotlib.figure.Figure.dpi" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Render the figure using <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.backend_bases.RendererBase</span></code></a>
instance <em>renderer</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.draw_artist">
<code class="descname">draw_artist</code><span class="sig-paren">(</span><em>a</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.draw_artist" title="Permalink to this definition">¶</a></dt>
<dd><p>draw <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.artist.Artist</span></code></a> instance <em>a</em> only –
this is available only after the figure is drawn</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.figure.Figure.figimage">
<code class="descname">figimage</code><span class="sig-paren">(</span><em>X</em>, <em>xo=0</em>, <em>yo=0</em>, <em>alpha=None</em>, <em>norm=None</em>, <em>cmap=None</em>, <em>vmin=None</em>, <em>vmax=None</em>, <em>origin=None</em>, <em>resize=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.figure.Figure.figimage" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a non-resampled image to the figure.</p>
<p>call signatures:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">figimage</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>adds a non-resampled array <em>X</em> to the figure.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">figimage</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">xo</span><span class="p">,</span> <span class="n">yo</span><span class="p">)</span>
</pre></div>
</div>
<p>with pixel offsets <em>xo</em>, <em>yo</em>,</p>
<p><em>X</em> must be a float array:</p>
<ul class="simple">
<li>If <em>X</em> is MxN, assume luminance (grayscale)</li>
<li>If <em>X</em> is MxNx3, assume RGB</li>
<li>If <em>X</em> is MxNx4, assume RGBA</li>
</ul>
<p>Optional keyword arguments:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="14%" />
<col width="86%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Keyword</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>resize</td>
<td>a boolean, True or False. If “True”, then re-size the
Figure to match the given image size.</td>
</tr>
<tr class="row-odd"><td>xo or yo</td>
<td>An integer, the <em>x</em> and <em>y</em> image offset in pixels</td>
</tr>
<tr class="row-even"><td>cmap</td>
<td>a <a class="reference internal" href="colors_api.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.colors.Colormap</span></code></a> instance, e.g.,
cm.jet. If <em>None</em>, default to the rc <code class="docutils literal"><span class="pre">image.cmap</span></code>
value</td>
</tr>