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

<head>

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

<title>tight_layout &mdash; Matplotlib 1.5.3 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.3',

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.3 documentation"

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

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

<link rel="top" title="Matplotlib 1.5.3 documentation" href="../index.html" />

<link rel="up" title="The Matplotlib API" href="index.html" />

<link rel="next" title="triangular grids" href="tri_api.html" />

<link rel="prev" title="ticker" href="ticker_api.html" />

<link rel="canonical" href="https://matplotlib.org/stable/api/tight_layout_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.3). For the latest version see <a href="https://matplotlib.org/stable/api/tight_layout_api.html">https://matplotlib.org/stable/api/tight_layout_api.html</a></div>

<div class="alert" style="background-color: #FEA46C; padding: 10px 0;

">

<h2>Matplotlib 2.0.0rc2 is available</h2>

<p><a href="../style_changes.html"

style="font-weight: bold;

color: #11557C;">Install the release candidate now!</a></p>

<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" />

<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">

<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>

<div 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="tri_api.html" title="triangular grids"

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

<li class="right" >

<a href="ticker_api.html" title="ticker"

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

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

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

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

<li><a href="pyplot_summary.html">pyplot</a>|&nbsp;</li>

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

<li><a href="index.html" accesskey="U">The Matplotlib API</a> &raquo;</li>

</ul>

</div>

<div class="sphinxsidebar">

<div class="sphinxsidebarwrapper">

<a href="http://depsy.org/package/python/matplotlib">

<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>

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

<ul>

<li><a class="reference internal" href="#">tight_layout</a><ul>

<li><a class="reference internal" href="#module-matplotlib.tight_layout"><code class="docutils literal"><span class="pre">matplotlib.tight_layout</span></code></a></li>

<div class="relations">

<h3>Related Topics</h3>

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

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

<li>Previous: <a href="ticker_api.html" title="previous chapter">ticker</a></li>

<li>Next: <a href="tri_api.html" title="next chapter">triangular grids</a></li>

</ul></li>

</ul></li>

<div role="note" aria-label="source link">

<h3>This Page</h3>

<ul class="this-page-menu">

<li><a href="../_sources/api/tight_layout_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">

<div><input type="text" name="q" /></div>

<div><input type="submit" value="Go" /></div>

<input type="hidden" name="check_keywords" value="yes" />

<input type="hidden" name="area" value="default" />

</form>

<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="tight-layout">

<h1>tight_layout<a class="headerlink" href="#tight-layout" title="Permalink to this headline">¶</a></h1>

<div class="section" id="module-matplotlib.tight_layout">

<span id="matplotlib-tight-layout"></span><h2><a class="reference internal" href="#module-matplotlib.tight_layout" title="matplotlib.tight_layout"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.tight_layout</span></code></a><a class="headerlink" href="#module-matplotlib.tight_layout" title="Permalink to this headline">¶</a></h2>

<p>This module provides routines to adjust subplot params so that subplots are

nicely fit in the figure. In doing so, only axis labels, tick labels, axes

titles and offsetboxes that are anchored to axes are currently considered.</p>

<p>Internally, it assumes that the margins (left_margin, etc.) which are

differences between ax.get_tightbbox and ax.bbox are independent of axes

position. This may fail if Axes.adjustable is datalim. Also, This will fail

for some cases (for example, left or right margin is affected by xlabel).</p>

<dl class="function">

<dt id="matplotlib.tight_layout.auto_adjust_subplotpars">

<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">auto_adjust_subplotpars</code><span class="sig-paren">(</span><em>fig</em>, <em>renderer</em>, <em>nrows_ncols</em>, <em>num1num2_list</em>, <em>subplot_list</em>, <em>ax_bbox_list=None</em>, <em>pad=1.08</em>, <em>h_pad=None</em>, <em>w_pad=None</em>, <em>rect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.tight_layout.auto_adjust_subplotpars" title="Permalink to this definition">¶</a></dt>

<dd><p>Return a dictionary of subplot parameters so that spacing between

subplots are adjusted. Note that this function ignore geometry

