-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathartists.html
More file actions
952 lines (888 loc) · 87.8 KB
/
artists.html
File metadata and controls
952 lines (888 loc) · 87.8 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
<!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>Artist tutorial — 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="Tutorials" href="../index.html" />
<link rel="next" title="Customizing Figure Layouts Using GridSpec and Other Functions" href="gridspec.html" />
<link rel="prev" title="Legend guide" href="legend_guide.html" />
<link rel="canonical" href="https://matplotlib.org/stable/tutorials/intermediate/artists.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</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/tutorials/intermediate/artists.html">https://matplotlib.org/stable/tutorials/intermediate/artists.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="gridspec.html" title="Customizing Figure Layouts Using GridSpec and Other Functions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="legend_guide.html" title="Legend guide"
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="../index.html">tutorials</a>| </li>
<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../../users/index.html" >User's Guide</a> »</li>
<li><a href="../index.html" accesskey="U">Tutorials</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="#">Artist tutorial</a><ul>
<li><a class="reference internal" href="#customizing-your-objects">Customizing your objects</a></li>
<li><a class="reference internal" href="#object-containers">Object containers</a><ul>
<li><a class="reference internal" href="#figure-container">Figure container</a></li>
<li><a class="reference internal" href="#axes-container">Axes container</a></li>
<li><a class="reference internal" href="#axis-containers">Axis containers</a></li>
<li><a class="reference internal" href="#tick-containers">Tick containers</a></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="../../users/index.html">User's Guide</a><ul>
<li><a href="../index.html">Tutorials</a><ul>
<li>Previous: <a href="legend_guide.html" title="previous chapter">Legend guide</a></li>
<li>Next: <a href="gridspec.html" title="next chapter">Customizing Figure Layouts Using GridSpec and Other Functions</a></li>
</ul></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/tutorials/intermediate/artists.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="sphx-glr-download-link-note admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Click <a class="reference internal" href="#sphx-glr-download-tutorials-intermediate-artists-py"><span class="std std-ref">here</span></a> to download the full example code</p>
</div>
<div class="sphx-glr-example-title section" id="artist-tutorial">
<span id="sphx-glr-tutorials-intermediate-artists-py"></span><h1>Artist tutorial<a class="headerlink" href="#artist-tutorial" title="Permalink to this headline">¶</a></h1>
<p>Using Artist objects to render on the canvas.</p>
<p>There are three layers to the matplotlib API.</p>
<ul class="simple">
<li>the <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.FigureCanvas</span></code> is the area onto which
the figure is drawn</li>
<li>the <code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.backend_bases.Renderer</span></code> is
the object which knows how to draw on the
<code class="xref py py-class docutils literal notranslate"><span class="pre">FigureCanvas</span></code></li>
<li>and the <a class="reference internal" href="../../api/artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.artist.Artist</span></code></a> is the object that knows how to use
a renderer to paint onto the canvas.</li>
</ul>
<p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">FigureCanvas</span></code> and
<code class="xref py py-class docutils literal notranslate"><span class="pre">Renderer</span></code> handle all the details of
talking to user interface toolkits like <a class="reference external" href="https://www.wxpython.org">wxPython</a> or drawing languages like PostScript®, and
the <code class="docutils literal notranslate"><span class="pre">Artist</span></code> handles all the high level constructs like representing
and laying out the figure, text, and lines. The typical user will
spend 95% of their time working with the <code class="docutils literal notranslate"><span class="pre">Artists</span></code>.</p>
<p>There are two types of <code class="docutils literal notranslate"><span class="pre">Artists</span></code>: primitives and containers. The primitives
represent the standard graphical objects we want to paint onto our canvas:
<a class="reference internal" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a>, <a class="reference internal" href="../../api/_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">Rectangle</span></code></a>,
<a class="reference internal" href="../../api/text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">Text</span></code></a>, <a class="reference internal" href="../../api/image_api.html#matplotlib.image.AxesImage" title="matplotlib.image.AxesImage"><code class="xref py py-class docutils literal notranslate"><span class="pre">AxesImage</span></code></a>, etc., and
the containers are places to put them (<a class="reference internal" href="../../api/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>,
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a> and <a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">Figure</span></code></a>). The
standard use is to create a <a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">Figure</span></code></a> instance, use
the <code class="docutils literal notranslate"><span class="pre">Figure</span></code> to create one or more <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a> or
<code class="xref py py-class docutils literal notranslate"><span class="pre">Subplot</span></code> instances, and use the <code class="docutils literal notranslate"><span class="pre">Axes</span></code> instance
helper methods to create the primitives. In the example below, we create a
<code class="docutils literal notranslate"><span class="pre">Figure</span></code> instance using <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.figure()</span></code></a>, which is a
convenience method for instantiating <code class="docutils literal notranslate"><span class="pre">Figure</span></code> instances and connecting them
with your user interface or drawing toolkit <code class="docutils literal notranslate"><span class="pre">FigureCanvas</span></code>. As we will
discuss below, this is not necessary -- you can work directly with PostScript,
PDF Gtk+, or wxPython <code class="docutils literal notranslate"><span class="pre">FigureCanvas</span></code> instances, instantiate your <code class="docutils literal notranslate"><span class="pre">Figures</span></code>
directly and connect them yourselves -- but since we are focusing here on the
<code class="docutils literal notranslate"><span class="pre">Artist</span></code> API we'll let <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pyplot</span></code></a> handle some of those details
for us:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="n">fig</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="View documentation for matplotlib.pyplot.figure"><span class="n">plt</span><span class="o">.</span><span class="n">figure</span></a><span class="p">()</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># two rows, one column, first plot</span>
</pre></div>
</div>
<p>The <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a> is probably the most important
class in the matplotlib API, and the one you will be working with most
of the time. This is because the <code class="docutils literal notranslate"><span class="pre">Axes</span></code> is the plotting area into
which most of the objects go, and the <code class="docutils literal notranslate"><span class="pre">Axes</span></code> has many special helper
methods (<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.plot.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-meth docutils literal notranslate"><span class="pre">plot()</span></code></a>,
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.text.html#matplotlib.axes.Axes.text" title="matplotlib.axes.Axes.text"><code class="xref py py-meth docutils literal notranslate"><span class="pre">text()</span></code></a>,
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.hist.html#matplotlib.axes.Axes.hist" title="matplotlib.axes.Axes.hist"><code class="xref py py-meth docutils literal notranslate"><span class="pre">hist()</span></code></a>,
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.imshow.html#matplotlib.axes.Axes.imshow" title="matplotlib.axes.Axes.imshow"><code class="xref py py-meth docutils literal notranslate"><span class="pre">imshow()</span></code></a>) to create the most common
graphics primitives (<a class="reference internal" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a>,
<a class="reference internal" href="../../api/text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">Text</span></code></a>,
<a class="reference internal" href="../../api/_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">Rectangle</span></code></a>,
<code class="xref py py-class docutils literal notranslate"><span class="pre">Image</span></code>, respectively). These helper methods
will take your data (e.g., <code class="docutils literal notranslate"><span class="pre">numpy</span></code> arrays and strings) and create
primitive <code class="docutils literal notranslate"><span class="pre">Artist</span></code> instances as needed (e.g., <code class="docutils literal notranslate"><span class="pre">Line2D</span></code>), add them to
the relevant containers, and draw them when requested. Most of you
are probably familiar with the <code class="xref py py-class docutils literal notranslate"><span class="pre">Subplot</span></code>,
which is just a special case of an <code class="docutils literal notranslate"><span class="pre">Axes</span></code> that lives on a regular
rows by columns grid of <code class="docutils literal notranslate"><span class="pre">Subplot</span></code> instances. If you want to create
an <code class="docutils literal notranslate"><span class="pre">Axes</span></code> at an arbitrary location, simply use the
<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.add_axes" title="matplotlib.figure.Figure.add_axes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_axes()</span></code></a> method which takes a list
of <code class="docutils literal notranslate"><span class="pre">[left,</span> <span class="pre">bottom,</span> <span class="pre">width,</span> <span class="pre">height]</span></code> values in 0-1 relative figure
coordinates:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">fig2</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="View documentation for matplotlib.pyplot.figure"><span class="n">plt</span><span class="o">.</span><span class="n">figure</span></a><span class="p">()</span>
<span class="n">ax2</span> <span class="o">=</span> <span class="n">fig2</span><span class="o">.</span><span class="n">add_axes</span><span class="p">([</span><span class="mf">0.15</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">])</span>
</pre></div>
</div>
<p>Continuing with our example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="n">t</span> <span class="o">=</span> <a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.arange.html#numpy.arange" title="View documentation for numpy.arange"><span class="n">np</span><span class="o">.</span><span class="n">arange</span></a><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.01</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.sin.html#numpy.sin" title="View documentation for numpy.sin"><span class="n">np</span><span class="o">.</span><span class="n">sin</span></a><span class="p">(</span><span class="mi">2</span><span class="o">*</span><a href="https://docs.scipy.org/doc/numpy/reference/constants.html#numpy.pi" title="View documentation for numpy.pi"><span class="n">np</span><span class="o">.</span><span class="n">pi</span></a><span class="o">*</span><span class="n">t</span><span class="p">)</span>
<span class="n">line</span><span class="p">,</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'blue'</span><span class="p">,</span> <span class="n">lw</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</pre></div>
</div>
<p>In this example, <code class="docutils literal notranslate"><span class="pre">ax</span></code> is the <code class="docutils literal notranslate"><span class="pre">Axes</span></code> instance created by the
<code class="docutils literal notranslate"><span class="pre">fig.add_subplot</span></code> call above (remember <code class="docutils literal notranslate"><span class="pre">Subplot</span></code> is just a
subclass of <code class="docutils literal notranslate"><span class="pre">Axes</span></code>) and when you call <code class="docutils literal notranslate"><span class="pre">ax.plot</span></code>, it creates a
<code class="docutils literal notranslate"><span class="pre">Line2D</span></code> instance and adds it to the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Axes.lines</span></code> list. In the interactive <a class="reference external" href="http://ipython.org/">ipython</a> session below, you can see that the
<code class="docutils literal notranslate"><span class="pre">Axes.lines</span></code> list is length one and contains the same line that was
returned by the <code class="docutils literal notranslate"><span class="pre">line,</span> <span class="pre">=</span> <span class="pre">ax.plot...</span></code> call:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [101]: </span><span class="n">ax</span><span class="o">.</span><span class="n">lines</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="gh">Out[101]: </span><span class="go"><matplotlib.lines.Line2D instance at 0x19a95710></span>
<span class="gp">In [102]: </span><span class="n">line</span>
<span class="gh">Out[102]: </span><span class="go"><matplotlib.lines.Line2D instance at 0x19a95710></span>
</pre></div>
</div>
<p>If you make subsequent calls to <code class="docutils literal notranslate"><span class="pre">ax.plot</span></code> (and the hold state is "on"
which is the default) then additional lines will be added to the list.
You can remove lines later simply by calling the list methods; either
of these will work:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">del</span> <span class="n">ax</span><span class="o">.</span><span class="n">lines</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">ax</span><span class="o">.</span><span class="n">lines</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">line</span><span class="p">)</span> <span class="c1"># one or the other, not both!</span>
</pre></div>
</div>
<p>The Axes also has helper methods to configure and decorate the x-axis
and y-axis tick, tick labels and axis labels:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">xtext</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">set_xlabel</span><span class="p">(</span><span class="s1">'my xdata'</span><span class="p">)</span> <span class="c1"># returns a Text instance</span>
<span class="n">ytext</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">set_ylabel</span><span class="p">(</span><span class="s1">'my ydata'</span><span class="p">)</span>
</pre></div>
</div>
<p>When you call <a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.set_xlabel.html#matplotlib.axes.Axes.set_xlabel" title="matplotlib.axes.Axes.set_xlabel"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ax.set_xlabel</span></code></a>,
it passes the information on the <a class="reference internal" href="../../api/text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">Text</span></code></a>
instance of the <a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.XAxis" title="matplotlib.axis.XAxis"><code class="xref py py-class docutils literal notranslate"><span class="pre">XAxis</span></code></a>. Each <code class="docutils literal notranslate"><span class="pre">Axes</span></code>
instance contains an <a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.XAxis" title="matplotlib.axis.XAxis"><code class="xref py py-class docutils literal notranslate"><span class="pre">XAxis</span></code></a> and a
<a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.YAxis" title="matplotlib.axis.YAxis"><code class="xref py py-class docutils literal notranslate"><span class="pre">YAxis</span></code></a> instance, which handle the layout and
drawing of the ticks, tick labels and axis labels.</p>
<p>Try creating the figure below.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="kn">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="kn">as</span> <span class="nn">plt</span>
<span class="n">fig</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="View documentation for matplotlib.pyplot.figure"><span class="n">plt</span><span class="o">.</span><span class="n">figure</span></a><span class="p">()</span>
<span class="n">fig</span><span class="o">.</span><span class="n">subplots_adjust</span><span class="p">(</span><span class="n">top</span><span class="o">=</span><span class="mf">0.8</span><span class="p">)</span>
<span class="n">ax1</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">211</span><span class="p">)</span>
<span class="n">ax1</span><span class="o">.</span><span class="n">set_ylabel</span><span class="p">(</span><span class="s1">'volts'</span><span class="p">)</span>
<span class="n">ax1</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s1">'a sine wave'</span><span class="p">)</span>
<span class="n">t</span> <span class="o">=</span> <a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.arange.html#numpy.arange" title="View documentation for numpy.arange"><span class="n">np</span><span class="o">.</span><span class="n">arange</span></a><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.01</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.sin.html#numpy.sin" title="View documentation for numpy.sin"><span class="n">np</span><span class="o">.</span><span class="n">sin</span></a><span class="p">(</span><span class="mi">2</span><span class="o">*</span><a href="https://docs.scipy.org/doc/numpy/reference/constants.html#numpy.pi" title="View documentation for numpy.pi"><span class="n">np</span><span class="o">.</span><span class="n">pi</span></a><span class="o">*</span><span class="n">t</span><span class="p">)</span>
<span class="n">line</span><span class="p">,</span> <span class="o">=</span> <span class="n">ax1</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'blue'</span><span class="p">,</span> <span class="n">lw</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="c1"># Fixing random state for reproducibility</span>
<a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.seed.html#numpy.random.seed" title="View documentation for numpy.random.seed"><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span></a><span class="p">(</span><span class="mi">19680801</span><span class="p">)</span>
<span class="n">ax2</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">([</span><span class="mf">0.15</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">])</span>
<span class="n">n</span><span class="p">,</span> <span class="n">bins</span><span class="p">,</span> <span class="n">patches</span> <span class="o">=</span> <span class="n">ax2</span><span class="o">.</span><span class="n">hist</span><span class="p">(</span><a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randn.html#numpy.random.randn" title="View documentation for numpy.random.randn"><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randn</span></a><span class="p">(</span><span class="mi">1000</span><span class="p">),</span> <span class="mi">50</span><span class="p">,</span>
<span class="n">facecolor</span><span class="o">=</span><span class="s1">'yellow'</span><span class="p">,</span> <span class="n">edgecolor</span><span class="o">=</span><span class="s1">'yellow'</span><span class="p">)</span>
<span class="n">ax2</span><span class="o">.</span><span class="n">set_xlabel</span><span class="p">(</span><span class="s1">'time (s)'</span><span class="p">)</span>
<a href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="View documentation for matplotlib.pyplot.show"><span class="n">plt</span><span class="o">.</span><span class="n">show</span></a><span class="p">()</span>
</pre></div>
</div>
<img alt="../../_images/sphx_glr_artists_001.png" class="sphx-glr-single-img" src="../../_images/sphx_glr_artists_001.png" />
<div class="section" id="customizing-your-objects">
<span id="customizing-artists"></span><h2>Customizing your objects<a class="headerlink" href="#customizing-your-objects" title="Permalink to this headline">¶</a></h2>
<p>Every element in the figure is represented by a matplotlib
<a class="reference internal" href="../../api/artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">Artist</span></code></a>, and each has an extensive list of
properties to configure its appearance. The figure itself contains a
<a class="reference internal" href="../../api/_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">Rectangle</span></code></a> exactly the size of the figure,
which you can use to set the background color and transparency of the
figures. Likewise, each <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a> bounding box
(the standard white box with black edges in the typical matplotlib
plot, has a <code class="docutils literal notranslate"><span class="pre">Rectangle</span></code> instance that determines the color,
transparency, and other properties of the Axes. These instances are
stored as member variables <code class="xref py py-attr docutils literal notranslate"><span class="pre">Figure.patch</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">Axes.patch</span></code> ("Patch" is a name inherited from
MATLAB, and is a 2D "patch" of color on the figure, e.g., rectangles,
circles and polygons). Every matplotlib <code class="docutils literal notranslate"><span class="pre">Artist</span></code> has the following
properties</p>
<table border="1" class="docutils">
<colgroup>
<col width="11%" />
<col width="89%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>alpha</td>
<td>The transparency - a scalar from 0-1</td>
</tr>
<tr class="row-odd"><td>animated</td>
<td>A boolean that is used to facilitate animated drawing</td>
</tr>
<tr class="row-even"><td>axes</td>
<td>The axes that the Artist lives in, possibly None</td>
</tr>
<tr class="row-odd"><td>clip_box</td>
<td>The bounding box that clips the Artist</td>
</tr>
<tr class="row-even"><td>clip_on</td>
<td>Whether clipping is enabled</td>
</tr>
<tr class="row-odd"><td>clip_path</td>
<td>The path the artist is clipped to</td>
</tr>
<tr class="row-even"><td>contains</td>
<td>A picking function to test whether the artist contains the pick point</td>
</tr>
<tr class="row-odd"><td>figure</td>
<td>The figure instance the artist lives in, possibly None</td>
</tr>
<tr class="row-even"><td>label</td>
<td>A text label (e.g., for auto-labeling)</td>
</tr>
<tr class="row-odd"><td>picker</td>
<td>A python object that controls object picking</td>
</tr>
<tr class="row-even"><td>transform</td>
<td>The transformation</td>
</tr>
<tr class="row-odd"><td>visible</td>
<td>A boolean whether the artist should be drawn</td>
</tr>
<tr class="row-even"><td>zorder</td>
<td>A number which determines the drawing order</td>
</tr>
<tr class="row-odd"><td>rasterized</td>
<td>Boolean; Turns vectors into rastergraphics: (for compression & eps transparency)</td>
</tr>
</tbody>
</table>
<p>Each of the properties is accessed with an old-fashioned setter or
getter (yes we know this irritates Pythonistas and we plan to support
direct access via properties or traits but it hasn't been done yet).
For example, to multiply the current alpha by a half:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">get_alpha</span><span class="p">()</span>
<span class="n">o</span><span class="o">.</span><span class="n">set_alpha</span><span class="p">(</span><span class="mf">0.5</span><span class="o">*</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
<p>If you want to set a number of properties at once, you can also use
the <code class="docutils literal notranslate"><span class="pre">set</span></code> method with keyword arguments. For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">o</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">alpha</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span> <span class="n">zorder</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</pre></div>
</div>
<p>If you are working interactively at the python shell, a handy way to
inspect the <code class="docutils literal notranslate"><span class="pre">Artist</span></code> properties is to use the
<a class="reference internal" href="../../api/_as_gen/matplotlib.artist.getp.html#matplotlib.artist.getp" title="matplotlib.artist.getp"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.artist.getp()</span></code></a> function (simply
<code class="xref py py-func docutils literal notranslate"><span class="pre">getp()</span></code> in pylab), which lists the properties
and their values. This works for classes derived from <code class="docutils literal notranslate"><span class="pre">Artist</span></code> as
well, e.g., <code class="docutils literal notranslate"><span class="pre">Figure</span></code> and <code class="docutils literal notranslate"><span class="pre">Rectangle</span></code>. Here are the <code class="docutils literal notranslate"><span class="pre">Figure</span></code> rectangle
properties mentioned above:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [149]: </span><span class="n">matplotlib</span><span class="o">.</span><span class="n">artist</span><span class="o">.</span><span class="n">getp</span><span class="p">(</span><span class="n">fig</span><span class="o">.</span><span class="n">patch</span><span class="p">)</span>
<span class="go"> alpha = 1.0</span>
<span class="go"> animated = False</span>
<span class="go"> antialiased or aa = True</span>
<span class="go"> axes = None</span>
<span class="go"> clip_box = None</span>
<span class="go"> clip_on = False</span>
<span class="go"> clip_path = None</span>
<span class="go"> contains = None</span>
<span class="go"> edgecolor or ec = w</span>
<span class="go"> facecolor or fc = 0.75</span>
<span class="go"> figure = Figure(8.125x6.125)</span>
<span class="go"> fill = 1</span>
<span class="go"> hatch = None</span>
<span class="go"> height = 1</span>
<span class="go"> label =</span>
<span class="go"> linewidth or lw = 1.0</span>
<span class="go"> picker = None</span>
<span class="go"> transform = <Affine object at 0x134cca84></span>
<span class="go"> verts = ((0, 0), (0, 1), (1, 1), (1, 0))</span>
<span class="go"> visible = True</span>
<span class="go"> width = 1</span>
<span class="go"> window_extent = <Bbox object at 0x134acbcc></span>
<span class="go"> x = 0</span>
<span class="go"> y = 0</span>
<span class="go"> zorder = 1</span>
</pre></div>
</div>
<p>The docstrings for all of the classes also contain the <code class="docutils literal notranslate"><span class="pre">Artist</span></code>
properties, so you can consult the interactive "help" or the
<a class="reference internal" href="../../api/artist_api.html#artist-api"><span class="std std-ref">artist Module</span></a> for a listing of properties for a given object.</p>
</div>
<div class="section" id="object-containers">
<span id="id1"></span><h2>Object containers<a class="headerlink" href="#object-containers" title="Permalink to this headline">¶</a></h2>
<p>Now that we know how to inspect and set the properties of a given
object we want to configure, we need to know how to get at that object.
As mentioned in the introduction, there are two kinds of objects:
primitives and containers. The primitives are usually the things you
want to configure (the font of a <a class="reference internal" href="../../api/text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">Text</span></code></a>
instance, the width of a <a class="reference internal" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a>) although
the containers also have some properties as well -- for example the
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a> <a class="reference internal" href="../../api/artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">Artist</span></code></a> is a
container that contains many of the primitives in your plot, but it
also has properties like the <code class="docutils literal notranslate"><span class="pre">xscale</span></code> to control whether the xaxis
is 'linear' or 'log'. In this section we'll review where the various
container objects store the <code class="docutils literal notranslate"><span class="pre">Artists</span></code> that you want to get at.</p>
<div class="section" id="figure-container">
<span id="id2"></span><h3>Figure container<a class="headerlink" href="#figure-container" title="Permalink to this headline">¶</a></h3>
<p>The top level container <code class="docutils literal notranslate"><span class="pre">Artist</span></code> is the
<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.figure.Figure</span></code></a>, and it contains everything in the
figure. The background of the figure is a
<a class="reference internal" href="../../api/_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">Rectangle</span></code></a> which is stored in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Figure.patch</span></code>. As
you add subplots (<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.add_subplot" title="matplotlib.figure.Figure.add_subplot"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_subplot()</span></code></a>) and
axes (<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.add_axes" title="matplotlib.figure.Figure.add_axes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_axes()</span></code></a>) to the figure
these will be appended to the <a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.axes" title="matplotlib.figure.Figure.axes"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Figure.axes</span></code></a>. These are also returned by the
methods that create them:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [156]: </span><span class="n">fig</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="View documentation for matplotlib.pyplot.figure"><span class="n">plt</span><span class="o">.</span><span class="n">figure</span></a><span class="p">()</span>
<span class="gp">In [157]: </span><span class="n">ax1</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">211</span><span class="p">)</span>
<span class="gp">In [158]: </span><span class="n">ax2</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">([</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">])</span>
<span class="gp">In [159]: </span><span class="n">ax1</span>
<span class="gh">Out[159]: </span><span class="go"><matplotlib.axes.Subplot instance at 0xd54b26c></span>
<span class="gp">In [160]: </span><span class="k">print</span><span class="p">(</span><span class="n">fig</span><span class="o">.</span><span class="n">axes</span><span class="p">)</span>
<span class="go">[<matplotlib.axes.Subplot instance at 0xd54b26c>, <matplotlib.axes.Axes instance at 0xd3f0b2c>]</span>
</pre></div>
</div>
<p>Because the figure maintains the concept of the "current axes" (see
<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.gca" title="matplotlib.figure.Figure.gca"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Figure.gca</span></code></a> and
<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.sca" title="matplotlib.figure.Figure.sca"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Figure.sca</span></code></a>) to support the
pylab/pyplot state machine, you should not insert or remove axes
directly from the axes list, but rather use the
<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.add_subplot" title="matplotlib.figure.Figure.add_subplot"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_subplot()</span></code></a> and
<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.add_axes" title="matplotlib.figure.Figure.add_axes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_axes()</span></code></a> methods to insert, and the
<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.delaxes" title="matplotlib.figure.Figure.delaxes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">delaxes()</span></code></a> method to delete. You are
free however, to iterate over the list of axes or index into it to get
access to <code class="docutils literal notranslate"><span class="pre">Axes</span></code> instances you want to customize. Here is an
example which turns all the axes grids on:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">ax</span> <span class="ow">in</span> <span class="n">fig</span><span class="o">.</span><span class="n">axes</span><span class="p">:</span>
<span class="n">ax</span><span class="o">.</span><span class="n">grid</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>The figure also has its own text, lines, patches and images, which you
can use to add primitives directly. The default coordinate system for
the <code class="docutils literal notranslate"><span class="pre">Figure</span></code> will simply be in pixels (which is not usually what you
want) but you can control this by setting the transform property of
the <code class="docutils literal notranslate"><span class="pre">Artist</span></code> you are adding to the figure.</p>
<p>More useful is "figure coordinates" where (0, 0) is the bottom-left of
the figure and (1, 1) is the top-right of the figure which you can
obtain by setting the <code class="docutils literal notranslate"><span class="pre">Artist</span></code> transform to <code class="xref py py-attr docutils literal notranslate"><span class="pre">fig.transFigure</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib.lines</span> <span class="kn">as</span> <span class="nn">lines</span>
<span class="n">fig</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="View documentation for matplotlib.pyplot.figure"><span class="n">plt</span><span class="o">.</span><span class="n">figure</span></a><span class="p">()</span>
<span class="n">l1</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="View documentation for matplotlib.lines.Line2D"><span class="n">lines</span><span class="o">.</span><span class="n">Line2D</span></a><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="n">transform</span><span class="o">=</span><span class="n">fig</span><span class="o">.</span><span class="n">transFigure</span><span class="p">,</span> <span class="n">figure</span><span class="o">=</span><span class="n">fig</span><span class="p">)</span>
<span class="n">l2</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="View documentation for matplotlib.lines.Line2D"><span class="n">lines</span><span class="o">.</span><span class="n">Line2D</span></a><span class="p">([</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="n">transform</span><span class="o">=</span><span class="n">fig</span><span class="o">.</span><span class="n">transFigure</span><span class="p">,</span> <span class="n">figure</span><span class="o">=</span><span class="n">fig</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">lines</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="n">l1</span><span class="p">,</span> <span class="n">l2</span><span class="p">])</span>
<a href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="View documentation for matplotlib.pyplot.show"><span class="n">plt</span><span class="o">.</span><span class="n">show</span></a><span class="p">()</span>
</pre></div>
</div>
<img alt="../../_images/sphx_glr_artists_002.png" class="sphx-glr-single-img" src="../../_images/sphx_glr_artists_002.png" />
<p>Here is a summary of the Artists the figure contains</p>
<table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Figure attribute</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>axes</td>
<td>A list of Axes instances (includes Subplot)</td>
</tr>
<tr class="row-odd"><td>patch</td>
<td>The Rectangle background</td>
</tr>
<tr class="row-even"><td>images</td>
<td>A list of FigureImages patches - useful for raw pixel display</td>
</tr>
<tr class="row-odd"><td>legends</td>
<td>A list of Figure Legend instances (different from Axes.legends)</td>
</tr>
<tr class="row-even"><td>lines</td>
<td>A list of Figure Line2D instances (rarely used, see Axes.lines)</td>
</tr>
<tr class="row-odd"><td>patches</td>
<td>A list of Figure patches (rarely used, see Axes.patches)</td>
</tr>
<tr class="row-even"><td>texts</td>
<td>A list Figure Text instances</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="axes-container">
<span id="id3"></span><h3>Axes container<a class="headerlink" href="#axes-container" title="Permalink to this headline">¶</a></h3>
<p>The <a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a> is the center of the matplotlib
universe -- it contains the vast majority of all the <code class="docutils literal notranslate"><span class="pre">Artists</span></code> used
in a figure with many helper methods to create and add these
<code class="docutils literal notranslate"><span class="pre">Artists</span></code> to itself, as well as helper methods to access and
customize the <code class="docutils literal notranslate"><span class="pre">Artists</span></code> it contains. Like the
<a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">Figure</span></code></a>, it contains a
<a class="reference internal" href="../../api/_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal notranslate"><span class="pre">Patch</span></code></a>
<code class="xref py py-attr docutils literal notranslate"><span class="pre">patch</span></code> which is a
<a class="reference internal" href="../../api/_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">Rectangle</span></code></a> for Cartesian coordinates and a
<a class="reference internal" href="../../api/_as_gen/matplotlib.patches.Circle.html#matplotlib.patches.Circle" title="matplotlib.patches.Circle"><code class="xref py py-class docutils literal notranslate"><span class="pre">Circle</span></code></a> for polar coordinates; this patch
determines the shape, background and border of the plotting region:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">)</span>
<span class="n">rect</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">patch</span> <span class="c1"># a Rectangle instance</span>
<span class="n">rect</span><span class="o">.</span><span class="n">set_facecolor</span><span class="p">(</span><span class="s1">'green'</span><span class="p">)</span>
</pre></div>
</div>
<p>When you call a plotting method, e.g., the canonical
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.plot.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-meth docutils literal notranslate"><span class="pre">plot()</span></code></a> and pass in arrays or lists of
values, the method will create a <a class="reference internal" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-meth docutils literal notranslate"><span class="pre">matplotlib.lines.Line2D()</span></code></a>
instance, update the line with all the <code class="docutils literal notranslate"><span class="pre">Line2D</span></code> properties passed as
keyword arguments, add the line to the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Axes.lines</span></code> container, and returns it to you:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [213]: </span><span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.rand.html#numpy.random.rand" title="View documentation for numpy.random.rand"><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span></a><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">100</span><span class="p">)</span>
<span class="gp">In [214]: </span><span class="n">line</span><span class="p">,</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="s1">'-'</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'blue'</span><span class="p">,</span> <span class="n">linewidth</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">plot</span></code> returns a list of lines because you can pass in multiple x, y
pairs to plot, and we are unpacking the first element of the length
one list into the line variable. The line has been added to the
<code class="docutils literal notranslate"><span class="pre">Axes.lines</span></code> list:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [229]: </span><span class="k">print</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">lines</span><span class="p">)</span>
<span class="go">[<matplotlib.lines.Line2D instance at 0xd378b0c>]</span>
</pre></div>
</div>
<p>Similarly, methods that create patches, like
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bar()</span></code></a> creates a list of rectangles, will
add the patches to the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Axes.patches</span></code> list:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [233]: </span><span class="n">n</span><span class="p">,</span> <span class="n">bins</span><span class="p">,</span> <span class="n">rectangles</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">hist</span><span class="p">(</span><a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.randn.html#numpy.random.randn" title="View documentation for numpy.random.randn"><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randn</span></a><span class="p">(</span><span class="mi">1000</span><span class="p">),</span> <span class="mi">50</span><span class="p">,</span> <span class="n">facecolor</span><span class="o">=</span><span class="s1">'yellow'</span><span class="p">)</span>
<span class="gp">In [234]: </span><span class="n">rectangles</span>
<span class="gh">Out[234]: </span><span class="go"><a list of 50 Patch objects></span>
<span class="gp">In [235]: </span><span class="k">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">patches</span><span class="p">))</span>
</pre></div>
</div>
<p>You should not add objects directly to the <code class="docutils literal notranslate"><span class="pre">Axes.lines</span></code> or
<code class="docutils literal notranslate"><span class="pre">Axes.patches</span></code> lists unless you know exactly what you are doing,
because the <code class="docutils literal notranslate"><span class="pre">Axes</span></code> needs to do a few things when it creates and adds
an object. It sets the figure and axes property of the <code class="docutils literal notranslate"><span class="pre">Artist</span></code>, as
well as the default <code class="docutils literal notranslate"><span class="pre">Axes</span></code> transformation (unless a transformation
is set). It also inspects the data contained in the <code class="docutils literal notranslate"><span class="pre">Artist</span></code> to
update the data structures controlling auto-scaling, so that the view
limits can be adjusted to contain the plotted data. You can,
nonetheless, create objects yourself and add them directly to the
<code class="docutils literal notranslate"><span class="pre">Axes</span></code> using helper methods like
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.add_line.html#matplotlib.axes.Axes.add_line" title="matplotlib.axes.Axes.add_line"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_line()</span></code></a> and
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.add_patch.html#matplotlib.axes.Axes.add_patch" title="matplotlib.axes.Axes.add_patch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_patch()</span></code></a>. Here is an annotated
interactive session illustrating what is going on:</p>
<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [262]: </span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="View documentation for matplotlib.pyplot.subplots"><span class="n">plt</span><span class="o">.</span><span class="n">subplots</span></a><span class="p">()</span>
<span class="go"># create a rectangle instance</span>
<span class="gp">In [263]: </span><span class="n">rect</span> <span class="o">=</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">patches</span><span class="o">.</span><span class="n">Rectangle</span><span class="p">(</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">),</span> <span class="n">width</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="mi">12</span><span class="p">)</span>
<span class="go"># by default the axes instance is None</span>
<span class="gp">In [264]: </span><span class="k">print</span><span class="p">(</span><span class="n">rect</span><span class="o">.</span><span class="n">get_axes</span><span class="p">())</span>
<span class="go">None</span>
<span class="go"># and the transformation instance is set to the "identity transform"</span>
<span class="gp">In [265]: </span><span class="k">print</span><span class="p">(</span><span class="n">rect</span><span class="o">.</span><span class="n">get_transform</span><span class="p">())</span>
<span class="go"><Affine object at 0x13695544></span>
<span class="go"># now we add the Rectangle to the Axes</span>
<span class="gp">In [266]: </span><span class="n">ax</span><span class="o">.</span><span class="n">add_patch</span><span class="p">(</span><span class="n">rect</span><span class="p">)</span>
<span class="go"># and notice that the ax.add_patch method has set the axes</span>
<span class="go"># instance</span>
<span class="gp">In [267]: </span><span class="k">print</span><span class="p">(</span><span class="n">rect</span><span class="o">.</span><span class="n">get_axes</span><span class="p">())</span>
<span class="go">Axes(0.125,0.1;0.775x0.8)</span>
<span class="go"># and the transformation has been set too</span>
<span class="gp">In [268]: </span><span class="k">print</span><span class="p">(</span><span class="n">rect</span><span class="o">.</span><span class="n">get_transform</span><span class="p">())</span>
<span class="go"><Affine object at 0x15009ca4></span>
<span class="go"># the default axes transformation is ax.transData</span>
<span class="gp">In [269]: </span><span class="k">print</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">transData</span><span class="p">)</span>
<span class="go"><Affine object at 0x15009ca4></span>
<span class="go"># notice that the xlimits of the Axes have not been changed</span>
<span class="gp">In [270]: </span><span class="k">print</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">get_xlim</span><span class="p">())</span>
<span class="go">(0.0, 1.0)</span>
<span class="go"># but the data limits have been updated to encompass the rectangle</span>
<span class="gp">In [271]: </span><span class="k">print</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">dataLim</span><span class="o">.</span><span class="n">bounds</span><span class="p">)</span>
<span class="go">(1.0, 1.0, 5.0, 12.0)</span>
<span class="go"># we can manually invoke the auto-scaling machinery</span>
<span class="gp">In [272]: </span><span class="n">ax</span><span class="o">.</span><span class="n">autoscale_view</span><span class="p">()</span>
<span class="go"># and now the xlim are updated to encompass the rectangle</span>
<span class="gp">In [273]: </span><span class="k">print</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">get_xlim</span><span class="p">())</span>
<span class="go">(1.0, 6.0)</span>
<span class="go"># we have to manually force a figure draw</span>
<span class="gp">In [274]: </span><span class="n">ax</span><span class="o">.</span><span class="n">figure</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">draw</span><span class="p">()</span>
</pre></div>
</div>
<p>There are many, many <code class="docutils literal notranslate"><span class="pre">Axes</span></code> helper methods for creating primitive
<code class="docutils literal notranslate"><span class="pre">Artists</span></code> and adding them to their respective containers. The table
below summarizes a small sampling of them, the kinds of <code class="docutils literal notranslate"><span class="pre">Artist</span></code> they
create, and where they store them</p>
<table border="1" class="docutils">
<colgroup>
<col width="41%" />
<col width="27%" />
<col width="32%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Helper method</th>
<th class="head">Artist</th>
<th class="head">Container</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>ax.annotate - text annotations</td>
<td>Annotate</td>
<td>ax.texts</td>
</tr>
<tr class="row-odd"><td>ax.bar - bar charts</td>
<td>Rectangle</td>
<td>ax.patches</td>
</tr>
<tr class="row-even"><td>ax.errorbar - error bar plots</td>
<td>Line2D and Rectangle</td>
<td>ax.lines and ax.patches</td>
</tr>
<tr class="row-odd"><td>ax.fill - shared area</td>
<td>Polygon</td>
<td>ax.patches</td>
</tr>
<tr class="row-even"><td>ax.hist - histograms</td>
<td>Rectangle</td>
<td>ax.patches</td>
</tr>
<tr class="row-odd"><td>ax.imshow - image data</td>
<td>AxesImage</td>
<td>ax.images</td>
</tr>
<tr class="row-even"><td>ax.legend - axes legends</td>
<td>Legend</td>
<td>ax.legends</td>
</tr>
<tr class="row-odd"><td>ax.plot - xy plots</td>
<td>Line2D</td>
<td>ax.lines</td>
</tr>
<tr class="row-even"><td>ax.scatter - scatter charts</td>
<td>PolygonCollection</td>
<td>ax.collections</td>
</tr>
<tr class="row-odd"><td>ax.text - text</td>
<td>Text</td>
<td>ax.texts</td>
</tr>
</tbody>
</table>
<p>In addition to all of these <code class="docutils literal notranslate"><span class="pre">Artists</span></code>, the <code class="docutils literal notranslate"><span class="pre">Axes</span></code> contains two
important <code class="docutils literal notranslate"><span class="pre">Artist</span></code> containers: the <a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.XAxis" title="matplotlib.axis.XAxis"><code class="xref py py-class docutils literal notranslate"><span class="pre">XAxis</span></code></a>
and <a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.YAxis" title="matplotlib.axis.YAxis"><code class="xref py py-class docutils literal notranslate"><span class="pre">YAxis</span></code></a>, which handle the drawing of the
ticks and labels. These are stored as instance variables
<code class="xref py py-attr docutils literal notranslate"><span class="pre">xaxis</span></code> and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">yaxis</span></code>. The <code class="docutils literal notranslate"><span class="pre">XAxis</span></code> and <code class="docutils literal notranslate"><span class="pre">YAxis</span></code>
containers will be detailed below, but note that the <code class="docutils literal notranslate"><span class="pre">Axes</span></code> contains
many helper methods which forward calls on to the
<a class="reference internal" href="../../api/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> instances so you often do not need to
work with them directly unless you want to. For example, you can set
the font color of the <code class="docutils literal notranslate"><span class="pre">XAxis</span></code> ticklabels using the <code class="docutils literal notranslate"><span class="pre">Axes</span></code> helper
method:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">label</span> <span class="ow">in</span> <span class="n">ax</span><span class="o">.</span><span class="n">get_xticklabels</span><span class="p">():</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s1">'orange'</span><span class="p">)</span>
</pre></div>
</div>
<p>Below is a summary of the Artists that the Axes contains</p>
<table border="1" class="docutils">
<colgroup>
<col width="27%" />
<col width="73%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Axes attribute</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>artists</td>
<td>A list of Artist instances</td>
</tr>
<tr class="row-odd"><td>patch</td>
<td>Rectangle instance for Axes background</td>
</tr>
<tr class="row-even"><td>collections</td>
<td>A list of Collection instances</td>
</tr>
<tr class="row-odd"><td>images</td>
<td>A list of AxesImage</td>
</tr>
<tr class="row-even"><td>legends</td>
<td>A list of Legend instances</td>
</tr>
<tr class="row-odd"><td>lines</td>
<td>A list of Line2D instances</td>
</tr>
<tr class="row-even"><td>patches</td>
<td>A list of Patch instances</td>
</tr>
<tr class="row-odd"><td>texts</td>
<td>A list of Text instances</td>
</tr>
<tr class="row-even"><td>xaxis</td>
<td>matplotlib.axis.XAxis instance</td>
</tr>
<tr class="row-odd"><td>yaxis</td>
<td>matplotlib.axis.YAxis instance</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="axis-containers">
<span id="axis-container"></span><h3>Axis containers<a class="headerlink" href="#axis-containers" title="Permalink to this headline">¶</a></h3>
<p>The <a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.Axis" title="matplotlib.axis.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axis.Axis</span></code></a> instances handle the drawing of the
tick lines, the grid lines, the tick labels and the axis label. You
can configure the left and right ticks separately for the y-axis, and
the upper and lower ticks separately for the x-axis. The <code class="docutils literal notranslate"><span class="pre">Axis</span></code>
also stores the data and view intervals used in auto-scaling, panning
and zooming, as well as the <a class="reference internal" href="../../api/ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal notranslate"><span class="pre">Locator</span></code></a> and
<a class="reference internal" href="../../api/ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Formatter</span></code></a> instances which control where
the ticks are placed and how they are represented as strings.</p>
<p>Each <code class="docutils literal notranslate"><span class="pre">Axis</span></code> object contains a <code class="xref py py-attr docutils literal notranslate"><span class="pre">label</span></code> attribute
(this is what <code class="xref py py-mod docutils literal notranslate"><span class="pre">pylab</span></code> modifies in calls to
<code class="xref py py-func docutils literal notranslate"><span class="pre">xlabel()</span></code> and <code class="xref py py-func docutils literal notranslate"><span class="pre">ylabel()</span></code>) as well
as a list of major and minor ticks. The ticks are
<a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.XTick" title="matplotlib.axis.XTick"><code class="xref py py-class docutils literal notranslate"><span class="pre">XTick</span></code></a> and <a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.YTick" title="matplotlib.axis.YTick"><code class="xref py py-class docutils literal notranslate"><span class="pre">YTick</span></code></a> instances,
which contain the actual line and text primitives that render the ticks and
ticklabels. Because the ticks are dynamically created as needed (e.g., when
panning and zooming), you should access the lists of major and minor ticks
through their accessor methods <a class="reference internal" href="../../api/_as_gen/matplotlib.axis.Axis.get_major_ticks.html#matplotlib.axis.Axis.get_major_ticks" title="matplotlib.axis.Axis.get_major_ticks"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_major_ticks()</span></code></a>
and <a class="reference internal" href="../../api/_as_gen/matplotlib.axis.Axis.get_minor_ticks.html#matplotlib.axis.Axis.get_minor_ticks" title="matplotlib.axis.Axis.get_minor_ticks"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_minor_ticks()</span></code></a>. Although the ticks contain
all the primitives and will be covered below, <code class="docutils literal notranslate"><span class="pre">Axis</span></code> instances have accessor
methods that return the tick lines, tick labels, tick locations etc.:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="View documentation for matplotlib.pyplot.subplots"><span class="n">plt</span><span class="o">.</span><span class="n">subplots</span></a><span class="p">()</span>
<span class="n">axis</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">xaxis</span>
<span class="n">axis</span><span class="o">.</span><span class="n">get_ticklocs</span><span class="p">()</span>
</pre></div>
</div>
<img alt="../../_images/sphx_glr_artists_003.png" class="sphx-glr-single-img" src="../../_images/sphx_glr_artists_003.png" />
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">axis</span><span class="o">.</span><span class="n">get_ticklabels</span><span class="p">()</span>
</pre></div>
</div>
<dl class="docutils">
<dt>note there are twice as many ticklines as labels because by</dt>
<dd>default there are tick lines at the top and bottom but only tick
labels below the xaxis; this can be customized</dd>
</dl>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">axis</span><span class="o">.</span><span class="n">get_ticklines</span><span class="p">()</span>
</pre></div>
</div>
<p>by default you get the major ticks back</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">axis</span><span class="o">.</span><span class="n">get_ticklines</span><span class="p">()</span>
</pre></div>
</div>
<p>but you can also ask for the minor ticks</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">axis</span><span class="o">.</span><span class="n">get_ticklines</span><span class="p">(</span><span class="n">minor</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="c1"># Here is a summary of some of the useful accessor methods of the ``Axis``</span>
<span class="c1"># (these have corresponding setters where useful, such as</span>
<span class="c1"># set_major_formatter)</span>
<span class="c1">#</span>
<span class="c1"># ====================== =========================================================</span>
<span class="c1"># Accessor method Description</span>
<span class="c1"># ====================== =========================================================</span>
<span class="c1"># get_scale The scale of the axis, e.g., 'log' or 'linear'</span>
<span class="c1"># get_view_interval The interval instance of the axis view limits</span>
<span class="c1"># get_data_interval The interval instance of the axis data limits</span>
<span class="c1"># get_gridlines A list of grid lines for the Axis</span>
<span class="c1"># get_label The axis label - a Text instance</span>
<span class="c1"># get_ticklabels A list of Text instances - keyword minor=True|False</span>
<span class="c1"># get_ticklines A list of Line2D instances - keyword minor=True|False</span>
<span class="c1"># get_ticklocs A list of Tick locations - keyword minor=True|False</span>
<span class="c1"># get_major_locator The matplotlib.ticker.Locator instance for major ticks</span>
<span class="c1"># get_major_formatter The matplotlib.ticker.Formatter instance for major ticks</span>
<span class="c1"># get_minor_locator The matplotlib.ticker.Locator instance for minor ticks</span>
<span class="c1"># get_minor_formatter The matplotlib.ticker.Formatter instance for minor ticks</span>
<span class="c1"># get_major_ticks A list of Tick instances for major ticks</span>
<span class="c1"># get_minor_ticks A list of Tick instances for minor ticks</span>
<span class="c1"># grid Turn the grid on or off for the major or minor ticks</span>
<span class="c1"># ====================== =========================================================</span>
<span class="c1">#</span>
<span class="c1"># Here is an example, not recommended for its beauty, which customizes</span>
<span class="c1"># the axes and tick properties</span>
<span class="c1"># plt.figure creates a matplotlib.figure.Figure instance</span>
<span class="n">fig</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="View documentation for matplotlib.pyplot.figure"><span class="n">plt</span><span class="o">.</span><span class="n">figure</span></a><span class="p">()</span>
<span class="n">rect</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">patch</span> <span class="c1"># a rectangle instance</span>
<span class="n">rect</span><span class="o">.</span><span class="n">set_facecolor</span><span class="p">(</span><span class="s1">'lightgoldenrodyellow'</span><span class="p">)</span>
<span class="n">ax1</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">([</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">,</span> <span class="mf">0.4</span><span class="p">,</span> <span class="mf">0.4</span><span class="p">])</span>
<span class="n">rect</span> <span class="o">=</span> <span class="n">ax1</span><span class="o">.</span><span class="n">patch</span>
<span class="n">rect</span><span class="o">.</span><span class="n">set_facecolor</span><span class="p">(</span><span class="s1">'lightslategray'</span><span class="p">)</span>
<span class="k">for</span> <span class="n">label</span> <span class="ow">in</span> <span class="n">ax1</span><span class="o">.</span><span class="n">xaxis</span><span class="o">.</span><span class="n">get_ticklabels</span><span class="p">():</span>
<span class="c1"># label is a Text instance</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s1">'red'</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_rotation</span><span class="p">(</span><span class="mi">45</span><span class="p">)</span>
<span class="n">label</span><span class="o">.</span><span class="n">set_fontsize</span><span class="p">(</span><span class="mi">16</span><span class="p">)</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">ax1</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">get_ticklines</span><span class="p">():</span>
<span class="c1"># line is a Line2D instance</span>
<span class="n">line</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s1">'green'</span><span class="p">)</span>
<span class="n">line</span><span class="o">.</span><span class="n">set_markersize</span><span class="p">(</span><span class="mi">25</span><span class="p">)</span>
<span class="n">line</span><span class="o">.</span><span class="n">set_markeredgewidth</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
<a href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="View documentation for matplotlib.pyplot.show"><span class="n">plt</span><span class="o">.</span><span class="n">show</span></a><span class="p">()</span>
</pre></div>
</div>
<img alt="../../_images/sphx_glr_artists_004.png" class="sphx-glr-single-img" src="../../_images/sphx_glr_artists_004.png" />
</div>
<div class="section" id="tick-containers">
<span id="tick-container"></span><h3>Tick containers<a class="headerlink" href="#tick-containers" title="Permalink to this headline">¶</a></h3>
<p>The <a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.Tick" title="matplotlib.axis.Tick"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axis.Tick</span></code></a> is the final container object in our
descent from the <a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">Figure</span></code></a> to the
<a class="reference internal" href="../../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axes</span></code></a> to the <a class="reference internal" href="../../api/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>
to the <a class="reference internal" href="../../api/axis_api.html#matplotlib.axis.Tick" title="matplotlib.axis.Tick"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tick</span></code></a>. The <code class="docutils literal notranslate"><span class="pre">Tick</span></code> contains the tick
and grid line instances, as well as the label instances for the upper
and lower ticks. Each of these is accessible directly as an attribute
of the <code class="docutils literal notranslate"><span class="pre">Tick</span></code>. In addition, there are boolean variables that determine
whether the upper labels and ticks are on for the x-axis and whether
the right labels and ticks are on for the y-axis.</p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="81%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Tick attribute</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>tick1line</td>
<td>Line2D instance</td>
</tr>
<tr class="row-odd"><td>tick2line</td>
<td>Line2D instance</td>
</tr>
<tr class="row-even"><td>gridline</td>
<td>Line2D instance</td>
</tr>
<tr class="row-odd"><td>label1</td>
<td>Text instance</td>
</tr>
<tr class="row-even"><td>label2</td>
<td>Text instance</td>
</tr>
<tr class="row-odd"><td>gridOn</td>
<td>boolean which determines whether to draw the gridline</td>
</tr>
<tr class="row-even"><td>tick1On</td>
<td>boolean which determines whether to draw the 1st tickline</td>
</tr>
<tr class="row-odd"><td>tick2On</td>
<td>boolean which determines whether to draw the 2nd tickline</td>
</tr>
<tr class="row-even"><td>label1On</td>
<td>boolean which determines whether to draw the 1st tick label</td>
</tr>
<tr class="row-odd"><td>label2On</td>
<td>boolean which determines whether to draw the 2nd tick label</td>
</tr>
</tbody>
</table>
<p>Here is an example which sets the formatter for the right side ticks with
dollar signs and colors them green on the right side of the yaxis</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib.ticker</span> <span class="kn">as</span> <span class="nn">ticker</span>
<span class="c1"># Fixing random state for reproducibility</span>
<a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.seed.html#numpy.random.seed" title="View documentation for numpy.random.seed"><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span></a><span class="p">(</span><span class="mi">19680801</span><span class="p">)</span>
<span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <a href="../../api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="View documentation for matplotlib.pyplot.subplots"><span class="n">plt</span><span class="o">.</span><span class="n">subplots</span></a><span class="p">()</span>
<span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="mi">100</span><span class="o">*</span><a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.random.rand.html#numpy.random.rand" title="View documentation for numpy.random.rand"><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span></a><span class="p">(</span><span class="mi">20</span><span class="p">))</span>
<span class="n">formatter</span> <span class="o">=</span> <a href="../../api/ticker_api.html#matplotlib.ticker.FormatStrFormatter" title="View documentation for matplotlib.ticker.FormatStrFormatter"><span class="n">ticker</span><span class="o">.</span><span class="n">FormatStrFormatter</span></a><span class="p">(</span><span class="s1">'$</span><span class="si">%1.2f</span><span class="s1">'</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">formatter</span><span class="p">)</span>
<span class="k">for</span> <span class="n">tick</span> <span class="ow">in</span> <span class="n">ax</span><span class="o">.</span><span class="n">yaxis</span><span class="o">.</span><span class="n">get_major_ticks</span><span class="p">():</span>
<span class="n">tick</span><span class="o">.</span><span class="n">label1On</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">tick</span><span class="o">.</span><span class="n">label2On</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">tick</span><span class="o">.</span><span class="n">label2</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s1">'green'</span><span class="p">)</span>
<a href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="View documentation for matplotlib.pyplot.show"><span class="n">plt</span><span class="o">.</span><span class="n">show</span></a><span class="p">()</span>
</pre></div>
</div>
<img alt="../../_images/sphx_glr_artists_005.png" class="sphx-glr-single-img" src="../../_images/sphx_glr_artists_005.png" />
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-tutorials-intermediate-artists-py">
<div class="sphx-glr-download docutils container">
<a class="reference download internal" download="" href="../../_downloads/c0dca0cebb664c0c9dec8119840480a9/artists.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">artists.py</span></code></a></div>
<div class="sphx-glr-download docutils container">
<a class="reference download internal" download="" href="../../_downloads/ea3874eba9fa9e462dc88342ed558371/artists.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">artists.ipynb</span></code></a></div>
</div>
<p class="sphx-glr-signature">Keywords: matplotlib code example, codex, python plot, pyplot
<a class="reference external" href="https://sphinx-gallery.readthedocs.io">Gallery generated by Sphinx-Gallery</a></p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Feb 28, 2019.
Created using
<ahref="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
Doc version v2.2.4-2-g38a93e9a0-dirty.
</div>
</body>
<footer>
</footer>
</html>