forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaxis_api.html
More file actions
1179 lines (1006 loc) · 66.1 KB
/
axis_api.html
File metadata and controls
1179 lines (1006 loc) · 66.1 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>axis — Matplotlib 1.5.3 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.5.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.5.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="Matplotlib 1.5.3 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="backends" href="index_backend_api.html" />
<link rel="prev" title="axes" href="axes_api.html" />
</head>
<body>
<div class="alert" style="background-color: #FEA46C; padding: 10px 0;
">
<h2>Matplotlib 2.0.0rc2 is available</h2>
<p><a href="../style_changes.html"
style="font-weight: bold;
color: #11557C;">Install the release candidate now!</a></p>
</div>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
</div>
<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="index_backend_api.html" title="backends"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="axes_api.html" title="axes"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</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">
<a href="http://depsy.org/package/python/matplotlib">
<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">axis</a><ul>
<li><a class="reference internal" href="#module-matplotlib.axis"><code class="docutils literal"><span class="pre">matplotlib.axis</span></code></a></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="axes_api.html" title="previous chapter">axes</a></li>
<li>Next: <a href="index_backend_api.html" title="next chapter">backends</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/axis_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="axis">
<h1>axis<a class="headerlink" href="#axis" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.axis">
<span id="matplotlib-axis"></span><h2><a class="reference internal" href="#module-matplotlib.axis" title="matplotlib.axis"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.axis</span></code></a><a class="headerlink" href="#module-matplotlib.axis" title="Permalink to this headline">¶</a></h2>
<p>Classes for the ticks and x and y axis</p>
<dl class="class">
<dt id="matplotlib.axis.Axis">
<em class="property">class </em><code class="descclassname">matplotlib.axis.</code><code class="descname">Axis</code><span class="sig-paren">(</span><em>axes</em>, <em>pickradius=15</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.artist.Artist</span></code></a></p>
<p>Public attributes</p>
<ul class="simple">
<li><code class="xref py py-attr docutils literal"><span class="pre">axes.transData</span></code> - transform data coords to display coords</li>
<li><code class="xref py py-attr docutils literal"><span class="pre">axes.transAxes</span></code> - transform axis coords to display coords</li>
<li><code class="xref py py-attr docutils literal"><span class="pre">labelpad</span></code> - number of points between the axis and its label</li>
</ul>
<p>Init the axis with the parent Axes instance</p>
<dl class="attribute">
<dt id="matplotlib.axis.Axis.OFFSETTEXTPAD">
<code class="descname">OFFSETTEXTPAD</code><em class="property"> = 3</em><a class="headerlink" href="#matplotlib.axis.Axis.OFFSETTEXTPAD" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.axis_date">
<code class="descname">axis_date</code><span class="sig-paren">(</span><em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.axis_date" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets up x-axis ticks and labels that treat the x data as dates.
<em>tz</em> is a <code class="xref py py-class docutils literal"><span class="pre">tzinfo</span></code> instance or a timezone string.
This timezone is used to create date labels.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.cla">
<code class="descname">cla</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.cla" title="Permalink to this definition">¶</a></dt>
<dd><p>clear the current axis</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.convert_units">
<code class="descname">convert_units</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.convert_units" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the axis lines, grid lines, tick lines and labels</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_children">
<code class="descname">get_children</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_children" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_data_interval">
<code class="descname">get_data_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_data_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis data limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_gridlines">
<code class="descname">get_gridlines</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_gridlines" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the grid lines as a list of Line2D instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_label">
<code class="descname">get_label</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the axis label as a Text instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_label_text">
<code class="descname">get_label_text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_label_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the text of the label</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_major_formatter">
<code class="descname">get_major_formatter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_major_formatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the formatter of the major ticker</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_major_locator">
<code class="descname">get_major_locator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_major_locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the locator of the major ticker</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_major_ticks">
<code class="descname">get_major_ticks</code><span class="sig-paren">(</span><em>numticks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_major_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>get the tick instances; grow as necessary</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_majorticklabels">
<code class="descname">get_majorticklabels</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_majorticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of Text instances for the major ticklabels</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_majorticklines">
<code class="descname">get_majorticklines</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_majorticklines" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the major tick lines as a list of Line2D instances</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_majorticklocs">
<code class="descname">get_majorticklocs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_majorticklocs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the major tick locations in data coordinates as a numpy array</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_minor_formatter">
<code class="descname">get_minor_formatter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_minor_formatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the formatter of the minor ticker</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_minor_locator">
<code class="descname">get_minor_locator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_minor_locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the locator of the minor ticker</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_minor_ticks">
<code class="descname">get_minor_ticks</code><span class="sig-paren">(</span><em>numticks=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_minor_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>get the minor tick instances; grow as necessary</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_minorticklabels">
<code class="descname">get_minorticklabels</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_minorticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of Text instances for the minor ticklabels</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_minorticklines">
<code class="descname">get_minorticklines</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_minorticklines" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the minor tick lines as a list of Line2D instances</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_minorticklocs">
<code class="descname">get_minorticklocs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_minorticklocs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the minor tick locations in data coordinates as a numpy array</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_offset_text">
<code class="descname">get_offset_text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_offset_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the axis offsetText as a Text instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_pickradius">
<code class="descname">get_pickradius</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_pickradius" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the depth of the axis used by the picker</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_scale">
<code class="descname">get_scale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_scale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_smart_bounds">
<code class="descname">get_smart_bounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_smart_bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>get whether the axis has smart bounds</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_ticklabel_extents">
<code class="descname">get_ticklabel_extents</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_ticklabel_extents" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the extents of the tick labels on either side
of the axes.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_ticklabels">
<code class="descname">get_ticklabels</code><span class="sig-paren">(</span><em>minor=False</em>, <em>which=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_ticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the x tick labels as a list of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal"><span class="pre">Text</span></code></a>
instances.</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"><p class="first"><strong>minor</strong> : bool</p>
<blockquote>
<div><p>If True return the minor ticklabels,
else return the major ticklabels</p>
</div></blockquote>
<p><strong>which</strong> : None, (‘minor’, ‘major’, ‘both’)</p>
<blockquote>
<div><p>Overrides <code class="xref py py-obj docutils literal"><span class="pre">minor</span></code>.</p>
<p>Selects which ticklabels to return</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ret</strong> : list</p>
<blockquote class="last">
<div><p>List of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal"><span class="pre">Text</span></code></a> instances.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_ticklines">
<code class="descname">get_ticklines</code><span class="sig-paren">(</span><em>minor=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_ticklines" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tick lines as a list of Line2D instances</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_ticklocs">
<code class="descname">get_ticklocs</code><span class="sig-paren">(</span><em>minor=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_ticklocs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the tick locations in data coordinates as a numpy array</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_tightbbox">
<code class="descname">get_tightbbox</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_tightbbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a bounding box that encloses the axis. It only accounts
tick labels, axis label, and offsetText.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_transform">
<code class="descname">get_transform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_transform" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_units">
<code class="descname">get_units</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_units" title="Permalink to this definition">¶</a></dt>
<dd><p>return the units for axis</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.get_view_interval">
<code class="descname">get_view_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.grid">
<code class="descname">grid</code><span class="sig-paren">(</span><em>b=None</em>, <em>which='major'</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.grid" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the axis grid on or off; b is a boolean. Use <em>which</em> =
‘major’ | ‘minor’ | ‘both’ to set the grid for major or minor ticks.</p>
<p>If <em>b</em> is <em>None</em> and len(kwargs)==0, toggle the grid state. If
<em>kwargs</em> are supplied, it is assumed you want the grid on and <em>b</em>
will be set to True.</p>
<p><em>kwargs</em> are used to set the line properties of the grids, e.g.,</p>
<blockquote>
<div>xax.grid(color=’r’, linestyle=’-‘, linewidth=2)</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.have_units">
<code class="descname">have_units</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.have_units" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.iter_ticks">
<code class="descname">iter_ticks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.iter_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>Iterate through all of the major and minor ticks.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.limit_range_for_scale">
<code class="descname">limit_range_for_scale</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.limit_range_for_scale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.pan">
<code class="descname">pan</code><span class="sig-paren">(</span><em>numsteps</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Pan <em>numsteps</em> (can be positive or negative)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.reset_ticks">
<code class="descname">reset_ticks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.reset_ticks" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_clip_path">
<code class="descname">set_clip_path</code><span class="sig-paren">(</span><em>clippath</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_clip_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_data_interval">
<code class="descname">set_data_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_data_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>set the axis data limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_default_intervals">
<code class="descname">set_default_intervals</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_default_intervals" title="Permalink to this definition">¶</a></dt>
<dd><p>set the default limits for the axis data and view interval if they
are not mutated</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_label_coords">
<code class="descname">set_label_coords</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_label_coords" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the coordinates of the label. By default, the x
coordinate of the y label is determined by the tick label
bounding boxes, but this can lead to poor alignment of
multiple ylabels if there are multiple axes. Ditto for the y
coodinate of the x label.</p>
<p>You can also specify the coordinate system of the label with
the transform. If None, the default coordinate system will be
the axes coordinate system (0,0) is (left,bottom), (0.5, 0.5)
is middle, etc</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_label_text">
<code class="descname">set_label_text</code><span class="sig-paren">(</span><em>label</em>, <em>fontdict=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_label_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the text value of the axis label</p>
<p>ACCEPTS: A string value for the label</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_major_formatter">
<code class="descname">set_major_formatter</code><span class="sig-paren">(</span><em>formatter</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_major_formatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the formatter of the major ticker</p>
<p>ACCEPTS: A <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">Formatter</span></code></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_major_locator">
<code class="descname">set_major_locator</code><span class="sig-paren">(</span><em>locator</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_major_locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locator of the major ticker</p>
<p>ACCEPTS: a <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">Locator</span></code></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_minor_formatter">
<code class="descname">set_minor_formatter</code><span class="sig-paren">(</span><em>formatter</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_minor_formatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the formatter of the minor ticker</p>
<p>ACCEPTS: A <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">Formatter</span></code></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_minor_locator">
<code class="descname">set_minor_locator</code><span class="sig-paren">(</span><em>locator</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_minor_locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locator of the minor ticker</p>
<p>ACCEPTS: a <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">Locator</span></code></a> instance</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_pickradius">
<code class="descname">set_pickradius</code><span class="sig-paren">(</span><em>pickradius</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_pickradius" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the depth of the axis used by the picker</p>
<p>ACCEPTS: a distance in points</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_smart_bounds">
<code class="descname">set_smart_bounds</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_smart_bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>set the axis to have smart bounds</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_tick_params">
<code class="descname">set_tick_params</code><span class="sig-paren">(</span><em>which='major'</em>, <em>reset=False</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_tick_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Set appearance parameters for ticks and ticklabels.</p>
<p>For documentation of keyword arguments, see
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.tick_params" title="matplotlib.axes.Axes.tick_params"><code class="xref py py-meth docutils literal"><span class="pre">matplotlib.axes.Axes.tick_params()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_ticklabels">
<code class="descname">set_ticklabels</code><span class="sig-paren">(</span><em>ticklabels</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_ticklabels" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text values of the tick labels. Return a list of Text
instances. Use <em>kwarg</em> <em>minor=True</em> to select minor ticks.
All other kwargs are used to update the text object properties.
As for get_ticklabels, label1 (left or bottom) is
affected for a given tick only if its label1On attribute
is True, and similarly for label2. The list of returned
label text objects consists of all such label1 objects followed
by all such label2 objects.</p>
<p>The input <em>ticklabels</em> is assumed to match the set of
tick locations, regardless of the state of label1On and
label2On.</p>
<p>ACCEPTS: sequence of strings or Text objects</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_ticks">
<code class="descname">set_ticks</code><span class="sig-paren">(</span><em>ticks</em>, <em>minor=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_ticks" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locations of the tick marks from sequence ticks</p>
<p>ACCEPTS: sequence of floats</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_units">
<code class="descname">set_units</code><span class="sig-paren">(</span><em>u</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_units" title="Permalink to this definition">¶</a></dt>
<dd><p>set the units for axis</p>
<p>ACCEPTS: a units tag</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.set_view_interval">
<code class="descname">set_view_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.update_units">
<code class="descname">update_units</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.update_units" title="Permalink to this definition">¶</a></dt>
<dd><p>introspect <em>data</em> for units converter and update the
axis.converter instance if necessary. Return <em>True</em>
if <em>data</em> is registered for unit conversion.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Axis.zoom">
<code class="descname">zoom</code><span class="sig-paren">(</span><em>direction</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Axis.zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Zoom in/out on axis; if <em>direction</em> is >0 zoom in, else zoom out</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.axis.Tick">
<em class="property">class </em><code class="descclassname">matplotlib.axis.</code><code class="descname">Tick</code><span class="sig-paren">(</span><em>axes</em>, <em>loc</em>, <em>label</em>, <em>size=None</em>, <em>width=None</em>, <em>color=None</em>, <em>tickdir=None</em>, <em>pad=None</em>, <em>labelsize=None</em>, <em>labelcolor=None</em>, <em>zorder=None</em>, <em>gridOn=None</em>, <em>tick1On=True</em>, <em>tick2On=True</em>, <em>label1On=True</em>, <em>label2On=False</em>, <em>major=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.artist.Artist</span></code></a></p>
<p>Abstract base class for the axis ticks, grid lines and labels</p>
<p>1 refers to the bottom of the plot for xticks and the left for yticks
2 refers to the top of the plot for xticks and the right for yticks</p>
<p>Publicly accessible attributes:</p>
<blockquote>
<div><dl class="docutils">
<dt><code class="xref py py-attr docutils literal"><span class="pre">tick1line</span></code></dt>
<dd>a Line2D instance</dd>
<dt><code class="xref py py-attr docutils literal"><span class="pre">tick2line</span></code></dt>
<dd>a Line2D instance</dd>
<dt><code class="xref py py-attr docutils literal"><span class="pre">gridline</span></code></dt>
<dd>a Line2D instance</dd>
<dt><code class="xref py py-attr docutils literal"><span class="pre">label1</span></code></dt>
<dd>a Text instance</dd>
<dt><code class="xref py py-attr docutils literal"><span class="pre">label2</span></code></dt>
<dd>a Text instance</dd>
<dt><code class="xref py py-attr docutils literal"><span class="pre">gridOn</span></code></dt>
<dd>a boolean which determines whether to draw the tickline</dd>
<dt><code class="xref py py-attr docutils literal"><span class="pre">tick1On</span></code></dt>
<dd>a boolean which determines whether to draw the 1st tickline</dd>
<dt><code class="xref py py-attr docutils literal"><span class="pre">tick2On</span></code></dt>
<dd>a boolean which determines whether to draw the 2nd tickline</dd>
<dt><code class="xref py py-attr docutils literal"><span class="pre">label1On</span></code></dt>
<dd>a boolean which determines whether to draw tick label</dd>
<dt><code class="xref py py-attr docutils literal"><span class="pre">label2On</span></code></dt>
<dd>a boolean which determines whether to draw tick label</dd>
</dl>
</div></blockquote>
<p>bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in points</p>
<dl class="method">
<dt id="matplotlib.axis.Tick.apply_tickdir">
<code class="descname">apply_tickdir</code><span class="sig-paren">(</span><em>tickdir</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.apply_tickdir" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate self._pad and self._tickmarkers</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em>mouseevent</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the mouse event occurred in the Tick marks.</p>
<p>This function always returns false. It is more useful to test if the
axis as a whole contains the mouse rather than the set of tick marks.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.draw" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.get_children">
<code class="descname">get_children</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.get_children" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.get_loc">
<code class="descname">get_loc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.get_loc" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the tick location (data coords) as a scalar</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.get_pad">
<code class="descname">get_pad</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.get_pad" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the value of the tick label pad in points</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.get_pad_pixels">
<code class="descname">get_pad_pixels</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.get_pad_pixels" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.get_view_interval">
<code class="descname">get_view_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the view Interval instance for the axis this tick is ticking</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.set_clip_path">
<code class="descname">set_clip_path</code><span class="sig-paren">(</span><em>clippath</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.set_clip_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist’s clip path, which may be:</p>
<blockquote>
<div><ul>
<li><p class="first">a <a class="reference internal" href="patches_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal"><span class="pre">Patch</span></code></a> (or subclass) instance</p>
</li>
<li><dl class="first docutils">
<dt>a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal"><span class="pre">Path</span></code></a> instance, in which case</dt>
<dd><p class="first last">an optional <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a>
instance may be provided, which will be applied to the
path before using it for clipping.</p>
</dd>
</dl>
</li>
<li><p class="first"><em>None</em>, to remove the clipping path</p>
</li>
</ul>
</div></blockquote>
<p>For efficiency, if the path happens to be an axis-aligned
rectangle, this method will set the clipping box to the
corresponding rectangle and set the clipping path to <em>None</em>.</p>
<p>ACCEPTS: [ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal"><span class="pre">Path</span></code></a>,
<a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a>) |
<a class="reference internal" href="patches_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal"><span class="pre">Patch</span></code></a> | None ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.set_label">
<code class="descname">set_label</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.set_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text of ticklabel</p>
<p>ACCEPTS: str</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.set_label1">
<code class="descname">set_label1</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.set_label1" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text of ticklabel</p>
<p>ACCEPTS: str</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.set_label2">
<code class="descname">set_label2</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.set_label2" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text of ticklabel2</p>
<p>ACCEPTS: str</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.Tick.set_pad">
<code class="descname">set_pad</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.Tick.set_pad" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the tick label pad in points</p>
<p>ACCEPTS: float</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.axis.Ticker">
<em class="property">class </em><code class="descclassname">matplotlib.axis.</code><code class="descname">Ticker</code><a class="headerlink" href="#matplotlib.axis.Ticker" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="attribute">
<dt id="matplotlib.axis.Ticker.formatter">
<code class="descname">formatter</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.axis.Ticker.formatter" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.axis.Ticker.locator">
<code class="descname">locator</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.axis.Ticker.locator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.axis.XAxis">
<em class="property">class </em><code class="descclassname">matplotlib.axis.</code><code class="descname">XAxis</code><span class="sig-paren">(</span><em>axes</em>, <em>pickradius=15</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.axis.Axis</span></code></a></p>
<p>Init the axis with the parent Axes instance</p>
<dl class="attribute">
<dt id="matplotlib.axis.XAxis.axis_name">
<code class="descname">axis_name</code><em class="property"> = 'x'</em><a class="headerlink" href="#matplotlib.axis.XAxis.axis_name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em>mouseevent</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the mouse event occured in the x axis.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.get_data_interval">
<code class="descname">get_data_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.get_data_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis data limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.get_label_position">
<code class="descname">get_label_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.get_label_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the label position (top or bottom)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.get_minpos">
<code class="descname">get_minpos</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.get_minpos" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.get_text_heights">
<code class="descname">get_text_heights</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.get_text_heights" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the amount of space one should reserve for text
above and below the axes. Returns a tuple (above, below)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.get_ticks_position">
<code class="descname">get_ticks_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.get_ticks_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the ticks position (top, bottom, default or unknown)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.get_view_interval">
<code class="descname">get_view_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.set_data_interval">
<code class="descname">set_data_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.set_data_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>set the axis data limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.set_default_intervals">
<code class="descname">set_default_intervals</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.set_default_intervals" title="Permalink to this definition">¶</a></dt>
<dd><p>set the default limits for the axis interval if they are not mutated</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.set_label_position">
<code class="descname">set_label_position</code><span class="sig-paren">(</span><em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.set_label_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the label position (top or bottom)</p>
<p>ACCEPTS: [ ‘top’ | ‘bottom’ ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.set_ticks_position">
<code class="descname">set_ticks_position</code><span class="sig-paren">(</span><em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.set_ticks_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the ticks position (top, bottom, both, default or none)
both sets the ticks to appear on both positions, but does not
change the tick labels. ‘default’ resets the tick positions to
the default: ticks on both positions, labels at bottom. ‘none’
can be used if you don’t want any ticks. ‘none’ and ‘both’
affect only the ticks, not the labels.</p>
<p>ACCEPTS: [ ‘top’ | ‘bottom’ | ‘both’ | ‘default’ | ‘none’ ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.set_view_interval">
<code class="descname">set_view_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>ignore</em> is <em>False</em>, the order of vmin, vmax
does not matter; the original axis orientation will
be preserved. In addition, the view limits can be
expanded, but will not be reduced. This method is
for mpl internal use; for normal use, see
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_xlim" title="matplotlib.axes.Axes.set_xlim"><code class="xref py py-meth docutils literal"><span class="pre">set_xlim()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.tick_bottom">
<code class="descname">tick_bottom</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.tick_bottom" title="Permalink to this definition">¶</a></dt>
<dd><p>use ticks only on bottom</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XAxis.tick_top">
<code class="descname">tick_top</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XAxis.tick_top" title="Permalink to this definition">¶</a></dt>
<dd><p>use ticks only on top</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.axis.XTick">
<em class="property">class </em><code class="descclassname">matplotlib.axis.</code><code class="descname">XTick</code><span class="sig-paren">(</span><em>axes</em>, <em>loc</em>, <em>label</em>, <em>size=None</em>, <em>width=None</em>, <em>color=None</em>, <em>tickdir=None</em>, <em>pad=None</em>, <em>labelsize=None</em>, <em>labelcolor=None</em>, <em>zorder=None</em>, <em>gridOn=None</em>, <em>tick1On=True</em>, <em>tick2On=True</em>, <em>label1On=True</em>, <em>label2On=False</em>, <em>major=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XTick" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.axis.Tick" title="matplotlib.axis.Tick"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.axis.Tick</span></code></a></p>
<p>Contains all the Artists needed to make an x tick - the tick line,
the label text and the grid line</p>
<p>bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in points</p>
<dl class="method">
<dt id="matplotlib.axis.XTick.apply_tickdir">
<code class="descname">apply_tickdir</code><span class="sig-paren">(</span><em>tickdir</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XTick.apply_tickdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XTick.get_view_interval">
<code class="descname">get_view_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XTick.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.XTick.update_position">
<code class="descname">update_position</code><span class="sig-paren">(</span><em>loc</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.XTick.update_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the location of tick in data coords with scalar <em>loc</em></p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.axis.YAxis">
<em class="property">class </em><code class="descclassname">matplotlib.axis.</code><code class="descname">YAxis</code><span class="sig-paren">(</span><em>axes</em>, <em>pickradius=15</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.axis.Axis</span></code></a></p>
<p>Init the axis with the parent Axes instance</p>
<dl class="attribute">
<dt id="matplotlib.axis.YAxis.axis_name">
<code class="descname">axis_name</code><em class="property"> = 'y'</em><a class="headerlink" href="#matplotlib.axis.YAxis.axis_name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em>mouseevent</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the mouse event occurred in the y axis.</p>
<p>Returns <em>True</em> | <em>False</em></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.get_data_interval">
<code class="descname">get_data_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.get_data_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis data limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.get_label_position">
<code class="descname">get_label_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.get_label_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the label position (left or right)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.get_minpos">
<code class="descname">get_minpos</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.get_minpos" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.get_text_widths">
<code class="descname">get_text_widths</code><span class="sig-paren">(</span><em>renderer</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.get_text_widths" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.get_ticks_position">
<code class="descname">get_ticks_position</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.get_ticks_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the ticks position (left, right, both or unknown)</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.get_view_interval">
<code class="descname">get_view_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.set_data_interval">
<code class="descname">set_data_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.set_data_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>set the axis data limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.set_default_intervals">
<code class="descname">set_default_intervals</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.set_default_intervals" title="Permalink to this definition">¶</a></dt>
<dd><p>set the default limits for the axis interval if they are not mutated</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.set_label_position">
<code class="descname">set_label_position</code><span class="sig-paren">(</span><em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.set_label_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the label position (left or right)</p>
<p>ACCEPTS: [ ‘left’ | ‘right’ ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.set_offset_position">
<code class="descname">set_offset_position</code><span class="sig-paren">(</span><em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.set_offset_position" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.set_ticks_position">
<code class="descname">set_ticks_position</code><span class="sig-paren">(</span><em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.set_ticks_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the ticks position (left, right, both, default or none)
‘both’ sets the ticks to appear on both positions, but does not
change the tick labels. ‘default’ resets the tick positions to
the default: ticks on both positions, labels at left. ‘none’
can be used if you don’t want any ticks. ‘none’ and ‘both’
affect only the ticks, not the labels.</p>
<p>ACCEPTS: [ ‘left’ | ‘right’ | ‘both’ | ‘default’ | ‘none’ ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.set_view_interval">
<code class="descname">set_view_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em>, <em>ignore=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>If <em>ignore</em> is <em>False</em>, the order of vmin, vmax
does not matter; the original axis orientation will
be preserved. In addition, the view limits can be
expanded, but will not be reduced. This method is
for mpl internal use; for normal use, see
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_ylim" title="matplotlib.axes.Axes.set_ylim"><code class="xref py py-meth docutils literal"><span class="pre">set_ylim()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.tick_left">
<code class="descname">tick_left</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.tick_left" title="Permalink to this definition">¶</a></dt>
<dd><p>use ticks only on left</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YAxis.tick_right">
<code class="descname">tick_right</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YAxis.tick_right" title="Permalink to this definition">¶</a></dt>
<dd><p>use ticks only on right</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.axis.YTick">
<em class="property">class </em><code class="descclassname">matplotlib.axis.</code><code class="descname">YTick</code><span class="sig-paren">(</span><em>axes</em>, <em>loc</em>, <em>label</em>, <em>size=None</em>, <em>width=None</em>, <em>color=None</em>, <em>tickdir=None</em>, <em>pad=None</em>, <em>labelsize=None</em>, <em>labelcolor=None</em>, <em>zorder=None</em>, <em>gridOn=None</em>, <em>tick1On=True</em>, <em>tick2On=True</em>, <em>label1On=True</em>, <em>label2On=False</em>, <em>major=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YTick" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.axis.Tick" title="matplotlib.axis.Tick"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.axis.Tick</span></code></a></p>
<p>Contains all the Artists needed to make a Y tick - the tick line,
the label text and the grid line</p>
<p>bbox is the Bound2D bounding box in display coords of the Axes
loc is the tick location in data coords
size is the tick size in points</p>
<dl class="method">
<dt id="matplotlib.axis.YTick.apply_tickdir">
<code class="descname">apply_tickdir</code><span class="sig-paren">(</span><em>tickdir</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YTick.apply_tickdir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YTick.get_view_interval">
<code class="descname">get_view_interval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YTick.get_view_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>return the Interval instance for this axis view limits</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.axis.YTick.update_position">
<code class="descname">update_position</code><span class="sig-paren">(</span><em>loc</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.axis.YTick.update_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the location of tick in data coords with scalar loc</p>
</dd></dl>
</dd></dl>