-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathdates_api.html
More file actions
1395 lines (1308 loc) · 146 KB
/
dates_api.html
File metadata and controls
1395 lines (1308 loc) · 146 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>matplotlib.dates — Matplotlib 3.4.3 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/mpl.css?v3.4.3-2-ge48e4acce0" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-rendered-html.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.4.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="matplotlib.docstring" href="docstring_api.html" />
<link rel="prev" title="matplotlib.contour" href="contour_api.html" />
<link rel="top" title="Matplotlib 3.4.3 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/dates_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.3). 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>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.4.3</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="docstring_api.html" title="matplotlib.docstring"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="contour_api.html" title="matplotlib.contour"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.dates</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">matplotlib.dates</span></code></a><ul>
<li><a class="reference internal" href="#matplotlib-date-format">Matplotlib date format</a></li>
<li><a class="reference internal" href="#date-tickers">Date tickers</a></li>
<li><a class="reference internal" href="#date-formatters">Date formatters</a></li>
</ul>
</li>
</ul>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/dates_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="matplotlib-dates">
<h1><code class="docutils literal notranslate"><span class="pre">matplotlib.dates</span></code><a class="headerlink" href="#matplotlib-dates" title="Permalink to this headline">¶</a></h1>
<div class="graphviz"><img src="../_images/inheritance-7cb5b23aab984ea1bec93197eb094f726f9f3799.png" alt="Inheritance diagram of matplotlib.dates" usemap="#inheritance1bda3e63b5" class="inheritance graphviz" /></div>
<map id="inheritance1bda3e63b5" name="inheritance1bda3e63b5">
<area shape="rect" id="node1" href="#matplotlib.dates.AutoDateFormatter" target="_top" title="A `.Formatter` which attempts to figure out the best format to use.  This" alt="" coords="313,71,445,92"/>
<area shape="rect" id="node2" href="ticker_api.html#matplotlib.ticker.Formatter" target="_top" title="Create a string based on a tick value and location." alt="" coords="185,140,259,160"/>
<area shape="rect" id="node7" href="#matplotlib.dates.ConciseDateFormatter" target="_top" title="A `.Formatter` which attempts to figure out the best format to use for the" alt="" coords="302,106,455,126"/>
<area shape="rect" id="node9" href="#matplotlib.dates.DateFormatter" target="_top" title="Format a tick (in days since the epoch) with a" alt="" coords="327,140,430,160"/>
<area shape="rect" id="node15" href="#matplotlib.dates.IndexDateFormatter" target="_top" title="[*Deprecated*] Use with `.IndexLocator` to cycle format strings by index." alt="" coords="309,174,448,194"/>
<area shape="rect" id="node3" href="#matplotlib.dates.AutoDateLocator" target="_top" title="On autoscale, this class picks the best `DateLocator` to set the view" alt="" coords="493,157,611,177"/>
<area shape="rect" id="node4" href="#matplotlib.dates.DateLocator" target="_top" title="Determines the tick locations when plotting dates." alt="" coords="334,208,423,228"/>
<area shape="rect" id="node12" href="#matplotlib.dates.RRuleLocator" target="_top" title="RRuleLocator" alt="" coords="504,191,599,211"/>
<area shape="rect" id="node16" href="#matplotlib.dates.MicrosecondLocator" target="_top" title="Make ticks on regular intervals of one or more microsecond(s)." alt="" coords="483,225,620,245"/>
<area shape="rect" id="node21" href="#matplotlib.dates.YearLocator" target="_top" title="Make ticks on a given day of each year that is a multiple of base." alt="" coords="509,259,594,280"/>
<area shape="rect" id="node5" href="#matplotlib.dates.ConciseDateConverter" target="_top" title="ConciseDateConverter" alt="" coords="302,37,455,57"/>
<area shape="rect" id="node6" href="#matplotlib.dates.DateConverter" target="_top" title="Converter for `datetime.date` and `datetime.datetime` data, or for" alt="" coords="170,37,274,57"/>
<area shape="rect" id="node8" href="units_api.html#matplotlib.units.ConversionInterface" target="_top" title="The minimal interface for a converter to take custom data types (or" alt="" coords="3,37,142,57"/>
<area shape="rect" id="node10" href="ticker_api.html#matplotlib.ticker.Locator" target="_top" title="Determine the tick locations;" alt="" coords="192,191,252,211"/>
<area shape="rect" id="node11" href="#matplotlib.dates.DayLocator" target="_top" title="Make ticks on occurrences of each day of the month.  For example," alt="" coords="665,106,749,126"/>
<area shape="rect" id="node14" href="#matplotlib.dates.HourLocator" target="_top" title="Make ticks on occurrences of each hour." alt="" coords="662,140,752,160"/>
<area shape="rect" id="node17" href="#matplotlib.dates.MinuteLocator" target="_top" title="Make ticks on occurrences of each minute." alt="" coords="656,174,758,194"/>
<area shape="rect" id="node18" href="#matplotlib.dates.MonthLocator" target="_top" title="Make ticks on occurrences of each month, e.g., 1, 3, 12." alt="" coords="657,208,756,228"/>
<area shape="rect" id="node19" href="#matplotlib.dates.SecondLocator" target="_top" title="Make ticks on occurrences of each second." alt="" coords="653,242,760,262"/>
<area shape="rect" id="node20" href="#matplotlib.dates.WeekdayLocator" target="_top" title="Make ticks on occurrences of each weekday." alt="" coords="648,276,765,297"/>
<area shape="rect" id="node13" href="ticker_api.html#matplotlib.ticker.TickHelper" target="_top" title="TickHelper" alt="" coords="33,157,112,177"/>
</map><span class="target" id="module-matplotlib.dates"></span><p>Matplotlib provides sophisticated date plotting capabilities, standing on the
shoulders of python <a class="reference external" href="https://docs.python.org/3/library/datetime.html#module-datetime" title="(in Python v3.9)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">datetime</span></code></a> and the add-on module <code class="xref py py-mod docutils literal notranslate"><span class="pre">dateutil</span></code>.</p>
<div class="section" id="matplotlib-date-format">
<span id="date-format"></span><h2>Matplotlib date format<a class="headerlink" href="#matplotlib-date-format" title="Permalink to this headline">¶</a></h2>
<p>Matplotlib represents dates using floating point numbers specifying the number
of days since a default epoch of 1970-01-01 UTC; for example,
1970-01-01, 06:00 is the floating point number 0.25. The formatters and
locators require the use of <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a> objects, so only dates between
year 0001 and 9999 can be represented. Microsecond precision
is achievable for (approximately) 70 years on either side of the epoch, and
20 microseconds for the rest of the allowable range of dates (year 0001 to
9999). The epoch can be changed at import time via <a class="reference internal" href="#matplotlib.dates.set_epoch" title="matplotlib.dates.set_epoch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dates.set_epoch</span></code></a> or
<code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=dates.epoch#a-sample-matplotlibrc-file"><span class="pre">rcParams["dates.epoch"]</span></a></code> to other dates if necessary; see
<a class="reference internal" href="../gallery/ticks_and_spines/date_precision_and_epochs.html"><span class="doc">Date Precision and Epochs</span></a> for a discussion.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Before Matplotlib 3.3, the epoch was 0000-12-31 which lost modern
microsecond precision and also made the default axis limit of 0 an invalid
datetime. In 3.3 the epoch was changed as above. To convert old
ordinal floats to the new epoch, users can do:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">new_ordinal</span> <span class="o">=</span> <span class="n">old_ordinal</span> <span class="o">+</span> <span class="n">mdates</span><span class="o">.</span><span class="n">date2num</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">datetime64</span><span class="p">(</span><span class="s1">'0000-12-31'</span><span class="p">))</span>
</pre></div>
</div>
</div>
<p>There are a number of helper functions to convert between <a class="reference external" href="https://docs.python.org/3/library/datetime.html#module-datetime" title="(in Python v3.9)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">datetime</span></code></a>
objects and Matplotlib dates:</p>
<table border="1" class="longtable docutils align-default">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.dates.datestr2num" title="matplotlib.dates.datestr2num"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datestr2num</span></code></a></td>
<td>Convert a date string to a datenum using <a class="reference external" href="https://dateutil.readthedocs.io/en/stable/parser.html#dateutil.parser.parse" title="(in dateutil v2.8.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dateutil.parser.parse</span></code></a>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.dates.date2num" title="matplotlib.dates.date2num"><code class="xref py py-obj docutils literal notranslate"><span class="pre">date2num</span></code></a></td>
<td>Convert datetime objects to Matplotlib dates.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.dates.num2date" title="matplotlib.dates.num2date"><code class="xref py py-obj docutils literal notranslate"><span class="pre">num2date</span></code></a></td>
<td>Convert Matplotlib dates to <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime</span></code></a> objects.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.dates.num2timedelta" title="matplotlib.dates.num2timedelta"><code class="xref py py-obj docutils literal notranslate"><span class="pre">num2timedelta</span></code></a></td>
<td>Convert number of days to a <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.timedelta" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timedelta</span></code></a> object.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.dates.drange" title="matplotlib.dates.drange"><code class="xref py py-obj docutils literal notranslate"><span class="pre">drange</span></code></a></td>
<td>Return a sequence of equally spaced Matplotlib dates.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.dates.set_epoch" title="matplotlib.dates.set_epoch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_epoch</span></code></a></td>
<td>Set the epoch (origin for dates) for datetime calculations.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.dates.get_epoch" title="matplotlib.dates.get_epoch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_epoch</span></code></a></td>
<td>Get the epoch used by <a class="reference internal" href="#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dates</span></code></a>.</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Like Python's <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a>, Matplotlib 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 Matplotlib 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-default notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">date</span><span class="p">(</span><span class="mi">2006</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">toordinal</span><span class="p">()</span> <span class="o">-</span> <span class="n">date</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">toordinal</span><span class="p">()</span>
<span class="n">Out</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="mi">732401</span>
</pre></div>
</div>
</div>
<p>All the Matplotlib date converters, tickers and formatters are timezone aware.
If no explicit timezone is provided, <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=timezone#a-sample-matplotlibrc-file"><span class="pre">rcParams["timezone"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'UTC'</span></code>) is assumed. If you want to
use a custom time zone, pass a <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.tzinfo" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.tzinfo</span></code></a> instance with the tz keyword
argument to <a class="reference internal" href="#matplotlib.dates.num2date" title="matplotlib.dates.num2date"><code class="xref py py-obj docutils literal notranslate"><span class="pre">num2date</span></code></a>, <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.plot_date.html#matplotlib.axes.Axes.plot_date" title="matplotlib.axes.Axes.plot_date"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_date</span></code></a>, and any custom date tickers or
locators you create.</p>
<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 notranslate"><span class="pre">matplotlib.ticker</span></code></a> for general information on tick locators
and formatters. These are described below.</p>
<p>The <a class="reference external" href="https://dateutil.readthedocs.io">dateutil</a> module provides additional code to handle date ticking, making it
easy to place ticks on any kinds of dates. See examples below.</p>
</div>
<div class="section" id="date-tickers">
<h2>Date tickers<a class="headerlink" href="#date-tickers" title="Permalink to this headline">¶</a></h2>
<p>Most of the date tickers can locate single or multiple values. For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># 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="c1"># 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="c1"># 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>
</div>
<p>In addition, most of the constructors take an interval argument:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># 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>
</div>
<p>The rrule locator allows completely general date ticking:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># 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>
</div>
<p>The available date tickers are:</p>
<ul class="simple">
<li><a class="reference internal" href="#matplotlib.dates.MicrosecondLocator" title="matplotlib.dates.MicrosecondLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MicrosecondLocator</span></code></a>: Locate microseconds.</li>
<li><a class="reference internal" href="#matplotlib.dates.SecondLocator" title="matplotlib.dates.SecondLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SecondLocator</span></code></a>: Locate seconds.</li>
<li><a class="reference internal" href="#matplotlib.dates.MinuteLocator" title="matplotlib.dates.MinuteLocator"><code class="xref py py-obj docutils literal notranslate"><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-obj docutils literal notranslate"><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-obj docutils literal notranslate"><span class="pre">DayLocator</span></code></a>: Locate specified days of the month.</li>
<li><a class="reference internal" href="#matplotlib.dates.WeekdayLocator" title="matplotlib.dates.WeekdayLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WeekdayLocator</span></code></a>: Locate days of the week, e.g., MO, TU.</li>
<li><a class="reference internal" href="#matplotlib.dates.MonthLocator" title="matplotlib.dates.MonthLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MonthLocator</span></code></a>: Locate months, e.g., 7 for July.</li>
<li><a class="reference internal" href="#matplotlib.dates.YearLocator" title="matplotlib.dates.YearLocator"><code class="xref py py-obj docutils literal notranslate"><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-obj docutils literal notranslate"><span class="pre">RRuleLocator</span></code></a>: Locate using a <code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.dates.rrulewrapper</span></code>.
<code class="xref py py-obj docutils literal notranslate"><span class="pre">rrulewrapper</span></code> is a simple wrapper around <a class="reference external" href="https://dateutil.readthedocs.io">dateutil</a>'s <a class="reference external" href="https://dateutil.readthedocs.io/en/stable/rrule.html#module-dateutil.rrule" title="(in dateutil v2.8.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dateutil.rrule</span></code></a> which
allow almost arbitrary date tick specifications. See <a class="reference internal" href="../gallery/ticks_and_spines/date_demo_rrule.html"><span class="doc">rrule example</span></a>.</li>
<li><a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AutoDateLocator</span></code></a>: On autoscale, this class picks the best <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DateLocator</span></code></a>
(e.g., <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RRuleLocator</span></code></a>) to set the view limits and the tick locations. If
called with <code class="docutils literal notranslate"><span class="pre">interval_multiples=True</span></code> it will make ticks line up with
sensible multiples of the tick intervals. E.g. if the interval is 4 hours,
it will pick hours 0, 4, 8, etc as ticks. This behaviour is not guaranteed
by default.</li>
</ul>
</div>
<div class="section" id="date-formatters">
<h2>Date formatters<a class="headerlink" href="#date-formatters" title="Permalink to this headline">¶</a></h2>
<p>The available date formatters are:</p>
<ul class="simple">
<li><a class="reference internal" href="#matplotlib.dates.AutoDateFormatter" title="matplotlib.dates.AutoDateFormatter"><code class="xref py py-obj docutils literal notranslate"><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-obj docutils literal notranslate"><span class="pre">AutoDateLocator</span></code></a>.</li>
<li><a class="reference internal" href="#matplotlib.dates.ConciseDateFormatter" title="matplotlib.dates.ConciseDateFormatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ConciseDateFormatter</span></code></a>: also attempts to figure out the best format to use,
and to make the format as compact as possible while still having complete
date information. 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-obj docutils literal notranslate"><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-obj docutils literal notranslate"><span class="pre">DateFormatter</span></code></a>: use <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime.strftime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">strftime</span></code></a> format strings.</li>
<li><a class="reference internal" href="#matplotlib.dates.IndexDateFormatter" title="matplotlib.dates.IndexDateFormatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IndexDateFormatter</span></code></a>: date plots with implicit <em>x</em> indexing.</li>
</ul>
<dl class="py 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><span class="n">locator</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">defaultfmt</span><span class="o">=</span><span class="default_value">'%Y-%m-%d'</span></em>, <em><span class="o">*</span></em>, <em><span class="n">usetex</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#AutoDateFormatter"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>A <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Formatter</span></code></a> which 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-obj docutils literal notranslate"><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-default notranslate"><div class="highlight"><pre><span></span><span class="bp">self</span><span class="o">.</span><span class="n">scaled</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">DAYS_PER_YEAR</span><span class="p">:</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.year'</span><span class="p">],</span>
<span class="n">DAYS_PER_MONTH</span><span class="p">:</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.month'</span><span class="p">],</span>
<span class="mf">1.0</span><span class="p">:</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.day'</span><span class="p">],</span>
<span class="mf">1.</span> <span class="o">/</span> <span class="n">HOURS_PER_DAY</span><span class="p">:</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.hour'</span><span class="p">],</span>
<span class="mf">1.</span> <span class="o">/</span> <span class="p">(</span><span class="n">MINUTES_PER_DAY</span><span class="p">):</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.minute'</span><span class="p">],</span>
<span class="mf">1.</span> <span class="o">/</span> <span class="p">(</span><span class="n">SEC_PER_DAY</span><span class="p">):</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.second'</span><span class="p">],</span>
<span class="mf">1.</span> <span class="o">/</span> <span class="p">(</span><span class="n">MUSECONDS_PER_DAY</span><span class="p">):</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.microsecond'</span><span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The algorithm picks the key in the dictionary that is >= the
current scale and uses that format string. You can customize this
dictionary by doing:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">locator</span> <span class="o">=</span> <span class="n">AutoDateLocator</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">formatter</span> <span class="o">=</span> <span class="n">AutoDateFormatter</span><span class="p">(</span><span class="n">locator</span><span class="p">)</span>
<span class="gp">>>> </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="s1">'%M:%S'</span> <span class="c1"># only show min and sec</span>
</pre></div>
</div>
<p>A custom <a class="reference internal" href="ticker_api.html#matplotlib.ticker.FuncFormatter" title="matplotlib.ticker.FuncFormatter"><code class="xref py py-obj docutils literal notranslate"><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-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </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="kc">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="s1">'%D %H:%M:%S.</span><span class="si">%f</span><span class="s1">'</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="s1">'%H:%M:%S.</span><span class="si">%f</span><span class="s1">'</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="s2">"0"</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="s2">"."</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">label</span>
<span class="gp">>>> </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">>>> </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>
</div>
<p>Autoformat the date labels.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>locator</strong><span class="classifier"><a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ticker.Locator</span></code></a></span></dt><dd><p>Locator that this axis is using.</p>
</dd>
<dt><strong>tz</strong><span class="classifier">str, optional</span></dt><dd><p>Passed to <a class="reference internal" href="#matplotlib.dates.date2num" title="matplotlib.dates.date2num"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dates.date2num</span></code></a>.</p>
</dd>
<dt><strong>defaultfmt</strong><span class="classifier">str</span></dt><dd><p>The default format to use if none of the values in <code class="docutils literal notranslate"><span class="pre">self.scaled</span></code>
are greater than the unit returned by <code class="docutils literal notranslate"><span class="pre">locator._get_unit()</span></code>.</p>
</dd>
<dt><strong>usetex</strong><span class="classifier">bool, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=text.usetex#a-sample-matplotlibrc-file"><span class="pre">rcParams["text.usetex"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>)</span></dt><dd><p>To enable/disable the use of TeX's math mode for rendering the
results of the formatter. If any entries in <code class="docutils literal notranslate"><span class="pre">self.scaled</span></code> are set
as functions, then it is up to the customized function to enable or
disable TeX's math mode itself.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py 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><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">minticks</span><span class="o">=</span><span class="default_value">5</span></em>, <em><span class="n">maxticks</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">interval_multiples</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#AutoDateLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><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-obj docutils literal notranslate"><span class="pre">DateLocator</span></code></a> to set the view
limits and the tick locations.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Attributes:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>intervald</strong><span class="classifier">dict</span></dt><dd><p>Mapping of tick frequencies to multiples allowed for that ticking.
The default is</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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="mi">21</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>
</div>
<p>where the keys are defined in <a class="reference external" href="https://dateutil.readthedocs.io/en/stable/rrule.html#module-dateutil.rrule" title="(in dateutil v2.8.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dateutil.rrule</span></code></a>.</p>
<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.</p>
<p>When customizing, you should only modify the values for the existing
keys. You should not add or delete entries.</p>
<p>Example for forcing ticks every 3 hours:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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="c1"># only show every 3 hours</span>
</pre></div>
</div>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>tz</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.tzinfo" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.tzinfo</span></code></a></span></dt><dd><p>Ticks timezone.</p>
</dd>
<dt><strong>minticks</strong><span class="classifier">int</span></dt><dd><p>The minimum number of ticks desired; controls whether ticks occur
yearly, monthly, etc.</p>
</dd>
<dt><strong>maxticks</strong><span class="classifier">int</span></dt><dd><p>The maximum number of ticks desired; controls the interval between
ticks (ticking every other, every 3, etc.). For 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-obj docutils literal notranslate"><span class="pre">AutoDateFormatter</span></code></a>. Any
frequency not specified in this dictionary is given a default
value.</p>
</dd>
<dt><strong>interval_multiples</strong><span class="classifier">bool, default: True</span></dt><dd><p>Whether ticks should be chosen to be multiple of the interval,
locking them to 'nicer' 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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.dates.AutoDateLocator.get_locator">
<code class="descname">get_locator</code><span class="sig-paren">(</span><em><span class="n">dmin</span></em>, <em><span class="n">dmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#AutoDateLocator.get_locator"><span class="viewcode-link">[source]</span></a><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>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.AutoDateLocator.nonsingular">
<code class="descname">nonsingular</code><span class="sig-paren">(</span><em><span class="n">vmin</span></em>, <em><span class="n">vmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#AutoDateLocator.nonsingular"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.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>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.AutoDateLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em><span class="n">vmin</span></em>, <em><span class="n">vmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#AutoDateLocator.tick_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.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 notranslate"><span class="pre">axis</span></code> simply call
the Locator instance:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </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"><type 'Locator'></span>
<span class="gp">>>> </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>
</div>
</div>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.dates.ConciseDateConverter">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">ConciseDateConverter</code><span class="sig-paren">(</span><em><span class="n">formats</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">zero_formats</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">offset_formats</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">show_offset</span><span class="o">=</span><span class="default_value">True</span></em>, <em><span class="o">*</span></em>, <em><span class="n">interval_multiples</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#ConciseDateConverter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.ConciseDateConverter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.DateConverter" title="matplotlib.dates.DateConverter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.dates.DateConverter</span></code></a></p>
<dl class="py method">
<dt id="matplotlib.dates.ConciseDateConverter.axisinfo">
<code class="descname">axisinfo</code><span class="sig-paren">(</span><em><span class="n">unit</span></em>, <em><span class="n">axis</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#ConciseDateConverter.axisinfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.ConciseDateConverter.axisinfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="units_api.html#matplotlib.units.AxisInfo" title="matplotlib.units.AxisInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AxisInfo</span></code></a> for <em>unit</em>.</p>
<p><em>unit</em> is a tzinfo instance or None.
The <em>axis</em> argument is required but not used.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.dates.ConciseDateFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">ConciseDateFormatter</code><span class="sig-paren">(</span><em><span class="n">locator</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">formats</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">offset_formats</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">zero_formats</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">show_offset</span><span class="o">=</span><span class="default_value">True</span></em>, <em><span class="o">*</span></em>, <em><span class="n">usetex</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#ConciseDateFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.ConciseDateFormatter" 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 notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>A <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Formatter</span></code></a> which attempts to figure out the best format to use for the
date, and to make it as compact as possible, but still be complete. 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-obj docutils literal notranslate"><span class="pre">AutoDateLocator</span></code></a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">locator</span> <span class="o">=</span> <span class="n">AutoDateLocator</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">formatter</span> <span class="o">=</span> <span class="n">ConciseDateFormatter</span><span class="p">(</span><span class="n">locator</span><span class="p">)</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>locator</strong><span class="classifier"><a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ticker.Locator</span></code></a></span></dt><dd><p>Locator that this axis is using.</p>
</dd>
<dt><strong>tz</strong><span class="classifier">str, optional</span></dt><dd><p>Passed to <a class="reference internal" href="#matplotlib.dates.date2num" title="matplotlib.dates.date2num"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dates.date2num</span></code></a>.</p>
</dd>
<dt><strong>formats</strong><span class="classifier">list of 6 strings, optional</span></dt><dd><p>Format strings for 6 levels of tick labelling: mostly years,
months, days, hours, minutes, and seconds. Strings use
the same format codes as <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime.strftime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">strftime</span></code></a>. Default is
<code class="docutils literal notranslate"><span class="pre">['%Y',</span> <span class="pre">'%b',</span> <span class="pre">'%d',</span> <span class="pre">'%H:%M',</span> <span class="pre">'%H:%M',</span> <span class="pre">'%S.%f']</span></code></p>
</dd>
<dt><strong>zero_formats</strong><span class="classifier">list of 6 strings, optional</span></dt><dd><p>Format strings for tick labels that are "zeros" for a given tick
level. For instance, if most ticks are months, ticks around 1 Jan 2005
will be labeled "Dec", "2005", "Feb". The default is
<code class="docutils literal notranslate"><span class="pre">['',</span> <span class="pre">'%Y',</span> <span class="pre">'%b',</span> <span class="pre">'%b-%d',</span> <span class="pre">'%H:%M',</span> <span class="pre">'%H:%M']</span></code></p>
</dd>
<dt><strong>offset_formats</strong><span class="classifier">list of 6 strings, optional</span></dt><dd><p>Format strings for the 6 levels that is applied to the "offset"
string found on the right side of an x-axis, or top of a y-axis.
Combined with the tick labels this should completely specify the
date. The default is:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="s1">''</span><span class="p">,</span> <span class="s1">'%Y'</span><span class="p">,</span> <span class="s1">'%Y-%b'</span><span class="p">,</span> <span class="s1">'%Y-%b-</span><span class="si">%d</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'%Y-%b-</span><span class="si">%d</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'%Y-%b-</span><span class="si">%d</span><span class="s1"> %H:%M'</span><span class="p">]</span>
</pre></div>
</div>
</dd>
<dt><strong>show_offset</strong><span class="classifier">bool, default: True</span></dt><dd><p>Whether to show the offset or not.</p>
</dd>
<dt><strong>usetex</strong><span class="classifier">bool, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=text.usetex#a-sample-matplotlibrc-file"><span class="pre">rcParams["text.usetex"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>)</span></dt><dd><p>To enable/disable the use of TeX's math mode for rendering the results
of the formatter.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<p>See <a class="reference internal" href="../gallery/ticks_and_spines/date_concise_formatter.html"><span class="doc">Formatting date ticks using ConciseDateFormatter</span></a></p>
<p>(<a class="reference external" href="../api/dates_api-1.py">Source code</a>, <a class="reference external" href="../api/dates_api-1.png">png</a>, <a class="reference external" href="../api/dates_api-1.pdf">pdf</a>)</p>
<div class="figure align-default">
<img alt="../_images/dates_api-1.png" class="plot-directive" src="../_images/dates_api-1.png" />
</div>
<p>Autoformat the date labels. The default format is used to form an
initial string, and then redundant elements are removed.</p>
<dl class="py method">
<dt id="matplotlib.dates.ConciseDateFormatter.format_data_short">
<code class="descname">format_data_short</code><span class="sig-paren">(</span><em><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#ConciseDateFormatter.format_data_short"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.ConciseDateFormatter.format_data_short" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a short string version of the tick value.</p>
<p>Defaults to the position-independent long value.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.ConciseDateFormatter.format_ticks">
<code class="descname">format_ticks</code><span class="sig-paren">(</span><em><span class="n">values</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#ConciseDateFormatter.format_ticks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.ConciseDateFormatter.format_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tick labels for all the ticks at once.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.ConciseDateFormatter.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#ConciseDateFormatter.get_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.ConciseDateFormatter.get_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.dates.DateConverter">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">DateConverter</code><span class="sig-paren">(</span><em><span class="o">*</span></em>, <em><span class="n">interval_multiples</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DateConverter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.DateConverter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="units_api.html#matplotlib.units.ConversionInterface" title="matplotlib.units.ConversionInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.units.ConversionInterface</span></code></a></p>
<p>Converter for <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.date" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.date</span></code></a> and <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a> data, or for
date/time data represented as it would be converted by <a class="reference internal" href="#matplotlib.dates.date2num" title="matplotlib.dates.date2num"><code class="xref py py-obj docutils literal notranslate"><span class="pre">date2num</span></code></a>.</p>
<p>The 'unit' tag for such data is None or a tzinfo instance.</p>
<dl class="py method">
<dt id="matplotlib.dates.DateConverter.axisinfo">
<code class="descname">axisinfo</code><span class="sig-paren">(</span><em><span class="n">unit</span></em>, <em><span class="n">axis</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DateConverter.axisinfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.DateConverter.axisinfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="units_api.html#matplotlib.units.AxisInfo" title="matplotlib.units.AxisInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AxisInfo</span></code></a> for <em>unit</em>.</p>
<p><em>unit</em> is a tzinfo instance or None.
The <em>axis</em> argument is required but not used.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.DateConverter.convert">
<em class="property">static </em><code class="descname">convert</code><span class="sig-paren">(</span><em><span class="n">value</span></em>, <em><span class="n">unit</span></em>, <em><span class="n">axis</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DateConverter.convert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.DateConverter.convert" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>value</em> is not already a number or sequence of numbers, convert it
with <a class="reference internal" href="#matplotlib.dates.date2num" title="matplotlib.dates.date2num"><code class="xref py py-obj docutils literal notranslate"><span class="pre">date2num</span></code></a>.</p>
<p>The <em>unit</em> and <em>axis</em> arguments are not used.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.DateConverter.default_units">
<em class="property">static </em><code class="descname">default_units</code><span class="sig-paren">(</span><em><span class="n">x</span></em>, <em><span class="n">axis</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DateConverter.default_units"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.DateConverter.default_units" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tzinfo instance of <em>x</em> or of its first element, or None</p>
</dd></dl>
</dd></dl>
<dl class="py 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><span class="n">fmt</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="o">*</span></em>, <em><span class="n">usetex</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DateFormatter"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Format a tick (in days since the epoch) with a
<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime.strftime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">strftime</span></code></a> format string.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>fmt</strong><span class="classifier">str</span></dt><dd><p><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime.strftime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">strftime</span></code></a> format string</p>
</dd>
<dt><strong>tz</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.tzinfo" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.tzinfo</span></code></a>, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=timezone#a-sample-matplotlibrc-file"><span class="pre">rcParams["timezone"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'UTC'</span></code>)</span></dt><dd><p>Ticks timezone.</p>
</dd>
<dt><strong>usetex</strong><span class="classifier">bool, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=text.usetex#a-sample-matplotlibrc-file"><span class="pre">rcParams["text.usetex"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>)</span></dt><dd><p>To enable/disable the use of TeX's math mode for rendering the
results of the formatter.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.dates.DateFormatter.illegal_s">
<em class="property">property </em><code class="descname">illegal_s</code><a class="headerlink" href="#matplotlib.dates.DateFormatter.illegal_s" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.DateFormatter.set_tzinfo">
<code class="descname">set_tzinfo</code><span class="sig-paren">(</span><em><span class="n">tz</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DateFormatter.set_tzinfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.DateFormatter.set_tzinfo" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py 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><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DateLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Determines the tick locations when plotting dates.</p>
<p>This class is subclassed by other Locators and
is not meant to be used on its own.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>tz</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.tzinfo" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.tzinfo</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py 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="reference internal" href="../_modules/matplotlib/dates.html#DateLocator.datalim_to_dt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.DateLocator.datalim_to_dt" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert axis data interval to datetime objects.</p>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.dates.DateLocator.hms0d">
<code class="descname">hms0d</code><em class="property"> = {'byhour': 0, 'byminute': 0, 'bysecond': 0}</em><a class="headerlink" href="#matplotlib.dates.DateLocator.hms0d" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.DateLocator.nonsingular">
<code class="descname">nonsingular</code><span class="sig-paren">(</span><em><span class="n">vmin</span></em>, <em><span class="n">vmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DateLocator.nonsingular"><span class="viewcode-link">[source]</span></a><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>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.DateLocator.set_tzinfo">
<code class="descname">set_tzinfo</code><span class="sig-paren">(</span><em><span class="n">tz</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DateLocator.set_tzinfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.DateLocator.set_tzinfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Set time zone info.</p>
</dd></dl>
<dl class="py 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="reference internal" href="../_modules/matplotlib/dates.html#DateLocator.viewlim_to_dt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.DateLocator.viewlim_to_dt" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the view interval to datetime objects.</p>
</dd></dl>
</dd></dl>
<dl class="py 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><span class="n">bymonthday</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">interval</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#DayLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurrences 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 notranslate"><span class="pre">bymonthday=range(1,</span> <span class="pre">32)</span></code>.</p>
</dd></dl>
<dl class="py 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><span class="n">byhour</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">interval</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#HourLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurrences 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 notranslate"><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 notranslate"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
</dd></dl>
<dl class="py 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><span class="n">t</span></em>, <em><span class="n">fmt</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#IndexDateFormatter"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>[<em>Deprecated</em>] Use with <a class="reference internal" href="ticker_api.html#matplotlib.ticker.IndexLocator" title="matplotlib.ticker.IndexLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IndexLocator</span></code></a> to cycle format strings by index.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3.</span></p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>t</strong><span class="classifier">list of float</span></dt><dd><p>A sequence of dates (floating point days).</p>
</dd>
<dt><strong>fmt</strong><span class="classifier">str</span></dt><dd><p>A <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime.strftime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">strftime</span></code></a> format string.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py 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><span class="n">interval</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#MicrosecondLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<p>Make ticks on regular intervals of one or more microsecond(s).</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>By default, Matplotlib uses a floating point representation of time in
days since the epoch, so plotting data with
microsecond time resolution does not work well for
dates that are far (about 70 years) from the epoch (check with
<a class="reference internal" href="#matplotlib.dates.get_epoch" title="matplotlib.dates.get_epoch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_epoch</span></code></a>).</p>
<p>If you want sub-microsecond resolution time plots, it is strongly
recommended to use floating point seconds, not datetime-like
time representation.</p>
<p class="last">If you really must use datetime.datetime() or similar and still
need microsecond precision, change the time origin via
<a class="reference internal" href="#matplotlib.dates.set_epoch" title="matplotlib.dates.set_epoch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dates.set_epoch</span></code></a> to something closer to the dates being plotted.
See <a class="reference internal" href="../gallery/ticks_and_spines/date_precision_and_epochs.html"><span class="doc">Date Precision and Epochs</span></a>.</p>
</div>
<p><em>interval</em> is the interval between each iteration. For
example, if <code class="docutils literal notranslate"><span class="pre">interval=2</span></code>, mark every second microsecond.</p>
<dl class="py method">
<dt id="matplotlib.dates.MicrosecondLocator.set_axis">
<code class="descname">set_axis</code><span class="sig-paren">(</span><em><span class="n">axis</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#MicrosecondLocator.set_axis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.set_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.MicrosecondLocator.set_data_interval">
<code class="descname">set_data_interval</code><span class="sig-paren">(</span><em><span class="n">vmin</span></em>, <em><span class="n">vmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#MicrosecondLocator.set_data_interval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.set_data_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.MicrosecondLocator.set_view_interval">
<code class="descname">set_view_interval</code><span class="sig-paren">(</span><em><span class="n">vmin</span></em>, <em><span class="n">vmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#MicrosecondLocator.set_view_interval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.MicrosecondLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em><span class="n">vmin</span></em>, <em><span class="n">vmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#MicrosecondLocator.tick_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.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 notranslate"><span class="pre">axis</span></code> simply call
the Locator instance:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </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"><type 'Locator'></span>
<span class="gp">>>> </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>
</div>
</div>
</dd></dl>
</dd></dl>
<dl class="py 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><span class="n">byminute</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">interval</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#MinuteLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurrences 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 notranslate"><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 notranslate"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
</dd></dl>
<dl class="py 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><span class="n">bymonth</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">bymonthday</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">interval</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#MonthLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurrences of each month, e.g., 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 notranslate"><span class="pre">range(1,</span> <span class="pre">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 notranslate"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
</dd></dl>
<dl class="py 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><span class="n">o</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#RRuleLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>tz</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.tzinfo" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.tzinfo</span></code></a></span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<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><span class="n">freq</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#RRuleLocator.get_unit_generic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.RRuleLocator.get_unit_generic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.dates.RRuleLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em><span class="n">vmin</span></em>, <em><span class="n">vmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#RRuleLocator.tick_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.RRuleLocator.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 notranslate"><span class="pre">axis</span></code> simply call
the Locator instance:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </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"><type 'Locator'></span>
<span class="gp">>>> </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>
</div>
</div>
</dd></dl>
</dd></dl>
<dl class="py 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><span class="n">bysecond</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">interval</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#SecondLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurrences 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 notranslate"><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 notranslate"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
</dd></dl>
<dl class="py 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><span class="n">byweekday</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">interval</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#WeekdayLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurrences 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 <a class="reference external" href="https://dateutil.readthedocs.io/en/stable/rrule.html#module-dateutil.rrule" title="(in dateutil v2.8.2)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dateutil.rrule</span></code></a>, 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 notranslate"><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 notranslate"><span class="pre">interval=2</span></code> plots every second week.</p>
</dd></dl>
<dl class="py 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><span class="n">base</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">month</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">day</span><span class="o">=</span><span class="default_value">1</span></em>, <em><span class="n">tz</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#YearLocator"><span class="viewcode-link">[source]</span></a><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 notranslate"><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-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># 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="c1"># 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>
</div>
<p>Mark years that are multiple of base on a given month and day
(default jan 1).</p>
<dl class="py method">
<dt id="matplotlib.dates.YearLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em><span class="n">vmin</span></em>, <em><span class="n">vmax</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#YearLocator.tick_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.YearLocator.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 notranslate"><span class="pre">axis</span></code> simply call
the Locator instance:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </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"><type 'Locator'></span>
<span class="gp">>>> </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>
</div>
</div>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.dates.date2num">
<code class="descclassname">matplotlib.dates.</code><code class="descname">date2num</code><span class="sig-paren">(</span><em><span class="n">d</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#date2num"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.date2num" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert datetime objects to Matplotlib dates.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>d</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a> or <a class="reference external" href="https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.datetime64" title="(in NumPy v1.21)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.datetime64</span></code></a> or sequences of these</span></dt><dd></dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>float or sequence of floats</dt><dd><p>Number of days since the epoch. See <a class="reference internal" href="#matplotlib.dates.get_epoch" title="matplotlib.dates.get_epoch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_epoch</span></code></a> for the
epoch, which can be changed by <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=date.epoch#a-sample-matplotlibrc-file"><span class="pre">rcParams["date.epoch"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'1970-01-01T00:00:00'</span></code>) or <a class="reference internal" href="#matplotlib.dates.set_epoch" title="matplotlib.dates.set_epoch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_epoch</span></code></a>. If
the epoch is "1970-01-01T00:00:00" (default) then noon Jan 1 1970
("1970-01-01T12:00:00") returns 0.5.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>The Gregorian calendar is assumed; this is not universal practice.
For details see the module docstring.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.dates.datestr2num">
<code class="descclassname">matplotlib.dates.</code><code class="descname">datestr2num</code><span class="sig-paren">(</span><em><span class="n">d</span></em>, <em><span class="n">default</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#datestr2num"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.datestr2num" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert a date string to a datenum using <a class="reference external" href="https://dateutil.readthedocs.io/en/stable/parser.html#dateutil.parser.parse" title="(in dateutil v2.8.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dateutil.parser.parse</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>d</strong><span class="classifier">str or sequence of str</span></dt><dd><p>The dates to convert.</p>
</dd>
<dt><strong>default</strong><span class="classifier">datetime.datetime, optional</span></dt><dd><p>The default date to use when fields are missing in <em>d</em>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.dates.drange">
<code class="descclassname">matplotlib.dates.</code><code class="descname">drange</code><span class="sig-paren">(</span><em><span class="n">dstart</span></em>, <em><span class="n">dend</span></em>, <em><span class="n">delta</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#drange"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.drange" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a sequence of equally spaced Matplotlib dates.</p>
<p>The dates start at <em>dstart</em> and reach up to, but not including <em>dend</em>.
They are spaced by <em>delta</em>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>dstart, dend</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime</span></code></a></span></dt><dd><p>The date limits.</p>
</dd>
<dt><strong>delta</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.timedelta" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime.timedelta</span></code></a></span></dt><dd><p>Spacing of the dates.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.array.html#numpy.array" title="(in NumPy v1.21)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.array</span></code></a></dt><dd><p>A list floats representing Matplotlib dates.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.dates.epoch2num">
<code class="descclassname">matplotlib.dates.</code><code class="descname">epoch2num</code><span class="sig-paren">(</span><em><span class="n">e</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/dates.html#epoch2num"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.dates.epoch2num" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert UNIX time to days since Matplotlib epoch.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>e</strong><span class="classifier">list of floats</span></dt><dd><p>Time in seconds since 1970-01-01.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.array.html#numpy.array" title="(in NumPy v1.21)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.array</span></code></a></dt><dd><p>Time in days since Matplotlib epoch (see <a class="reference internal" href="#matplotlib.dates.get_epoch" title="matplotlib.dates.get_epoch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_epoch()</span></code></a>).</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">