-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathfigure_api.html
More file actions
3571 lines (3292 loc) · 363 KB
/
figure_api.html
File metadata and controls
3571 lines (3292 loc) · 363 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" data-content_root="../" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>matplotlib.figure — Matplotlib 3.9.3 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="../_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/css/style.css?v=86e00652" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../_static/mpl.css?v=369bd9d1" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
<script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="../_static/documentation_options.js?v=d2a2d18c"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=ccdb6887"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></script>
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'api/figure_api';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.15.4';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.9.3-2-g1d7e71eafa';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.9.3';
DOCUMENTATION_OPTIONS.show_version_warning_banner = true;
</script>
<link rel="canonical" href="https://matplotlib.org/stable/api/figure_api.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.9.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="matplotlib.figure.Figure" href="_as_gen/matplotlib.figure.Figure.html" />
<link rel="prev" title="matplotlib.dviread" href="dviread.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docbuild:last-update" content="Dec 01, 2024"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<input type="checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
<input type="checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="https://matplotlib.org/stable/">
<img src="../_static/logo_light.svg" class="logo__image only-light" alt="Matplotlib 3.9.3 documentation - Home"/>
<script>document.write(`<img src="../_static/logo_dark.svg" class="logo__image only-dark" alt="Matplotlib 3.9.3 documentation - Home"/>`);</script>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../devel/index.html">Contribute</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<script>
document.write(`
<button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
`);
</script>
</div>
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item">
<script>
document.write(`
<div class="version-switcher__container dropdown">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-gitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Gitter</span></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discourse fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discourse</span></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-twitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Twitter</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<script>
document.write(`
<button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
`);
</script>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item"><ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../devel/index.html">Contribute</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item">
<script>
document.write(`
<div class="version-switcher__container dropdown">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-gitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Gitter</span></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discourse fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discourse</span></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-twitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Twitter</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html">matplotlib.figure.Figure</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_axes.html">matplotlib.figure.Figure.add_axes</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_subplot.html">matplotlib.figure.Figure.add_subplot</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.subplots.html">matplotlib.figure.Figure.subplots</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.subplot_mosaic.html">matplotlib.figure.Figure.subplot_mosaic</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_gridspec.html">matplotlib.figure.Figure.add_gridspec</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_axes.html">matplotlib.figure.Figure.get_axes</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.axes.html">matplotlib.figure.Figure.axes</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.delaxes.html">matplotlib.figure.Figure.delaxes</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.subfigures.html">matplotlib.figure.Figure.subfigures</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_subfigure.html">matplotlib.figure.Figure.add_subfigure</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.savefig.html">matplotlib.figure.Figure.savefig</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.colorbar.html">matplotlib.figure.Figure.colorbar</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.legend.html">matplotlib.figure.Figure.legend</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.text.html">matplotlib.figure.Figure.text</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.suptitle.html">matplotlib.figure.Figure.suptitle</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_suptitle.html">matplotlib.figure.Figure.get_suptitle</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.supxlabel.html">matplotlib.figure.Figure.supxlabel</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_supxlabel.html">matplotlib.figure.Figure.get_supxlabel</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.supylabel.html">matplotlib.figure.Figure.supylabel</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_supylabel.html">matplotlib.figure.Figure.get_supylabel</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.align_labels.html">matplotlib.figure.Figure.align_labels</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.align_xlabels.html">matplotlib.figure.Figure.align_xlabels</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.align_ylabels.html">matplotlib.figure.Figure.align_ylabels</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.align_titles.html">matplotlib.figure.Figure.align_titles</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.autofmt_xdate.html">matplotlib.figure.Figure.autofmt_xdate</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_size_inches.html">matplotlib.figure.Figure.set_size_inches</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_size_inches.html">matplotlib.figure.Figure.get_size_inches</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_figheight.html">matplotlib.figure.Figure.set_figheight</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_figheight.html">matplotlib.figure.Figure.get_figheight</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_figwidth.html">matplotlib.figure.Figure.set_figwidth</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_figwidth.html">matplotlib.figure.Figure.get_figwidth</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.dpi.html">matplotlib.figure.Figure.dpi</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_dpi.html">matplotlib.figure.Figure.set_dpi</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_dpi.html">matplotlib.figure.Figure.get_dpi</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.subplots_adjust.html">matplotlib.figure.Figure.subplots_adjust</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_layout_engine.html">matplotlib.figure.Figure.set_layout_engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_layout_engine.html">matplotlib.figure.Figure.get_layout_engine</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.tight_layout.html">matplotlib.figure.Figure.tight_layout</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_tight_layout.html">matplotlib.figure.Figure.set_tight_layout</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_tight_layout.html">matplotlib.figure.Figure.get_tight_layout</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_constrained_layout.html">matplotlib.figure.Figure.set_constrained_layout</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_constrained_layout.html">matplotlib.figure.Figure.get_constrained_layout</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_constrained_layout_pads.html">matplotlib.figure.Figure.set_constrained_layout_pads</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_constrained_layout_pads.html">matplotlib.figure.Figure.get_constrained_layout_pads</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.ginput.html">matplotlib.figure.Figure.ginput</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_axobserver.html">matplotlib.figure.Figure.add_axobserver</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.waitforbuttonpress.html">matplotlib.figure.Figure.waitforbuttonpress</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.pick.html">matplotlib.figure.Figure.pick</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_frameon.html">matplotlib.figure.Figure.set_frameon</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_frameon.html">matplotlib.figure.Figure.get_frameon</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_linewidth.html">matplotlib.figure.Figure.set_linewidth</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_linewidth.html">matplotlib.figure.Figure.get_linewidth</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_facecolor.html">matplotlib.figure.Figure.set_facecolor</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_facecolor.html">matplotlib.figure.Figure.get_facecolor</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_edgecolor.html">matplotlib.figure.Figure.set_edgecolor</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_edgecolor.html">matplotlib.figure.Figure.get_edgecolor</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_artist.html">matplotlib.figure.Figure.add_artist</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_children.html">matplotlib.figure.Figure.get_children</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.figimage.html">matplotlib.figure.Figure.figimage</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.clear.html">matplotlib.figure.Figure.clear</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.gca.html">matplotlib.figure.Figure.gca</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.sca.html">matplotlib.figure.Figure.sca</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_tightbbox.html">matplotlib.figure.Figure.get_tightbbox</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_window_extent.html">matplotlib.figure.Figure.get_window_extent</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.show.html">matplotlib.figure.Figure.show</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_canvas.html">matplotlib.figure.Figure.set_canvas</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.draw.html">matplotlib.figure.Figure.draw</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.draw_without_rendering.html">matplotlib.figure.Figure.draw_without_rendering</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.draw_artist.html">matplotlib.figure.Figure.draw_artist</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.html">matplotlib.figure.SubFigure</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.add_axes.html">matplotlib.figure.SubFigure.add_axes</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.add_subplot.html">matplotlib.figure.SubFigure.add_subplot</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.subplots.html">matplotlib.figure.SubFigure.subplots</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.subplot_mosaic.html">matplotlib.figure.SubFigure.subplot_mosaic</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.add_gridspec.html">matplotlib.figure.SubFigure.add_gridspec</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.delaxes.html">matplotlib.figure.SubFigure.delaxes</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.add_subfigure.html">matplotlib.figure.SubFigure.add_subfigure</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.subfigures.html">matplotlib.figure.SubFigure.subfigures</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.colorbar.html">matplotlib.figure.SubFigure.colorbar</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.legend.html">matplotlib.figure.SubFigure.legend</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.text.html">matplotlib.figure.SubFigure.text</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.suptitle.html">matplotlib.figure.SubFigure.suptitle</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.get_suptitle.html">matplotlib.figure.SubFigure.get_suptitle</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.supxlabel.html">matplotlib.figure.SubFigure.supxlabel</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.get_supxlabel.html">matplotlib.figure.SubFigure.get_supxlabel</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.supylabel.html">matplotlib.figure.SubFigure.supylabel</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.get_supylabel.html">matplotlib.figure.SubFigure.get_supylabel</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.align_labels.html">matplotlib.figure.SubFigure.align_labels</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.align_xlabels.html">matplotlib.figure.SubFigure.align_xlabels</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.align_ylabels.html">matplotlib.figure.SubFigure.align_ylabels</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.align_titles.html">matplotlib.figure.SubFigure.align_titles</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.add_artist.html">matplotlib.figure.SubFigure.add_artist</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.get_children.html">matplotlib.figure.SubFigure.get_children</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.set_frameon.html">matplotlib.figure.SubFigure.set_frameon</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.get_frameon.html">matplotlib.figure.SubFigure.get_frameon</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.set_linewidth.html">matplotlib.figure.SubFigure.set_linewidth</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.get_linewidth.html">matplotlib.figure.SubFigure.get_linewidth</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.set_facecolor.html">matplotlib.figure.SubFigure.set_facecolor</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.get_facecolor.html">matplotlib.figure.SubFigure.get_facecolor</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.set_edgecolor.html">matplotlib.figure.SubFigure.set_edgecolor</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.get_edgecolor.html">matplotlib.figure.SubFigure.get_edgecolor</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.set_dpi.html">matplotlib.figure.SubFigure.set_dpi</a></li>
<li class="toctree-l1"><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.get_dpi.html">matplotlib.figure.SubFigure.get_dpi</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="index.html" class="nav-link">API Reference</a></li>
<li class="breadcrumb-item active" aria-current="page"><code...</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="module-matplotlib.figure">
<span id="matplotlib-figure"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.figure</span></code><a class="headerlink" href="#module-matplotlib.figure" title="Link to this heading">#</a></h1>
<p><a class="reference internal" href="#module-matplotlib.figure" title="matplotlib.figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.figure</span></code></a> implements the following classes:</p>
<dl class="simple">
<dt><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></dt><dd><p>Top level <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a>, which holds all plot elements.
Many methods are implemented in <a class="reference internal" href="#matplotlib.figure.FigureBase" title="matplotlib.figure.FigureBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FigureBase</span></code></a>.</p>
</dd>
<dt><a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.html#matplotlib.figure.SubFigure" title="matplotlib.figure.SubFigure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubFigure</span></code></a></dt><dd><p>A logical figure inside a figure, usually added to a figure (or parent
<a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.html#matplotlib.figure.SubFigure" title="matplotlib.figure.SubFigure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubFigure</span></code></a>) with <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_subfigure.html#matplotlib.figure.Figure.add_subfigure" title="matplotlib.figure.Figure.add_subfigure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_subfigure</span></code></a> or <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.subfigures.html#matplotlib.figure.Figure.subfigures" title="matplotlib.figure.Figure.subfigures"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.subfigures</span></code></a> methods
(provisional API v3.4).</p>
</dd>
</dl>
<p>Figures are typically created using pyplot methods <a class="reference internal" href="_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">figure</span></code></a>,
<a class="reference internal" href="_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="matplotlib.pyplot.subplots"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subplots</span></code></a>, and <a class="reference internal" href="_as_gen/matplotlib.pyplot.subplot_mosaic.html#matplotlib.pyplot.subplot_mosaic" title="matplotlib.pyplot.subplot_mosaic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subplot_mosaic</span></code></a>.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">facecolor</span><span class="o">=</span><span class="s1">'lightskyblue'</span><span class="p">,</span>
<span class="n">layout</span><span class="o">=</span><span class="s1">'constrained'</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">suptitle</span><span class="p">(</span><span class="s1">'Figure'</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s1">'Axes'</span><span class="p">,</span> <span class="n">loc</span><span class="o">=</span><span class="s1">'left'</span><span class="p">,</span> <span class="n">fontstyle</span><span class="o">=</span><span class="s1">'oblique'</span><span class="p">,</span> <span class="n">fontsize</span><span class="o">=</span><span class="s1">'medium'</span><span class="p">)</span>
</pre></div>
</div>
<p>(<a class="reference download internal" download="" href="../_downloads/3928de11b4fbd0ba3f492ed92aebda79/figure_api-1.py"><code class="xref download docutils literal notranslate"><span class="pre">Source</span> <span class="pre">code</span></code></a>, <a class="reference download internal" download="" href="../_downloads/37981875abad13945405683f462a9931/figure_api-1.2x.png"><code class="xref download docutils literal notranslate"><span class="pre">2x.png</span></code></a>, <a class="reference download internal" download="" href="../_downloads/38bf68f42cdd9788ce147da6927a8a7d/figure_api-1.png"><code class="xref download docutils literal notranslate"><span class="pre">png</span></code></a>)</p>
<figure class="align-center">
<a class="reference internal image-reference" href="../_images/api-figure_api-1.2x.png">
<img src="../_images/api-figure_api-1.png" style="" srcset="../_images/api-figure_api-1.png, ../_images/api-figure_api-1.2x.png 2.00x" alt="" class="plot-directive"/>
</a>
</figure>
<p>Some situations call for directly instantiating a <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> class,
usually inside an application of some sort (see <a class="reference internal" href="../gallery/user_interfaces/index.html#user-interfaces"><span class="std std-ref">Embedding Matplotlib in graphical user interfaces</span></a> for a
list of examples) . More information about Figures can be found at
<a class="reference internal" href="../users/explain/figure/figure_intro.html#figure-intro"><span class="std std-ref">Introduction to Figures</span></a>.</p>
<section id="figure">
<h2>Figure<a class="headerlink" href="#figure" title="Link to this heading">#</a></h2>
<section id="figure-class">
<h3>Figure class<a class="headerlink" href="#figure-class" title="Link to this heading">#</a></h3>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></p></td>
<td><p>The top level container for all the plot elements.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="adding-axes-and-subfigures">
<h3>Adding Axes and SubFigures<a class="headerlink" href="#adding-axes-and-subfigures" title="Link to this heading">#</a></h3>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_axes.html#matplotlib.figure.Figure.add_axes" title="matplotlib.figure.Figure.add_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_axes</span></code></a></p></td>
<td><p>Add an <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> to the figure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_subplot.html#matplotlib.figure.Figure.add_subplot" title="matplotlib.figure.Figure.add_subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_subplot</span></code></a></p></td>
<td><p>Add an <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> to the figure as part of a subplot arrangement.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.subplots.html#matplotlib.figure.Figure.subplots" title="matplotlib.figure.Figure.subplots"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.subplots</span></code></a></p></td>
<td><p>Add a set of subplots to this figure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.subplot_mosaic.html#matplotlib.figure.Figure.subplot_mosaic" title="matplotlib.figure.Figure.subplot_mosaic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.subplot_mosaic</span></code></a></p></td>
<td><p>Build a layout of Axes based on ASCII art or nested lists.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_gridspec.html#matplotlib.figure.Figure.add_gridspec" title="matplotlib.figure.Figure.add_gridspec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_gridspec</span></code></a></p></td>
<td><p>Low-level API for creating a <a class="reference internal" href="_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec" title="matplotlib.gridspec.GridSpec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GridSpec</span></code></a> that has this figure as a parent.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_axes.html#matplotlib.figure.Figure.get_axes" title="matplotlib.figure.Figure.get_axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_axes</span></code></a></p></td>
<td><p>List of Axes in the Figure.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.axes.html#matplotlib.figure.Figure.axes" title="matplotlib.figure.Figure.axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.axes</span></code></a></p></td>
<td><p>List of Axes in the Figure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.delaxes.html#matplotlib.figure.Figure.delaxes" title="matplotlib.figure.Figure.delaxes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.delaxes</span></code></a></p></td>
<td><p>Remove the <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> <em>ax</em> from the figure; update the current Axes.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.subfigures.html#matplotlib.figure.Figure.subfigures" title="matplotlib.figure.Figure.subfigures"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.subfigures</span></code></a></p></td>
<td><p>Add a set of subfigures to this figure or subfigure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_subfigure.html#matplotlib.figure.Figure.add_subfigure" title="matplotlib.figure.Figure.add_subfigure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_subfigure</span></code></a></p></td>
<td><p>Add a <a class="reference internal" href="_as_gen/matplotlib.figure.SubFigure.html#matplotlib.figure.SubFigure" title="matplotlib.figure.SubFigure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubFigure</span></code></a> to the figure as part of a subplot arrangement.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="saving">
<h3>Saving<a class="headerlink" href="#saving" title="Link to this heading">#</a></h3>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.savefig.html#matplotlib.figure.Figure.savefig" title="matplotlib.figure.Figure.savefig"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.savefig</span></code></a></p></td>
<td><p>Save the current figure as an image or vector graphic to a file.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="annotating">
<h3>Annotating<a class="headerlink" href="#annotating" title="Link to this heading">#</a></h3>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.colorbar.html#matplotlib.figure.Figure.colorbar" title="matplotlib.figure.Figure.colorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.colorbar</span></code></a></p></td>
<td><p>Add a colorbar to a plot.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.legend.html#matplotlib.figure.Figure.legend" title="matplotlib.figure.Figure.legend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.legend</span></code></a></p></td>
<td><p>Place a legend on the figure.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.text.html#matplotlib.figure.Figure.text" title="matplotlib.figure.Figure.text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.text</span></code></a></p></td>
<td><p>Add text to figure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.suptitle.html#matplotlib.figure.Figure.suptitle" title="matplotlib.figure.Figure.suptitle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.suptitle</span></code></a></p></td>
<td><p>Add a centered suptitle to the figure.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_suptitle.html#matplotlib.figure.Figure.get_suptitle" title="matplotlib.figure.Figure.get_suptitle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_suptitle</span></code></a></p></td>
<td><p>Return the suptitle as string or an empty string if not set.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.supxlabel.html#matplotlib.figure.Figure.supxlabel" title="matplotlib.figure.Figure.supxlabel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.supxlabel</span></code></a></p></td>
<td><p>Add a centered supxlabel to the figure.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_supxlabel.html#matplotlib.figure.Figure.get_supxlabel" title="matplotlib.figure.Figure.get_supxlabel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_supxlabel</span></code></a></p></td>
<td><p>Return the supxlabel as string or an empty string if not set.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.supylabel.html#matplotlib.figure.Figure.supylabel" title="matplotlib.figure.Figure.supylabel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.supylabel</span></code></a></p></td>
<td><p>Add a centered supylabel to the figure.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_supylabel.html#matplotlib.figure.Figure.get_supylabel" title="matplotlib.figure.Figure.get_supylabel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_supylabel</span></code></a></p></td>
<td><p>Return the supylabel as string or an empty string if not set.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.align_labels.html#matplotlib.figure.Figure.align_labels" title="matplotlib.figure.Figure.align_labels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.align_labels</span></code></a></p></td>
<td><p>Align the xlabels and ylabels of subplots with the same subplots row or column (respectively) if label alignment is being done automatically (i.e. the label position is not manually set).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.align_xlabels.html#matplotlib.figure.Figure.align_xlabels" title="matplotlib.figure.Figure.align_xlabels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.align_xlabels</span></code></a></p></td>
<td><p>Align the xlabels of subplots in the same subplot row if label alignment is being done automatically (i.e. the label position is not manually set).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.align_ylabels.html#matplotlib.figure.Figure.align_ylabels" title="matplotlib.figure.Figure.align_ylabels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.align_ylabels</span></code></a></p></td>
<td><p>Align the ylabels of subplots in the same subplot column if label alignment is being done automatically (i.e. the label position is not manually set).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.align_titles.html#matplotlib.figure.Figure.align_titles" title="matplotlib.figure.Figure.align_titles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.align_titles</span></code></a></p></td>
<td><p>Align the titles of subplots in the same subplot row if title alignment is being done automatically (i.e. the title position is not manually set).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.autofmt_xdate.html#matplotlib.figure.Figure.autofmt_xdate" title="matplotlib.figure.Figure.autofmt_xdate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.autofmt_xdate</span></code></a></p></td>
<td><p>Date ticklabels often overlap, so it is useful to rotate them and right align them.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="figure-geometry">
<h3>Figure geometry<a class="headerlink" href="#figure-geometry" title="Link to this heading">#</a></h3>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_size_inches.html#matplotlib.figure.Figure.set_size_inches" title="matplotlib.figure.Figure.set_size_inches"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_size_inches</span></code></a></p></td>
<td><p>Set the figure size in inches.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_size_inches.html#matplotlib.figure.Figure.get_size_inches" title="matplotlib.figure.Figure.get_size_inches"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_size_inches</span></code></a></p></td>
<td><p>Return the current size of the figure in inches.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_figheight.html#matplotlib.figure.Figure.set_figheight" title="matplotlib.figure.Figure.set_figheight"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_figheight</span></code></a></p></td>
<td><p>Set the height of the figure in inches.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_figheight.html#matplotlib.figure.Figure.get_figheight" title="matplotlib.figure.Figure.get_figheight"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_figheight</span></code></a></p></td>
<td><p>Return the figure height in inches.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_figwidth.html#matplotlib.figure.Figure.set_figwidth" title="matplotlib.figure.Figure.set_figwidth"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_figwidth</span></code></a></p></td>
<td><p>Set the width of the figure in inches.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_figwidth.html#matplotlib.figure.Figure.get_figwidth" title="matplotlib.figure.Figure.get_figwidth"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_figwidth</span></code></a></p></td>
<td><p>Return the figure width in inches.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.dpi.html#matplotlib.figure.Figure.dpi" title="matplotlib.figure.Figure.dpi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.dpi</span></code></a></p></td>
<td><p>The resolution in dots per inch.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_dpi.html#matplotlib.figure.Figure.set_dpi" title="matplotlib.figure.Figure.set_dpi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_dpi</span></code></a></p></td>
<td><p>Set the resolution of the figure in dots-per-inch.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_dpi.html#matplotlib.figure.Figure.get_dpi" title="matplotlib.figure.Figure.get_dpi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_dpi</span></code></a></p></td>
<td><p>Return the resolution in dots per inch as a float.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="subplot-layout">
<h3>Subplot layout<a class="headerlink" href="#subplot-layout" title="Link to this heading">#</a></h3>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.subplots_adjust.html#matplotlib.figure.Figure.subplots_adjust" title="matplotlib.figure.Figure.subplots_adjust"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.subplots_adjust</span></code></a></p></td>
<td><p>Adjust the subplot layout parameters.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_layout_engine.html#matplotlib.figure.Figure.set_layout_engine" title="matplotlib.figure.Figure.set_layout_engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_layout_engine</span></code></a></p></td>
<td><p>Set the layout engine for this figure.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_layout_engine.html#matplotlib.figure.Figure.get_layout_engine" title="matplotlib.figure.Figure.get_layout_engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_layout_engine</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</div>
<section id="discouraged-or-deprecated">
<h4>Discouraged or deprecated<a class="headerlink" href="#discouraged-or-deprecated" title="Link to this heading">#</a></h4>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.tight_layout.html#matplotlib.figure.Figure.tight_layout" title="matplotlib.figure.Figure.tight_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.tight_layout</span></code></a></p></td>
<td><p>Adjust the padding between and around subplots.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_tight_layout.html#matplotlib.figure.Figure.set_tight_layout" title="matplotlib.figure.Figure.set_tight_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_tight_layout</span></code></a></p></td>
<td><p>[<em>Deprecated</em>] Set whether and how <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.tight_layout.html#matplotlib.figure.Figure.tight_layout" title="matplotlib.figure.Figure.tight_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.tight_layout</span></code></a> is called when drawing.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_tight_layout.html#matplotlib.figure.Figure.get_tight_layout" title="matplotlib.figure.Figure.get_tight_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_tight_layout</span></code></a></p></td>
<td><p>Return whether <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.tight_layout.html#matplotlib.figure.Figure.tight_layout" title="matplotlib.figure.Figure.tight_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.tight_layout</span></code></a> is called when drawing.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_constrained_layout.html#matplotlib.figure.Figure.set_constrained_layout" title="matplotlib.figure.Figure.set_constrained_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_constrained_layout</span></code></a></p></td>
<td><p>[<em>Deprecated</em>] Set whether <code class="docutils literal notranslate"><span class="pre">constrained_layout</span></code> is used upon drawing.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_constrained_layout.html#matplotlib.figure.Figure.get_constrained_layout" title="matplotlib.figure.Figure.get_constrained_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_constrained_layout</span></code></a></p></td>
<td><p>Return whether constrained layout is being used.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_constrained_layout_pads.html#matplotlib.figure.Figure.set_constrained_layout_pads" title="matplotlib.figure.Figure.set_constrained_layout_pads"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_constrained_layout_pads</span></code></a></p></td>
<td><p>[<em>Deprecated</em>] Set padding for <code class="docutils literal notranslate"><span class="pre">constrained_layout</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_constrained_layout_pads.html#matplotlib.figure.Figure.get_constrained_layout_pads" title="matplotlib.figure.Figure.get_constrained_layout_pads"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_constrained_layout_pads</span></code></a></p></td>
<td><p>[<em>Deprecated</em>] Get padding for <code class="docutils literal notranslate"><span class="pre">constrained_layout</span></code>.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
</section>
<section id="interactive">
<h3>Interactive<a class="headerlink" href="#interactive" title="Link to this heading">#</a></h3>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="../users/explain/figure/event_handling.html#event-handling"><span class="std std-ref">Event handling and picking</span></a></p></li>
</ul>
</div>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.ginput.html#matplotlib.figure.Figure.ginput" title="matplotlib.figure.Figure.ginput"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.ginput</span></code></a></p></td>
<td><p>Blocking call to interact with a figure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_axobserver.html#matplotlib.figure.Figure.add_axobserver" title="matplotlib.figure.Figure.add_axobserver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_axobserver</span></code></a></p></td>
<td><p>Whenever the Axes state change, <code class="docutils literal notranslate"><span class="pre">func(self)</span></code> will be called.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.waitforbuttonpress.html#matplotlib.figure.Figure.waitforbuttonpress" title="matplotlib.figure.Figure.waitforbuttonpress"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.waitforbuttonpress</span></code></a></p></td>
<td><p>Blocking call to interact with the figure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.pick.html#matplotlib.figure.Figure.pick" title="matplotlib.figure.Figure.pick"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.pick</span></code></a></p></td>
<td><p>Process a pick event.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="modifying-appearance">
<h3>Modifying appearance<a class="headerlink" href="#modifying-appearance" title="Link to this heading">#</a></h3>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_frameon.html#matplotlib.figure.Figure.set_frameon" title="matplotlib.figure.Figure.set_frameon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_frameon</span></code></a></p></td>
<td><p>Set the figure's background patch visibility, i.e. whether the figure background will be drawn.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_frameon.html#matplotlib.figure.Figure.get_frameon" title="matplotlib.figure.Figure.get_frameon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_frameon</span></code></a></p></td>
<td><p>Return the figure's background patch visibility, i.e. whether the figure background will be drawn.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_linewidth.html#matplotlib.figure.Figure.set_linewidth" title="matplotlib.figure.Figure.set_linewidth"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_linewidth</span></code></a></p></td>
<td><p>Set the line width of the Figure rectangle.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_linewidth.html#matplotlib.figure.Figure.get_linewidth" title="matplotlib.figure.Figure.get_linewidth"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_linewidth</span></code></a></p></td>
<td><p>Get the line width of the Figure rectangle.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_facecolor.html#matplotlib.figure.Figure.set_facecolor" title="matplotlib.figure.Figure.set_facecolor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_facecolor</span></code></a></p></td>
<td><p>Set the face color of the Figure rectangle.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_facecolor.html#matplotlib.figure.Figure.get_facecolor" title="matplotlib.figure.Figure.get_facecolor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_facecolor</span></code></a></p></td>
<td><p>Get the face color of the Figure rectangle.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_edgecolor.html#matplotlib.figure.Figure.set_edgecolor" title="matplotlib.figure.Figure.set_edgecolor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_edgecolor</span></code></a></p></td>
<td><p>Set the edge color of the Figure rectangle.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_edgecolor.html#matplotlib.figure.Figure.get_edgecolor" title="matplotlib.figure.Figure.get_edgecolor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_edgecolor</span></code></a></p></td>
<td><p>Get the edge color of the Figure rectangle.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="adding-and-getting-artists">
<h3>Adding and getting Artists<a class="headerlink" href="#adding-and-getting-artists" title="Link to this heading">#</a></h3>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.add_artist.html#matplotlib.figure.Figure.add_artist" title="matplotlib.figure.Figure.add_artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_artist</span></code></a></p></td>
<td><p>Add an <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a> to the figure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_children.html#matplotlib.figure.Figure.get_children" title="matplotlib.figure.Figure.get_children"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_children</span></code></a></p></td>
<td><p>Get a list of artists contained in the figure.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.figimage.html#matplotlib.figure.Figure.figimage" title="matplotlib.figure.Figure.figimage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.figimage</span></code></a></p></td>
<td><p>Add a non-resampled image to the figure.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="getting-and-modifying-state">
<h3>Getting and modifying state<a class="headerlink" href="#getting-and-modifying-state" title="Link to this heading">#</a></h3>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="../users/explain/figure/interactive.html#interactive-figures"><span class="std std-ref">Interactive figures</span></a></p></li>
</ul>
</div>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.clear.html#matplotlib.figure.Figure.clear" title="matplotlib.figure.Figure.clear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.clear</span></code></a></p></td>
<td><p>Clear the figure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.gca.html#matplotlib.figure.Figure.gca" title="matplotlib.figure.Figure.gca"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.gca</span></code></a></p></td>
<td><p>Get the current Axes.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.sca.html#matplotlib.figure.Figure.sca" title="matplotlib.figure.Figure.sca"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.sca</span></code></a></p></td>
<td><p>Set the current Axes to be <em>a</em> and return <em>a</em>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_tightbbox.html#matplotlib.figure.Figure.get_tightbbox" title="matplotlib.figure.Figure.get_tightbbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_tightbbox</span></code></a></p></td>
<td><p>Return a (tight) bounding box of the figure <em>in inches</em>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.get_window_extent.html#matplotlib.figure.Figure.get_window_extent" title="matplotlib.figure.Figure.get_window_extent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.get_window_extent</span></code></a></p></td>
<td><p>Get the artist's bounding box in display space.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.show.html#matplotlib.figure.Figure.show" title="matplotlib.figure.Figure.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.show</span></code></a></p></td>
<td><p>If using a GUI backend with pyplot, display the figure window.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.set_canvas.html#matplotlib.figure.Figure.set_canvas" title="matplotlib.figure.Figure.set_canvas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.set_canvas</span></code></a></p></td>
<td><p>Set the canvas that contains the figure</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.draw.html#matplotlib.figure.Figure.draw" title="matplotlib.figure.Figure.draw"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.draw</span></code></a></p></td>
<td><p>Draw the Artist (and its children) using the given renderer.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.draw_without_rendering.html#matplotlib.figure.Figure.draw_without_rendering" title="matplotlib.figure.Figure.draw_without_rendering"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.draw_without_rendering</span></code></a></p></td>
<td><p>Draw the figure with no output.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.draw_artist.html#matplotlib.figure.Figure.draw_artist" title="matplotlib.figure.Figure.draw_artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.draw_artist</span></code></a></p></td>
<td><p>Draw <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a> <em>a</em> only.</p></td>
</tr>
</tbody>
</table>
</div>
</section>
</section>
<section id="subfigure">