matplotlib.github.com/1.5.3/api/ticker_api.html at main · matplotlib/matplotlib.github.com

939 lines (822 loc) · 64.3 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="Content-Type" content="text/html; charset=utf-8" />
    <title>ticker &mdash; Matplotlib 1.5.3 documentation</title>
    <link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.5.3',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Matplotlib 1.5.3 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
    <link rel="top" title="Matplotlib 1.5.3 documentation" href="../index.html" />
    <link rel="up" title="The Matplotlib API" href="index.html" />
    <link rel="next" title="tight_layout" href="tight_layout_api.html" />
    <link rel="prev" title="text" href="text_api.html" /> 
    <link rel="canonical" href="https://matplotlib.org/stable/api/ticker_api.html" />
    <script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<div id="unreleased-message"> You are reading an old version of the documentation (v1.5.3).  For the latest version see <a href="https://matplotlib.org/stable/api/ticker_api.html">https://matplotlib.org/stable/api/ticker_api.html</a></div>
    <div class="alert" style="background-color: #FEA46C; padding: 10px 0;
<h2>Matplotlib 2.0.0rc2 is available</h2>
<p><a href="../style_changes.html"
style="font-weight: bold;
color: #11557C;">Install the release candidate now!</a></p>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
    <area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
    <div class="related">
      <h3>Navigation</h3>
        <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="tight_layout_api.html" title="tight_layout"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="text_api.html" title="text"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">home</a>|&nbsp;</li>
        <li><a href="../examples/index.html">examples</a>|&nbsp;</li>
        <li><a href="../gallery.html">gallery</a>|&nbsp;</li>
        <li><a href="pyplot_summary.html">pyplot</a>|&nbsp;</li>
        <li><a href="../contents.html">docs</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">The Matplotlib API</a> &raquo;</li> 
      </ul>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
<a href="http://depsy.org/package/python/matplotlib">
  <img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
  <img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
  <h3><a href="../contents.html">Table Of Contents</a></h3>
<li><a class="reference internal" href="#">ticker</a><ul>
<li><a class="reference internal" href="#module-matplotlib.ticker"><code class="docutils literal"><span class="pre">matplotlib.ticker</span></code></a><ul>
<li><a class="reference internal" href="#tick-locating-and-formatting">Tick locating and formatting</a><ul>
<li><a class="reference internal" href="#default-formatter">Default Formatter</a></li>
<li><a class="reference internal" href="#tick-locating">Tick locating</a></li>
<li><a class="reference internal" href="#tick-formatting">Tick formatting</a></li>
<div class="relations">
<h3>Related Topics</h3>
  <li><a href="../contents.html">Documentation overview</a><ul>
  <li><a href="index.html">The Matplotlib API</a><ul>
      <li>Previous: <a href="text_api.html" title="previous chapter">text</a></li>
      <li>Next: <a href="tight_layout_api.html" title="next chapter">tight_layout</a></li>
  </ul></li>
  </ul></li>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/api/ticker_api.txt"
            rel="nofollow">Show Source</a></li>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
  <div class="section" id="ticker">
