iframe-proxy | Sunbelt Computer Software

899 lines (878 loc) · 97.7 KB
<!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">
    <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>API Changes &#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="Old API Changes" href="api_changes_old.html" />
    <link rel="prev" title="API Overview" href="index.html" />
<link rel="top" title="Matplotlib 3.2.2 documentation" href="#" />
    <link rel="canonical" href="https://matplotlib.org/3.4.3/api/api_changes.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="/stable/">https://matplotlib.org/stable/</a> </div>
<div id="annc-banner">
<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>
    <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>
        <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="api_changes_old.html" title="Old API Changes"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="API Overview"
             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="">API Changes</a></li> 
      </ul>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../contents.html">Table of Contents</a></h3>
<li><a class="reference internal" href="#">API Changes</a><ul>
<li><a class="reference internal" href="#api-changes-for-3-2-0">API Changes for 3.2.0</a><ul>
<li><a class="reference internal" href="#behavior-changes">Behavior changes</a><ul>
<li><a class="reference internal" href="#reduced-default-value-of-rcparams-axes-formatter-limits-default-5-6">Reduced default value of <code class="docutils literal notranslate"><span class="pre">rcParams[&quot;axes.formatter.limits&quot;]</span></code> (default: [-5, 6])</a></li>
<li><a class="reference internal" href="#matplotlib-colorbar-colorbar-uses-un-normalized-axes-for-all-mappables"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.colorbar.Colorbar</span></code> uses un-normalized axes for all mappables</a></li>
<li><a class="reference internal" href="#moviewriterregistry"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriterRegistry</span></code></a></li>
<li><a class="reference internal" href="#autoscaling">Autoscaling</a></li>
<li><a class="reference internal" href="#log-scale-bar-hist-autolimits">log-scale bar() / hist() autolimits</a></li>
<li><a class="reference internal" href="#axes-labels-spanning-multiple-rows-columns">Axes labels spanning multiple rows/columns</a></li>
<li><a class="reference internal" href="#locators">Locators</a></li>
<li><a class="reference internal" href="#nonsingular-locators">nonsingular Locators</a></li>
<li><a class="reference internal" href="#get-data-ratio"><code class="docutils literal notranslate"><span class="pre">get_data_ratio</span></code></a></li>
<li><a class="reference internal" href="#artist-sticky-edges">Artist sticky edges</a></li>
<li><a class="reference internal" href="#gid-in-svg-output"><code class="docutils literal notranslate"><span class="pre">gid</span></code> in svg output</a></li>
<li><a class="reference internal" href="#fonts">Fonts</a></li>
<li><a class="reference internal" href="#color-like-checking">Color-like checking</a></li>
<li><a class="reference internal" href="#default-image-interpolation">Default image interpolation</a></li>
<li><a class="reference internal" href="#rcparams">rcParams</a></li>
<li><a class="reference internal" href="#add-subplot"><code class="docutils literal notranslate"><span class="pre">add_subplot()</span></code></a></li>
<li><a class="reference internal" href="#indicate-inset"><code class="docutils literal notranslate"><span class="pre">indicate_inset()</span></code></a></li>
<li><a class="reference internal" href="#pgf-backend">PGF backend</a></li>
<li><a class="reference internal" href="#cbook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cbook</span></code></a></li>
<li><a class="reference internal" href="#testing">Testing</a></li>
<li><a class="reference internal" href="#backend-supports-blit">Backend <code class="docutils literal notranslate"><span class="pre">supports_blit</span></code></a></li>
<li><a class="reference internal" href="#exception-changes">Exception changes</a></li>
<li><a class="reference internal" href="#mplot3d-auto-registration">mplot3d auto-registration</a></li>
<li><a class="reference internal" href="#symlognorm-now-has-a-base-parameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SymLogNorm</span></code> now has a <em>base</em> parameter</a></li>
<li><a class="reference internal" href="#deprecations">Deprecations</a><ul>
<li><a class="reference internal" href="#matplotlib-use"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.use</span></code></a></li>
<li><a class="reference internal" href="#plotfile">plotfile</a></li>
<li><a class="reference internal" href="#axes-and-axis">axes and axis</a></li>
<li><a class="reference internal" href="#minor-argument-will-become-keyword-only"><code class="docutils literal notranslate"><span class="pre">minor</span></code> argument will become keyword-only</a></li>
<li><a class="reference internal" href="#axes-grid1"><code class="docutils literal notranslate"><span class="pre">axes_grid1</span></code></a></li>
<li><a class="reference internal" href="#axes3d">Axes3D</a></li>
<li><a class="reference internal" href="#matplotlib-cm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.cm</span></code></a></li>
<li><a class="reference internal" href="#axisartist">axisartist</a></li>
<li><a class="reference internal" href="#id1">Locators</a></li>
<li><a class="reference internal" href="#animation">Animation</a></li>
<li><a class="reference internal" href="#smart-bounds"><code class="docutils literal notranslate"><span class="pre">smart_bounds()</span></code></a></li>
<li><a class="reference internal" href="#boxplot"><code class="docutils literal notranslate"><span class="pre">boxplot()</span></code></a></li>
<li><a class="reference internal" href="#fill-between"><code class="docutils literal notranslate"><span class="pre">fill_between()</span></code></a></li>
<li><a class="reference internal" href="#tight-layout"><code class="docutils literal notranslate"><span class="pre">tight_layout()</span></code></a></li>
<li><a class="reference internal" href="#id2">rcParams</a></li>
<li><a class="reference internal" href="#dates">Dates</a></li>
<li><a class="reference internal" href="#tk">TK</a></li>
<li><a class="reference internal" href="#wx">WX</a></li>
<li><a class="reference internal" href="#pgf">PGF</a></li>
<li><a class="reference internal" href="#figurecanvas">FigureCanvas</a></li>
<li><a class="reference internal" href="#quiverkey-doc">QuiverKey doc</a></li>
<li><a class="reference internal" href="#matplotlib-mlab"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.mlab</span></code></a></li>
<li><a class="reference internal" href="#id3">Fonts</a></li>
<li><a class="reference internal" href="#colors">Colors</a></li>
<li><a class="reference internal" href="#scales">Scales</a></li>
<li><a class="reference internal" href="#id4">Testing</a></li>
<li><a class="reference internal" href="#divergingnorm-renamed-to-twoslopenorm"><code class="docutils literal notranslate"><span class="pre">DivergingNorm</span></code> renamed to <code class="docutils literal notranslate"><span class="pre">TwoSlopeNorm</span></code></a></li>
<li><a class="reference internal" href="#misc">Misc</a></li>
<li><a class="reference internal" href="#the-datapath-rcparam">The <code class="docutils literal notranslate"><span class="pre">datapath</span></code> rcParam</a></li>
<li><a class="reference internal" href="#removals">Removals</a></li>
<li><a class="reference internal" href="#development-changes">Development changes</a><ul>
<li><a class="reference internal" href="#windows-build">Windows build</a></li>
<li><a class="reference internal" href="#packaging-dlls">Packaging DLLs</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="index.html" title="previous chapter">API Overview</a></li>
      <li>Next: <a href="api_changes_old.html" title="next chapter">Old API Changes</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/api_changes.rst.txt"
     style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
        </div>
      </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <div class="section" id="api-changes">
