<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>tight_layout — Matplotlib 1.2.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.2.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.2.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.2.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="units" href="units_api.html" />
<link rel="prev" title="ticker" href="ticker_api.html" />
</head>
<body>
<!-- Piwik -->
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
}
</script>
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
piwik_action_name = '';
piwik_idsite = 1;
piwik_url = pkBaseURL + "piwik.php";
piwik_log(piwik_action_name, piwik_idsite, piwik_url);
document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));
}
</script>
<!-- End Piwik Tag -->
<link rel="shortcut icon" href="_static/favicon.ico">
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="units_api.html" title="units"
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>| </li>
<li><a href="../search.html">search</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">tight_layout</a><ul>
<li><a class="reference internal" href="#module-matplotlib.tight_layout"><tt class="docutils literal"><span class="pre">matplotlib.tight_layout</span></tt></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="ticker_api.html"
title="previous chapter">ticker</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="units_api.html"
title="next chapter">units</a></p>
<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 id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="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"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.tight_layout</span></tt></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 and axes
titles 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">
<tt class="descclassname">matplotlib.tight_layout.</tt><tt class="descname">auto_adjust_subplotpars</tt><big>(</big><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><big>)</big><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 <tt class="docutils literal"><span class="pre">adjustable=datalim</span></tt>.</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 <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd>padding between the figure edge and the edges of subplots, as a fraction
of the font-size.</dd>
<dt>h_pad, w_pad <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd><dl class="first last docutils">
<dt>padding (height/width) between edges of adjacent subplots.</dt>
<dd>Defaults to <tt class="xref py py-obj docutils literal"><span class="pre">pad_inches</span></tt>.</dd>
</dl>
</dd>
<dt>rect</dt>
<dd>[left, bottom, right, top] in normalized (0, 1) figure coordinates.</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.tight_layout.get_renderer">
<tt class="descclassname">matplotlib.tight_layout.</tt><tt class="descname">get_renderer</tt><big>(</big><em>fig</em><big>)</big><a class="headerlink" href="#matplotlib.tight_layout.get_renderer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.tight_layout.get_subplotspec_list">
<tt class="descclassname">matplotlib.tight_layout.</tt><tt class="descname">get_subplotspec_list</tt><big>(</big><em>axes_list</em>, <em>grid_spec=None</em><big>)</big><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>
</dd></dl>
<dl class="function">
<dt id="matplotlib.tight_layout.get_tight_layout_figure">
<tt class="descclassname">matplotlib.tight_layout.</tt><tt class="descname">get_tight_layout_figure</tt><big>(</big><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><big>)</big><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>
<blockquote>
<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> <span class="classifier-delimiter">:</span> <span class="classifier">a list of subplotspec associated with each</span></dt>
<dd>axes in axes_list</dd>
</dl>
<p><em>renderer</em> : renderer instance</p>
<dl class="docutils">
<dt><em>pad</em> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<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> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd>padding (height/width) between edges of adjacent subplots.
Defaults to <tt class="xref py py-obj docutils literal"><span class="pre">pad_inches</span></tt>.</dd>
<dt><em>rect</em> <span class="classifier-delimiter">:</span> <span class="classifier">if rect is given, it is interpreted as a rectangle</span></dt>
<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>
</dl>
</div></blockquote>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="units_api.html" title="units"
>next</a> |</li>
<li class="right" >
<a href="ticker_api.html" title="ticker"
>previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../search.html">search</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" >The Matplotlib API</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the matplotlib development team.
Last updated on Jul 23, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
