iframe-proxy | Sunbelt Computer Software

752 lines (679 loc) · 63.4 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>dates &mdash; Matplotlib 1.4.2 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.4.2',
        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.4.2 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="top" title="Matplotlib 1.4.2 documentation" href="../index.html" />
    <link rel="up" title="The Matplotlib API" href="index.html" />
    <link rel="next" title="dviread" href="dviread.html" />
    <link rel="prev" title="colors" href="colors_api.html" /> 
<link href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet" type="text/css">
    <link rel="canonical" href="https://matplotlib.org/stable/api/dates_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.4.2).  For the latest version see <a href="https://matplotlib.org/stable/api/dates_api.html">https://matplotlib.org/stable/api/dates_api.html</a></div>
<link rel="shortcut icon" href="/_static/favicon.ico">
<!-- 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.png" 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="dviread.html" title="dviread"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="colors_api.html" title="colors"
             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">
  <h3><a href="../contents.html">Table Of Contents</a></h3>
<li><a class="reference internal" href="#">dates</a><ul>
<li><a class="reference internal" href="#module-matplotlib.dates"><code class="docutils literal"><span class="pre">matplotlib.dates</span></code></a><ul>
<li><a class="reference internal" href="#date-tickers">Date tickers</a></li>
<li><a class="reference internal" href="#date-formatters">Date formatters</a></li>
  <h4>Previous topic</h4>
  <p class="topless"><a href="colors_api.html"
                        title="previous chapter">colors</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="dviread.html"
                        title="next chapter">dviread</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/api/dates_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">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
