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

<head>

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

<title>The Matplotlib API &mdash; Matplotlib 1.3.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.3.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 1.3.1 documentation"

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

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

<link rel="next" title="Plotting commands summary" href="pyplot_summary.html" />

<link rel="prev" title="mplot3d FAQ" href="../mpl_toolkits/mplot3d/faq.html" />

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

<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 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'));

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

<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.png" 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="pyplot_summary.html" title="Plotting commands summary"

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

<li class="right" >

<a href="../mpl_toolkits/mplot3d/faq.html" title="mplot3d FAQ"

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>

</ul>

</div>

<div class="sphinxsidebar">

<div class="sphinxsidebarwrapper">

<h4>Previous topic</h4>

<p class="topless"><a href="../mpl_toolkits/mplot3d/faq.html"

title="previous chapter">mplot3d FAQ</a></p>

<h4>Next topic</h4>

<p class="topless"><a href="pyplot_summary.html"

title="next chapter">Plotting commands summary</a></p>

<h3>This Page</h3>

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

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

<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="the-matplotlib-api">

<span id="api-index"></span><h1>The Matplotlib API<a class="headerlink" href="#the-matplotlib-api" title="Permalink to this headline">¶</a></h1>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Release:</th><td class="field-body">1.3.1</td>

<tr class="field-even field"><th class="field-name">Date:</th><td class="field-body">October 10, 2013</td>

<div class="toctree-wrapper compound">

<li class="toctree-l1"><a class="reference internal" href="pyplot_summary.html">Plotting commands summary</a></li>

<li class="toctree-l1"><a class="reference internal" href="api_changes.html">API Changes</a></li>

<li class="toctree-l1"><a class="reference internal" href="matplotlib_configuration_api.html">The top level <tt class="docutils literal"><span class="pre">matplotlib</span></tt> module</a></li>

<li class="toctree-l1"><a class="reference internal" href="afm_api.html">afm (Adobe Font Metrics interface)</a></li>

<li class="toctree-l1"><a class="reference internal" href="animation_api.html">animation</a></li>

<li class="toctree-l1"><a class="reference internal" href="artist_api.html">artists</a></li>

<li class="toctree-l1"><a class="reference internal" href="axes_api.html">axes</a></li>

<li class="toctree-l1"><a class="reference internal" href="axis_api.html">axis</a></li>

<li class="toctree-l1"><a class="reference internal" href="index_backend_api.html">backends</a></li>

<li class="toctree-l1"><a class="reference internal" href="cbook_api.html">cbook</a></li>

<li class="toctree-l1"><a class="reference internal" href="cm_api.html">cm (colormap)</a></li>

<li class="toctree-l1"><a class="reference internal" href="collections_api.html">collections</a></li>

<li class="toctree-l1"><a class="reference internal" href="colorbar_api.html">colorbar</a></li>

<li class="toctree-l1"><a class="reference internal" href="colors_api.html">colors</a></li>

<li class="toctree-l1"><a class="reference internal" href="dates_api.html">dates</a></li>

<li class="toctree-l1"><a class="reference internal" href="figure_api.html">figure</a></li>

<li class="toctree-l1"><a class="reference internal" href="font_manager_api.html">font_manager</a></li>

<li class="toctree-l1"><a class="reference internal" href="gridspec_api.html">gridspec</a></li>

<li class="toctree-l1"><a class="reference internal" href="legend_api.html">legend</a></li>

<li class="toctree-l1"><a class="reference internal" href="markers_api.html">Markers</a></li>

<li class="toctree-l1"><a class="reference internal" href="mathtext_api.html">mathtext</a></li>

<li class="toctree-l1"><a class="reference internal" href="mlab_api.html">mlab</a></li>

<li class="toctree-l1"><a class="reference internal" href="path_api.html">path</a></li>

<li class="toctree-l1"><a class="reference internal" href="pyplot_api.html">pyplot</a></li>

<li class="toctree-l1"><a class="reference internal" href="sankey_api.html">sankey</a></li>

<li class="toctree-l1"><a class="reference internal" href="spines_api.html">spines</a></li>

<li class="toctree-l1"><a class="reference internal" href="ticker_api.html">ticker</a></li>

<li class="toctree-l1"><a class="reference internal" href="tight_layout_api.html">tight_layout</a></li>

<li class="toctree-l1"><a class="reference internal" href="tri_api.html">triangular grids</a></li>

<li class="toctree-l1"><a class="reference internal" href="units_api.html">units</a></li>

<li class="toctree-l1"><a class="reference internal" href="widgets_api.html">widgets</a></li>

</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="pyplot_summary.html" title="Plotting commands summary"

>next</a> |</li>

<li class="right" >

<a href="../mpl_toolkits/mplot3d/faq.html" title="mplot3d FAQ"

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

</ul>

</div>

<div class="footer">

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

Last updated on Oct 10, 2013.

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b2.

</div>

</body>