<h1>API Changes<a class="headerlink" href="#api-changes" title="Permalink to this headline">¶</a></h1>
<p>If updating Matplotlib breaks your scripts, this list may help you figure out
what caused the breakage and how to fix it by updating your code.</p>
<p>For API changes in older versions see</p>
<div class="toctree-wrapper compound">
<li class="toctree-l1"><a class="reference internal" href="api_changes_old.html">Old API Changes</a></li>
<p>Changes for the latest version are listed below. For new features that were
added to Matplotlib, see <a class="reference internal" href="../users/whats_new.html#whats-new"><span class="std std-ref">Whats New</span></a>.</p>
<div class="section" id="api-changes-for-3-2-0">
<h2>API Changes for 3.2.0<a class="headerlink" href="#api-changes-for-3-2-0" title="Permalink to this headline">¶</a></h2>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#behavior-changes" id="id5">Behavior changes</a></li>
<li><a class="reference internal" href="#deprecations" id="id6">Deprecations</a></li>
<li><a class="reference internal" href="#removals" id="id7">Removals</a></li>
<li><a class="reference internal" href="#development-changes" id="id8">Development changes</a></li>
<div class="section" id="behavior-changes">
<h3><a class="toc-backref" href="#id5">Behavior changes</a><a class="headerlink" href="#behavior-changes" title="Permalink to this headline">¶</a></h3>
<div class="section" id="reduced-default-value-of-rcparams-axes-formatter-limits-default-5-6">
<h4>Reduced default value of <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=axes.formatter.limits#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;axes.formatter.limits&quot;]</span></a></code> (default: [-5, 6])<a class="headerlink" href="#reduced-default-value-of-rcparams-axes-formatter-limits-default-5-6" title="Permalink to this headline">¶</a></h4>
<p>Changed the default value of <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=axes.formatter.limits#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;axes.formatter.limits&quot;]</span></a></code> (default: [-5, 6]) from -7, 7 to
-5, 6 for better readability.</p>
<p>(<a class="reference external" href="../api/api_changes-1.py">Source code</a>, <a class="reference external" href="../api/api_changes-1.png">png</a>, <a class="reference external" href="../api/api_changes-1.pdf">pdf</a>)</p>
<div class="figure align-default">
<img alt="../_images/api_changes-1.png" src="../_images/api_changes-1.png" />
<div class="section" id="matplotlib-colorbar-colorbar-uses-un-normalized-axes-for-all-mappables">
<h4><a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.Colorbar" title="matplotlib.colorbar.Colorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.colorbar.Colorbar</span></code></a> uses un-normalized axes for all mappables<a class="headerlink" href="#matplotlib-colorbar-colorbar-uses-un-normalized-axes-for-all-mappables" title="Permalink to this headline">¶</a></h4>
<p>Before 3.0, <a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.Colorbar" title="matplotlib.colorbar.Colorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.colorbar.Colorbar</span></code></a> (<a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.colorbar" title="matplotlib.figure.Figure.colorbar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">colorbar</span></code></a>) normalized
all axes limits between 0 and 1 and had custom tickers to handle the
labelling of the colorbar ticks.  After 3.0, colorbars constructed from
mappables that were <em>not</em> contours were constructed with axes that had
limits between <code class="docutils literal notranslate"><span class="pre">vmin</span></code> and <code class="docutils literal notranslate"><span class="pre">vmax</span></code> of the mappable's norm, and the tickers
were made children of the normal axes tickers.</p>
<p>This version of Matplotlib extends that to mappables made by contours, and
allows the axes to run between the lowest boundary in the contour and the
highest.</p>
<p>Code that worked around the normalization between 0 and 1 will need to be
modified.</p>
<div class="section" id="moviewriterregistry">
<h4><code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriterRegistry</span></code><a class="headerlink" href="#moviewriterregistry" title="Permalink to this headline">¶</a></h4>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriterRegistry</span></code> now always checks the availability of the writer classes
before returning them.  If one wishes, for example, to get the first available
writer, without performing the availability check on subsequent writers, it is
now possible to iterate over the registry, which will yield the names of the
available classes.</p>
<div class="section" id="autoscaling">
<h4>Autoscaling<a class="headerlink" href="#autoscaling" title="Permalink to this headline">¶</a></h4>
<p>Matplotlib used to recompute autoscaled limits after every plotting
(<code class="docutils literal notranslate"><span class="pre">plot()</span></code>, <code class="docutils literal notranslate"><span class="pre">bar()</span></code>, etc.) call.  It now only does so when actually
rendering the canvas, or when the user queries the Axes limits.  This is a
major performance improvement for plots with a large number of artists.</p>
<p>In particular, this means that artists added manually with <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.add_line</span></code>,
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.add_patch</span></code>, etc. will be taken into account by the autoscale, even
without an explicit call to <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.autoscale_view</span></code>.</p>
<p>In some cases, this can result in different limits being reported.  If this is
an issue, consider triggering a draw with <code class="xref py py-obj docutils literal notranslate"><span class="pre">fig.canvas.draw</span></code>.</p>
<p>Autoscaling has also changed for artists that are based on the <a class="reference internal" href="collections_api.html#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Collection</span></code></a>
class.  Previously, the method that calculates the automatic limits
<a class="reference internal" href="collections_api.html#matplotlib.collections.Collection.get_datalim" title="matplotlib.collections.Collection.get_datalim"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Collection.get_datalim</span></code></a> tried to take into account the size of objects
in the collection and make the limits large enough to not clip any of the
object, i.e., for <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.scatter.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.scatter</span></code></a> it would make the limits large enough to not
clip any markers in the scatter.  This is problematic when the object size is
specified in physical space, or figure-relative space, because the transform
from physical units to data limits requires knowing the data limits, and
becomes invalid when the new limits are applied.  This is an inverse
problem that is theoretically solvable (if the object is physically smaller
than the axes), but the extra complexity was not deemed worth it, particularly
as the most common use case is for markers in scatter that are usually small
enough to be accommodated by the default data limit margins.</p>
<p>While the new behavior is algorithmically simpler, it is conditional on
properties of the <a class="reference internal" href="collections_api.html#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Collection</span></code></a> object:</p>
<blockquote>
<div><ol class="arabic simple">
<li><code class="docutils literal notranslate"><span class="pre">offsets</span> <span class="pre">=</span> <span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">transform</span></code> is a child of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.transData</span></code>: use the paths
for the automatic limits (i.e. for <a class="reference internal" href="collections_api.html#matplotlib.collections.LineCollection" title="matplotlib.collections.LineCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LineCollection</span></code></a> in <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.streamplot.html#matplotlib.axes.Axes.streamplot" title="matplotlib.axes.Axes.streamplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.streamplot</span></code></a>).</li>
<li><code class="docutils literal notranslate"><span class="pre">offsets</span> <span class="pre">!=</span> <span class="pre">None</span></code>, and <code class="docutils literal notranslate"><span class="pre">offset_transform</span></code> is child of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.transData</span></code>:</li>
<blockquote>
<div><ol class="loweralpha simple">
<li><dl class="first docutils">
<dt><code class="docutils literal notranslate"><span class="pre">transform</span></code> is child of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.transData</span></code>: use the <code class="docutils literal notranslate"><span class="pre">path</span> <span class="pre">+</span> <span class="pre">offset</span></code> for</dt><dd>limits (i.e., for <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.bar</span></code></a>).</dd>
<li><dl class="first docutils">
<dt><code class="docutils literal notranslate"><span class="pre">transform</span></code> is not a child of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.transData</span></code>: just use the offsets</dt><dd>for the limits (i.e. for scatter)</dd>
</div></blockquote>
<ol class="arabic simple" start="3">
<li>otherwise return a null <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a>.</li>
</div></blockquote>
<p>While this seems complicated, the logic is simply to use the information from
the object that are in data space for the limits, but not information that is
in physical units.</p>
<div class="section" id="log-scale-bar-hist-autolimits">
<h4>log-scale bar() / hist() autolimits<a class="headerlink" href="#log-scale-bar-hist-autolimits" title="Permalink to this headline">¶</a></h4>
<p>The autolimits computation in <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bar</span></code></a> and <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.hist.html#matplotlib.axes.Axes.hist" title="matplotlib.axes.Axes.hist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hist</span></code></a> when the axes
already uses log-scale has changed to match the computation when the axes is
switched to log-scale after the call to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bar</span></code></a> and <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.hist.html#matplotlib.axes.Axes.hist" title="matplotlib.axes.Axes.hist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hist</span></code></a>, and
when calling <code class="docutils literal notranslate"><span class="pre">bar(...,</span> <span class="pre">log=True)</span></code> / <code class="docutils literal notranslate"><span class="pre">hist(...,</span> <span class="pre">log=True)</span></code>: if there are
at least two different bar heights, add the normal axes margins to them (in
log-scale); if there is only a single bar height, expand the axes limits by one
order of magnitude around it and then apply axes margins.</p>
<div class="section" id="axes-labels-spanning-multiple-rows-columns">
<h4>Axes labels spanning multiple rows/columns<a class="headerlink" href="#axes-labels-spanning-multiple-rows-columns" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">Axes.label_outer</span></code> now correctly keep the x labels and tick labels visible
for Axes spanning multiple rows, as long as they cover the last row of the Axes
grid.  (This is consistent with keeping the y labels and tick labels visible
for Axes spanning multiple columns as long as they cover the first column of
the Axes grid.)</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Axes.is_last_row</span></code> and <code class="docutils literal notranslate"><span class="pre">Axes.is_last_col</span></code> methods now correctly return
True for Axes spanning multiple rows, as long as they cover the last row or
column respectively.  Again this is consistent with the behavior for axes
covering the first row or column.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Axes.rowNum</span></code> and <code class="docutils literal notranslate"><span class="pre">Axes.colNum</span></code> attributes are deprecated, as they only
refer to the first grid cell covered by the Axes.  Instead, use the new
<code class="docutils literal notranslate"><span class="pre">ax.get_subplotspec().rowspan</span></code> and <code class="docutils literal notranslate"><span class="pre">ax.get_subplotspec().colspan</span></code>
properties, which are <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#range" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">range</span></code></a> objects indicating the whole span of rows and
columns covered by the subplot.</p>
<p>(Note that all methods and attributes mentioned here actually only exist on
the <code class="docutils literal notranslate"><span class="pre">Subplot</span></code> subclass of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code>, which is used for grid-positioned Axes but
not for Axes positioned directly in absolute coordinates.)</p>
<p>The <a class="reference internal" href="_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec" title="matplotlib.gridspec.GridSpec"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GridSpec</span></code></a> class gained the <code class="docutils literal notranslate"><span class="pre">nrows</span></code> and <code class="docutils literal notranslate"><span class="pre">ncols</span></code> properties as more
explicit synonyms for the parameters returned by <code class="docutils literal notranslate"><span class="pre">GridSpec.get_geometry</span></code>.</p>
<div class="section" id="locators">
<h4>Locators<a class="headerlink" href="#locators" title="Permalink to this headline">¶</a></h4>
<p>When more than <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator.MAXTICKS" title="matplotlib.ticker.Locator.MAXTICKS"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Locator.MAXTICKS</span></code></a> ticks are generated, the behavior of
<a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator.raise_if_exceeds" title="matplotlib.ticker.Locator.raise_if_exceeds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Locator.raise_if_exceeds</span></code></a> changed from raising a RuntimeError to emitting a
log at WARNING level.</p>
<div class="section" id="nonsingular-locators">
<h4>nonsingular Locators<a class="headerlink" href="#nonsingular-locators" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">Locator.nonsingular</span></code> (introduced in mpl 3.1), <code class="docutils literal notranslate"><span class="pre">DateLocator.nonsingular</span></code>, and
<code class="docutils literal notranslate"><span class="pre">AutoDateLocator.nonsingular</span></code> now returns a range <code class="docutils literal notranslate"><span class="pre">v0,</span> <span class="pre">v1</span></code> with <code class="docutils literal notranslate"><span class="pre">v0</span> <span class="pre">&lt;=</span> <span class="pre">v1</span></code>.
This behavior is consistent with the implementation of <code class="docutils literal notranslate"><span class="pre">nonsingular</span></code> by the
<code class="docutils literal notranslate"><span class="pre">LogLocator</span></code> and <code class="docutils literal notranslate"><span class="pre">LogitLocator</span></code> subclasses.</p>
<div class="section" id="get-data-ratio">
<h4><code class="docutils literal notranslate"><span class="pre">get_data_ratio</span></code><a class="headerlink" href="#get-data-ratio" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">Axes.get_data_ratio</span></code> now takes the axes scale into account (linear, log,
logit, etc.) before computing the y-to-x ratio.  This change allows fixed
aspects to be applied to any combination of x and y scales.</p>
<div class="section" id="artist-sticky-edges">
<h4>Artist sticky edges<a class="headerlink" href="#artist-sticky-edges" title="Permalink to this headline">¶</a></h4>
<p>Previously, the <code class="docutils literal notranslate"><span class="pre">sticky_edges</span></code> attribute of artists was a list of values such
that if an axis limit coincides with a sticky edge, it would not be expanded by
the axes margins (this is the mechanism that e.g. prevents margins from being
added around images).</p>
<p><code class="docutils literal notranslate"><span class="pre">sticky_edges</span></code> now have an additional effect on margins application: even if
an axis limit did not coincide with a sticky edge, it cannot <em>cross</em> a sticky
edge through margin application -- instead, the margins will only expand the
axis limit until it bumps against the sticky edge.</p>
<p>This change improves the margins of axes displaying a <code class="xref py py-obj docutils literal notranslate"><span class="pre">streamplot</span></code>:</p>
<ul class="simple">
<li>if the streamplot goes all the way to the edges of the vector field, then the
axis limits are set to match exactly the vector field limits (whereas they
would sometimes be off by a small floating point error previously).</li>
<li>if the streamplot does not reach the edges of the vector field (e.g., due to
the use of <code class="docutils literal notranslate"><span class="pre">start_points</span></code> and <code class="docutils literal notranslate"><span class="pre">maxlength</span></code>), then margins expansion will
not cross the vector field limits anymore.</li>
<p>This change is also used internally to ensure that polar plots don't display
negative <em>r</em> values unless the user really passes in a negative value.</p>
<div class="section" id="gid-in-svg-output">
<h4><code class="docutils literal notranslate"><span class="pre">gid</span></code> in svg output<a class="headerlink" href="#gid-in-svg-output" title="Permalink to this headline">¶</a></h4>
<p>Previously, if a figure, axis, legend or some other artists had a custom
<code class="docutils literal notranslate"><span class="pre">gid</span></code> set (e.g. via <code class="docutils literal notranslate"><span class="pre">.set_gid()</span></code>), this would not be reflected in
the svg output. Instead a default gid, like <code class="docutils literal notranslate"><span class="pre">figure_1</span></code> would be shown.
This is now fixed, such that e.g. <code class="docutils literal notranslate"><span class="pre">fig.set_gid(&quot;myfigure&quot;)</span></code> correctly
shows up as <code class="docutils literal notranslate"><span class="pre">&lt;g</span> <span class="pre">id=&quot;myfigure&quot;&gt;</span></code> in the svg file. If you relied on the
gid having the default format, you now need to make sure not to set the
<code class="docutils literal notranslate"><span class="pre">gid</span></code> parameter of the artists.</p>
<div class="section" id="fonts">
<h4>Fonts<a class="headerlink" href="#fonts" title="Permalink to this headline">¶</a></h4>
<p>Font weight guessing now first checks for the presence of the FT_STYLE_BOLD_FLAG
before trying to match substrings in the font name.  In particular, this means
that Times New Roman Bold is now correctly detected as bold, not normal weight.</p>
<div class="section" id="color-like-checking">
<h4>Color-like checking<a class="headerlink" href="#color-like-checking" title="Permalink to this headline">¶</a></h4>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.color.is_colorlike()</span></code> used to return True for all string
representations of floats. However, only those with values in 0-1 are valid
colors (representing grayscale values). <code class="docutils literal notranslate"><span class="pre">is_colorlike()</span></code> now returns False
for string representations of floats outside 0-1.</p>
<div class="section" id="default-image-interpolation">
<h4>Default image interpolation<a class="headerlink" href="#default-image-interpolation" title="Permalink to this headline">¶</a></h4>
<p>Images displayed in Matplotlib previously used nearest-neighbor
interpolation, leading to aliasing effects for downscaling and non-integer
upscaling.</p>
<p>New default for <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=image.interpolation#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;image.interpolation&quot;]</span></a></code> (default: 'antialiased') is the new option &quot;antialiased&quot;.
<code class="xref py py-obj docutils literal notranslate"><span class="pre">imshow(A,</span> <span class="pre">interpolation='antialiased')</span></code> will apply a Hanning filter when
resampling the data in A for display (or saving to file) <em>if</em> the upsample
rate is less than a factor of three, and not an integer; downsampled data is
always smoothed at resampling.</p>
<p>To get the old behavior, set <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=image.interpolation#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;image.interpolation&quot;]</span></a></code> (default: 'antialiased') to the old default &quot;nearest&quot;
(or specify the <code class="docutils literal notranslate"><span class="pre">interpolation</span></code> kwarg of <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.imshow.html#matplotlib.axes.Axes.imshow" title="matplotlib.axes.Axes.imshow"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.imshow</span></code></a>)</p>
<p>To always get the anti-aliasing behavior, no matter what the up/down sample
rate, set <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=image.interpolation#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;image.interpolation&quot;]</span></a></code> (default: 'antialiased') to &quot;hanning&quot; (or one of the other filters
available).</p>
<p>Note that the &quot;hanning&quot; filter was chosen because it has only a modest
performance penalty.  Anti-aliasing can be improved with other filters.</p>
<div class="section" id="rcparams">
<h4>rcParams<a class="headerlink" href="#rcparams" title="Permalink to this headline">¶</a></h4>
<p>When using <code class="xref py py-obj docutils literal notranslate"><span class="pre">RendererSVG</span></code> with <code class="docutils literal notranslate"><span class="pre">rcParams[&quot;svg.image_inline&quot;]</span> <span class="pre">==</span>
<span class="pre">True</span></code>, externally written images now use a single counter even if the
<code class="docutils literal notranslate"><span class="pre">renderer.basename</span></code> attribute is overwritten, rather than a counter per
basename.</p>
<p>This change will only affect you if you used <code class="docutils literal notranslate"><span class="pre">rcParams[&quot;svg.image_inline&quot;]</span> <span class="pre">=</span> <span class="pre">True</span></code>
(the default is False) <em>and</em> manually modified <code class="docutils literal notranslate"><span class="pre">renderer.basename</span></code>.</p>
<p>Changed the default value of <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=axes.formatter.limits#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;axes.formatter.limits&quot;]</span></a></code> (default: [-5, 6]) from -7, 7 to -5, 6
for better readability.</p>
<div class="section" id="add-subplot">
<h4><code class="docutils literal notranslate"><span class="pre">add_subplot()</span></code><a class="headerlink" href="#add-subplot" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.add_subplot" title="matplotlib.figure.Figure.add_subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.add_subplot()</span></code></a> and <a class="reference internal" href="_as_gen/matplotlib.pyplot.subplot.html#matplotlib.pyplot.subplot" title="matplotlib.pyplot.subplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplot()</span></code></a> do not accept a <code class="xref py py-obj docutils literal notranslate"><span class="pre">figure</span></code>
keyword argument anymore. It only used to work anyway if the passed figure
was <code class="docutils literal notranslate"><span class="pre">self</span></code> or the current figure, respectively.</p>
<div class="section" id="indicate-inset">
<h4><code class="docutils literal notranslate"><span class="pre">indicate_inset()</span></code><a class="headerlink" href="#indicate-inset" title="Permalink to this headline">¶</a></h4>
<p>In &lt;= 3.1.0, <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.indicate_inset.html#matplotlib.axes.Axes.indicate_inset" title="matplotlib.axes.Axes.indicate_inset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">indicate_inset</span></code></a> and
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.indicate_inset_zoom.html#matplotlib.axes.Axes.indicate_inset_zoom" title="matplotlib.axes.Axes.indicate_inset_zoom"><code class="xref py py-obj docutils literal notranslate"><span class="pre">indicate_inset_zoom</span></code></a> were documented as returning
a 4-tuple of <a class="reference internal" href="_as_gen/matplotlib.patches.ConnectionPatch.html#matplotlib.patches.ConnectionPatch" title="matplotlib.patches.ConnectionPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ConnectionPatch</span></code></a>, where in fact they
returned a 4-length list.</p>
<p>They now correctly return a 4-tuple.
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.indicate_inset.html#matplotlib.axes.Axes.indicate_inset" title="matplotlib.axes.Axes.indicate_inset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">indicate_inset</span></code></a> would previously raise an error if
the optional <em>inset_ax</em> was not supplied; it now completes successfully,
and returns <em>None</em> instead of the tuple of <code class="docutils literal notranslate"><span class="pre">ConnectionPatch</span></code>.</p>
<div class="section" id="pgf-backend">
<h4>PGF backend<a class="headerlink" href="#pgf-backend" title="Permalink to this headline">¶</a></h4>
<p>The pgf backend's get_canvas_width_height now returns the canvas size in
display units rather than in inches, which it previously did.
The new behavior is the correct one given the uses of <code class="docutils literal notranslate"><span class="pre">get_canvas_width_height</span></code>
in the rest of the codebase.</p>
<p>The pgf backend now includes images using <code class="docutils literal notranslate"><span class="pre">\includegraphics</span></code> instead of
<code class="docutils literal notranslate"><span class="pre">\pgfimage</span></code> if the version of <code class="docutils literal notranslate"><span class="pre">graphicx</span></code> is recent enough to support the
<code class="docutils literal notranslate"><span class="pre">interpolate</span></code> option (this is detected automatically).</p>
<div class="section" id="cbook">
<h4><a class="reference internal" href="cbook_api.html#module-matplotlib.cbook" title="matplotlib.cbook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cbook</span></code></a><a class="headerlink" href="#cbook" title="Permalink to this headline">¶</a></h4>
<p>The default value of the &quot;obj_type&quot; parameter to <code class="docutils literal notranslate"><span class="pre">cbook.warn_deprecated</span></code> has
been changed from &quot;attribute&quot; (a default that was never used internally) to the
empty string.</p>
<div class="section" id="testing">
<h4>Testing<a class="headerlink" href="#testing" title="Permalink to this headline">¶</a></h4>
<p>The test suite no longer turns on the Python fault handler by default.
Set the standard <code class="docutils literal notranslate"><span class="pre">PYTHONFAULTHANDLER</span></code> environment variable to do so.</p>
<div class="section" id="backend-supports-blit">
<h4>Backend <code class="docutils literal notranslate"><span class="pre">supports_blit</span></code><a class="headerlink" href="#backend-supports-blit" title="Permalink to this headline">¶</a></h4>
<p>Backends do not need to explicitly define the flag <code class="docutils literal notranslate"><span class="pre">supports_blit</span></code> anymore.
This is only relevant for backend developers. Backends had to define the flag
<code class="docutils literal notranslate"><span class="pre">supports_blit</span></code>. This is not needed anymore because the blitting capability
is now automatically detected.</p>
<div class="section" id="exception-changes">
<h4>Exception changes<a class="headerlink" href="#exception-changes" title="Permalink to this headline">¶</a></h4>
<p>Various APIs that raised a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a> for incorrectly typed inputs now raise
<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TypeError</span></code></a> instead: <code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_bases.GraphicsContextBase.set_clip_path</span></code>,
<code class="xref py py-obj docutils literal notranslate"><span class="pre">blocking_input.BlockingInput.__call__</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">cm.register_cmap</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">dviread.DviFont</span></code>,
<code class="xref py py-obj docutils literal notranslate"><span class="pre">rcsetup.validate_hatch</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">rcsetup.validate_animation_writer_path</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">spines.Spine</span></code>,
many classes in the <a class="reference internal" href="transformations.html#module-matplotlib.transforms" title="matplotlib.transforms"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.transforms</span></code></a> module and <a class="reference internal" href="tri_api.html#module-matplotlib.tri" title="matplotlib.tri"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.tri</span></code></a>
package, and Axes methods that take a <code class="docutils literal notranslate"><span class="pre">norm</span></code> parameter.</p>
<p>If extra kwargs are passed to <a class="reference internal" href="scale_api.html#matplotlib.scale.LogScale" title="matplotlib.scale.LogScale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LogScale</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TypeError</span></code></a> will now be
raised instead of <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a>.</p>
<div class="section" id="mplot3d-auto-registration">
<h4>mplot3d auto-registration<a class="headerlink" href="#mplot3d-auto-registration" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="toolkits/mplot3d.html#module-mpl_toolkits.mplot3d" title="mpl_toolkits.mplot3d"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d</span></code></a> is always registered by default now. It is no
longer necessary to import mplot3d to create 3d axes with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">,</span> <span class="n">projection</span><span class="o">=</span><span class="s2">&quot;3d&quot;</span><span class="p">)</span>
</pre></div>
<div class="section" id="symlognorm-now-has-a-base-parameter">
<h4><a class="reference internal" href="_as_gen/matplotlib.colors.SymLogNorm.html#matplotlib.colors.SymLogNorm" title="matplotlib.colors.SymLogNorm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SymLogNorm</span></code></a> now has a <em>base</em> parameter<a class="headerlink" href="#symlognorm-now-has-a-base-parameter" title="Permalink to this headline">¶</a></h4>
<p>Previously, <a class="reference internal" href="_as_gen/matplotlib.colors.SymLogNorm.html#matplotlib.colors.SymLogNorm" title="matplotlib.colors.SymLogNorm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SymLogNorm</span></code></a> had no <em>base</em> keyword argument and the base was
hard-coded to <code class="docutils literal notranslate"><span class="pre">base=np.e</span></code>. This was inconsistent with the default behavior of
<a class="reference internal" href="scale_api.html#matplotlib.scale.SymmetricalLogScale" title="matplotlib.scale.SymmetricalLogScale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SymmetricalLogScale</span></code></a> (which defaults to <code class="docutils literal notranslate"><span class="pre">base=10</span></code>) and the use of the word
&quot;decade&quot; in the documentation.</p>
<p>In preparation for changing the default base to 10, calling <a class="reference internal" href="_as_gen/matplotlib.colors.SymLogNorm.html#matplotlib.colors.SymLogNorm" title="matplotlib.colors.SymLogNorm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SymLogNorm</span></code></a>
without the new <em>base</em> keyword argument emits a deprecation warning.</p>
<div class="section" id="deprecations">
<h3><a class="toc-backref" href="#id6">Deprecations</a><a class="headerlink" href="#deprecations" title="Permalink to this headline">¶</a></h3>
<div class="section" id="matplotlib-use">
<h4><a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.use" title="matplotlib.use"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.use</span></code></a><a class="headerlink" href="#matplotlib-use" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">warn</span></code> parameter to <a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.use" title="matplotlib.use"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.use()</span></code></a> is deprecated (catch the
<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ImportError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ImportError</span></code></a> emitted on backend switch failure and reemit a warning yourself
if so desired).</p>
<div class="section" id="plotfile">
<h4>plotfile<a class="headerlink" href="#plotfile" title="Permalink to this headline">¶</a></h4>
<p><a class="reference internal" href="_as_gen/matplotlib.pyplot.plotfile.html#matplotlib.pyplot.plotfile" title="matplotlib.pyplot.plotfile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.plotfile</span></code></a> is deprecated in favor of separately loading and plotting
the data.  See <a class="reference internal" href="../gallery/misc/plotfile_demo_sgskip.html"><span class="doc">Plotting data from a file</span></a> for various ways to
use pandas or NumPy to load data, and pandas or matplotlib to plot the
resulting data.</p>
<div class="section" id="axes-and-axis">
<h4>axes and axis<a class="headerlink" href="#axes-and-axis" title="Permalink to this headline">¶</a></h4>
<p>Setting <code class="docutils literal notranslate"><span class="pre">Axis.major.locator</span></code>, <code class="docutils literal notranslate"><span class="pre">Axis.minor.locator</span></code>, <code class="docutils literal notranslate"><span class="pre">Axis.major.formatter</span></code>
or <code class="docutils literal notranslate"><span class="pre">Axis.minor.formatter</span></code> to an object that is not a subclass of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Locator</span></code> or
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Formatter</span></code> (respectively) is deprecated.  Note that these attributes should
usually be set using <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.set_major_locator</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis.set_minor_locator</span></code>, etc.
which already raise an exception when an object of the wrong class is passed.</p>
<p>Passing more than one positional argument or unsupported keyword arguments to
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.axis.html#matplotlib.axes.Axes.axis" title="matplotlib.axes.Axes.axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axis()</span></code></a> is deprecated (such arguments used to be
silently ignored).</p>
<div class="section" id="minor-argument-will-become-keyword-only">
<h4><code class="docutils literal notranslate"><span class="pre">minor</span></code> argument will become keyword-only<a class="headerlink" href="#minor-argument-will-become-keyword-only" title="Permalink to this headline">¶</a></h4>
<p>Using the parameter <code class="docutils literal notranslate"><span class="pre">minor</span></code> to <code class="docutils literal notranslate"><span class="pre">get_*ticks()</span></code> / <code class="docutils literal notranslate"><span class="pre">set_*ticks()</span></code> as a
positional parameter is deprecated. It will become keyword-only in future
versions.</p>
<div class="section" id="axes-grid1">
<h4><code class="docutils literal notranslate"><span class="pre">axes_grid1</span></code><a class="headerlink" href="#axes-grid1" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid1.colorbar</span></code> module and its colorbar implementation
are deprecated in favor of <a class="reference internal" href="colorbar_api.html#module-matplotlib.colorbar" title="matplotlib.colorbar"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.colorbar</span></code></a>, as the former is
essentially abandoned and the latter is a more featureful replacement with a
nearly compatible API (for example, the following additional keywords are
supported: <code class="docutils literal notranslate"><span class="pre">panchor</span></code>, <code class="docutils literal notranslate"><span class="pre">extendfrac</span></code>, <code class="docutils literal notranslate"><span class="pre">extendrect</span></code>).</p>
<p>The main differences are:</p>
<ul class="simple">
<li>Setting the ticks on the colorbar is done by calling <code class="docutils literal notranslate"><span class="pre">colorbar.set_ticks</span></code>
rather than <code class="docutils literal notranslate"><span class="pre">colorbar.cbar_axis.set_xticks</span></code> or
<code class="docutils literal notranslate"><span class="pre">colorbar.cbar_axis.set_yticks</span></code>; the <code class="docutils literal notranslate"><span class="pre">locator</span></code> parameter to <code class="docutils literal notranslate"><span class="pre">colorbar()</span></code>
is deprecated in favor of its synonym <code class="docutils literal notranslate"><span class="pre">ticks</span></code> (which already existed
previously, and is consistent with <a class="reference internal" href="colorbar_api.html#module-matplotlib.colorbar" title="matplotlib.colorbar"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.colorbar</span></code></a>).</li>
<li>The colorbar's long axis is accessed with <code class="docutils literal notranslate"><span class="pre">colorbar.xaxis</span></code> or
<code class="docutils literal notranslate"><span class="pre">colorbar.yaxis</span></code> depending on the orientation, rather than
<code class="docutils literal notranslate"><span class="pre">colorbar.cbar_axis</span></code>.</li>
<li>The default ticker is no longer <code class="docutils literal notranslate"><span class="pre">MaxNLocator(5)</span></code>, but a
<code class="docutils literal notranslate"><span class="pre">_ColorbarAutoLocator</span></code>.</li>
<li>Overdrawing multiple colorbars on top of one another in a single Axes (e.g.
when using the <code class="docutils literal notranslate"><span class="pre">cax</span></code> attribute of <a class="reference internal" href="_as_gen/mpl_toolkits.axes_grid1.axes_grid.ImageGrid.html#mpl_toolkits.axes_grid1.axes_grid.ImageGrid" title="mpl_toolkits.axes_grid1.axes_grid.ImageGrid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ImageGrid</span></code></a>
elements) is not supported; if you previously relied on the second colorbar
being drawn over the first, you can call <code class="docutils literal notranslate"><span class="pre">cax.cla()</span></code> to clear the axes
before drawing the second colorbar.</li>
<p>During the deprecation period, the <code class="docutils literal notranslate"><span class="pre">mpl_toolkits.legacy_colorbar</span></code>
rcParam can be set to True to use <code class="docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid1.colorbar</span></code> in
<a class="reference internal" href="toolkits/axes_grid1.html#module-mpl_toolkits.axes_grid1" title="mpl_toolkits.axes_grid1"><code class="xref py py-mod docutils literal notranslate"><span class="pre">mpl_toolkits.axes_grid1</span></code></a> code with a deprecation warning (the default),
or to False to use <code class="docutils literal notranslate"><span class="pre">matplotlib.colorbar</span></code>.</p>
<p>Passing a <code class="docutils literal notranslate"><span class="pre">pad</span></code> size of <code class="docutils literal notranslate"><span class="pre">None</span></code> (the default) as a synonym for zero to
the <code class="docutils literal notranslate"><span class="pre">append_axes</span></code>, <code class="docutils literal notranslate"><span class="pre">new_horizontal</span></code> and <code class="docutils literal notranslate"><span class="pre">new_vertical</span></code> methods of
<a class="reference internal" href="_as_gen/mpl_toolkits.axes_grid1.axes_divider.AxesDivider.html#mpl_toolkits.axes_grid1.axes_divider.AxesDivider" title="mpl_toolkits.axes_grid1.axes_divider.AxesDivider"><code class="xref py py-obj docutils literal notranslate"><span class="pre">axes_grid1.axes_divider.AxesDivider</span></code></a> is deprecated.  In a future release, the
default value of <code class="docutils literal notranslate"><span class="pre">None</span></code> will mean &quot;use <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=figure.subplot.wspace#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;figure.subplot.wspace&quot;]</span></a></code> (default: 0.2) or
<code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=figure.subplot.hspace#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;figure.subplot.hspace&quot;]</span></a></code> (default: 0.2)&quot; (depending on the orientation).  Explicitly pass
<code class="docutils literal notranslate"><span class="pre">pad=0</span></code> to keep the old behavior.</p>
<div class="section" id="axes3d">
<h4>Axes3D<a class="headerlink" href="#axes3d" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">mplot3d.axis3d.get_flip_min_max</span></code> is deprecated.</p>
<p><code class="docutils literal notranslate"><span class="pre">axes3d.unit_bbox</span></code> is deprecated (use <code class="docutils literal notranslate"><span class="pre">Bbox.unit</span></code> instead).</p>
<p><code class="docutils literal notranslate"><span class="pre">axes3d.Axes3D.w_xaxis</span></code>, <code class="docutils literal notranslate"><span class="pre">.w_yaxis</span></code>, and <code class="docutils literal notranslate"><span class="pre">.w_zaxis</span></code> are deprecated (use
<code class="docutils literal notranslate"><span class="pre">.xaxis</span></code>, <code class="docutils literal notranslate"><span class="pre">.yaxis</span></code>, and <code class="docutils literal notranslate"><span class="pre">.zaxis</span></code> instead).</p>
<div class="section" id="matplotlib-cm">
<h4><a class="reference internal" href="cm_api.html#module-matplotlib.cm" title="matplotlib.cm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.cm</span></code></a><a class="headerlink" href="#matplotlib-cm" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">cm.revcmap</span></code> is deprecated.  Use <a class="reference internal" href="_as_gen/matplotlib.colors.Colormap.html#matplotlib.colors.Colormap.reversed" title="matplotlib.colors.Colormap.reversed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Colormap.reversed</span></code></a> to reverse a colormap.</p>
<p><code class="docutils literal notranslate"><span class="pre">cm.datad</span></code> no longer contains entries for reversed colormaps in their
&quot;unconverted&quot; form.</p>
<div class="section" id="axisartist">
<h4>axisartist<a class="headerlink" href="#axisartist" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">mpl_toolkits.axisartist.grid_finder.GridFinderBase</span></code> is deprecated (its
only use is to be inherited by the <code class="xref py py-obj docutils literal notranslate"><span class="pre">GridFinder</span></code> class which just provides
more defaults in the constructor and directly sets the transforms, so
<code class="docutils literal notranslate"><span class="pre">GridFinderBase</span></code>'s methods were just moved to <code class="xref py py-obj docutils literal notranslate"><span class="pre">GridFinder</span></code>).</p>
<p><code class="docutils literal notranslate"><span class="pre">axisartist.axis_artist.BezierPath</span></code> is deprecated (use <a class="reference internal" href="_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">patches.PathPatch</span></code></a>
to draw arbitrary Paths).</p>
<p><code class="docutils literal notranslate"><span class="pre">AxisArtist.line</span></code> is now a <a class="reference internal" href="_as_gen/matplotlib.patches.PathPatch.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">patches.PathPatch</span></code></a> instance instead of a
<code class="docutils literal notranslate"><span class="pre">BezierPath</span></code> instance.</p>
<p>Returning a factor equal to None from axisartist Locators (which are <strong>not</strong>
the same as &quot;standard&quot; tick Locators), or passing a factor equal to None
to axisartist Formatters (which are <strong>not</strong> the same as &quot;standard&quot; tick
Formatters) is deprecated.  Pass a factor equal to 1 instead.</p>
<p>For the <a class="reference internal" href="_as_gen/mpl_toolkits.axisartist.axis_artist.AttributeCopier.html#mpl_toolkits.axisartist.axis_artist.AttributeCopier" title="mpl_toolkits.axisartist.axis_artist.AttributeCopier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">mpl_toolkits.axisartist.axis_artist.AttributeCopier</span></code></a> class, the
constructor and the <code class="docutils literal notranslate"><span class="pre">set_ref_artist</span></code> method, and the <em>default_value</em>
parameter of <code class="docutils literal notranslate"><span class="pre">get_attribute_from_ref_artist</span></code>, are deprecated.</p>
<p>Deprecation of the constructor means that classes inheriting from
<a class="reference internal" href="_as_gen/mpl_toolkits.axisartist.axis_artist.AttributeCopier.html#mpl_toolkits.axisartist.axis_artist.AttributeCopier" title="mpl_toolkits.axisartist.axis_artist.AttributeCopier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AttributeCopier</span></code></a> should no longer call its constructor.</p>
<div class="section" id="id1">
<h4>Locators<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
<p>The unused <code class="xref py py-obj docutils literal notranslate"><span class="pre">Locator.autoscale()</span></code> method is deprecated (pass the axis limits to
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Locator.view_limits()</span></code> instead).</p>
<div class="section" id="animation">
<h4>Animation<a class="headerlink" href="#animation" title="Permalink to this headline">¶</a></h4>
<p>The following methods and attributes of the <code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriterRegistry</span></code> class are
deprecated: <code class="docutils literal notranslate"><span class="pre">set_dirty</span></code>, <code class="docutils literal notranslate"><span class="pre">ensure_not_dirty</span></code>, <code class="docutils literal notranslate"><span class="pre">reset_available_writers</span></code>,
<code class="docutils literal notranslate"><span class="pre">avail</span></code>.</p>
<div class="section" id="smart-bounds">
<h4><code class="docutils literal notranslate"><span class="pre">smart_bounds()</span></code><a class="headerlink" href="#smart-bounds" title="Permalink to this headline">¶</a></h4>
<p>The &quot;smart_bounds&quot; functionality is deprecated.  This includes
<code class="docutils literal notranslate"><span class="pre">Axis.set_smart_bounds()</span></code>, <code class="docutils literal notranslate"><span class="pre">Axis.get_smart_bounds()</span></code>,
<code class="docutils literal notranslate"><span class="pre">Spine.set_smart_bounds()</span></code>, and <code class="docutils literal notranslate"><span class="pre">Spine.get_smart_bounds()</span></code>.</p>
<div class="section" id="boxplot">
<h4><code class="docutils literal notranslate"><span class="pre">boxplot()</span></code><a class="headerlink" href="#boxplot" title="Permalink to this headline">¶</a></h4>
<p>Setting the <code class="docutils literal notranslate"><span class="pre">whis</span></code> parameter of <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.boxplot.html#matplotlib.axes.Axes.boxplot" title="matplotlib.axes.Axes.boxplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.boxplot</span></code></a> and <a class="reference internal" href="cbook_api.html#matplotlib.cbook.boxplot_stats" title="matplotlib.cbook.boxplot_stats"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cbook.boxplot_stats</span></code></a> to
&quot;range&quot; to mean &quot;the whole data range&quot; is deprecated; set it to (0, 100) (which
gets interpreted as percentiles) to achieve the same effect.</p>
<div class="section" id="fill-between">
<h4><code class="docutils literal notranslate"><span class="pre">fill_between()</span></code><a class="headerlink" href="#fill-between" title="Permalink to this headline">¶</a></h4>
<p>Passing scalars to parameter <em>where</em> in <code class="docutils literal notranslate"><span class="pre">fill_between()</span></code> and
<code class="docutils literal notranslate"><span class="pre">fill_betweenx()</span></code> is deprecated. While the documentation already states that
<em>where</em> must be of the same size as <em>x</em> (or <em>y</em>), scalars were accepted and
broadcasted to the size of <em>x</em>. Non-matching sizes will raise a <code class="docutils literal notranslate"><span class="pre">ValueError</span></code>
in the future.</p>
<div class="section" id="tight-layout">
<h4><code class="docutils literal notranslate"><span class="pre">tight_layout()</span></code><a class="headerlink" href="#tight-layout" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">renderer</span></code> parameter to <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.tight_layout" title="matplotlib.figure.Figure.tight_layout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.tight_layout</span></code></a> is deprecated; this method
now always uses the renderer instance cached on the <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>.</p>
<div class="section" id="id2">
<h4>rcParams<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">rcsetup.validate_animation_writer_path</span></code> function is deprecated.</p>
<p>Setting <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=savefig.format#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;savefig.format&quot;]</span></a></code> (default: 'png') to &quot;auto&quot; is deprecated; use its synonym &quot;png&quot; instead.</p>
<p>Setting <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=text.hinting#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;text.hinting&quot;]</span></a></code> (default: 'auto') to True or False is deprecated; use their synonyms
&quot;auto&quot; or &quot;none&quot; instead.</p>
<p><code class="docutils literal notranslate"><span class="pre">rcsetup.update_savefig_format</span></code> is deprecated.</p>
<p><code class="docutils literal notranslate"><span class="pre">rcsetup.validate_path_exists</span></code> is deprecated (use <code class="docutils literal notranslate"><span class="pre">os.path.exists</span></code> to check
whether a path exists).</p>
<p><code class="docutils literal notranslate"><span class="pre">rcsetup.ValidateInterval</span></code> is deprecated.</p>
<div class="section" id="dates">
<h4>Dates<a class="headerlink" href="#dates" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">dates.mx2num</span></code> is deprecated.</p>
<div class="section" id="tk">
<h4>TK<a class="headerlink" href="#tk" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">NavigationToolbar2Tk.set_active</span></code> is deprecated, as it has no (observable)
effect.</p>
<div class="section" id="wx">
<h4>WX<a class="headerlink" href="#wx" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">FigureFrameWx.statusbar</span></code> and <code class="docutils literal notranslate"><span class="pre">NavigationToolbar2Wx.statbar</span></code> are deprecated.
The status bar can be retrieved by calling standard wx methods
(<code class="docutils literal notranslate"><span class="pre">frame.GetStatusBar()</span></code> and <code class="docutils literal notranslate"><span class="pre">toolbar.GetTopLevelParent().GetStatusBar()</span></code>).</p>
<p><code class="docutils literal notranslate"><span class="pre">backend_wx.ConfigureSubplotsWx.configure_subplots</span></code> and
<code class="docutils literal notranslate"><span class="pre">backend_wx.ConfigureSubplotsWx.get_canvas</span></code> are deprecated.</p>
<div class="section" id="pgf">
<h4>PGF<a class="headerlink" href="#pgf" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">backend_pgf.repl_escapetext</span></code> and <code class="docutils literal notranslate"><span class="pre">backend_pgf.repl_mathdefault</span></code> are
deprecated.</p>
<p><code class="docutils literal notranslate"><span class="pre">RendererPgf.latexManager</span></code> is deprecated.</p>
<div class="section" id="figurecanvas">
<h4>FigureCanvas<a class="headerlink" href="#figurecanvas" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">FigureCanvasBase.draw_cursor</span></code> (which has never done anything and has never
been overridden in any backend) is deprecated.</p>
<p><code class="docutils literal notranslate"><span class="pre">FigureCanvasMac.invalidate</span></code> is deprecated in favor of its synonym,
<code class="docutils literal notranslate"><span class="pre">FigureCanvasMac.draw_idle</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">dryrun</span></code> parameter to the various <code class="docutils literal notranslate"><span class="pre">FigureCanvasFoo.print_foo</span></code> methods
is deprecated.</p>
<div class="section" id="quiverkey-doc">
<h4>QuiverKey doc<a class="headerlink" href="#quiverkey-doc" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">quiver.QuiverKey.quiverkey_doc</span></code> is deprecated; use
<code class="docutils literal notranslate"><span class="pre">quiver.QuiverKey.__init__.__doc__</span></code> instead.</p>
<div class="section" id="matplotlib-mlab">
<h4><a class="reference internal" href="mlab_api.html#module-matplotlib.mlab" title="matplotlib.mlab"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.mlab</span></code></a><a class="headerlink" href="#matplotlib-mlab" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">mlab.apply_window</span></code> and <code class="docutils literal notranslate"><span class="pre">mlab.stride_repeat</span></code> are deprecated.</p>
<div class="section" id="id3">
<h4>Fonts<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">font_manager.JSONEncoder</span></code> is deprecated.  Use <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.json_dump" title="matplotlib.font_manager.json_dump"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.json_dump</span></code></a> to
dump a <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontManager" title="matplotlib.font_manager.FontManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontManager</span></code></a> instance.</p>
<p><code class="docutils literal notranslate"><span class="pre">font_manager.createFontList</span></code> is deprecated.  <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontManager.addfont" title="matplotlib.font_manager.FontManager.addfont"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontManager.addfont</span></code></a>
is now available to register a font at a given path.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">as_str</span></code>, <code class="docutils literal notranslate"><span class="pre">as_rgba_str</span></code>, <code class="docutils literal notranslate"><span class="pre">as_array</span></code>, <code class="docutils literal notranslate"><span class="pre">get_width</span></code> and <code class="docutils literal notranslate"><span class="pre">get_height</span></code>
methods of <code class="docutils literal notranslate"><span class="pre">matplotlib.ft2font.FT2Image</span></code> are deprecated.  Convert the <code class="docutils literal notranslate"><span class="pre">FT2Image</span></code>
to a NumPy array with <code class="docutils literal notranslate"><span class="pre">np.asarray</span></code> before processing it.</p>
<div class="section" id="colors">
<h4>Colors<a class="headerlink" href="#colors" title="Permalink to this headline">¶</a></h4>
<p>The function <a class="reference internal" href="_as_gen/matplotlib.colors.makeMappingArray.html#matplotlib.colors.makeMappingArray" title="matplotlib.colors.makeMappingArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.colors.makeMappingArray</span></code></a> is not considered part of
the public API any longer. Thus, it's deprecated.</p>
<p>Using a string of single-character colors as a color sequence (e.g. &quot;rgb&quot;) is
deprecated. Use an explicit list instead.</p>
<div class="section" id="scales">
<h4>Scales<a class="headerlink" href="#scales" title="Permalink to this headline">¶</a></h4>
<p>Passing unsupported keyword arguments to <a class="reference internal" href="scale_api.html#matplotlib.scale.ScaleBase" title="matplotlib.scale.ScaleBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ScaleBase</span></code></a>, and its subclasses
<a class="reference internal" href="scale_api.html#matplotlib.scale.LinearScale" title="matplotlib.scale.LinearScale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LinearScale</span></code></a> and <a class="reference internal" href="scale_api.html#matplotlib.scale.SymmetricalLogScale" title="matplotlib.scale.SymmetricalLogScale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SymmetricalLogScale</span></code></a>, is deprecated and will raise a
<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TypeError</span></code></a> in 3.3.</p>
<p>If extra keyword arguments are passed to <a class="reference internal" href="scale_api.html#matplotlib.scale.LogScale" title="matplotlib.scale.LogScale"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LogScale</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TypeError</span></code></a> will now be
raised instead of <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ValueError</span></code></a>.</p>
<div class="section" id="id4">
<h4>Testing<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">matplotlib.testing.disable_internet</span></code> module is deprecated.  Use (for
example) <a class="reference external" href="https://pypi.org/project/pytest-remotedata/">pytest-remotedata</a> instead.</p>
<p>Support in <a class="reference internal" href="testing_api.html#module-matplotlib.testing" title="matplotlib.testing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></a> for nose-based tests is deprecated (a
deprecation is emitted if using e.g. the decorators from that module while
both 1) matplotlib's conftests have not been called and 2) nose is in
<code class="docutils literal notranslate"><span class="pre">sys.modules</span></code>).</p>
<p><code class="docutils literal notranslate"><span class="pre">testing.is_called_from_pytest</span></code> is deprecated.</p>
<p>During the deprecation period, to force the generation of nose base tests,
import nose first.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">switch_backend_warn</span></code> parameter to <code class="docutils literal notranslate"><span class="pre">matplotlib.test</span></code> has no effect and
is deprecated.</p>
<p><code class="docutils literal notranslate"><span class="pre">testing.jpl_units.UnitDbl.UnitDbl.checkUnits</span></code> is deprecated.</p>
<div class="section" id="divergingnorm-renamed-to-twoslopenorm">
<h4><code class="docutils literal notranslate"><span class="pre">DivergingNorm</span></code> renamed to <code class="docutils literal notranslate"><span class="pre">TwoSlopeNorm</span></code><a class="headerlink" href="#divergingnorm-renamed-to-twoslopenorm" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">DivergingNorm</span></code> was a misleading name; although the norm was
developed with the idea that it would likely be used with diverging
colormaps, the word 'diverging' does not describe or evoke the norm's
mapping function.  Since that function is monotonic, continuous, and
piece-wise linear with two segments, the norm has been renamed to
<a class="reference internal" href="_as_gen/matplotlib.colors.TwoSlopeNorm.html#matplotlib.colors.TwoSlopeNorm" title="matplotlib.colors.TwoSlopeNorm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TwoSlopeNorm</span></code></a></p>
<div class="section" id="misc">
<h4>Misc<a class="headerlink" href="#misc" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">matplotlib.get_home</span></code> is deprecated (use e.g. <code class="docutils literal notranslate"><span class="pre">os.path.expanduser(&quot;~&quot;)</span></code>)
instead.</p>
<p><code class="docutils literal notranslate"><span class="pre">matplotlib.compare_versions</span></code> is deprecated (use comparison of
<code class="docutils literal notranslate"><span class="pre">distutils.version.LooseVersion</span></code>s instead).</p>
<p><code class="docutils literal notranslate"><span class="pre">matplotlib.checkdep_ps_distiller</span></code> is deprecated.</p>
<p><code class="docutils literal notranslate"><span class="pre">matplotlib.figure.AxesStack</span></code> is considered private API and will be removed
from the public API in future versions.</p>
<p><code class="docutils literal notranslate"><span class="pre">BboxBase.is_unit</span></code> is deprecated (check the Bbox extents if needed).</p>
<p><code class="docutils literal notranslate"><span class="pre">Affine2DBase.matrix_from_values(...)</span></code> is deprecated.  Use (for example)
<code class="docutils literal notranslate"><span class="pre">Affine2D.from_values(...).get_matrix()</span></code> instead.</p>
<p><code class="docutils literal notranslate"><span class="pre">style.core.is_style_file</span></code> and <code class="docutils literal notranslate"><span class="pre">style.core.iter_style_files</span></code>
are deprecated.</p>
<div class="section" id="the-datapath-rcparam">
<h4>The <code class="docutils literal notranslate"><span class="pre">datapath</span></code> rcParam<a class="headerlink" href="#the-datapath-rcparam" title="Permalink to this headline">¶</a></h4>
<p>Use <a class="reference internal" href="matplotlib_configuration_api.html#matplotlib.get_data_path" title="matplotlib.get_data_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_data_path</span></code></a> instead.  (The rcParam is deprecated because it cannot be
meaningfully set by an end user.)  The rcParam had no effect from 3.2.0, but
was deprecated only in 3.2.1.  In 3.2.1+ if <code class="docutils literal notranslate"><span class="pre">'datapath'</span></code> is set in a
<code class="docutils literal notranslate"><span class="pre">matplotlibrc</span></code> file it will be respected, but this behavior will be removed in 3.3.</p>
<div class="section" id="removals">
<h3><a class="toc-backref" href="#id7">Removals</a><a class="headerlink" href="#removals" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">matplotlib.testing.determinism</span></code> module, which exposes no public API, has
been deleted.</p>
<p>The following API elements have been removed:</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">backend_gtk3.PIXELS_PER_INCH</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">backend_pgf.re_escapetext</span></code>, <code class="docutils literal notranslate"><span class="pre">backend_pgf.re_mathdefault</span></code>.</li>
<li>the <code class="docutils literal notranslate"><span class="pre">matplotlib.backends.tkagg</span></code>, <code class="docutils literal notranslate"><span class="pre">matplotlib.backends.windowing</span></code>,
<code class="docutils literal notranslate"><span class="pre">matplotlib.backends.wx_compat</span></code>, and <code class="docutils literal notranslate"><span class="pre">matplotlib.compat.subprocess</span></code>
modules</li>
<li><code class="docutils literal notranslate"><span class="pre">RcParams.msg_depr</span></code>, <code class="docutils literal notranslate"><span class="pre">RcParams.msg_depr_ignore</span></code>,
<code class="docutils literal notranslate"><span class="pre">RcParams.msg_depr_set</span></code>, <code class="docutils literal notranslate"><span class="pre">RcParams.msg_obsolete</span></code>,
<code class="docutils literal notranslate"><span class="pre">RcParams.msg_backend_obsolete</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">afm.parse_afm</span></code> (use <code class="docutils literal notranslate"><span class="pre">afm.AFM</span> <span class="pre">instead</span></code>)</li>
<li><code class="docutils literal notranslate"><span class="pre">axes.Axes.mouseover_set</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">backend_cairo.ArrayWrapper</span></code>, <code class="docutils literal notranslate"><span class="pre">backend_cairo.RendererCairo.convert_path</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">backend_gtk3.FileChooserDialog.sorted_filetypes</span></code> (use
<code class="docutils literal notranslate"><span class="pre">sorted(self.filetypes.items())</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">backend_pgf.get_texcommand</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">backend_pdf.PdfFile.texFontMap</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">backend_ps.get_bbox</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">backend_qt.FigureCanvasQt.keyAutoRepeat</span></code> (use
<code class="docutils literal notranslate"><span class="pre">event.guiEvent.isAutoRepeat</span></code> instead), <code class="docutils literal notranslate"><span class="pre">backend_qt.error_msg_qt</span></code>,
<code class="docutils literal notranslate"><span class="pre">backend_qt.exception_handler</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">backend_wx.FigureCanvasWx.macros</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">backends.pylab_setup</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">cbook.Bunch</span></code> (use <code class="docutils literal notranslate"><span class="pre">types.SimpleNamespace</span></code> instead), <code class="docutils literal notranslate"><span class="pre">cbook.Locked</span></code>,
<code class="docutils literal notranslate"><span class="pre">cbook.unicode_safe</span></code>, <code class="docutils literal notranslate"><span class="pre">cbook.is_numlike</span></code> (use
<code class="docutils literal notranslate"><span class="pre">isinstance(...,</span> <span class="pre">numbers.Number)</span></code> instead), <code class="docutils literal notranslate"><span class="pre">cbook.mkdirs</span></code> (use
<code class="docutils literal notranslate"><span class="pre">os.makedirs(...,</span> <span class="pre">exist_ok=True)</span></code> instead), <code class="docutils literal notranslate"><span class="pre">cbook.GetRealpathAndStat</span></code>
(use <code class="docutils literal notranslate"><span class="pre">cbook.get_realpath_and_stat</span></code> instead),
<code class="docutils literal notranslate"><span class="pre">cbook.listFiles</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">container.Container.set_remove_method</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">contour.ContourLabeler.cl</span></code>, <code class="docutils literal notranslate"><span class="pre">contour.ContourLabeler.cl_xy</span></code>,
<code class="docutils literal notranslate"><span class="pre">contour.ContourLabeler.cl_cvalues</span></code> (use <code class="docutils literal notranslate"><span class="pre">labelTexts</span></code>, <code class="docutils literal notranslate"><span class="pre">labelXYs</span></code>,
<code class="docutils literal notranslate"><span class="pre">labelCValues</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">dates.DateFormatter.strftime</span></code>, <code class="docutils literal notranslate"><span class="pre">dates.DateFormatter.strftime_pre_1900</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">font_manager.TempCache</span></code>, <code class="docutils literal notranslate"><span class="pre">font_manager.FontManager.ttffiles</span></code>,
<code class="docutils literal notranslate"><span class="pre">font_manager.FontManager.afmfiles</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">mathtext.unichr_safe</span></code> (use <code class="docutils literal notranslate"><span class="pre">chr</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">patches.YAArrow</span></code> (use <code class="docutils literal notranslate"><span class="pre">patches.FancyArrowPatch</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">sphinxext.plot_directive.remove_coding</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">table.Table.get_child_artists</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">testing.compare.compare_float</span></code>, <code class="docutils literal notranslate"><span class="pre">testing.decorators.CleanupTest</span></code>,
<code class="docutils literal notranslate"><span class="pre">testing.decorators.ImageComparisonTest</span></code>,
<code class="docutils literal notranslate"><span class="pre">testing.decorators.skip_if_command_unavailable</span></code>,
support for nose-based tests</li>
<li><code class="docutils literal notranslate"><span class="pre">text.Annotation.arrow</span></code> (use <code class="docutils literal notranslate"><span class="pre">text.Annotation.arrow_patch</span></code> instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">textpath.TextToPath.tex_font_map</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">ticker.Base</span></code>, <code class="docutils literal notranslate"><span class="pre">ticker.closeto</span></code>, <code class="docutils literal notranslate"><span class="pre">ticker.nearest_long</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">axes_grid1.axes_divider.LocatableAxesBase</span></code>,
<code class="docutils literal notranslate"><span class="pre">axes_grid1.axes_divider.locatable_axes_factory</span></code>,
<code class="docutils literal notranslate"><span class="pre">axes_grid1.axes_divider.Axes</span></code> (use <code class="docutils literal notranslate"><span class="pre">axes_grid1.mpl_axes.Axes</span></code> instead),
<code class="docutils literal notranslate"><span class="pre">axes_grid1.axes_divider.LocatableAxes</span></code> (use <code class="docutils literal notranslate"><span class="pre">axes_grid1.mpl_axes.Axes</span></code>
instead)</li>
<li><code class="docutils literal notranslate"><span class="pre">axisartist.axes_divider.Axes</span></code>, <code class="docutils literal notranslate"><span class="pre">axisartist.axes_divider.LocatableAxes</span></code>
(use <code class="docutils literal notranslate"><span class="pre">axisartist.axislines.Axes</span></code> instead)</li>
<li>the <code class="docutils literal notranslate"><span class="pre">normed</span></code> kwarg to <code class="docutils literal notranslate"><span class="pre">hist</span></code> (use <code class="docutils literal notranslate"><span class="pre">density</span></code> instead)</li>
<li>the <code class="docutils literal notranslate"><span class="pre">verts</span></code> parameter to <code class="docutils literal notranslate"><span class="pre">scatter</span></code> (use <code class="docutils literal notranslate"><span class="pre">marker</span></code> instead)</li>
<li>passing <code class="docutils literal notranslate"><span class="pre">(verts,</span> <span class="pre">0)</span></code> or <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">3)</span></code> when specifying a marker to specify a
path or a circle, respectively (instead, use <code class="docutils literal notranslate"><span class="pre">verts</span></code> or <code class="docutils literal notranslate"><span class="pre">&quot;o&quot;</span></code>,
respectively)</li>
<li><code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=examples.directory#a-sample-matplotlibrc-file"><span class="pre">rcParams[&quot;examples.directory&quot;]</span></a></code></li>
<p>The following members of <code class="docutils literal notranslate"><span class="pre">matplotlib.backends.backend_pdf.PdfFile</span></code> were removed:</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">nextObject</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">nextFont</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">nextAlphaState</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">nextHatch</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">nextImage</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">alphaStateObject</span></code></li>
<p>The <code class="docutils literal notranslate"><span class="pre">required_interactive_framework</span></code> attribute of backend modules introduced
in Matplotlib 3.0 has been moved to the <code class="docutils literal notranslate"><span class="pre">FigureCanvas</span></code> class, in order to
let it be inherited by third-party canvas subclasses and to make it easier to
know what interactive framework is required by a canvas class.</p>
<p><code class="docutils literal notranslate"><span class="pre">backend_qt4.FigureCanvasQT5</span></code>, which is an alias for
<code class="docutils literal notranslate"><span class="pre">backend_qt5.FigureCanvasQT</span></code> (but only exists under that name in
<code class="docutils literal notranslate"><span class="pre">backend_qt4</span></code>), has been removed.</p>
<div class="section" id="development-changes">
<h3><a class="toc-backref" href="#id8">Development changes</a><a class="headerlink" href="#development-changes" title="Permalink to this headline">¶</a></h3>
<div class="section" id="windows-build">
<h4>Windows build<a class="headerlink" href="#windows-build" title="Permalink to this headline">¶</a></h4>
<p>Previously, when building the <code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib._png</span></code> extension, the build
script would add &quot;png&quot; and &quot;z&quot; to the extensions <code class="docutils literal notranslate"><span class="pre">.libraries</span></code> attribute (if
pkg-config information is not available, which is in particular the case on
Windows).</p>
<p>In particular, this implies that the Windows build would look up files named
<code class="docutils literal notranslate"><span class="pre">png.lib</span></code> and <code class="docutils literal notranslate"><span class="pre">z.lib</span></code>; but neither libpng upstream nor zlib upstream
provides these files by default.  (On Linux, this would look up <code class="docutils literal notranslate"><span class="pre">libpng.so</span></code>
and <code class="docutils literal notranslate"><span class="pre">libz.so</span></code>, which are indeed standard names.)</p>
<p>Instead, on Windows, we now look up <code class="docutils literal notranslate"><span class="pre">libpng16.lib</span></code> and <code class="docutils literal notranslate"><span class="pre">zlib.lib</span></code>, which
<em>are</em> the upstream names for the shared libraries (as of libpng 1.6.x).</p>
<p>For a statically-linked build, the upstream names are <code class="docutils literal notranslate"><span class="pre">libpng16_static.lib</span></code>
and <code class="docutils literal notranslate"><span class="pre">zlibstatic.lib</span></code>; one still needs to manually rename them if such a build
is desired.</p>
<div class="section" id="packaging-dlls">
<h4>Packaging DLLs<a class="headerlink" href="#packaging-dlls" title="Permalink to this headline">¶</a></h4>
<p>Previously, it was possible to package Windows DLLs into the Maptlotlib
wheel (or sdist) by copying them into the source tree and setting the
<code class="docutils literal notranslate"><span class="pre">package_data.dlls</span></code> entry in <code class="docutils literal notranslate"><span class="pre">setup.cfg</span></code>.</p>
<p>DLLs copied in the source tree are now always packaged; the
<code class="docutils literal notranslate"><span class="pre">package_data.dlls</span></code> entry has no effect anymore.  If you do not want to
include the DLLs, don't copy them into the source tree.</p>
          </div>
        </div>
      </div>
      <div class="clearer"></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.
    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.
Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

api_changes.html

Latest commit

History

api_changes.html

File metadata and controls