<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="dates">
<h1>dates<a class="headerlink" href="#dates" title="Permalink to this headline">¶</a></h1>
<p class="graphviz">
<img src="../_images/inheritance-e8e0230291bdd42e0775e62fe1dd367f0407fe9b.png" alt="Inheritance diagram of matplotlib.dates" usemap="#inheritance1bda3e63b5" class="inheritance"/>
<map id="inheritance1bda3e63b5" name="inheritance1bda3e63b5">
<area shape="rect" id="node1" href="#matplotlib.dates.AutoDateFormatter" title="This class attempts to figure out the best format to use. &#160;This is" alt="" coords="316,66,441,88"/>
<area shape="rect" id="node2" href="ticker_api.html#matplotlib.ticker.Formatter" title="Convert the tick location to a string" alt="" coords="186,130,260,152"/>
<area shape="rect" id="node7" href="#matplotlib.dates.DateFormatter" title="Tick location is seconds since the epoch. &#160;Use a :func:`strftime`" alt="" coords="328,108,428,130"/>
<area shape="rect" id="node13" href="#matplotlib.dates.IndexDateFormatter" title="Use with :class:`~matplotlib.ticker.IndexLocator` to cycle format" alt="" coords="314,151,443,172"/>
<area shape="rect" id="node3" href="#matplotlib.dates.AutoDateLocator" title="On autoscale, this class picks the best" alt="" coords="493,129,604,151"/>
<area shape="rect" id="node4" href="#matplotlib.dates.DateLocator" title="DateLocator" alt="" coords="335,193,421,214"/>
<area shape="rect" id="node10" href="#matplotlib.dates.RRuleLocator" title="RRuleLocator" alt="" coords="504,171,593,193"/>
<area shape="rect" id="node14" href="#matplotlib.dates.MicrosecondLocator" title="Make ticks on occurances of each microsecond." alt="" coords="485,213,613,235"/>
<area shape="rect" id="node19" href="#matplotlib.dates.YearLocator" title="Make ticks on a given day of each year that is a multiple of base." alt="" coords="508,255,590,277"/>
<area shape="rect" id="node5" href="units_api.html#matplotlib.units.ConversionInterface" title="The minimal interface for a converter to take custom instances (or" alt="" coords="5,88,132,110"/>
<area shape="rect" id="node6" title="Converter for datetime.date and datetime.datetime data," alt="" coords="173,88,272,110"/>
<area shape="rect" id="node8" href="ticker_api.html#matplotlib.ticker.Locator" title="Determine the tick locations;" alt="" coords="192,172,253,194"/>
<area shape="rect" id="node9" href="#matplotlib.dates.DayLocator" title="Make ticks on occurances of each day of the month. &#160;For example," alt="" coords="669,65,749,87"/>
<area shape="rect" id="node12" href="#matplotlib.dates.HourLocator" title="Make ticks on occurances of each hour." alt="" coords="666,107,752,129"/>
<area shape="rect" id="node15" href="#matplotlib.dates.MinuteLocator" title="Make ticks on occurances of each minute." alt="" coords="661,149,757,171"/>
<area shape="rect" id="node16" href="#matplotlib.dates.MonthLocator" title="Make ticks on occurances of each month month, eg 1, 3, 12." alt="" coords="662,191,756,213"/>
<area shape="rect" id="node17" href="#matplotlib.dates.SecondLocator" title="Make ticks on occurances of each second." alt="" coords="658,233,759,255"/>
<area shape="rect" id="node18" href="#matplotlib.dates.WeekdayLocator" title="Make ticks on occurances of each weekday." alt="" coords="655,276,763,297"/>
<area shape="rect" id="node11" href="ticker_api.html#matplotlib.ticker.TickHelper" title="TickHelper" alt="" coords="31,152,106,173"/>
<area shape="rect" id="node21" title="Use this class to parse date strings to matplotlib datenums when" alt="" coords="20,4,116,26"/>
<div class="section" id="module-matplotlib.dates">
<span id="matplotlib-dates"></span><h2><a class="reference internal" href="#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.dates</span></code></a><a class="headerlink" href="#module-matplotlib.dates" title="Permalink to this headline">¶</a></h2>
<p>Matplotlib provides sophisticated date plotting capabilities, standing on the
shoulders of python <code class="xref py py-mod docutils literal"><span class="pre">datetime</span></code>, the add-on modules <code class="xref py py-mod docutils literal"><span class="pre">pytz</span></code> and
<code class="xref py py-mod docutils literal"><span class="pre">dateutil</span></code>.  <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> objects are converted to floating point
numbers which represent time in days since 0001-01-01 UTC, plus 1.  For
example, 0001-01-01, 06:00 is 1.25, not 0.25.  The helper functions
<a class="reference internal" href="#matplotlib.dates.date2num" title="matplotlib.dates.date2num"><code class="xref py py-func docutils literal"><span class="pre">date2num()</span></code></a>, <a class="reference internal" href="#matplotlib.dates.num2date" title="matplotlib.dates.num2date"><code class="xref py py-func docutils literal"><span class="pre">num2date()</span></code></a> and <a class="reference internal" href="#matplotlib.dates.drange" title="matplotlib.dates.drange"><code class="xref py py-func docutils literal"><span class="pre">drange()</span></code></a> are used to facilitate
easy conversion to and from <code class="xref py py-mod docutils literal"><span class="pre">datetime</span></code> and numeric ranges.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Like Python&#8217;s datetime, mpl uses the Gregorian calendar for all
conversions between dates and floating point numbers. This practice
is not universal, and calendar differences can cause confusing
differences between what Python and mpl give as the number of days
since 0001-01-01 and what other software and databases yield.  For
example, the US Naval Observatory uses a calendar that switches
from Julian to Gregorian in October, 1582.  Hence, using their
calculator, the number of days between 0001-01-01 and 2006-04-01 is
732403, whereas using the Gregorian calendar via the datetime
module we find:</p>
<div class="last highlight-python"><div class="highlight"><pre>In [31]:date(2006,4,1).toordinal() - date(1,1,1).toordinal()
Out[31]:732401
</pre></div>
<p>A wide range of specific and general purpose date tick locators and
formatters are provided in this module.  See
<a class="reference internal" href="ticker_api.html#module-matplotlib.ticker" title="matplotlib.ticker"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.ticker</span></code></a> for general information on tick locators
and formatters.  These are described below.</p>
<p>All the matplotlib date converters, tickers and formatters are
timezone aware, and the default timezone is given by the timezone
parameter in your <code class="file docutils literal"><span class="pre">matplotlibrc</span></code> file.  If you leave out a
<code class="xref py py-class docutils literal"><span class="pre">tz</span></code> timezone instance, the default from your rc file will be
assumed.  If you want to use a custom time zone, pass a
<code class="xref py py-class docutils literal"><span class="pre">pytz.timezone</span></code> instance with the tz keyword argument to
<a class="reference internal" href="#matplotlib.dates.num2date" title="matplotlib.dates.num2date"><code class="xref py py-func docutils literal"><span class="pre">num2date()</span></code></a>, <code class="xref py py-func docutils literal"><span class="pre">plot_date()</span></code>, and any custom date tickers or
locators you create.  See <a class="reference external" href="http://pytz.sourceforge.net">pytz</a> for
information on <code class="xref py py-mod docutils literal"><span class="pre">pytz</span></code> and timezone handling.</p>
<p>The <a class="reference external" href="http://labix.org/python-dateutil">dateutil module</a> provides
additional code to handle date ticking, making it easy to place ticks
on any kinds of dates.  See examples below.</p>
<div class="section" id="date-tickers">
<h3>Date tickers<a class="headerlink" href="#date-tickers" title="Permalink to this headline">¶</a></h3>
<p>Most of the date tickers can locate single or multiple values.  For
example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># import constants for the days of the week</span>
<span class="kn">from</span> <span class="nn">matplotlib.dates</span> <span class="kn">import</span> <span class="n">MO</span><span class="p">,</span> <span class="n">TU</span><span class="p">,</span> <span class="n">WE</span><span class="p">,</span> <span class="n">TH</span><span class="p">,</span> <span class="n">FR</span><span class="p">,</span> <span class="n">SA</span><span class="p">,</span> <span class="n">SU</span>
<span class="c"># tick on mondays every week</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">WeekdayLocator</span><span class="p">(</span><span class="n">byweekday</span><span class="o">=</span><span class="n">MO</span><span class="p">,</span> <span class="n">tz</span><span class="o">=</span><span class="n">tz</span><span class="p">)</span>
<span class="c"># tick on mondays and saturdays</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">WeekdayLocator</span><span class="p">(</span><span class="n">byweekday</span><span class="o">=</span><span class="p">(</span><span class="n">MO</span><span class="p">,</span> <span class="n">SA</span><span class="p">))</span>
</pre></div>
<p>In addition, most of the constructors take an interval argument:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># tick on mondays every second week</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">WeekdayLocator</span><span class="p">(</span><span class="n">byweekday</span><span class="o">=</span><span class="n">MO</span><span class="p">,</span> <span class="n">interval</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</pre></div>
<p>The rrule locator allows completely general date ticking:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># tick every 5th easter</span>
<span class="n">rule</span> <span class="o">=</span> <span class="n">rrulewrapper</span><span class="p">(</span><span class="n">YEARLY</span><span class="p">,</span> <span class="n">byeaster</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">interval</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">RRuleLocator</span><span class="p">(</span><span class="n">rule</span><span class="p">)</span>
</pre></div>
<p>Here are all the date tickers:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="#matplotlib.dates.MinuteLocator" title="matplotlib.dates.MinuteLocator"><code class="xref py py-class docutils literal"><span class="pre">MinuteLocator</span></code></a>: locate minutes</li>
<li><a class="reference internal" href="#matplotlib.dates.HourLocator" title="matplotlib.dates.HourLocator"><code class="xref py py-class docutils literal"><span class="pre">HourLocator</span></code></a>: locate hours</li>
<li><a class="reference internal" href="#matplotlib.dates.DayLocator" title="matplotlib.dates.DayLocator"><code class="xref py py-class docutils literal"><span class="pre">DayLocator</span></code></a>: locate specifed days of the month</li>
<li><a class="reference internal" href="#matplotlib.dates.WeekdayLocator" title="matplotlib.dates.WeekdayLocator"><code class="xref py py-class docutils literal"><span class="pre">WeekdayLocator</span></code></a>: Locate days of the week, eg MO, TU</li>
<li><a class="reference internal" href="#matplotlib.dates.MonthLocator" title="matplotlib.dates.MonthLocator"><code class="xref py py-class docutils literal"><span class="pre">MonthLocator</span></code></a>: locate months, eg 7 for july</li>
<li><a class="reference internal" href="#matplotlib.dates.YearLocator" title="matplotlib.dates.YearLocator"><code class="xref py py-class docutils literal"><span class="pre">YearLocator</span></code></a>: locate years that are multiples of base</li>
<li><a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">RRuleLocator</span></code></a>: locate using a
<code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.rrulewrapper</span></code>.  The
<code class="xref py py-class docutils literal"><span class="pre">rrulewrapper</span></code> is a simple wrapper around a
<code class="xref py py-class docutils literal"><span class="pre">dateutil.rrule</span></code> (<a class="reference external" href="http://labix.org/python-dateutil">dateutil</a>) which allow almost
arbitrary date tick specifications.  See <a class="reference external" href="../examples/pylab_examples/date_demo_rrule.html">rrule example</a>.</li>
<li><a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><code class="xref py py-class docutils literal"><span class="pre">AutoDateLocator</span></code></a>: On autoscale, this class picks the best
<code class="xref py py-class docutils literal"><span class="pre">MultipleDateLocator</span></code> to set the view limits and the tick
locations.</li>
</div></blockquote>
<div class="section" id="date-formatters">
<h3>Date formatters<a class="headerlink" href="#date-formatters" title="Permalink to this headline">¶</a></h3>
<p>Here all all the date formatters:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="#matplotlib.dates.AutoDateFormatter" title="matplotlib.dates.AutoDateFormatter"><code class="xref py py-class docutils literal"><span class="pre">AutoDateFormatter</span></code></a>: attempts to figure out the best format
to use.  This is most useful when used with the <a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><code class="xref py py-class docutils literal"><span class="pre">AutoDateLocator</span></code></a>.</li>
<li><a class="reference internal" href="#matplotlib.dates.DateFormatter" title="matplotlib.dates.DateFormatter"><code class="xref py py-class docutils literal"><span class="pre">DateFormatter</span></code></a>: use <code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code> format strings</li>
<li><a class="reference internal" href="#matplotlib.dates.IndexDateFormatter" title="matplotlib.dates.IndexDateFormatter"><code class="xref py py-class docutils literal"><span class="pre">IndexDateFormatter</span></code></a>: date plots with implicit <em>x</em>
indexing.</li>
</div></blockquote>
<dl class="function">
<dt id="matplotlib.dates.date2num">
<code class="descclassname">matplotlib.dates.</code><code class="descname">date2num</code><span class="sig-paren">(</span><em>d</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.date2num" title="Permalink to this definition">¶</a></dt>
<dd><p><em>d</em> is either a <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> instance or a sequence of datetimes.</p>
<p>Return value is a floating point number (or sequence of floats)
which gives the number of days (fraction part represents hours,
minutes, seconds) since 0001-01-01 00:00:00 UTC, <em>plus</em> <em>one</em>.
The addition of one here is a historical artifact.  Also, note
that the Gregorian calendar is assumed; this is not universal
practice.  For details, see the module docstring.</p>
<dl class="function">
<dt id="matplotlib.dates.num2date">
<code class="descclassname">matplotlib.dates.</code><code class="descname">num2date</code><span class="sig-paren">(</span><em>x</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.num2date" title="Permalink to this definition">¶</a></dt>
<dd><p><em>x</em> is a float value which gives the number of days
(fraction part represents hours, minutes, seconds) since
0001-01-01 00:00:00 UTC <em>plus</em> <em>one</em>.
The addition of one here is a historical artifact.  Also, note
that the Gregorian calendar is assumed; this is not universal
practice.  For details, see the module docstring.</p>
<p>Return value is a <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> instance in timezone <em>tz</em> (default to
rcparams TZ value).</p>
<p>If <em>x</em> is a sequence, a sequence of <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> objects will
be returned.</p>
<dl class="function">
<dt id="matplotlib.dates.drange">
<code class="descclassname">matplotlib.dates.</code><code class="descname">drange</code><span class="sig-paren">(</span><em>dstart</em>, <em>dend</em>, <em>delta</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.drange" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a date range as float Gregorian ordinals.  <em>dstart</em> and
<em>dend</em> are <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> instances.  <em>delta</em> is a
<code class="xref py py-class docutils literal"><span class="pre">datetime.timedelta</span></code> instance.</p>
<dl class="function">
<dt id="matplotlib.dates.epoch2num">
<code class="descclassname">matplotlib.dates.</code><code class="descname">epoch2num</code><span class="sig-paren">(</span><em>e</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.epoch2num" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert an epoch or sequence of epochs to the new date format,
that is days since 0001.</p>
<dl class="function">
<dt id="matplotlib.dates.num2epoch">
<code class="descclassname">matplotlib.dates.</code><code class="descname">num2epoch</code><span class="sig-paren">(</span><em>d</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.num2epoch" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert days since 0001 to epoch.  <em>d</em> can be a number or sequence.</p>
<dl class="function">
<dt id="matplotlib.dates.mx2num">
<code class="descclassname">matplotlib.dates.</code><code class="descname">mx2num</code><span class="sig-paren">(</span><em>mxdates</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.mx2num" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert mx <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> instance (or sequence of mx
instances) to the new date format.</p>
<dl class="class">
<dt id="matplotlib.dates.DateFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">DateFormatter</code><span class="sig-paren">(</span><em>fmt</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#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 seconds since the epoch.  Use a <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code></a>
format string.</p>
<p>Python only supports <code class="xref py py-mod docutils literal"><span class="pre">datetime</span></code> <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code></a> formatting
for years greater than 1900.  Thanks to Andrew Dalke, Dalke
Scientific Software who contributed the <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code></a> code
below to include dates earlier than this year.</p>
<p><em>fmt</em> is an <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code></a> format string; <em>tz</em> is the
<code class="xref py py-class docutils literal"><span class="pre">tzinfo</span></code> instance.</p>
<dl class="attribute">
<dt id="matplotlib.dates.DateFormatter.illegal_s">
<code class="descname">illegal_s</code><em class="property"> = &lt;_sre.SRE_Pattern object at 0x7fc4f7966138&gt;</em><a class="headerlink" href="#matplotlib.dates.DateFormatter.illegal_s" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateFormatter.set_tzinfo">
<code class="descname">set_tzinfo</code><span class="sig-paren">(</span><em>tz</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateFormatter.set_tzinfo" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateFormatter.strftime">
<code class="descname">strftime</code><span class="sig-paren">(</span><em>dt</em>, <em>fmt</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateFormatter.strftime" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.dates.IndexDateFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">IndexDateFormatter</code><span class="sig-paren">(</span><em>t</em>, <em>fmt</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.IndexDateFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#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 with <a class="reference internal" href="ticker_api.html#matplotlib.ticker.IndexLocator" title="matplotlib.ticker.IndexLocator"><code class="xref py py-class docutils literal"><span class="pre">IndexLocator</span></code></a> to cycle format
strings by index.</p>
<p><em>t</em> is a sequence of dates (floating point days).  <em>fmt</em> is a
<code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code> format string.</p>
<dl class="class">
<dt id="matplotlib.dates.AutoDateFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">AutoDateFormatter</code><span class="sig-paren">(</span><em>locator</em>, <em>tz=None</em>, <em>defaultfmt=u'%Y-%m-%d'</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#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>This class attempts to figure out the best format to use.  This is
most useful when used with the <a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><code class="xref py py-class docutils literal"><span class="pre">AutoDateLocator</span></code></a>.</p>
<p>The AutoDateFormatter has a scale dictionary that maps the scale
of the tick (the distance in days between one major tick) and a
format string.  The default looks like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="bp">self</span><span class="o">.</span><span class="n">scaled</span> <span class="o">=</span> <span class="p">{</span>
   <span class="mf">365.0</span>  <span class="p">:</span> <span class="s">&#39;%Y&#39;</span><span class="p">,</span>
   <span class="mf">30.</span>    <span class="p">:</span> <span class="s">&#39;%b %Y&#39;</span><span class="p">,</span>
   <span class="mf">1.0</span>    <span class="p">:</span> <span class="s">&#39;%b </span><span class="si">%d</span><span class="s"> %Y&#39;</span><span class="p">,</span>
   <span class="mf">1.</span><span class="o">/</span><span class="mf">24.</span> <span class="p">:</span> <span class="s">&#39;%H:%M:%S&#39;</span><span class="p">,</span>
   <span class="mf">1.</span> <span class="o">/</span> <span class="p">(</span><span class="mf">24.</span> <span class="o">*</span> <span class="mf">60.</span><span class="p">):</span> <span class="s">&#39;%H:%M:%S.</span><span class="si">%f</span><span class="s">&#39;</span><span class="p">,</span>
   <span class="p">}</span>
</pre></div>
<p>The algorithm picks the key in the dictionary that is &gt;= the
current scale and uses that format string.  You can customize this
dictionary by doing:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">formatter</span> <span class="o">=</span> <span class="n">AutoDateFormatter</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">formatter</span><span class="o">.</span><span class="n">scaled</span><span class="p">[</span><span class="mi">1</span><span class="o">/</span><span class="p">(</span><span class="mf">24.</span><span class="o">*</span><span class="mf">60.</span><span class="p">)]</span> <span class="o">=</span> <span class="s">&#39;%M:%S&#39;</span> <span class="c"># only show min and sec</span>
</pre></div>
<p>A custom <a class="reference internal" href="ticker_api.html#matplotlib.ticker.FuncFormatter" title="matplotlib.ticker.FuncFormatter"><code class="xref py py-class docutils literal"><span class="pre">FuncFormatter</span></code></a> can also be used.
The following example shows how to use a custom format function to strip
trailing zeros from decimal seconds and adds the date to the first
ticklabel:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">def</span> <span class="nf">my_format_function</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">pos</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="gp">... </span>    <span class="n">x</span> <span class="o">=</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">dates</span><span class="o">.</span><span class="n">num2date</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="gp">... </span>    <span class="k">if</span> <span class="n">pos</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="gp">... </span>        <span class="n">fmt</span> <span class="o">=</span> <span class="s">&#39;%D %H:%M:%S.</span><span class="si">%f</span><span class="s">&#39;</span>
<span class="gp">... </span>    <span class="k">else</span><span class="p">:</span>
<span class="gp">... </span>        <span class="n">fmt</span> <span class="o">=</span> <span class="s">&#39;%H:%M:%S.</span><span class="si">%f</span><span class="s">&#39;</span>
<span class="gp">... </span>    <span class="n">label</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="n">fmt</span><span class="p">)</span>
<span class="gp">... </span>    <span class="n">label</span> <span class="o">=</span> <span class="n">label</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s">&quot;0&quot;</span><span class="p">)</span>
<span class="gp">... </span>    <span class="n">label</span> <span class="o">=</span> <span class="n">label</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s">&quot;.&quot;</span><span class="p">)</span>
<span class="gp">... </span>    <span class="k">return</span> <span class="n">label</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">matplotlib.ticker</span> <span class="kn">import</span> <span class="n">FuncFormatter</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">formatter</span><span class="o">.</span><span class="n">scaled</span><span class="p">[</span><span class="mi">1</span><span class="o">/</span><span class="p">(</span><span class="mf">24.</span><span class="o">*</span><span class="mf">60.</span><span class="p">)]</span> <span class="o">=</span> <span class="n">FuncFormatter</span><span class="p">(</span><span class="n">my_format_function</span><span class="p">)</span>
</pre></div>
<p>Autoformat the date labels.  The default format is the one to use
if none of the values in <code class="docutils literal"><span class="pre">self.scaled</span></code> are greater than the unit
returned by <code class="docutils literal"><span class="pre">locator._get_unit()</span></code>.</p>
<dl class="class">
<dt id="matplotlib.dates.DateLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">DateLocator</code><span class="sig-paren">(</span><em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#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><em>tz</em> is a <code class="xref py py-class docutils literal"><span class="pre">tzinfo</span></code> instance.</p>
<dl class="method">
<dt id="matplotlib.dates.DateLocator.datalim_to_dt">
<code class="descname">datalim_to_dt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator.datalim_to_dt" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.dates.DateLocator.hms0d">
<code class="descname">hms0d</code><em class="property"> = {u'byminute': 0, u'byhour': 0, u'bysecond': 0}</em><a class="headerlink" href="#matplotlib.dates.DateLocator.hms0d" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateLocator.nonsingular">
<code class="descname">nonsingular</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator.nonsingular" title="Permalink to this definition">¶</a></dt>
<dd><p>Given the proposed upper and lower extent, adjust the range
if it is too close to being singular (i.e. a range of ~0).</p>
<dl class="method">
<dt id="matplotlib.dates.DateLocator.set_tzinfo">
<code class="descname">set_tzinfo</code><span class="sig-paren">(</span><em>tz</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator.set_tzinfo" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateLocator.viewlim_to_dt">
<code class="descname">viewlim_to_dt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator.viewlim_to_dt" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.dates.RRuleLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">RRuleLocator</code><span class="sig-paren">(</span><em>o</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.RRuleLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<dl class="method">
<dt id="matplotlib.dates.RRuleLocator.autoscale">
<code class="descname">autoscale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.RRuleLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the view limits to include the data range.</p>
<dl class="staticmethod">
<dt id="matplotlib.dates.RRuleLocator.get_unit_generic">
<em class="property">static </em><code class="descname">get_unit_generic</code><span class="sig-paren">(</span><em>freq</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.RRuleLocator.get_unit_generic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.dates.AutoDateLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">AutoDateLocator</code><span class="sig-paren">(</span><em>tz=None</em>, <em>minticks=5</em>, <em>maxticks=None</em>, <em>interval_multiples=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<p>On autoscale, this class picks the best
<a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal"><span class="pre">DateLocator</span></code></a> to set the view limits and the tick
locations.</p>
<p><em>minticks</em> is the minimum number of ticks desired, which is used to
select the type of ticking (yearly, monthly, etc.).</p>
<p><em>maxticks</em> is the maximum number of ticks desired, which controls
any interval between ticks (ticking every other, every 3, etc.).
For really fine-grained control, this can be a dictionary mapping
individual rrule frequency constants (YEARLY, MONTHLY, etc.)
to their own maximum number of ticks.  This can be used to keep
the number of ticks appropriate to the format chosen in
<a class="reference internal" href="#matplotlib.dates.AutoDateFormatter" title="matplotlib.dates.AutoDateFormatter"><code class="xref py py-class docutils literal"><span class="pre">AutoDateFormatter</span></code></a>. Any frequency not specified in this
dictionary is given a default value.</p>
<p><em>tz</em> is a <code class="xref py py-class docutils literal"><span class="pre">tzinfo</span></code> instance.</p>
<p><em>interval_multiples</em> is a boolean that indicates whether ticks
should be chosen to be multiple of the interval. This will lock
ticks to &#8216;nicer&#8217; locations. For example, this will force the
ticks to be at hours 0,6,12,18 when hourly ticking is done at
6 hour intervals.</p>
<p>The AutoDateLocator has an interval dictionary that maps the
frequency of the tick (a constant from dateutil.rrule) and a
multiple allowed for that ticking.  The default looks like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="bp">self</span><span class="o">.</span><span class="n">intervald</span> <span class="o">=</span> <span class="p">{</span>
  <span class="n">YEARLY</span>  <span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">40</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">200</span><span class="p">,</span> <span class="mi">400</span><span class="p">,</span> <span class="mi">500</span><span class="p">,</span>
            <span class="mi">1000</span><span class="p">,</span> <span class="mi">2000</span><span class="p">,</span> <span class="mi">4000</span><span class="p">,</span> <span class="mi">5000</span><span class="p">,</span> <span class="mi">10000</span><span class="p">],</span>
  <span class="n">MONTHLY</span> <span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">6</span><span class="p">],</span>
  <span class="n">DAILY</span>   <span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">14</span><span class="p">],</span>
  <span class="n">HOURLY</span>  <span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">12</span><span class="p">],</span>
  <span class="n">MINUTELY</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">30</span><span class="p">],</span>
  <span class="n">SECONDLY</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">30</span><span class="p">],</span>
  <span class="n">MICROSECONDLY</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">200</span><span class="p">,</span> <span class="mi">500</span><span class="p">,</span> <span class="mi">1000</span><span class="p">,</span> <span class="mi">2000</span><span class="p">,</span>
                 <span class="mi">5000</span><span class="p">,</span> <span class="mi">10000</span><span class="p">,</span> <span class="mi">20000</span><span class="p">,</span> <span class="mi">50000</span><span class="p">,</span> <span class="mi">100000</span><span class="p">,</span> <span class="mi">200000</span><span class="p">,</span> <span class="mi">500000</span><span class="p">,</span>
                 <span class="mi">1000000</span><span class="p">],</span>
  <span class="p">}</span>
</pre></div>
<p>The interval is used to specify multiples that are appropriate for
the frequency of ticking. For instance, every 7 days is sensible
for daily ticks, but for minutes/seconds, 15 or 30 make sense.
You can customize this dictionary by doing:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">locator</span> <span class="o">=</span> <span class="n">AutoDateLocator</span><span class="p">()</span>
<span class="n">locator</span><span class="o">.</span><span class="n">intervald</span><span class="p">[</span><span class="n">HOURLY</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="c"># only show every 3 hours</span>
</pre></div>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.autoscale">
<code class="descname">autoscale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>Try to choose the view limits intelligently.</p>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.get_locator">
<code class="descname">get_locator</code><span class="sig-paren">(</span><em>dmin</em>, <em>dmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.get_locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Pick the best locator based on a distance.</p>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.nonsingular">
<code class="descname">nonsingular</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.nonsingular" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.refresh">
<code class="descname">refresh</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.refresh" title="Permalink to this definition">¶</a></dt>
<dd><p>Refresh internal information based on current limits.</p>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.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.dates.AutoDateLocator.set_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.dates.YearLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">YearLocator</code><span class="sig-paren">(</span><em>base=1</em>, <em>month=1</em>, <em>day=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.YearLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<p>Make ticks on a given day of each year that is a multiple of base.</p>
<p>Examples:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># Tick every year on Jan 1st</span>
<span class="n">locator</span> <span class="o">=</span> <span class="n">YearLocator</span><span class="p">()</span>
<span class="c"># Tick every 5 years on July 4th</span>
<span class="n">locator</span> <span class="o">=</span> <span class="n">YearLocator</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="n">month</span><span class="o">=</span><span class="mi">7</span><span class="p">,</span> <span class="n">day</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
</pre></div>
<p>Mark years that are multiple of base on a given month and day
(default jan 1).</p>
<dl class="method">
<dt id="matplotlib.dates.YearLocator.autoscale">
<code class="descname">autoscale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.YearLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the view limits to include the data range.</p>
<dl class="class">
<dt id="matplotlib.dates.MonthLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">MonthLocator</code><span class="sig-paren">(</span><em>bymonth=None</em>, <em>bymonthday=1</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MonthLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each month month, eg 1, 3, 12.</p>
<p>Mark every month in <em>bymonth</em>; <em>bymonth</em> can be an int or
sequence.  Default is <code class="docutils literal"><span class="pre">range(1,13)</span></code>, i.e. every month.</p>
<p><em>interval</em> is the interval between each iteration.  For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second occurance.</p>
<dl class="class">
<dt id="matplotlib.dates.WeekdayLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">WeekdayLocator</code><span class="sig-paren">(</span><em>byweekday=1</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.WeekdayLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each weekday.</p>
<p>Mark every weekday in <em>byweekday</em>; <em>byweekday</em> can be a number or
sequence.</p>
<p>Elements of <em>byweekday</em> must be one of MO, TU, WE, TH, FR, SA,
SU, the constants from <code class="xref py py-mod docutils literal"><span class="pre">dateutil.rrule</span></code>, which have been
imported into the <a class="reference internal" href="#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.dates</span></code></a> namespace.</p>
<p><em>interval</em> specifies the number of weeks to skip.  For example,
<code class="docutils literal"><span class="pre">interval=2</span></code> plots every second week.</p>
<dl class="class">
<dt id="matplotlib.dates.DayLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">DayLocator</code><span class="sig-paren">(</span><em>bymonthday=None</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DayLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each day of the month.  For example,
1, 15, 30.</p>
<p>Mark every day in <em>bymonthday</em>; <em>bymonthday</em> can be an int or
sequence.</p>
<p>Default is to tick every day of the month: <code class="docutils literal"><span class="pre">bymonthday=range(1,32)</span></code></p>
<dl class="class">
<dt id="matplotlib.dates.HourLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">HourLocator</code><span class="sig-paren">(</span><em>byhour=None</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.HourLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each hour.</p>
<p>Mark every hour in <em>byhour</em>; <em>byhour</em> can be an int or sequence.
Default is to tick every hour: <code class="docutils literal"><span class="pre">byhour=range(24)</span></code></p>
<p><em>interval</em> is the interval between each iteration.  For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
<dl class="class">
<dt id="matplotlib.dates.MinuteLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">MinuteLocator</code><span class="sig-paren">(</span><em>byminute=None</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MinuteLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each minute.</p>
<p>Mark every minute in <em>byminute</em>; <em>byminute</em> can be an int or
sequence.  Default is to tick every minute: <code class="docutils literal"><span class="pre">byminute=range(60)</span></code></p>
<p><em>interval</em> is the interval between each iteration.  For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
<dl class="class">
<dt id="matplotlib.dates.SecondLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">SecondLocator</code><span class="sig-paren">(</span><em>bysecond=None</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.SecondLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each second.</p>
<p>Mark every second in <em>bysecond</em>; <em>bysecond</em> can be an int or
sequence.  Default is to tick every second: <code class="docutils literal"><span class="pre">bysecond</span> <span class="pre">=</span> <span class="pre">range(60)</span></code></p>
<p><em>interval</em> is the interval between each iteration.  For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
<dl class="class">
<dt id="matplotlib.dates.MicrosecondLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">MicrosecondLocator</code><span class="sig-paren">(</span><em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<p>Make ticks on occurances of each microsecond.</p>
<p><em>interval</em> is the interval between each iteration.  For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second microsecond.</p>
<dl class="method">
<dt id="matplotlib.dates.MicrosecondLocator.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.dates.MicrosecondLocator.set_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.MicrosecondLocator.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.dates.MicrosecondLocator.set_data_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.MicrosecondLocator.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.dates.MicrosecondLocator.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="matplotlib.dates.rrule">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">rrule</code><span class="sig-paren">(</span><em>freq</em>, <em>dtstart=None</em>, <em>interval=1</em>, <em>wkst=None</em>, <em>count=None</em>, <em>until=None</em>, <em>bysetpos=None</em>, <em>bymonth=None</em>, <em>bymonthday=None</em>, <em>byyearday=None</em>, <em>byeaster=None</em>, <em>byweekno=None</em>, <em>byweekday=None</em>, <em>byhour=None</em>, <em>byminute=None</em>, <em>bysecond=None</em>, <em>cache=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.rrule" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">dateutil.rrule.rrulebase</span></code></p>
<dl class="class">
<dt id="matplotlib.dates.relativedelta">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">relativedelta</code><span class="sig-paren">(</span><em>dt1=None</em>, <em>dt2=None</em>, <em>years=0</em>, <em>months=0</em>, <em>days=0</em>, <em>leapdays=0</em>, <em>weeks=0</em>, <em>hours=0</em>, <em>minutes=0</em>, <em>seconds=0</em>, <em>microseconds=0</em>, <em>year=None</em>, <em>month=None</em>, <em>day=None</em>, <em>weekday=None</em>, <em>yearday=None</em>, <em>nlyearday=None</em>, <em>hour=None</em>, <em>minute=None</em>, <em>second=None</em>, <em>microsecond=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.relativedelta" title="Permalink to this definition">¶</a></dt>
<dd><p>The relativedelta type is based on the specification of the excelent
work done by M.-A. Lemburg in his mx.DateTime extension. However,
notice that this type does <em>NOT</em> implement the same algorithm as
his work. Do <em>NOT</em> expect it to behave like mx.DateTime&#8217;s counterpart.</p>
<p>There&#8217;s two different ways to build a relativedelta instance. The
first one is passing it two date/datetime classes:</p>
<blockquote>
<div>relativedelta(datetime1, datetime2)</div></blockquote>
<p>And the other way is to use the following keyword arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt>year, month, day, hour, minute, second, microsecond:</dt>
<dd>Absolute information.</dd>
<dt>years, months, weeks, days, hours, minutes, seconds, microseconds:</dt>
<dd>Relative information, may be negative.</dd>
<dt>weekday:</dt>
<dd>One of the weekday instances (MO, TU, etc). These instances may
receive a parameter N, specifying the Nth weekday, which could
be positive or negative (like MO(+1) or MO(-2). Not specifying
it is the same as specifying +1. You can also use an integer,
where 0=MO.</dd>
<dt>leapdays:</dt>
<dd>Will add given days to the date found, if year is a leap
year, and the date found is post 28 of february.</dd>
<dt>yearday, nlyearday:</dt>
<dd>Set the yearday or the non-leap year day (jump leap days).
These are converted to day/month/leapdays information.</dd>
</div></blockquote>
<p>Here is the behavior of operations with relativedelta:</p>
<ol class="arabic simple">
<li>Calculate the absolute year, using the &#8216;year&#8217; argument, or the
original datetime year, if the argument is not present.</li>
<li>Add the relative &#8216;years&#8217; argument to the absolute year.</li>
<li>Do steps 1 and 2 for month/months.</li>
<li>Calculate the absolute day, using the &#8216;day&#8217; argument, or the
original datetime day, if the argument is not present. Then,
subtract from the day until it fits in the year and month
found after their operations.</li>
<li>Add the relative &#8216;days&#8217; argument to the absolute day. Notice
that the &#8216;weeks&#8217; argument is multiplied by 7 and added to
&#8216;days&#8217;.</li>
<li>Do steps 1 and 2 for hour/hours, minute/minutes, second/seconds,
microsecond/microseconds.</li>
<li>If the &#8216;weekday&#8217; argument is present, calculate the weekday,
with the given (wday, nth) tuple. wday is the index of the
weekday (0-6, 0=Mon), and nth is the number of weeks to add
forward or backward, depending on its signal. Notice that if
the calculated date is already Monday, for example, using
(0, 1) or (0, -1) won&#8217;t change the day.</li>
<dl class="function">
<dt id="matplotlib.dates.seconds">
<code class="descclassname">matplotlib.dates.</code><code class="descname">seconds</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.seconds" title="Permalink to this definition">¶</a></dt>
<dd><p>Return seconds as days.</p>
<dl class="function">
<dt id="matplotlib.dates.minutes">
<code class="descclassname">matplotlib.dates.</code><code class="descname">minutes</code><span class="sig-paren">(</span><em>m</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.minutes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return minutes as days.</p>
<dl class="function">
<dt id="matplotlib.dates.hours">
<code class="descclassname">matplotlib.dates.</code><code class="descname">hours</code><span class="sig-paren">(</span><em>h</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.hours" title="Permalink to this definition">¶</a></dt>
<dd><p>Return hours as days.</p>
<dl class="function">
<dt id="matplotlib.dates.weeks">
<code class="descclassname">matplotlib.dates.</code><code class="descname">weeks</code><span class="sig-paren">(</span><em>w</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.weeks" title="Permalink to this definition">¶</a></dt>
<dd><p>Return weeks as days.</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 Oct 25, 2014.
      Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.3b2.
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

dates_api.html

Latest commit

History

dates_api.html

File metadata and controls
