<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="X-UA-Compatible" content="IE=Edge" />

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>matplotlib.figure &#8212; Matplotlib 3.2.2 documentation</title>

<link rel="stylesheet" href="../_static/mpl.css?v3.2.2-2-g137edd56a" type="text/css" />

<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />

<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />

<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />

<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />

<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />

<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>

<script src="../_static/jquery.js"></script>

<script src="../_static/underscore.js"></script>

<script src="../_static/doctools.js"></script>

<script src="../_static/language_data.js"></script>

<script src="../_static/clipboard.min.js"></script>

<script src="../_static/copybutton.js"></script>

<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

<link rel="search" type="application/opensearchdescription+xml"

title="Search within Matplotlib 3.2.2 documentation"

href="../_static/opensearch.xml"/>

<link rel="shortcut icon" href="../_static/favicon.ico"/>

<link rel="index" title="Index" href="../genindex.html" />

<link rel="search" title="Search" href="../search.html" />

<link rel="next" title="matplotlib.figure.AxesStack" href="_as_gen/matplotlib.figure.AxesStack.html" />

<link rel="prev" title="matplotlib.dviread" href="dviread.html" />

<link rel="top" title="Matplotlib 3.2.2 documentation" href="#" />

<link rel="canonical" href="https://matplotlib.org/stable/api/figure_api.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />

<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

<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 (v3.2.2). 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 style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">

<a href="../index.html">

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.2.2</span></div>

<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>

<!-- The "Fork me on github" ribbon -->

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<nav class="main-nav">

<ul>

<li><a href="../users/installing.html">Installation</a></li>

<li><a href="../contents.html">Documentation</a></li>

<li><a href="../gallery/index.html">Examples</a></li>

<li><a href="../tutorials/index.html">Tutorials</a></li>

<li><a href="../devel/index.html">Contributing</a></li>

<li class="nav-right">

<form class="search" action="../search.html" method="get">

<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>

</form>

</li>

</ul>

</nav>

<div class="related" role="navigation" aria-label="related navigation">

<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="_as_gen/matplotlib.figure.AxesStack.html" title="matplotlib.figure.AxesStack"

accesskey="N">next</a> |</li>

<li class="right" >

<a href="dviread.html" title="matplotlib.dviread"

accesskey="P">previous</a> |</li>

<li><a href="../index.html">home</a>|&nbsp;</li>

<li><a href="../contents.html">contents</a> &raquo;</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> &#187;</li>

<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.figure</span></code></a></li>

</ul>

</div>

<div class="sphinxsidebar" role="navigation" aria-label="main navigation">

<div class="sphinxsidebarwrapper">

<h3><a href="../contents.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">matplotlib.figure</span></code></a><ul>

<li><a class="reference internal" href="#classes">Classes</a></li>

<li><a class="reference internal" href="#functions">Functions</a></li>

<div class="relations">

<h3>Related Topics</h3>

<li><a href="../contents.html">Documentation overview</a><ul>

<li><a href="index.html">API Overview</a><ul>

<li>Previous: <a href="dviread.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.dviread</span></code></a></li>

<li>Next: <a href="_as_gen/matplotlib.figure.AxesStack.html" title="next chapter">matplotlib.figure.AxesStack</a></li>

</ul></li>

</ul></li>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/api/figure_api.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

</div>

</div>

<div class="document">

<div class="documentwrapper">

<div class="bodywrapper">

<div class="body" role="main">

<div class="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="Permalink to this headline">¶</a></h1>

<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 notranslate"><span class="pre">Artist</span></code></a>, the <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><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="_as_gen/matplotlib.figure.SubplotParams.html#matplotlib.figure.SubplotParams" title="matplotlib.figure.SubplotParams"><code class="xref py py-class docutils literal notranslate"><span class="pre">SubplotParams</span></code></a></dt><dd>control the default spacing of the subplots</dd>

<dt><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">Figure</span></code></a></dt><dd>Top level container for all plot elements.</dd>

<div class="section" id="classes">

<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>

<table border="1" class="longtable docutils align-default">

<col width="10%" />

<col width="90%" />

<tbody valign="top">

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.figure.AxesStack.html#matplotlib.figure.AxesStack" title="matplotlib.figure.AxesStack"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AxesStack</span></code></a></td>

<td>[<em>Deprecated</em>]</td>

<tr class="row-even"><td><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></td>

<td>The top level container for all the plot elements.</td>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.figure.SubplotParams.html#matplotlib.figure.SubplotParams" title="matplotlib.figure.SubplotParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SubplotParams</span></code></a></td>

<td>A class to hold the parameters for a subplot.</td>

<div class="section" id="functions">

<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>

<table border="1" class="longtable docutils align-default">

<col width="10%" />

<col width="90%" />

<tbody valign="top">

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.figure.figaspect.html#matplotlib.figure.figaspect" title="matplotlib.figure.figaspect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">figaspect</span></code></a></td>

<td>Calculate the width and height for a figure with a specified aspect ratio.</td>

</div>

</div>

</div>

<div class="clearer"></div>

</div>

<div class="footer">

&copy; Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.

<br />

Last updated on Jun 17, 2020.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.

Doc version v3.2.2-2-g137edd56a.

</div>

</body>