<h1>ticker<a class="headerlink" href="#ticker" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.ticker">
<span id="matplotlib-ticker"></span><h2><a class="reference internal" href="#module-matplotlib.ticker" title="matplotlib.ticker"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.ticker</span></code></a><a class="headerlink" href="#module-matplotlib.ticker" title="Permalink to this headline">¶</a></h2>
<div class="section" id="tick-locating-and-formatting">
<h3>Tick locating and formatting<a class="headerlink" href="#tick-locating-and-formatting" title="Permalink to this headline">¶</a></h3>
<p>This module contains classes to support completely configurable tick locating
and formatting.  Although the locators know nothing about major or minor
ticks, they are used by the Axis class to support major and minor tick
locating and formatting.  Generic tick locators and formatters are provided,
as well as domain specific custom ones..</p>
<div class="section" id="default-formatter">
<h4>Default Formatter<a class="headerlink" href="#default-formatter" title="Permalink to this headline">¶</a></h4>
<p>The default formatter identifies when the x-data being
plotted is a small range on top of a large off set.  To
reduce the chances that the ticklabels overlap the ticks
are labeled as deltas from a fixed offset.  For example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">2000</span><span class="p">,</span> <span class="mi">2010</span><span class="p">),</span> <span class="nb">range</span><span class="p">(</span><span class="mi">10</span><span class="p">))</span>
</pre></div>
<p>will have tick of 0-9 with an offset of +2e3.  If this
is not desired turn off the use of the offset on the default
formatter:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">get_xaxis</span><span class="p">()</span><span class="o">.</span><span class="n">get_major_formatter</span><span class="p">()</span><span class="o">.</span><span class="n">set_useOffset</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
<p>set the rcParam <code class="docutils literal"><span class="pre">axes.formatter.useoffset=False</span></code> to turn it off
globally, or set a different formatter.</p>
<div class="section" id="tick-locating">
<h4>Tick locating<a class="headerlink" href="#tick-locating" title="Permalink to this headline">¶</a></h4>
<p>The Locator class is the base class for all tick locators.  The locators
handle autoscaling of the view limits based on the data limits, and the
choosing of tick locations.  A useful semi-automatic tick locator is
MultipleLocator.  You initialize this with a base, e.g., 10, and it picks axis
limits and ticks that are multiples of your base.</p>
<p>The Locator subclasses defined here are</p>
<dl class="docutils">
<dt><a class="reference internal" href="#matplotlib.ticker.NullLocator" title="matplotlib.ticker.NullLocator"><code class="xref py py-class docutils literal"><span class="pre">NullLocator</span></code></a></dt>
<dd>No ticks</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.FixedLocator" title="matplotlib.ticker.FixedLocator"><code class="xref py py-class docutils literal"><span class="pre">FixedLocator</span></code></a></dt>
<dd>Tick locations are fixed</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.IndexLocator" title="matplotlib.ticker.IndexLocator"><code class="xref py py-class docutils literal"><span class="pre">IndexLocator</span></code></a></dt>
<dd>locator for index plots (e.g., where x = range(len(y)))</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LinearLocator" title="matplotlib.ticker.LinearLocator"><code class="xref py py-class docutils literal"><span class="pre">LinearLocator</span></code></a></dt>
<dd>evenly spaced ticks from min to max</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-class docutils literal"><span class="pre">LogLocator</span></code></a></dt>
<dd>logarithmically ticks from min to max</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.SymmetricalLogLocator" title="matplotlib.ticker.SymmetricalLogLocator"><code class="xref py py-class docutils literal"><span class="pre">SymmetricalLogLocator</span></code></a></dt>
<dd>locator for use with with the symlog norm, works like the <a class="reference internal" href="#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-obj docutils literal"><span class="pre">LogLocator</span></code></a> for
the part outside of the threshold and add 0 if inside the limits</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.MultipleLocator" title="matplotlib.ticker.MultipleLocator"><code class="xref py py-class docutils literal"><span class="pre">MultipleLocator</span></code></a></dt>
<dd><dl class="first last docutils">
<dt>ticks and range are a multiple of base;</dt>
<dd>either integer or float</dd>
<dt><code class="xref py py-class docutils literal"><span class="pre">OldAutoLocator</span></code></dt>
<dd>choose a MultipleLocator and dyamically reassign it for
intelligent ticking during navigation</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.MaxNLocator" title="matplotlib.ticker.MaxNLocator"><code class="xref py py-class docutils literal"><span class="pre">MaxNLocator</span></code></a></dt>
<dd>finds up to a max number of ticks at nice locations</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.AutoLocator" title="matplotlib.ticker.AutoLocator"><code class="xref py py-class docutils literal"><span class="pre">AutoLocator</span></code></a></dt>
<dd><a class="reference internal" href="#matplotlib.ticker.MaxNLocator" title="matplotlib.ticker.MaxNLocator"><code class="xref py py-class docutils literal"><span class="pre">MaxNLocator</span></code></a> with simple defaults. This is the default
tick locator for most plotting.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.AutoMinorLocator" title="matplotlib.ticker.AutoMinorLocator"><code class="xref py py-class docutils literal"><span class="pre">AutoMinorLocator</span></code></a></dt>
<dd>locator for minor ticks when the axis is linear and the
major ticks are uniformly spaced.  It subdivides the major
tick interval into a specified number of minor intervals,
defaulting to 4 or 5 depending on the major interval.</dd>
<p>There are a number of locators specialized for date locations - see
the dates module</p>
<p>You can define your own locator by deriving from Locator.  You must
override the __call__ method, which returns a sequence of locations,
and you will probably want to override the autoscale method to set the
view limits from the data limits.</p>
<p>If you want to override the default locator, use one of the above or a
custom locator and pass it to the x or y axis instance.  The relevant
methods are:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set_major_locator</span><span class="p">(</span> <span class="n">xmajorLocator</span> <span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set_minor_locator</span><span class="p">(</span> <span class="n">xminorLocator</span> <span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">set_major_locator</span><span class="p">(</span> <span class="n">ymajorLocator</span> <span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">set_minor_locator</span><span class="p">(</span> <span class="n">yminorLocator</span> <span class="p">)</span>
</pre></div>
<p>The default minor locator is the NullLocator, e.g., no minor ticks on by
default.</p>
<div class="section" id="tick-formatting">
<h4>Tick formatting<a class="headerlink" href="#tick-formatting" title="Permalink to this headline">¶</a></h4>
<p>Tick formatting is controlled by classes derived from Formatter.  The
formatter operates on a single tick value and returns a string to the
<dl class="docutils">
<dt><a class="reference internal" href="#matplotlib.ticker.NullFormatter" title="matplotlib.ticker.NullFormatter"><code class="xref py py-class docutils literal"><span class="pre">NullFormatter</span></code></a></dt>
<dd>no labels on the ticks</dd>
<dt><code class="xref py py-class docutils literal"><span class="pre">IndexFormatter</span></code></dt>
<dd>set the strings from a list of labels</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.FixedFormatter" title="matplotlib.ticker.FixedFormatter"><code class="xref py py-class docutils literal"><span class="pre">FixedFormatter</span></code></a></dt>
<dd>set the strings manually for the labels</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.FuncFormatter" title="matplotlib.ticker.FuncFormatter"><code class="xref py py-class docutils literal"><span class="pre">FuncFormatter</span></code></a></dt>
<dd>user defined function sets the labels</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.StrMethodFormatter" title="matplotlib.ticker.StrMethodFormatter"><code class="xref py py-class docutils literal"><span class="pre">StrMethodFormatter</span></code></a></dt>
<dd>Use string <code class="xref py py-obj docutils literal"><span class="pre">format</span></code> method</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.FormatStrFormatter" title="matplotlib.ticker.FormatStrFormatter"><code class="xref py py-class docutils literal"><span class="pre">FormatStrFormatter</span></code></a></dt>
<dd>use a sprintf format string</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.ScalarFormatter" title="matplotlib.ticker.ScalarFormatter"><code class="xref py py-class docutils literal"><span class="pre">ScalarFormatter</span></code></a></dt>
<dd>default formatter for scalars; autopick the fmt string</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LogFormatter" title="matplotlib.ticker.LogFormatter"><code class="xref py py-class docutils literal"><span class="pre">LogFormatter</span></code></a></dt>
<dd>formatter for log axes</dd>
<p>You can derive your own formatter from the Formatter base class by
simply overriding the <code class="docutils literal"><span class="pre">__call__</span></code> method.  The formatter class has access
to the axis view and data limits.</p>
<p>To control the major and minor tick label formats, use one of the
following methods:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set_major_formatter</span><span class="p">(</span> <span class="n">xmajorFormatter</span> <span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set_minor_formatter</span><span class="p">(</span> <span class="n">xminorFormatter</span> <span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">set_major_formatter</span><span class="p">(</span> <span class="n">ymajorFormatter</span> <span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">set_minor_formatter</span><span class="p">(</span> <span class="n">yminorFormatter</span> <span class="p">)</span>
</pre></div>
<p>See <a class="reference internal" href="../examples/pylab_examples/major_minor_demo1.html#pylab-examples-major-minor-demo1"><span class="std std-ref">pylab_examples example code: major_minor_demo1.py</span></a> for an example of setting
major and minor ticks.  See the <a class="reference internal" href="dates_api.html#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.dates</span></code></a> module for
more information and examples of using date locators and formatters.</p>
<dl class="class">
<dt id="matplotlib.ticker.TickHelper">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">TickHelper</code><a class="headerlink" href="#matplotlib.ticker.TickHelper" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="attribute">
<dt id="matplotlib.ticker.TickHelper.axis">
<code class="descname">axis</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.ticker.TickHelper.axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.create_dummy_axis">
<code class="descname">create_dummy_axis</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.TickHelper.create_dummy_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.set_axis">
<code class="descname">set_axis</code><span class="sig-paren">(</span><em>axis</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.TickHelper.set_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.set_bounds">
<code class="descname">set_bounds</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.TickHelper.set_bounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.set_data_interval">
<code class="descname">set_data_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.TickHelper.set_data_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.set_view_interval">
<code class="descname">set_view_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.TickHelper.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.Formatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">Formatter</code><a class="headerlink" href="#matplotlib.ticker.Formatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.TickHelper" title="matplotlib.ticker.TickHelper"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.TickHelper</span></code></a></p>
<p>Convert the tick location to a string</p>
<dl class="method">
<dt id="matplotlib.ticker.Formatter.fix_minus">
<code class="descname">fix_minus</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Formatter.fix_minus" title="Permalink to this definition">¶</a></dt>
<dd><p>Some classes may want to replace a hyphen for minus with the
proper unicode symbol (U+2212) for typographical correctness.
The default is to not replace it.</p>
<p>Note, if you use this method, e.g., in <a class="reference internal" href="#matplotlib.ticker.Formatter.format_data" title="matplotlib.ticker.Formatter.format_data"><code class="xref py py-meth docutils literal"><span class="pre">format_data()</span></code></a> or
call, you probably don&#8217;t want to use it for
<a class="reference internal" href="#matplotlib.ticker.Formatter.format_data_short" title="matplotlib.ticker.Formatter.format_data_short"><code class="xref py py-meth docutils literal"><span class="pre">format_data_short()</span></code></a> since the toolbar uses this for
interactive coord reporting and I doubt we can expect GUIs
across platforms will handle the unicode correctly.  So for
now the classes that override <a class="reference internal" href="#matplotlib.ticker.Formatter.fix_minus" title="matplotlib.ticker.Formatter.fix_minus"><code class="xref py py-meth docutils literal"><span class="pre">fix_minus()</span></code></a> should have an
explicit <a class="reference internal" href="#matplotlib.ticker.Formatter.format_data_short" title="matplotlib.ticker.Formatter.format_data_short"><code class="xref py py-meth docutils literal"><span class="pre">format_data_short()</span></code></a> method</p>
<dl class="method">
<dt id="matplotlib.ticker.Formatter.format_data">
<code class="descname">format_data</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Formatter.format_data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Formatter.format_data_short">
<code class="descname">format_data_short</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Formatter.format_data_short" title="Permalink to this definition">¶</a></dt>
<dd><p>return a short string version</p>
<dl class="method">
<dt id="matplotlib.ticker.Formatter.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Formatter.get_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.ticker.Formatter.locs">
<code class="descname">locs</code><em class="property"> = []</em><a class="headerlink" href="#matplotlib.ticker.Formatter.locs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Formatter.set_locs">
<code class="descname">set_locs</code><span class="sig-paren">(</span><em>locs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Formatter.set_locs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.FixedFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">FixedFormatter</code><span class="sig-paren">(</span><em>seq</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.FixedFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Return fixed strings for tick labels</p>
<p><em>seq</em> is a sequence of strings.  For positions <code class="docutils literal"><span class="pre">i</span> <span class="pre">&lt;</span> <span class="pre">len(seq)</span></code> return
<em>seq[i]</em> regardless of <em>x</em>.  Otherwise return &#8216;&#8217;</p>
<dl class="method">
<dt id="matplotlib.ticker.FixedFormatter.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.FixedFormatter.get_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.FixedFormatter.set_offset_string">
<code class="descname">set_offset_string</code><span class="sig-paren">(</span><em>ofs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.FixedFormatter.set_offset_string" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.NullFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">NullFormatter</code><a class="headerlink" href="#matplotlib.ticker.NullFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Always return the empty string</p>
<dl class="class">
<dt id="matplotlib.ticker.FuncFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">FuncFormatter</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.FuncFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>User defined function for formatting</p>
<p>The function should take in two inputs (tick value <em>x</em> and position <em>pos</em>)
and return a string</p>
<dl class="class">
<dt id="matplotlib.ticker.FormatStrFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">FormatStrFormatter</code><span class="sig-paren">(</span><em>fmt</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.FormatStrFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Use an old-style (&#8216;%&#8217; operator) format string to format the tick</p>
<dl class="class">
<dt id="matplotlib.ticker.StrMethodFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">StrMethodFormatter</code><span class="sig-paren">(</span><em>fmt</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.StrMethodFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Use a new-style format string (as used by <code class="xref py py-obj docutils literal"><span class="pre">str.format()</span></code>)
to format the tick.  The field formatting must be labeled <code class="xref py py-obj docutils literal"><span class="pre">x</span></code>.</p>
<dl class="class">
<dt id="matplotlib.ticker.ScalarFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">ScalarFormatter</code><span class="sig-paren">(</span><em>useOffset=None</em>, <em>useMathText=None</em>, <em>useLocale=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Tick location is a plain old number.  If useOffset==True and the data range
is much smaller than the data average, then an offset will be determined
such that the tick labels are meaningful. Scientific notation is used for
data &lt; 10^-n or data &gt;= 10^m, where n and m are the power limits set using
set_powerlimits((n,m)). The defaults for these are controlled by the
axes.formatter.limits rc parameter.</p>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.fix_minus">
<code class="descname">fix_minus</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.fix_minus" title="Permalink to this definition">¶</a></dt>
<dd><p>use a unicode minus rather than hyphen</p>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.format_data">
<code class="descname">format_data</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.format_data" title="Permalink to this definition">¶</a></dt>
<dd><p>return a formatted string representation of a number</p>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.format_data_short">
<code class="descname">format_data_short</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.format_data_short" title="Permalink to this definition">¶</a></dt>
<dd><p>return a short formatted string representation of a number</p>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.get_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Return scientific notation, plus offset</p>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.get_useLocale">
<code class="descname">get_useLocale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.get_useLocale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.get_useOffset">
<code class="descname">get_useOffset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.get_useOffset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.pprint_val">
<code class="descname">pprint_val</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.pprint_val" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_locs">
<code class="descname">set_locs</code><span class="sig-paren">(</span><em>locs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_locs" title="Permalink to this definition">¶</a></dt>
<dd><p>set the locations of the ticks</p>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_powerlimits">
<code class="descname">set_powerlimits</code><span class="sig-paren">(</span><em>lims</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_powerlimits" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets size thresholds for scientific notation.</p>
<p>e.g., <code class="docutils literal"><span class="pre">formatter.set_powerlimits((-3,</span> <span class="pre">4))</span></code> sets the pre-2007 default
in which scientific notation is used for numbers less than 1e-3 or
greater than 1e4.
See also <a class="reference internal" href="#matplotlib.ticker.ScalarFormatter.set_scientific" title="matplotlib.ticker.ScalarFormatter.set_scientific"><code class="xref py py-meth docutils literal"><span class="pre">set_scientific()</span></code></a>.</p>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_scientific">
<code class="descname">set_scientific</code><span class="sig-paren">(</span><em>b</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_scientific" title="Permalink to this definition">¶</a></dt>
<dd><p>True or False to turn scientific notation on or off
see also <a class="reference internal" href="#matplotlib.ticker.ScalarFormatter.set_powerlimits" title="matplotlib.ticker.ScalarFormatter.set_powerlimits"><code class="xref py py-meth docutils literal"><span class="pre">set_powerlimits()</span></code></a></p>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_useLocale">
<code class="descname">set_useLocale</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_useLocale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_useOffset">
<code class="descname">set_useOffset</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_useOffset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.ticker.ScalarFormatter.useLocale">
<code class="descname">useLocale</code><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.useLocale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.ticker.ScalarFormatter.useOffset">
<code class="descname">useOffset</code><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.useOffset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.LogFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatter</code><span class="sig-paren">(</span><em>base=10.0</em>, <em>labelOnlyBase=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Format values for log axis;</p>
<p><em>base</em> is used to locate the decade tick,
which will be the only one to be labeled if <em>labelOnlyBase</em>
is <code class="docutils literal"><span class="pre">False</span></code></p>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.base">
<code class="descname">base</code><span class="sig-paren">(</span><em>base</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogFormatter.base" title="Permalink to this definition">¶</a></dt>
<dd><p>change the <em>base</em> for labeling - warning: should always match the
base used for <a class="reference internal" href="#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-class docutils literal"><span class="pre">LogLocator</span></code></a></p>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.format_data">
<code class="descname">format_data</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogFormatter.format_data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.format_data_short">
<code class="descname">format_data_short</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogFormatter.format_data_short" title="Permalink to this definition">¶</a></dt>
<dd><p>return a short formatted string representation of a number</p>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.label_minor">
<code class="descname">label_minor</code><span class="sig-paren">(</span><em>labelOnlyBase</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogFormatter.label_minor" title="Permalink to this definition">¶</a></dt>
<dd><p>switch on/off minor ticks labeling</p>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.pprint_val">
<code class="descname">pprint_val</code><span class="sig-paren">(</span><em>x</em>, <em>d</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogFormatter.pprint_val" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.LogFormatterExponent">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatterExponent</code><span class="sig-paren">(</span><em>base=10.0</em>, <em>labelOnlyBase=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogFormatterExponent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.LogFormatter" title="matplotlib.ticker.LogFormatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.LogFormatter</span></code></a></p>
<p>Format values for log axis; using <code class="docutils literal"><span class="pre">exponent</span> <span class="pre">=</span> <span class="pre">log_base(value)</span></code></p>
<p><em>base</em> is used to locate the decade tick,
which will be the only one to be labeled if <em>labelOnlyBase</em>
is <code class="docutils literal"><span class="pre">False</span></code></p>
<dl class="class">
<dt id="matplotlib.ticker.LogFormatterMathtext">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatterMathtext</code><span class="sig-paren">(</span><em>base=10.0</em>, <em>labelOnlyBase=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogFormatterMathtext" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.LogFormatter" title="matplotlib.ticker.LogFormatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.LogFormatter</span></code></a></p>
<p>Format values for log axis; using <code class="docutils literal"><span class="pre">exponent</span> <span class="pre">=</span> <span class="pre">log_base(value)</span></code></p>
<p><em>base</em> is used to locate the decade tick,
which will be the only one to be labeled if <em>labelOnlyBase</em>
is <code class="docutils literal"><span class="pre">False</span></code></p>
<dl class="class">
<dt id="matplotlib.ticker.Locator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">Locator</code><a class="headerlink" href="#matplotlib.ticker.Locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.TickHelper" title="matplotlib.ticker.TickHelper"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.TickHelper</span></code></a></p>
<p>Determine the tick locations;</p>
<p>Note, you should not use the same locator between different
<a class="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-class docutils literal"><span class="pre">Axis</span></code></a> because the locator stores references to
the Axis data and view limits</p>
<dl class="attribute">
<dt id="matplotlib.ticker.Locator.MAXTICKS">
<code class="descname">MAXTICKS</code><em class="property"> = 1000</em><a class="headerlink" href="#matplotlib.ticker.Locator.MAXTICKS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Locator.autoscale">
<code class="descname">autoscale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Locator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>autoscale the view limits</p>
<dl class="method">
<dt id="matplotlib.ticker.Locator.pan">
<code class="descname">pan</code><span class="sig-paren">(</span><em>numsteps</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Locator.pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Pan numticks (can be positive or negative)</p>
<dl class="method">
<dt id="matplotlib.ticker.Locator.raise_if_exceeds">
<code class="descname">raise_if_exceeds</code><span class="sig-paren">(</span><em>locs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Locator.raise_if_exceeds" title="Permalink to this definition">¶</a></dt>
<dd><p>raise a RuntimeError if Locator attempts to create more than
MAXTICKS locs</p>
<dl class="method">
<dt id="matplotlib.ticker.Locator.refresh">
<code class="descname">refresh</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Locator.refresh" title="Permalink to this definition">¶</a></dt>
<dd><p>refresh internal information based on current lim</p>
<dl class="method">
<dt id="matplotlib.ticker.Locator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Locator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Do nothing, and rase a warning. Any locator class not supporting the
set_params() function will call this.</p>
<dl class="method">
<dt id="matplotlib.ticker.Locator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Locator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the values of the located ticks given <strong>vmin</strong> and <strong>vmax</strong>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>To get tick locations with the vmin and vmax values defined
automatically for the associated <code class="xref py py-attr docutils literal"><span class="pre">axis</span></code> simply call
the Locator instance:</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">((</span><span class="nb">type</span><span class="p">(</span><span class="n">loc</span><span class="p">)))</span>
<span class="go">&lt;type &#39;Locator&#39;&gt;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">((</span><span class="n">loc</span><span class="p">()))</span>
<span class="go">[1, 2, 3, 4]</span>
</pre></div>
<dl class="method">
<dt id="matplotlib.ticker.Locator.view_limits">
<code class="descname">view_limits</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Locator.view_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>select a scale for the range from vmin to vmax</p>
<p>Normally this method is overridden by subclasses to
change locator behaviour.</p>
<dl class="method">
<dt id="matplotlib.ticker.Locator.zoom">
<code class="descname">zoom</code><span class="sig-paren">(</span><em>direction</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.Locator.zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Zoom in/out on axis; if direction is &gt;0 zoom in, else zoom out</p>
<dl class="class">
<dt id="matplotlib.ticker.IndexLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">IndexLocator</code><span class="sig-paren">(</span><em>base</em>, <em>offset</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.IndexLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Place a tick on every multiple of some base number of points
plotted, e.g., on every 5th point.  It is assumed that you are doing
index plotting; i.e., the axis is 0, len(data).  This is mainly
useful for x ticks.</p>
<p>place ticks on the i-th data points where (i-offset)%base==0</p>
<dl class="method">
<dt id="matplotlib.ticker.IndexLocator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>base=None</em>, <em>offset=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.IndexLocator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set parameters within this locator</p>
<dl class="method">
<dt id="matplotlib.ticker.IndexLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.IndexLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.FixedLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">FixedLocator</code><span class="sig-paren">(</span><em>locs</em>, <em>nbins=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.FixedLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Tick locations are fixed.  If nbins is not None,
the array of possible positions will be subsampled to
keep the number of ticks &lt;= nbins +1.
The subsampling will be done so as to include the smallest
absolute value; for example, if zero is included in the
array of possibilities, then it is guaranteed to be one of
the chosen ticks.</p>
<dl class="method">
<dt id="matplotlib.ticker.FixedLocator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>nbins=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.FixedLocator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set parameters within this locator.</p>
<dl class="method">
<dt id="matplotlib.ticker.FixedLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.FixedLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd><p>&#8221;
Return the locations of the ticks.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Because the values are fixed, vmin and vmax are not used in this
method.</p>
<dl class="class">
<dt id="matplotlib.ticker.NullLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">NullLocator</code><a class="headerlink" href="#matplotlib.ticker.NullLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>No ticks</p>
<dl class="method">
<dt id="matplotlib.ticker.NullLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.NullLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd><p>&#8221;
Return the locations of the ticks.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Because the values are Null, vmin and vmax are not used in this
method.</p>
<dl class="class">
<dt id="matplotlib.ticker.LinearLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LinearLocator</code><span class="sig-paren">(</span><em>numticks=None</em>, <em>presets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LinearLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Determine the tick locations</p>
<p>The first time this function is called it will try to set the
number of ticks to make a nice tick partitioning.  Thereafter the
number of ticks will be fixed so that interactive navigation will
be nice</p>
<p>Use presets to set locs based on lom.  A dict mapping vmin, vmax-&gt;locs</p>
<dl class="method">
<dt id="matplotlib.ticker.LinearLocator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>numticks=None</em>, <em>presets=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LinearLocator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set parameters within this locator.</p>
<dl class="method">
<dt id="matplotlib.ticker.LinearLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LinearLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.LinearLocator.view_limits">
<code class="descname">view_limits</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LinearLocator.view_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>Try to choose the view limits intelligently</p>
<dl class="class">
<dt id="matplotlib.ticker.LogLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LogLocator</code><span class="sig-paren">(</span><em>base=10.0, subs=[1.0], numdecs=4, numticks=15</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Determine the tick locations for log axes</p>
<p>place ticks on the location= base**i*subs[j]</p>
<dl class="method">
<dt id="matplotlib.ticker.LogLocator.base">
<code class="descname">base</code><span class="sig-paren">(</span><em>base</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogLocator.base" title="Permalink to this definition">¶</a></dt>
<dd><p>set the base of the log scaling (major tick every base**i, i integer)</p>
<dl class="method">
<dt id="matplotlib.ticker.LogLocator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>base=None</em>, <em>subs=None</em>, <em>numdecs=None</em>, <em>numticks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogLocator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set parameters within this locator.</p>
<dl class="method">
<dt id="matplotlib.ticker.LogLocator.subs">
<code class="descname">subs</code><span class="sig-paren">(</span><em>subs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogLocator.subs" title="Permalink to this definition">¶</a></dt>
<dd><p>set the minor ticks the log scaling every base**i*subs[j]</p>
<dl class="method">
<dt id="matplotlib.ticker.LogLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.LogLocator.view_limits">
<code class="descname">view_limits</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.LogLocator.view_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>Try to choose the view limits intelligently</p>
<dl class="class">
<dt id="matplotlib.ticker.AutoLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">AutoLocator</code><a class="headerlink" href="#matplotlib.ticker.AutoLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.MaxNLocator" title="matplotlib.ticker.MaxNLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.MaxNLocator</span></code></a></p>
<dl class="class">
<dt id="matplotlib.ticker.MultipleLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">MultipleLocator</code><span class="sig-paren">(</span><em>base=1.0</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.MultipleLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Set a tick on every integer that is multiple of base in the
view interval</p>
<dl class="method">
<dt id="matplotlib.ticker.MultipleLocator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>base</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.MultipleLocator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set parameters within this locator.</p>
<dl class="method">
<dt id="matplotlib.ticker.MultipleLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.MultipleLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.MultipleLocator.view_limits">
<code class="descname">view_limits</code><span class="sig-paren">(</span><em>dmin</em>, <em>dmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.MultipleLocator.view_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the view limits to the nearest multiples of base that
contain the data</p>
<dl class="class">
<dt id="matplotlib.ticker.MaxNLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">MaxNLocator</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.MaxNLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Select no more than N intervals at nice locations.</p>
<p>Keyword args:</p>
<dl class="docutils">
<dt><em>nbins</em></dt>
<dd>Maximum number of intervals; one less than max number of ticks.</dd>
<dt><em>steps</em></dt>
<dd>Sequence of nice numbers starting with 1 and ending with 10;
e.g., [1, 2, 4, 5, 10]</dd>
<dt><em>integer</em></dt>
<dd>If True, ticks will take only integer values.</dd>
<dt><em>symmetric</em></dt>
<dd>If True, autoscaling will result in a range symmetric
about zero.</dd>
<dt><em>prune</em></dt>
<dd>[&#8216;lower&#8217; | &#8216;upper&#8217; | &#8216;both&#8217; | None]
Remove edge ticks &#8211; useful for stacked or ganged plots
where the upper tick of one axes overlaps with the lower
tick of the axes above it.
If prune==&#8217;lower&#8217;, the smallest tick will
be removed.  If prune==&#8217;upper&#8217;, the largest tick will be
removed.  If prune==&#8217;both&#8217;, the largest and smallest ticks
will be removed.  If prune==None, no ticks will be removed.</dd>
<dl class="method">
<dt id="matplotlib.ticker.MaxNLocator.bin_boundaries">
<code class="descname">bin_boundaries</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.MaxNLocator.bin_boundaries" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.ticker.MaxNLocator.default_params">
<code class="descname">default_params</code><em class="property"> = {'nbins': 10, 'prune': None, 'symmetric': False, 'steps': None, 'integer': False, 'trim': True}</em><a class="headerlink" href="#matplotlib.ticker.MaxNLocator.default_params" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.MaxNLocator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.MaxNLocator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set parameters within this locator.</p>
<dl class="method">
<dt id="matplotlib.ticker.MaxNLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.MaxNLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.MaxNLocator.view_limits">
<code class="descname">view_limits</code><span class="sig-paren">(</span><em>dmin</em>, <em>dmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.MaxNLocator.view_limits" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.AutoMinorLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">AutoMinorLocator</code><span class="sig-paren">(</span><em>n=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.AutoMinorLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Dynamically find minor tick positions based on the positions of
major ticks. Assumes the scale is linear and major ticks are
evenly spaced.</p>
<p><em>n</em> is the number of subdivisions of the interval between
major ticks; e.g., n=2 will place a single minor tick midway
between major ticks.</p>
<p>If <em>n</em> is omitted or None, it will be set to 5 or 4.</p>
<dl class="method">
<dt id="matplotlib.ticker.AutoMinorLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.AutoMinorLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.SymmetricalLogLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">SymmetricalLogLocator</code><span class="sig-paren">(</span><em>transform</em>, <em>subs=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.SymmetricalLogLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Determine the tick locations for log axes</p>
<p>place ticks on the location= base**i*subs[j]</p>
<dl class="method">
<dt id="matplotlib.ticker.SymmetricalLogLocator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>subs=None</em>, <em>numticks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.SymmetricalLogLocator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set parameters within this locator.</p>
<dl class="method">
<dt id="matplotlib.ticker.SymmetricalLogLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.SymmetricalLogLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.SymmetricalLogLocator.view_limits">
<code class="descname">view_limits</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.ticker.SymmetricalLogLocator.view_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>Try to choose the view limits intelligently</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 - 2014 The matplotlib development team.
      Last updated on Dec 19, 2016.
      Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.4.3.
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

ticker_api.html

Latest commit

History

ticker_api.html

File metadata and controls
