<!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>mpl_toolkits.axes_grid.axes_divider — Matplotlib v1.1.1 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.1.1',
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 v1.1.1 documentation"
href="../../../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib v1.1.1 documentation" href="../../../index.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><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>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/mpl_toolkits/axes_grid/api/axes_divider_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" size="18" />
<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="mpl-toolkits-axes-grid-axes-divider">
<h1><tt class="xref py py-mod docutils literal"><span class="pre">mpl_toolkits.axes_grid.axes_divider</span></tt><a class="headerlink" href="#mpl-toolkits-axes-grid-axes-divider" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider">
<em class="property">class </em><tt class="descclassname">mpl_toolkits.axes_grid.axes_divider.</tt><tt class="descname">Divider</tt><big>(</big><em>fig</em>, <em>pos</em>, <em>horizontal</em>, <em>vertical</em>, <em>aspect=None</em>, <em>anchor='C'</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the class that is used calculates the axes position. It
divides the given rectangular area into several
sub-rectangles. You initialize the divider by setting the
horizontal and vertical lists of sizes
(<a class="reference internal" href="axes_size_api.html#module-mpl_toolkits.axes_grid.axes_size" title="mpl_toolkits.axes_grid.axes_size"><tt class="xref py py-mod docutils literal"><span class="pre">mpl_toolkits.axes_grid.axes_size</span></tt></a>) that the division will
be based on. You then use the new_locator method to create a
callable object that can be used to as the axes_locator of the
axes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>fig</strong> – matplotlib figure</li>
<li><strong>pos</strong> – position (tuple of 4 floats) of the rectangle that
will be divided.</li>
<li><strong>horizontal</strong> – list of sizes
(<a class="reference internal" href="axes_size_api.html#module-mpl_toolkits.axes_grid.axes_size" title="mpl_toolkits.axes_grid.axes_size"><tt class="xref py py-mod docutils literal"><span class="pre">axes_size</span></tt></a>)
for horizontal division</li>
<li><strong>vertical</strong> – list of sizes
(<a class="reference internal" href="axes_size_api.html#module-mpl_toolkits.axes_grid.axes_size" title="mpl_toolkits.axes_grid.axes_size"><tt class="xref py py-mod docutils literal"><span class="pre">axes_size</span></tt></a>)
for vertical division</li>
<li><strong>aspect</strong> – if True, the overall rectangular area is reduced
so that the relative part of the horizontal and
vertical scales have same scale.</li>
<li><strong>anchor</strong> – Determine how the reduced rectangle is placed
when aspect is True.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.add_auto_adjustable_area">
<tt class="descname">add_auto_adjustable_area</tt><big>(</big><em>use_axes, pad=0.10000000000000001, adjust_dirs=['left', 'right', 'bottom', 'top']</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.add_auto_adjustable_area" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.append_size">
<tt class="descname">append_size</tt><big>(</big><em>position</em>, <em>size</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.append_size" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_anchor">
<tt class="descname">get_anchor</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_anchor" title="Permalink to this definition">¶</a></dt>
<dd><p>return the anchor</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_aspect">
<tt class="descname">get_aspect</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_aspect" title="Permalink to this definition">¶</a></dt>
<dd><p>return aspect</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_horizontal">
<tt class="descname">get_horizontal</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_horizontal" title="Permalink to this definition">¶</a></dt>
<dd><p>return horizontal sizes</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_horizontal_sizes">
<tt class="descname">get_horizontal_sizes</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_horizontal_sizes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_locator">
<tt class="descname">get_locator</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_locator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_position">
<tt class="descname">get_position</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_position" title="Permalink to this definition">¶</a></dt>
<dd><p>return the position of the rectangle.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_position_runtime">
<tt class="descname">get_position_runtime</tt><big>(</big><em>ax</em>, <em>renderer</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_position_runtime" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_vertical">
<tt class="descname">get_vertical</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_vertical" title="Permalink to this definition">¶</a></dt>
<dd><p>return vertical sizes</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_vertical_sizes">
<tt class="descname">get_vertical_sizes</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_vertical_sizes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.get_vsize_hsize">
<tt class="descname">get_vsize_hsize</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.get_vsize_hsize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.locate">
<tt class="descname">locate</tt><big>(</big><em>nx</em>, <em>ny</em>, <em>nx1=None</em>, <em>ny1=None</em>, <em>axes=None</em>, <em>renderer=None</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.locate" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>nx1</strong> (<em>nx,</em>) – Integers specifying the column-position of the
cell. When nx1 is None, a single nx-th column is
specified. Otherwise location of columns spanning between nx
to nx1 (but excluding nx1-th column) is specified.</li>
<li><strong>ny1</strong> (<em>ny,</em>) – same as nx and nx1, but for row positions.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.new_locator">
<tt class="descname">new_locator</tt><big>(</big><em>nx</em>, <em>ny</em>, <em>nx1=None</em>, <em>ny1=None</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.new_locator" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a new locator
(<a class="reference internal" href="#mpl_toolkits.axes_grid.axes_divider.AxesLocator" title="mpl_toolkits.axes_grid.axes_divider.AxesLocator"><tt class="xref py py-class docutils literal"><span class="pre">mpl_toolkits.axes_grid.axes_divider.AxesLocator</span></tt></a>) for
specified cell.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>nx1</strong> (<em>nx,</em>) – Integers specifying the column-position of the
cell. When nx1 is None, a single nx-th column is
specified. Otherwise location of columns spanning between nx
to nx1 (but excluding nx1-th column) is specified.</li>
<li><strong>ny1</strong> (<em>ny,</em>) – same as nx and nx1, but for row positions.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.set_anchor">
<tt class="descname">set_anchor</tt><big>(</big><em>anchor</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.set_anchor" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>anchor</strong> – <p>anchor position</p>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="71%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">value</th>
<th class="head">description</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>‘C’</td>
<td>Center</td>
</tr>
<tr><td>‘SW’</td>
<td>bottom left</td>
</tr>
<tr><td>‘S’</td>
<td>bottom</td>
</tr>
<tr><td>‘SE’</td>
<td>bottom right</td>
</tr>
<tr><td>‘E’</td>
<td>right</td>
</tr>
<tr><td>‘NE’</td>
<td>top right</td>
</tr>
<tr><td>‘N’</td>
<td>top</td>
</tr>
<tr><td>‘NW’</td>
<td>top left</td>
</tr>
<tr><td>‘W’</td>
<td>left</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.set_aspect">
<tt class="descname">set_aspect</tt><big>(</big><em>aspect=False</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.set_aspect" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>anchor</strong> – True or False</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.set_horizontal">
<tt class="descname">set_horizontal</tt><big>(</big><em>h</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.set_horizontal" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>horizontal</strong> – list of sizes
(<a class="reference internal" href="axes_size_api.html#module-mpl_toolkits.axes_grid.axes_size" title="mpl_toolkits.axes_grid.axes_size"><tt class="xref py py-mod docutils literal"><span class="pre">axes_size</span></tt></a>)
for horizontal division</td>
</tr>
</tbody>
</table>
<p>.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.set_locator">
<tt class="descname">set_locator</tt><big>(</big><em>_locator</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.set_locator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.set_position">
<tt class="descname">set_position</tt><big>(</big><em>pos</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.set_position" title="Permalink to this definition">¶</a></dt>
<dd><p>set the position of the rectangle.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pos</strong> – position (tuple of 4 floats) of the rectangle that
will be divided.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.Divider.set_vertical">
<tt class="descname">set_vertical</tt><big>(</big><em>v</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.Divider.set_vertical" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>horizontal</strong> – list of sizes
(<a class="reference internal" href="axes_size_api.html#module-mpl_toolkits.axes_grid.axes_size" title="mpl_toolkits.axes_grid.axes_size"><tt class="xref py py-mod docutils literal"><span class="pre">axes_size</span></tt></a>)
for horizontal division</td>
</tr>
</tbody>
</table>
<p>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="mpl_toolkits.axes_grid.axes_divider.AxesLocator">
<em class="property">class </em><tt class="descclassname">mpl_toolkits.axes_grid.axes_divider.</tt><tt class="descname">AxesLocator</tt><big>(</big><em>axes_divider</em>, <em>nx</em>, <em>ny</em>, <em>nx1=None</em>, <em>ny1=None</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.AxesLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>A simple callable object, initialized with AxesDivider class,
returns the position and size of the given cell.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>axes_divider</strong> – An instance of AxesDivider class.</li>
<li><strong>nx1</strong> (<em>nx,</em>) – Integers specifying the column-position of the
cell. When nx1 is None, a single nx-th column is
specified. Otherwise location of columns spanning between nx
to nx1 (but excluding nx1-th column) is is specified.</li>
<li><strong>ny1</strong> (<em>ny,</em>) – same as nx and nx1, but for row positions.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.AxesLocator.get_subplotspec">
<tt class="descname">get_subplotspec</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.AxesLocator.get_subplotspec" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="mpl_toolkits.axes_grid.axes_divider.SubplotDivider">
<em class="property">class </em><tt class="descclassname">mpl_toolkits.axes_grid.axes_divider.</tt><tt class="descname">SubplotDivider</tt><big>(</big><em>fig</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.SubplotDivider" title="Permalink to this definition">¶</a></dt>
<dd><p>The Divider class whose rectangle area is specified as a subplot geometry.</p>
<p><em>fig</em> is a <a class="reference internal" href="../../../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></tt></a> instance.</p>
<p><em>args</em> is the tuple (<em>numRows</em>, <em>numCols</em>, <em>plotNum</em>), where
the array of subplots in the figure has dimensions <em>numRows</em>,
<em>numCols</em>, and where <em>plotNum</em> is the number of the subplot
being created. <em>plotNum</em> starts at 1 in the upper left
corner and increases to the right.</p>
<p>If <em>numRows</em> <= <em>numCols</em> <= <em>plotNum</em> < 10, <em>args</em> can be the
decimal integer <em>numRows</em> * 100 + <em>numCols</em> * 10 + <em>plotNum</em>.</p>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.SubplotDivider.change_geometry">
<tt class="descname">change_geometry</tt><big>(</big><em>numrows</em>, <em>numcols</em>, <em>num</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.SubplotDivider.change_geometry" title="Permalink to this definition">¶</a></dt>
<dd><p>change subplot geometry, eg. from 1,1,1 to 2,2,3</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.SubplotDivider.get_geometry">
<tt class="descname">get_geometry</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.SubplotDivider.get_geometry" title="Permalink to this definition">¶</a></dt>
<dd><p>get the subplot geometry, eg 2,2,3</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.SubplotDivider.get_position">
<tt class="descname">get_position</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.SubplotDivider.get_position" title="Permalink to this definition">¶</a></dt>
<dd><p>return the bounds of the subplot box</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.SubplotDivider.get_subplotspec">
<tt class="descname">get_subplotspec</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.SubplotDivider.get_subplotspec" title="Permalink to this definition">¶</a></dt>
<dd><p>get the SubplotSpec instance</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.SubplotDivider.set_subplotspec">
<tt class="descname">set_subplotspec</tt><big>(</big><em>subplotspec</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.SubplotDivider.set_subplotspec" title="Permalink to this definition">¶</a></dt>
<dd><p>set the SubplotSpec instance</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.SubplotDivider.update_params">
<tt class="descname">update_params</tt><big>(</big><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.SubplotDivider.update_params" title="Permalink to this definition">¶</a></dt>
<dd><p>update the subplot position from fig.subplotpars</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="mpl_toolkits.axes_grid.axes_divider.AxesDivider">
<em class="property">class </em><tt class="descclassname">mpl_toolkits.axes_grid.axes_divider.</tt><tt class="descname">AxesDivider</tt><big>(</big><em>axes</em>, <em>xref=None</em>, <em>yref=None</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.AxesDivider" title="Permalink to this definition">¶</a></dt>
<dd><p>Divider based on the pre-existing axes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>axes</strong> – axes</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.AxesDivider.append_axes">
<tt class="descname">append_axes</tt><big>(</big><em>position</em>, <em>size</em>, <em>pad=None</em>, <em>add_to_figure=True</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.AxesDivider.append_axes" title="Permalink to this definition">¶</a></dt>
<dd><p>create an axes at the given <em>position</em> with the same height
(or width) of the main axes.</p>
<blockquote>
<div><dl class="docutils">
<dt><em>position</em></dt>
<dd>[“left”|”right”|”bottom”|”top”]</dd>
</dl>
<p><em>size</em> and <em>pad</em> should be axes_grid.axes_size compatible.</p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.AxesDivider.new_horizontal">
<tt class="descname">new_horizontal</tt><big>(</big><em>size</em>, <em>pad=None</em>, <em>pack_start=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.AxesDivider.new_horizontal" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new axes on the right (or left) side of the main axes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>size</strong> – A width of the axes. A <a class="reference internal" href="axes_size_api.html#module-mpl_toolkits.axes_grid.axes_size" title="mpl_toolkits.axes_grid.axes_size"><tt class="xref py py-mod docutils literal"><span class="pre">axes_size</span></tt></a>
instance or if float or string is given, <em>from_any</em>
function is used to create one, with <em>ref_size</em> set to AxesX instance
of the current axes.</li>
<li><strong>pad</strong> – pad between the axes. It takes same argument as <em>size</em>.</li>
<li><strong>pack_start</strong> – If False, the new axes is appended at the end
of the list, i.e., it became the right-most axes. If True, it is
inserted at the start of the list, and becomes the left-most axes.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>All extra keywords arguments are passed to the created axes.
If <em>axes_class</em> is given, the new axes will be created as an
instance of the given class. Otherwise, the same class of the
main axes will be used.</p>
</dd></dl>
<dl class="method">
<dt id="mpl_toolkits.axes_grid.axes_divider.AxesDivider.new_vertical">
<tt class="descname">new_vertical</tt><big>(</big><em>size</em>, <em>pad=None</em>, <em>pack_start=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#mpl_toolkits.axes_grid.axes_divider.AxesDivider.new_vertical" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new axes on the top (or bottom) side of the main axes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>size</strong> – A height of the axes. A <a class="reference internal" href="axes_size_api.html#module-mpl_toolkits.axes_grid.axes_size" title="mpl_toolkits.axes_grid.axes_size"><tt class="xref py py-mod docutils literal"><span class="pre">axes_size</span></tt></a>
instance or if float or string is given, <em>from_any</em>
function is used to create one, with <em>ref_size</em> set to AxesX instance
of the current axes.</li>
<li><strong>pad</strong> – pad between the axes. It takes same argument as <em>size</em>.</li>
<li><strong>pack_start</strong> – If False, the new axes is appended at the end
of the list, i.e., it became the top-most axes. If True, it is
inserted at the start of the list, and becomes the bottom-most axes.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>All extra keywords arguments are passed to the created axes.
If <em>axes_class</em> is given, the new axes will be created as an
instance of the given class. Otherwise, the same class of the
main axes will be used.</p>
</dd></dl>
</dd></dl>
</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><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>
</ul>
</div>
<div class="footer">
© Copyright 2008, John Hunter, Darren Dale, Michael Droettboom.
Last updated on Oct 04, 2012.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
a44f8c7e78ee9c5838c1fb080c9e7630
>
files
>
3982