information of subplot itself, but uses what is given by

<em>nrows_ncols</em> and <em>num1num2_list</em> parameteres. Also, the results could be

incorrect if some subplots have <code class="docutils literal"><span class="pre">adjustable=datalim</span></code>.</p>

<p>Parameters:</p>

<dl class="docutils">

<dt>nrows_ncols</dt>

<dd>number of rows and number of columns of the grid.</dd>

<dt>num1num2_list</dt>

<dd>list of numbers specifying the area occupied by the subplot</dd>

<dt>subplot_list</dt>

<dd>list of subplots that will be used to calcuate optimal subplot_params.</dd>

<dt>pad</dt>

<span class="classifier-delimiter">:</span> <span class="classifier">float</span><dd>padding between the figure edge and the edges of subplots, as a fraction

of the font-size.</dd>

<dt>h_pad, w_pad</dt>

<span class="classifier-delimiter">:</span> <span class="classifier">float</span><dd><dl class="first last docutils">

<dt>padding (height/width) between edges of adjacent subplots.</dt>

<dd>Defaults to <code class="xref py py-obj docutils literal"><span class="pre">pad_inches</span></code>.</dd>

<dt>rect</dt>

<dd>[left, bottom, right, top] in normalized (0, 1) figure coordinates.</dd>

<dl class="function">

<dt id="matplotlib.tight_layout.get_renderer">

<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">get_renderer</code><span class="sig-paren">(</span><em>fig</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.tight_layout.get_renderer" title="Permalink to this definition">¶</a></dt>

<dl class="function">

<dt id="matplotlib.tight_layout.get_subplotspec_list">

<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">get_subplotspec_list</code><span class="sig-paren">(</span><em>axes_list</em>, <em>grid_spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.tight_layout.get_subplotspec_list" title="Permalink to this definition">¶</a></dt>

<dd><p>Return a list of subplotspec from the given list of axes. For an

instance of axes that does not support subplotspec, None is

inserted in the list.</p>

<p>If grid_spec is given, None is inserted for those not from

the given grid_spec.</p>

<dl class="function">

<dt id="matplotlib.tight_layout.get_tight_layout_figure">

<code class="descclassname">matplotlib.tight_layout.</code><code class="descname">get_tight_layout_figure</code><span class="sig-paren">(</span><em>fig</em>, <em>axes_list</em>, <em>subplotspec_list</em>, <em>renderer</em>, <em>pad=1.08</em>, <em>h_pad=None</em>, <em>w_pad=None</em>, <em>rect=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.tight_layout.get_tight_layout_figure" title="Permalink to this definition">¶</a></dt>

<dd><p>Return subplot parameters for tight-layouted-figure with specified

padding.</p>

<p>Parameters:</p>

<div><p><em>fig</em> : figure instance</p>

<p><em>axes_list</em> : a list of axes</p>

<dl class="docutils">

<dt><em>subplotspec_list</em></dt>

<span class="classifier-delimiter">:</span> <span class="classifier">a list of subplotspec associated with each</span><dd>axes in axes_list</dd>

<p><em>renderer</em> : renderer instance</p>

<dl class="docutils">

<dt><em>pad</em></dt>

<span class="classifier-delimiter">:</span> <span class="classifier">float</span><dd>padding between the figure edge and the edges of subplots,

as a fraction of the font-size.</dd>

<dt><em>h_pad</em>, <em>w_pad</em></dt>

<span class="classifier-delimiter">:</span> <span class="classifier">float</span><dd>padding (height/width) between edges of adjacent subplots.

Defaults to <code class="xref py py-obj docutils literal"><span class="pre">pad_inches</span></code>.</dd>

<dt><em>rect</em></dt>

<span class="classifier-delimiter">:</span> <span class="classifier">if rect is given, it is interpreted as a rectangle</span><dd>(left, bottom, right, top) in the normalized figure

coordinate that the whole subplots area (including

labels) will fit into. Default is (0, 0, 1, 1).</dd>

</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 - 2014 The matplotlib development team.

Last updated on Dec 19, 2016.

Created using <a

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

</div>