-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathticker_api.html
More file actions
1416 lines (1282 loc) · 117 KB
/
ticker_api.html
File metadata and controls
1416 lines (1282 loc) · 117 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="Content-Type" content="text/html; charset=utf-8" />
<title>ticker — Matplotlib 2.2.4 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.4 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="top" title="Matplotlib 2.2.4 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="tight_layout" href="tight_layout_api.html" />
<link rel="prev" title="text" href="text_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/ticker_api.html" />
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.4). For the latest version see <a href="https://matplotlib.org/stable/api/ticker_api.html">https://matplotlib.org/stable/api/ticker_api.html</a></div>
<div 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 2.2.4</span></div>
<img src="../_static/logo2.png" 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>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="tight_layout_api.html" title="tight_layout"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="text_api.html" title="text"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ticker</a><ul>
<li><a class="reference internal" href="#module-matplotlib.ticker"><code class="docutils literal notranslate"><span class="pre">matplotlib.ticker</span></code></a><ul>
<li><a class="reference internal" href="#tick-locating-and-formatting">Tick locating and formatting</a><ul>
<li><a class="reference internal" href="#default-formatter">Default Formatter</a></li>
<li><a class="reference internal" href="#tick-locating">Tick locating</a></li>
<li><a class="reference internal" href="#tick-formatting">Tick formatting</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li>Previous: <a href="text_api.html" title="previous chapter">text</a></li>
<li>Next: <a href="tight_layout_api.html" title="next chapter">tight_layout</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<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/ticker_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">
<div class="section" id="ticker">
<h1>ticker<a class="headerlink" href="#ticker" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.ticker">
<span id="matplotlib-ticker"></span><h2><a class="reference internal" href="#module-matplotlib.ticker" title="matplotlib.ticker"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.ticker</span></code></a><a class="headerlink" href="#module-matplotlib.ticker" title="Permalink to this headline">¶</a></h2>
<div class="section" id="tick-locating-and-formatting">
<h3>Tick locating and formatting<a class="headerlink" href="#tick-locating-and-formatting" title="Permalink to this headline">¶</a></h3>
<p>This module contains classes to support completely configurable tick
locating and formatting. Although the locators know nothing about major
or minor ticks, they are used by the Axis class to support major and
minor tick locating and formatting. Generic tick locators and
formatters are provided, as well as domain specific custom ones.</p>
<div class="section" id="default-formatter">
<h4>Default Formatter<a class="headerlink" href="#default-formatter" title="Permalink to this headline">¶</a></h4>
<p>The default formatter identifies when the x-data being plotted is a
small range on top of a large offset. To reduce the chances that the
ticklabels overlap, the ticks are labeled as deltas from a fixed offset.
For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">2000</span><span class="p">,</span> <span class="mi">2010</span><span class="p">),</span> <span class="nb">range</span><span class="p">(</span><span class="mi">10</span><span class="p">))</span>
</pre></div>
</div>
<p>will have tick of 0-9 with an offset of +2e3. If this is not desired
turn off the use of the offset on the default formatter:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">get_xaxis</span><span class="p">()</span><span class="o">.</span><span class="n">get_major_formatter</span><span class="p">()</span><span class="o">.</span><span class="n">set_useOffset</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
<p>set the rcParam <code class="docutils literal notranslate"><span class="pre">axes.formatter.useoffset=False</span></code> to turn it off
globally, or set a different formatter.</p>
</div>
<div class="section" id="tick-locating">
<h4>Tick locating<a class="headerlink" href="#tick-locating" title="Permalink to this headline">¶</a></h4>
<p>The Locator class is the base class for all tick locators. The locators
handle autoscaling of the view limits based on the data limits, and the
choosing of tick locations. A useful semi-automatic tick locator is
<a class="reference internal" href="#matplotlib.ticker.MultipleLocator" title="matplotlib.ticker.MultipleLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MultipleLocator</span></code></a>. It is initialized with a base, e.g., 10, and it picks
axis limits and ticks that are multiples of that base.</p>
<p>The Locator subclasses defined here are</p>
<dl class="docutils">
<dt><a class="reference internal" href="#matplotlib.ticker.AutoLocator" title="matplotlib.ticker.AutoLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">AutoLocator</span></code></a></dt>
<dd><a class="reference internal" href="#matplotlib.ticker.MaxNLocator" title="matplotlib.ticker.MaxNLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MaxNLocator</span></code></a> with simple defaults. This is the default tick locator for
most plotting.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.MaxNLocator" title="matplotlib.ticker.MaxNLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">MaxNLocator</span></code></a></dt>
<dd>Finds up to a max number of intervals with ticks at nice locations.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LinearLocator" title="matplotlib.ticker.LinearLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinearLocator</span></code></a></dt>
<dd>Space ticks evenly from min to max.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogLocator</span></code></a></dt>
<dd>Space ticks logarithmically from min to max.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.MultipleLocator" title="matplotlib.ticker.MultipleLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultipleLocator</span></code></a></dt>
<dd>Ticks and range are a multiple of base; either integer or float.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.FixedLocator" title="matplotlib.ticker.FixedLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">FixedLocator</span></code></a></dt>
<dd>Tick locations are fixed.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.IndexLocator" title="matplotlib.ticker.IndexLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">IndexLocator</span></code></a></dt>
<dd>Locator for index plots (e.g., where <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">=</span> <span class="pre">range(len(y))</span></code>).</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.NullLocator" title="matplotlib.ticker.NullLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">NullLocator</span></code></a></dt>
<dd>No ticks.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.SymmetricalLogLocator" title="matplotlib.ticker.SymmetricalLogLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">SymmetricalLogLocator</span></code></a></dt>
<dd>Locator for use with with the symlog norm; works like <a class="reference internal" href="#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LogLocator</span></code></a> for the
part outside of the threshold and adds 0 if inside the limits.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LogitLocator" title="matplotlib.ticker.LogitLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogitLocator</span></code></a></dt>
<dd>Locator for logit scaling.</dd>
<dt><code class="xref py py-class docutils literal notranslate"><span class="pre">OldAutoLocator</span></code></dt>
<dd>Choose a <a class="reference internal" href="#matplotlib.ticker.MultipleLocator" title="matplotlib.ticker.MultipleLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MultipleLocator</span></code></a> and dynamically reassign it for intelligent
ticking during navigation.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.AutoMinorLocator" title="matplotlib.ticker.AutoMinorLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">AutoMinorLocator</span></code></a></dt>
<dd>Locator for minor ticks when the axis is linear and the
major ticks are uniformly spaced. Subdivides the major
tick interval into a specified number of minor intervals,
defaulting to 4 or 5 depending on the major interval.</dd>
</dl>
<p>There are a number of locators specialized for date locations - see
the <code class="xref py py-obj docutils literal notranslate"><span class="pre">dates</span></code> module.</p>
<p>You can define your own locator by deriving from Locator. You must
override the <code class="docutils literal notranslate"><span class="pre">__call__</span></code> method, which returns a sequence of locations,
and you will probably want to override the autoscale method to set the
view limits from the data limits.</p>
<p>If you want to override the default locator, use one of the above or a custom
locator and pass it to the x or y axis instance. The relevant methods are:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set_major_locator</span><span class="p">(</span><span class="n">xmajor_locator</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set_minor_locator</span><span class="p">(</span><span class="n">xminor_locator</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">set_major_locator</span><span class="p">(</span><span class="n">ymajor_locator</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">set_minor_locator</span><span class="p">(</span><span class="n">yminor_locator</span><span class="p">)</span>
</pre></div>
</div>
<p>The default minor locator is <a class="reference internal" href="#matplotlib.ticker.NullLocator" title="matplotlib.ticker.NullLocator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NullLocator</span></code></a>, i.e., no minor ticks on by default.</p>
</div>
<div class="section" id="tick-formatting">
<h4>Tick formatting<a class="headerlink" href="#tick-formatting" title="Permalink to this headline">¶</a></h4>
<p>Tick formatting is controlled by classes derived from Formatter. The formatter
operates on a single tick value and returns a string to the axis.</p>
<dl class="docutils">
<dt><a class="reference internal" href="#matplotlib.ticker.NullFormatter" title="matplotlib.ticker.NullFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">NullFormatter</span></code></a></dt>
<dd>No labels on the ticks.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.IndexFormatter" title="matplotlib.ticker.IndexFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">IndexFormatter</span></code></a></dt>
<dd>Set the strings from a list of labels.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.FixedFormatter" title="matplotlib.ticker.FixedFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">FixedFormatter</span></code></a></dt>
<dd>Set the strings manually for the labels.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.FuncFormatter" title="matplotlib.ticker.FuncFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">FuncFormatter</span></code></a></dt>
<dd>User defined function sets the labels.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.StrMethodFormatter" title="matplotlib.ticker.StrMethodFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">StrMethodFormatter</span></code></a></dt>
<dd>Use string <a class="reference external" href="https://docs.python.org/3/library/functions.html#format" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">format</span></code></a> method.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.FormatStrFormatter" title="matplotlib.ticker.FormatStrFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">FormatStrFormatter</span></code></a></dt>
<dd>Use an old-style sprintf format string.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.ScalarFormatter" title="matplotlib.ticker.ScalarFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScalarFormatter</span></code></a></dt>
<dd>Default formatter for scalars: autopick the format string.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LogFormatter" title="matplotlib.ticker.LogFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogFormatter</span></code></a></dt>
<dd>Formatter for log axes.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LogFormatterExponent" title="matplotlib.ticker.LogFormatterExponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogFormatterExponent</span></code></a></dt>
<dd>Format values for log axis using <code class="docutils literal notranslate"><span class="pre">exponent</span> <span class="pre">=</span> <span class="pre">log_base(value)</span></code>.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LogFormatterMathtext" title="matplotlib.ticker.LogFormatterMathtext"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogFormatterMathtext</span></code></a></dt>
<dd>Format values for log axis using <code class="docutils literal notranslate"><span class="pre">exponent</span> <span class="pre">=</span> <span class="pre">log_base(value)</span></code>
using Math text.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LogFormatterSciNotation" title="matplotlib.ticker.LogFormatterSciNotation"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogFormatterSciNotation</span></code></a></dt>
<dd>Format values for log axis using scientific notation.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.LogitFormatter" title="matplotlib.ticker.LogitFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogitFormatter</span></code></a></dt>
<dd>Probability formatter.</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.EngFormatter" title="matplotlib.ticker.EngFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">EngFormatter</span></code></a></dt>
<dd>Format labels in engineering notation</dd>
<dt><a class="reference internal" href="#matplotlib.ticker.PercentFormatter" title="matplotlib.ticker.PercentFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">PercentFormatter</span></code></a></dt>
<dd>Format labels as a percentage</dd>
</dl>
<p>You can derive your own formatter from the Formatter base class by
simply overriding the <code class="docutils literal notranslate"><span class="pre">__call__</span></code> method. The formatter class has
access to the axis view and data limits.</p>
<p>To control the major and minor tick label formats, use one of the
following methods:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set_major_formatter</span><span class="p">(</span><span class="n">xmajor_formatter</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">set_minor_formatter</span><span class="p">(</span><span class="n">xminor_formatter</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">set_major_formatter</span><span class="p">(</span><span class="n">ymajor_formatter</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">set_minor_formatter</span><span class="p">(</span><span class="n">yminor_formatter</span><span class="p">)</span>
</pre></div>
</div>
<p>See <a class="reference internal" href="../gallery/ticks_and_spines/major_minor_demo.html"><span class="doc">Major Minor Demo</span></a> for an
example of setting major and minor ticks. See the <a class="reference internal" href="dates_api.html#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.dates</span></code></a>
module for more information and examples of using date locators and formatters.</p>
<dl class="class">
<dt id="matplotlib.ticker.TickHelper">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">TickHelper</code><a class="reference internal" href="../_modules/matplotlib/ticker.html#TickHelper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.TickHelper" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="attribute">
<dt id="matplotlib.ticker.TickHelper.axis">
<code class="descname">axis</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.ticker.TickHelper.axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.create_dummy_axis">
<code class="descname">create_dummy_axis</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#TickHelper.create_dummy_axis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.TickHelper.create_dummy_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.set_axis">
<code class="descname">set_axis</code><span class="sig-paren">(</span><em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#TickHelper.set_axis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.TickHelper.set_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.set_bounds">
<code class="descname">set_bounds</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#TickHelper.set_bounds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.TickHelper.set_bounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.set_data_interval">
<code class="descname">set_data_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#TickHelper.set_data_interval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.TickHelper.set_data_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.TickHelper.set_view_interval">
<code class="descname">set_view_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#TickHelper.set_view_interval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.TickHelper.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.Formatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">Formatter</code><a class="reference internal" href="../_modules/matplotlib/ticker.html#Formatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Formatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.TickHelper" title="matplotlib.ticker.TickHelper"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.TickHelper</span></code></a></p>
<p>Create a string based on a tick value and location.</p>
<dl class="method">
<dt id="matplotlib.ticker.Formatter.fix_minus">
<code class="descname">fix_minus</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Formatter.fix_minus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Formatter.fix_minus" title="Permalink to this definition">¶</a></dt>
<dd><p>Some classes may want to replace a hyphen for minus with the
proper unicode symbol (U+2212) for typographical correctness.
The default is to not replace it.</p>
<p>Note, if you use this method, e.g., in <a class="reference internal" href="#matplotlib.ticker.Formatter.format_data" title="matplotlib.ticker.Formatter.format_data"><code class="xref py py-meth docutils literal notranslate"><span class="pre">format_data()</span></code></a> or
call, you probably don't want to use it for
<a class="reference internal" href="#matplotlib.ticker.Formatter.format_data_short" title="matplotlib.ticker.Formatter.format_data_short"><code class="xref py py-meth docutils literal notranslate"><span class="pre">format_data_short()</span></code></a> since the toolbar uses this for
interactive coord reporting and I doubt we can expect GUIs
across platforms will handle the unicode correctly. So for
now the classes that override <a class="reference internal" href="#matplotlib.ticker.Formatter.fix_minus" title="matplotlib.ticker.Formatter.fix_minus"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fix_minus()</span></code></a> should have an
explicit <a class="reference internal" href="#matplotlib.ticker.Formatter.format_data_short" title="matplotlib.ticker.Formatter.format_data_short"><code class="xref py py-meth docutils literal notranslate"><span class="pre">format_data_short()</span></code></a> method</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Formatter.format_data">
<code class="descname">format_data</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Formatter.format_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Formatter.format_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the full string representation of the value with the
position unspecified.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Formatter.format_data_short">
<code class="descname">format_data_short</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Formatter.format_data_short"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Formatter.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="method">
<dt id="matplotlib.ticker.Formatter.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Formatter.get_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Formatter.get_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.ticker.Formatter.locs">
<code class="descname">locs</code><em class="property"> = []</em><a class="headerlink" href="#matplotlib.ticker.Formatter.locs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Formatter.set_locs">
<code class="descname">set_locs</code><span class="sig-paren">(</span><em>locs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Formatter.set_locs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Formatter.set_locs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.FixedFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">FixedFormatter</code><span class="sig-paren">(</span><em>seq</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#FixedFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.FixedFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Return fixed strings for tick labels based only on position, not
value.</p>
<p>Set the sequence of strings that will be used for labels.</p>
<dl class="method">
<dt id="matplotlib.ticker.FixedFormatter.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#FixedFormatter.get_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.FixedFormatter.get_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.FixedFormatter.set_offset_string">
<code class="descname">set_offset_string</code><span class="sig-paren">(</span><em>ofs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#FixedFormatter.set_offset_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.FixedFormatter.set_offset_string" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.NullFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">NullFormatter</code><a class="reference internal" href="../_modules/matplotlib/ticker.html#NullFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.NullFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Always return the empty string.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.FuncFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">FuncFormatter</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#FuncFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.FuncFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Use a user-defined function for formatting.</p>
<p>The function should take in two inputs (a tick value <code class="docutils literal notranslate"><span class="pre">x</span></code> and a
position <code class="docutils literal notranslate"><span class="pre">pos</span></code>), and return a string containing the corresponding
tick label.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.FormatStrFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">FormatStrFormatter</code><span class="sig-paren">(</span><em>fmt</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#FormatStrFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.FormatStrFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Use an old-style ('%' operator) format string to format the tick.</p>
<p>The format string should have a single variable format (%) in it.
It will be applied to the value (not the position) of the tick.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.StrMethodFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">StrMethodFormatter</code><span class="sig-paren">(</span><em>fmt</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#StrMethodFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.StrMethodFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Use a new-style format string (as used by <code class="xref py py-obj docutils literal notranslate"><span class="pre">str.format()</span></code>)
to format the tick.</p>
<p>The field used for the value must be labeled <code class="xref py py-obj docutils literal notranslate"><span class="pre">x</span></code> and the field used
for the position must be labeled <code class="xref py py-obj docutils literal notranslate"><span class="pre">pos</span></code>.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.ScalarFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">ScalarFormatter</code><span class="sig-paren">(</span><em>useOffset=None</em>, <em>useMathText=None</em>, <em>useLocale=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Format tick values as a number.</p>
<p>Tick value is interpreted as a plain old number. If
<code class="docutils literal notranslate"><span class="pre">useOffset==True</span></code> and the data range is much smaller than the data
average, then an offset will be determined such that the tick labels
are meaningful. Scientific notation is used for <code class="docutils literal notranslate"><span class="pre">data</span> <span class="pre"><</span> <span class="pre">10^-n</span></code> or
<code class="docutils literal notranslate"><span class="pre">data</span> <span class="pre">>=</span> <span class="pre">10^m</span></code>, where <code class="docutils literal notranslate"><span class="pre">n</span></code> and <code class="docutils literal notranslate"><span class="pre">m</span></code> are the power limits set
using <code class="docutils literal notranslate"><span class="pre">set_powerlimits((n,m))</span></code>. The defaults for these are
controlled by the <code class="docutils literal notranslate"><span class="pre">axes.formatter.limits</span></code> rc parameter.</p>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.fix_minus">
<code class="descname">fix_minus</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.fix_minus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.fix_minus" title="Permalink to this definition">¶</a></dt>
<dd><p>Replace hyphens with a unicode minus.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.format_data">
<code class="descname">format_data</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.format_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.format_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a formatted string representation of a number.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.format_data_short">
<code class="descname">format_data_short</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.format_data_short"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.format_data_short" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a short formatted string representation of a number.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.get_offset">
<code class="descname">get_offset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.get_offset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.get_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Return scientific notation, plus offset.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.get_useLocale">
<code class="descname">get_useLocale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.get_useLocale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.get_useLocale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.get_useMathText">
<code class="descname">get_useMathText</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.get_useMathText"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.get_useMathText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.get_useOffset">
<code class="descname">get_useOffset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.get_useOffset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.get_useOffset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.pprint_val">
<code class="descname">pprint_val</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.pprint_val"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.pprint_val" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_locs">
<code class="descname">set_locs</code><span class="sig-paren">(</span><em>locs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.set_locs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_locs" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locations of the ticks.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_powerlimits">
<code class="descname">set_powerlimits</code><span class="sig-paren">(</span><em>lims</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.set_powerlimits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_powerlimits" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets size thresholds for scientific notation.</p>
<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>lims</strong> <span class="classifier-delimiter">:</span> <span class="classifier">(min_exp, max_exp)</span></dt>
<dd><p class="first">A tuple containing the powers of 10 that determine the switchover
threshold. Numbers below <code class="docutils literal notranslate"><span class="pre">10**min_exp</span></code> and above <code class="docutils literal notranslate"><span class="pre">10**max_exp</span></code>
will be displayed in scientific notation.</p>
<p class="last">For example, <code class="docutils literal notranslate"><span class="pre">formatter.set_powerlimits((-3,</span> <span class="pre">4))</span></code> sets the
pre-2007 default in which scientific notation is used for
numbers less than 1e-3 or greater than 1e4.</p>
</dd>
<dt><strong>.. seealso:: Method :meth:`set_scientific`</strong></dt>
<dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_scientific">
<code class="descname">set_scientific</code><span class="sig-paren">(</span><em>b</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.set_scientific"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_scientific" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn scientific notation on or off.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">Method <a class="reference internal" href="#matplotlib.ticker.ScalarFormatter.set_powerlimits" title="matplotlib.ticker.ScalarFormatter.set_powerlimits"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_powerlimits()</span></code></a></p>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_useLocale">
<code class="descname">set_useLocale</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.set_useLocale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_useLocale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_useMathText">
<code class="descname">set_useMathText</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.set_useMathText"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_useMathText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.ScalarFormatter.set_useOffset">
<code class="descname">set_useOffset</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#ScalarFormatter.set_useOffset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.set_useOffset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.ticker.ScalarFormatter.useLocale">
<code class="descname">useLocale</code><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.useLocale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.ticker.ScalarFormatter.useMathText">
<code class="descname">useMathText</code><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.useMathText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.ticker.ScalarFormatter.useOffset">
<code class="descname">useOffset</code><a class="headerlink" href="#matplotlib.ticker.ScalarFormatter.useOffset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.LogFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatter</code><span class="sig-paren">(</span><em>base=10.0</em>, <em>labelOnlyBase=False</em>, <em>minor_thresholds=None</em>, <em>linthresh=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Base class for formatting ticks on a log or symlog scale.</p>
<p>It may be instantiated directly, or subclassed.</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>base</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float, optional, default: 10.</span></dt>
<dd><p class="first last">Base of the logarithm used in all calculations.</p>
</dd>
<dt><strong>labelOnlyBase</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional, default: False</span></dt>
<dd><p class="first last">If True, label ticks only at integer powers of base.
This is normally True for major ticks and False for
minor ticks.</p>
</dd>
<dt><strong>minor_thresholds</strong> <span class="classifier-delimiter">:</span> <span class="classifier">(subset, all), optional, default: (1, 0.4)</span></dt>
<dd><p class="first last">If labelOnlyBase is False, these two numbers control
the labeling of ticks that are not at integer powers of
base; normally these are the minor ticks. The controlling
parameter is the log of the axis data range. In the typical
case where base is 10 it is the number of decades spanned
by the axis, so we can call it 'numdec'. If <code class="docutils literal notranslate"><span class="pre">numdec</span> <span class="pre"><=</span> <span class="pre">all</span></code>,
all minor ticks will be labeled. If <code class="docutils literal notranslate"><span class="pre">all</span> <span class="pre"><</span> <span class="pre">numdec</span> <span class="pre"><=</span> <span class="pre">subset</span></code>,
then only a subset of minor ticks will be labeled, so as to
avoid crowding. If <code class="docutils literal notranslate"><span class="pre">numdec</span> <span class="pre">></span> <span class="pre">subset</span></code> then no minor ticks will
be labeled.</p>
</dd>
<dt><strong>linthresh</strong> <span class="classifier-delimiter">:</span> <span class="classifier">None or float, optional, default: None</span></dt>
<dd><p class="first last">If a symmetric log scale is in use, its <code class="docutils literal notranslate"><span class="pre">linthresh</span></code>
parameter must be supplied here.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>The <a class="reference internal" href="#matplotlib.ticker.LogFormatter.set_locs" title="matplotlib.ticker.LogFormatter.set_locs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_locs</span></code></a> method must be called to enable the subsetting
logic controlled by the <code class="docutils literal notranslate"><span class="pre">minor_thresholds</span></code> parameter.</p>
<p>In some cases such as the colorbar, there is no distinction between
major and minor ticks; the tick locations might be set manually,
or by a locator that puts ticks at integer powers of base and
at intermediate locations. For this situation, disable the
minor_thresholds logic by using <code class="docutils literal notranslate"><span class="pre">minor_thresholds=(np.inf,</span> <span class="pre">np.inf)</span></code>,
so that all ticks will be labeled.</p>
<p>To disable labeling of minor ticks when 'labelOnlyBase' is False,
use <code class="docutils literal notranslate"><span class="pre">minor_thresholds=(0,</span> <span class="pre">0)</span></code>. This is the default for the
"classic" style.</p>
<p class="rubric">Examples</p>
<p>To label a subset of minor ticks when the view limits span up
to 2 decades, and all of the ticks when zoomed in to 0.5 decades
or less, use <code class="docutils literal notranslate"><span class="pre">minor_thresholds=(2,</span> <span class="pre">0.5)</span></code>.</p>
<p>To label all minor ticks when the view limits span up to 1.5
decades, use <code class="docutils literal notranslate"><span class="pre">minor_thresholds=(1.5,</span> <span class="pre">1.5)</span></code>.</p>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.base">
<code class="descname">base</code><span class="sig-paren">(</span><em>base</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatter.base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatter.base" title="Permalink to this definition">¶</a></dt>
<dd><p>Change the <em>base</em> for labeling.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Should always match the base used for <a class="reference internal" href="#matplotlib.ticker.LogLocator" title="matplotlib.ticker.LogLocator"><code class="xref py py-class docutils literal notranslate"><span class="pre">LogLocator</span></code></a></p>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.format_data">
<code class="descname">format_data</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatter.format_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatter.format_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the full string representation of the value with the
position unspecified.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.format_data_short">
<code class="descname">format_data_short</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatter.format_data_short"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatter.format_data_short" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a short formatted string representation of a number.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.label_minor">
<code class="descname">label_minor</code><span class="sig-paren">(</span><em>labelOnlyBase</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatter.label_minor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatter.label_minor" title="Permalink to this definition">¶</a></dt>
<dd><p>Switch minor tick labeling on or off.</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>labelOnlyBase</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">If True, label ticks only at integer powers of base.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.pprint_val">
<code class="descname">pprint_val</code><span class="sig-paren">(</span><em>x</em>, <em>d</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatter.pprint_val"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatter.pprint_val" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.LogFormatter.set_locs">
<code class="descname">set_locs</code><span class="sig-paren">(</span><em>locs=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatter.set_locs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatter.set_locs" title="Permalink to this definition">¶</a></dt>
<dd><p>Use axis view limits to control which ticks are labeled.</p>
<p>The <em>locs</em> parameter is ignored in the present algorithm.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.LogFormatterExponent">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatterExponent</code><span class="sig-paren">(</span><em>base=10.0</em>, <em>labelOnlyBase=False</em>, <em>minor_thresholds=None</em>, <em>linthresh=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatterExponent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatterExponent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.LogFormatter" title="matplotlib.ticker.LogFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.LogFormatter</span></code></a></p>
<p>Format values for log axis using <code class="docutils literal notranslate"><span class="pre">exponent</span> <span class="pre">=</span> <span class="pre">log_base(value)</span></code>.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.LogFormatterMathtext">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatterMathtext</code><span class="sig-paren">(</span><em>base=10.0</em>, <em>labelOnlyBase=False</em>, <em>minor_thresholds=None</em>, <em>linthresh=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatterMathtext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatterMathtext" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.LogFormatter" title="matplotlib.ticker.LogFormatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.LogFormatter</span></code></a></p>
<p>Format values for log axis using <code class="docutils literal notranslate"><span class="pre">exponent</span> <span class="pre">=</span> <span class="pre">log_base(value)</span></code>.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.IndexFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">IndexFormatter</code><span class="sig-paren">(</span><em>labels</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#IndexFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.IndexFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Format the position x to the nearest i-th label where i=int(x+0.5)</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.LogFormatterSciNotation">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LogFormatterSciNotation</code><span class="sig-paren">(</span><em>base=10.0</em>, <em>labelOnlyBase=False</em>, <em>minor_thresholds=None</em>, <em>linthresh=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogFormatterSciNotation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogFormatterSciNotation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.LogFormatterMathtext" title="matplotlib.ticker.LogFormatterMathtext"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.LogFormatterMathtext</span></code></a></p>
<p>Format values following scientific notation in a logarithmic axis.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.LogitFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">LogitFormatter</code><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogitFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogitFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Probability formatter (using Math text).</p>
<dl class="method">
<dt id="matplotlib.ticker.LogitFormatter.format_data_short">
<code class="descname">format_data_short</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#LogitFormatter.format_data_short"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.LogitFormatter.format_data_short" title="Permalink to this definition">¶</a></dt>
<dd><p>return a short formatted string representation of a number</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.EngFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">EngFormatter</code><span class="sig-paren">(</span><em>unit=''</em>, <em>places=None</em>, <em>sep=' '</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#EngFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.EngFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Formats axis values using engineering prefixes to represent powers
of 1000, plus a specified unit, e.g., 10 MHz instead of 1e7.</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>unit</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str (default: "")</span></dt>
<dd><p class="first last">Unit symbol to use, suitable for use with single-letter
representations of powers of 1000. For example, 'Hz' or 'm'.</p>
</dd>
<dt><strong>places</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int (default: None)</span></dt>
<dd><p class="first last">Precision with which to display the number, specified in
digits after the decimal point (there will be between one
and three digits before the decimal point). If it is None,
the formatting falls back to the floating point format '%g',
which displays up to 6 <em>significant</em> digits, i.e. the equivalent
value for <em>places</em> varies between 0 and 5 (inclusive).</p>
</dd>
<dt><strong>sep</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str (default: " ")</span></dt>
<dd><p class="first">Separator used between the value and the prefix/unit. For
example, one get '3.14 mV' if <code class="docutils literal notranslate"><span class="pre">sep</span></code> is " " (default) and
'3.14mV' if <code class="docutils literal notranslate"><span class="pre">sep</span></code> is "". Besides the default behavior, some
other useful options may be:</p>
<ul class="last simple">
<li><code class="docutils literal notranslate"><span class="pre">sep=""</span></code> to append directly the prefix/unit to the value;</li>
<li><code class="docutils literal notranslate"><span class="pre">sep="\N{THIN</span> <span class="pre">SPACE}"</span></code> (<code class="docutils literal notranslate"><span class="pre">U+2009</span></code>);</li>
<li><code class="docutils literal notranslate"><span class="pre">sep="\N{NARROW</span> <span class="pre">NO-BREAK</span> <span class="pre">SPACE}"</span></code> (<code class="docutils literal notranslate"><span class="pre">U+202F</span></code>);</li>
<li><code class="docutils literal notranslate"><span class="pre">sep="\N{NO-BREAK</span> <span class="pre">SPACE}"</span></code> (<code class="docutils literal notranslate"><span class="pre">U+00A0</span></code>).</li>
</ul>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="matplotlib.ticker.EngFormatter.ENG_PREFIXES">
<code class="descname">ENG_PREFIXES</code><em class="property"> = {-24: 'y', -21: 'z', -18: 'a', -15: 'f', -12: 'p', -9: 'n', -6: 'μ', -3: 'm', 0: '', 3: 'k', 6: 'M', 9: 'G', 12: 'T', 15: 'P', 18: 'E', 21: 'Z', 24: 'Y'}</em><a class="headerlink" href="#matplotlib.ticker.EngFormatter.ENG_PREFIXES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.EngFormatter.format_eng">
<code class="descname">format_eng</code><span class="sig-paren">(</span><em>num</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#EngFormatter.format_eng"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.EngFormatter.format_eng" title="Permalink to this definition">¶</a></dt>
<dd><p>Formats a number in engineering notation, appending a letter
representing the power of 1000 of the original number.
Some examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">format_eng</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># for self.places = 0</span>
<span class="go">'0'</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">format_eng</span><span class="p">(</span><span class="mi">1000000</span><span class="p">)</span> <span class="c1"># for self.places = 1</span>
<span class="go">'1.0 M'</span>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">format_eng</span><span class="p">(</span><span class="s2">"-1e-6"</span><span class="p">)</span> <span class="c1"># for self.places = 2</span>
<span class="go">u'-1.00 μ'</span>
</pre></div>
</div>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">num</span></code> may be a numeric value or a string that can be converted
to a numeric value with <code class="docutils literal notranslate"><span class="pre">float(num)</span></code>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.PercentFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">PercentFormatter</code><span class="sig-paren">(</span><em>xmax=100</em>, <em>decimals=None</em>, <em>symbol='%'</em>, <em>is_latex=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#PercentFormatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.PercentFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>Format numbers as a percentage.</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>xmax</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd><p class="first last">Determines how the number is converted into a percentage.
<em>xmax</em> is the data value that corresponds to 100%.
Percentages are computed as <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">/</span> <span class="pre">xmax</span> <span class="pre">*</span> <span class="pre">100</span></code>. So if the data is
already scaled to be percentages, <em>xmax</em> will be 100. Another common
situation is where <code class="xref py py-obj docutils literal notranslate"><span class="pre">xmax</span></code> is 1.0.</p>
</dd>
<dt><strong>decimals</strong> <span class="classifier-delimiter">:</span> <span class="classifier">None or int</span></dt>
<dd><p class="first last">The number of decimal places to place after the point.
If <em>None</em> (the default), the number will be computed automatically.</p>
</dd>
<dt><strong>symbol</strong> <span class="classifier-delimiter">:</span> <span class="classifier">string or None</span></dt>
<dd><p class="first last">A string that will be appended to the label. It may be
<em>None</em> or empty to indicate that no symbol should be used. LaTeX
special characters are escaped in <em>symbol</em> whenever latex mode is
enabled, unless <em>is_latex</em> is <em>True</em>.</p>
</dd>
<dt><strong>is_latex</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">If <em>False</em>, reserved LaTeX characters in <em>symbol</em> will be escaped.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.ticker.PercentFormatter.convert_to_pct">
<code class="descname">convert_to_pct</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#PercentFormatter.convert_to_pct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.PercentFormatter.convert_to_pct" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.PercentFormatter.format_pct">
<code class="descname">format_pct</code><span class="sig-paren">(</span><em>x</em>, <em>display_range</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#PercentFormatter.format_pct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.PercentFormatter.format_pct" title="Permalink to this definition">¶</a></dt>
<dd><p>Formats the number as a percentage number with the correct
number of decimals and adds the percent symbol, if any.</p>
<p>If <code class="xref py py-obj docutils literal notranslate"><span class="pre">self.decimals</span></code> is <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>, the number of digits after the
decimal point is set based on the <code class="xref py py-obj docutils literal notranslate"><span class="pre">display_range</span></code> of the axis
as follows:</p>
<table border="1" class="docutils">
<colgroup>
<col width="31%" />
<col width="20%" />
<col width="49%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>display_range</td>
<td>decimals</td>
<td>sample</td>
</tr>
<tr class="row-even"><td>>50</td>
<td>0</td>
<td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">=</span> <span class="pre">34.5</span></code> => 35%</td>
</tr>
<tr class="row-odd"><td>>5</td>
<td>1</td>
<td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">=</span> <span class="pre">34.5</span></code> => 34.5%</td>
</tr>
<tr class="row-even"><td>>0.5</td>
<td>2</td>
<td><code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">=</span> <span class="pre">34.5</span></code> => 34.50%</td>
</tr>
<tr class="row-odd"><td>...</td>
<td>...</td>
<td>...</td>
</tr>
</tbody>
</table>
<p>This method will not be very good for tiny axis ranges or
extremely large ones. It assumes that the values on the chart
are percentages displayed on a reasonable scale.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.ticker.PercentFormatter.symbol">
<code class="descname">symbol</code><a class="headerlink" href="#matplotlib.ticker.PercentFormatter.symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>The configured percent symbol as a string.</p>
<p>If LaTeX is enabled via <code class="docutils literal notranslate"><span class="pre">rcParams["text.usetex"]</span></code>, the special characters
<code class="docutils literal notranslate"><span class="pre">{'#',</span> <span class="pre">'$',</span> <span class="pre">'%',</span> <span class="pre">'&',</span> <span class="pre">'~',</span> <span class="pre">'_',</span> <span class="pre">'^',</span> <span class="pre">'\',</span> <span class="pre">'{',</span> <span class="pre">'}'}</span></code> are
automatically escaped in the string.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.Locator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">Locator</code><a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.TickHelper" title="matplotlib.ticker.TickHelper"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.TickHelper</span></code></a></p>
<p>Determine the tick locations;</p>
<p>Note, you should not use the same locator between different
<a class="reference internal" href="axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a> because the locator stores references to
the Axis data and view limits</p>
<dl class="attribute">
<dt id="matplotlib.ticker.Locator.MAXTICKS">
<code class="descname">MAXTICKS</code><em class="property"> = 1000</em><a class="headerlink" href="#matplotlib.ticker.Locator.MAXTICKS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Locator.autoscale">
<code class="descname">autoscale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.autoscale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Locator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>autoscale the view limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Locator.pan">
<code class="descname">pan</code><span class="sig-paren">(</span><em>numsteps</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.pan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Locator.pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Pan numticks (can be positive or negative)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Locator.raise_if_exceeds">
<code class="descname">raise_if_exceeds</code><span class="sig-paren">(</span><em>locs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.raise_if_exceeds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Locator.raise_if_exceeds" title="Permalink to this definition">¶</a></dt>
<dd><p>raise a RuntimeError if Locator attempts to create more than
MAXTICKS locs</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Locator.refresh">
<code class="descname">refresh</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.refresh"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Locator.refresh" title="Permalink to this definition">¶</a></dt>
<dd><p>refresh internal information based on current lim</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Locator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.set_params"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Locator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Do nothing, and rase a warning. Any locator class not supporting the
set_params() function will call this.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Locator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.tick_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Locator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the values of the located ticks given <strong>vmin</strong> and <strong>vmax</strong>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>To get tick locations with the vmin and vmax values defined
automatically for the associated <code class="xref py py-attr docutils literal 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>
<dl class="method">
<dt id="matplotlib.ticker.Locator.view_limits">
<code class="descname">view_limits</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.view_limits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Locator.view_limits" title="Permalink to this definition">¶</a></dt>
<dd><p>select a scale for the range from vmin to vmax</p>
<p>Normally this method is overridden by subclasses to
change locator behaviour.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.Locator.zoom">
<code class="descname">zoom</code><span class="sig-paren">(</span><em>direction</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#Locator.zoom"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.Locator.zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Zoom in/out on axis; if direction is >0 zoom in, else zoom out</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.ticker.IndexLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">IndexLocator</code><span class="sig-paren">(</span><em>base</em>, <em>offset</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#IndexLocator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.IndexLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Place a tick on every multiple of some base number of points
plotted, e.g., on every 5th point. It is assumed that you are doing
index plotting; i.e., the axis is 0, len(data). This is mainly
useful for x ticks.</p>
<p>place ticks on the i-th data points where (i-offset)%base==0</p>
<dl class="method">
<dt id="matplotlib.ticker.IndexLocator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>base=None</em>, <em>offset=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#IndexLocator.set_params"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.IndexLocator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set parameters within this locator</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.IndexLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#IndexLocator.tick_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.IndexLocator.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="class">
<dt id="matplotlib.ticker.FixedLocator">
<em class="property">class </em><code class="descclassname">matplotlib.ticker.</code><code class="descname">FixedLocator</code><span class="sig-paren">(</span><em>locs</em>, <em>nbins=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#FixedLocator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.FixedLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Tick locations are fixed. If nbins is not None,
the array of possible positions will be subsampled to
keep the number of ticks <= nbins +1.
The subsampling will be done so as to include the smallest
absolute value; for example, if zero is included in the
array of possibilities, then it is guaranteed to be one of
the chosen ticks.</p>
<dl class="method">
<dt id="matplotlib.ticker.FixedLocator.set_params">
<code class="descname">set_params</code><span class="sig-paren">(</span><em>nbins=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#FixedLocator.set_params"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.FixedLocator.set_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set parameters within this locator.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.ticker.FixedLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/ticker.html#FixedLocator.tick_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.ticker.FixedLocator.tick_values" title="Permalink to this definition">¶</a></dt>