forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcollections_api.html
More file actions
1386 lines (1259 loc) · 91.9 KB
/
collections_api.html
File metadata and controls
1386 lines (1259 loc) · 91.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>collections — Matplotlib 1.3.1 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.3.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.3.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.3.1 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="colorbar" href="colorbar_api.html" />
<link rel="prev" title="cm (colormap)" href="cm_api.html" />
</head>
<body>
<!-- Piwik -->
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
}
</script>
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
piwik_action_name = '';
piwik_idsite = 1;
piwik_url = pkBaseURL + "piwik.php";
piwik_log(piwik_action_name, piwik_idsite, piwik_url);
document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));
}
</script>
<!-- End Piwik Tag -->
<link rel="shortcut icon" href="_static/favicon.ico">
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</div>
<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="colorbar_api.html" title="colorbar"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="cm_api.html" title="cm (colormap)"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">collections</a><ul>
<li><a class="reference internal" href="#module-matplotlib.collections"><tt class="docutils literal"><span class="pre">matplotlib.collections</span></tt></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="cm_api.html"
title="previous chapter">cm (colormap)</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="colorbar_api.html"
title="next chapter">colorbar</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/collections_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="collections">
<h1>collections<a class="headerlink" href="#collections" title="Permalink to this headline">¶</a></h1>
<p class="graphviz">
<img src="../_images/inheritance-beca91d991cfcaeac66dd6025f1acc1fa0c921d5.png" alt="Inheritance diagram of matplotlib.collections" usemap="#inheritance829eaf436e" class="inheritance"/>
<map id="inheritance829eaf436e" name="inheritance829eaf436e">
<area shape="rect" id="node1" href="#matplotlib.collections.QuadMesh" title="Class for the efficient drawing of a quadrilateral mesh." alt="" coords="357,4,489,24"/>
<area shape="rect" id="node2" href="#matplotlib.collections.Collection" title="Base class for Collections.  Must be subclassed to be usable." alt="" coords="165,164,291,185"/>
<area shape="rect" id="node5" href="#matplotlib.collections.RegularPolyCollection" title="Draw a collection of regular polygons with *numsides*." alt="" coords="330,44,516,65"/>
<area shape="rect" id="node7" href="#matplotlib.collections.PathCollection" title="This is the most basic :class:`Collection` subclass." alt="" coords="349,84,497,105"/>
<area shape="rect" id="node10" href="#matplotlib.collections.PolyCollection" title="collections.PolyCollection" alt="" coords="349,124,497,145"/>
<area shape="rect" id="node12" href="#matplotlib.collections.LineCollection" title="All parameters must be sequences or scalars; if scalars, they will" alt="" coords="349,164,497,185"/>
<area shape="rect" id="node14" href="#matplotlib.collections.TriMesh" title="Class for the efficient drawing of a triangular mesh using" alt="" coords="366,204,480,225"/>
<area shape="rect" id="node16" href="#matplotlib.collections.EllipseCollection" title="A collection of ellipses, drawn using splines." alt="" coords="344,245,502,265"/>
<area shape="rect" id="node27" href="#matplotlib.collections.CircleCollection" title="A collection of circles, drawn using splines." alt="" coords="345,285,501,305"/>
<area shape="rect" id="node30" href="#matplotlib.collections.PatchCollection" title="A generic collection of patches." alt="" coords="345,325,501,345"/>
<area shape="rect" id="node4" href="#matplotlib.collections.StarPolygonCollection" title="Draw a collection of regular stars with *numsides* points." alt="" coords="565,24,754,45"/>
<area shape="rect" id="node18" href="#matplotlib.collections.AsteriskPolygonCollection" title="Draw a collection of regular asterisks with *numsides* points." alt="" coords="555,65,764,85"/>
<area shape="rect" id="node9" href="#matplotlib.collections.BrokenBarHCollection" title="A collection of horizontal bars spanning *yrange* with a sequence of" alt="" coords="565,124,754,145"/>
<area shape="rect" id="node20" href="#matplotlib.collections.EventCollection" title="A collection of discrete events." alt="" coords="582,164,737,185"/>
<area shape="rect" id="node22" href="artist_api.html#matplotlib.artist.Artist" title="Abstract base class for someone who renders into a" alt="" coords="27,144,103,164"/>
<area shape="rect" id="node24" href="cm_api.html#matplotlib.cm.ScalarMappable" title="This is a mixin class to support scalar data to RGBA mapping." alt="" coords="5,184,125,204"/>
</map>
</p>
<div class="section" id="module-matplotlib.collections">
<span id="matplotlib-collections"></span><h2><a class="reference internal" href="#module-matplotlib.collections" title="matplotlib.collections"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.collections</span></tt></a><a class="headerlink" href="#module-matplotlib.collections" title="Permalink to this headline">¶</a></h2>
<p>Classes for the efficient drawing of large collections of objects that
share most properties, e.g., a large number of line segments or
polygons.</p>
<p>The classes are not meant to be as flexible as their single element
counterparts (e.g., you may not be able to select all line styles) but
they are meant to be fast for common use cases (e.g., a large set of solid
line segemnts)</p>
<dl class="class">
<dt id="matplotlib.collections.AsteriskPolygonCollection">
<em class="property">class </em><tt class="descclassname">matplotlib.collections.</tt><tt class="descname">AsteriskPolygonCollection</tt><big>(</big><em>numsides</em>, <em>rotation=0</em>, <em>sizes=(1</em>, <em>)</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.AsteriskPolygonCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.collections.RegularPolyCollection" title="matplotlib.collections.RegularPolyCollection"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.collections.RegularPolyCollection</span></tt></a></p>
<p>Draw a collection of regular asterisks with <em>numsides</em> points.</p>
<dl class="docutils">
<dt><em>numsides</em></dt>
<dd>the number of sides of the polygon</dd>
<dt><em>rotation</em></dt>
<dd>the rotation of the polygon in radians</dd>
<dt><em>sizes</em></dt>
<dd><p class="first">gives the area of the circle circumscribing the
regular polygon in points^2</p>
<p>Valid Collection keyword arguments:</p>
<blockquote>
<div><ul class="simple">
<li><em>edgecolors</em>: None</li>
<li><em>facecolors</em>: None</li>
<li><em>linewidths</em>: None</li>
<li><em>antialiaseds</em>: None</li>
<li><em>offsets</em>: None</li>
<li><em>transOffset</em>: transforms.IdentityTransform()</li>
<li><em>norm</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
<li><em>cmap</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
</ul>
</div></blockquote>
<p><em>offsets</em> and <em>transOffset</em> are used to translate the patch after
rendering (default no offsets)</p>
<p class="last">If any of <em>edgecolors</em>, <em>facecolors</em>, <em>linewidths</em>, <em>antialiaseds</em>
are None, they default to their <tt class="xref py py-data docutils literal"><span class="pre">matplotlib.rcParams</span></tt> patch
setting, in sequence form.</p>
</dd>
</dl>
<p>Example: see <tt class="file docutils literal"><span class="pre">examples/dynamic_collection.py</span></tt> for
complete example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">offsets</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span>
<span class="n">facecolors</span> <span class="o">=</span> <span class="p">[</span><span class="n">cm</span><span class="o">.</span><span class="n">jet</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">(</span><span class="mi">20</span><span class="p">)]</span>
<span class="n">black</span> <span class="o">=</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</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">collection</span> <span class="o">=</span> <span class="n">RegularPolyCollection</span><span class="p">(</span>
<span class="n">numsides</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="c"># a pentagon</span>
<span class="n">rotation</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">sizes</span><span class="o">=</span><span class="p">(</span><span class="mi">50</span><span class="p">,),</span>
<span class="n">facecolors</span> <span class="o">=</span> <span class="n">facecolors</span><span class="p">,</span>
<span class="n">edgecolors</span> <span class="o">=</span> <span class="p">(</span><span class="n">black</span><span class="p">,),</span>
<span class="n">linewidths</span> <span class="o">=</span> <span class="p">(</span><span class="mi">1</span><span class="p">,),</span>
<span class="n">offsets</span> <span class="o">=</span> <span class="n">offsets</span><span class="p">,</span>
<span class="n">transOffset</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">transData</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="matplotlib.collections.BrokenBarHCollection">
<em class="property">class </em><tt class="descclassname">matplotlib.collections.</tt><tt class="descname">BrokenBarHCollection</tt><big>(</big><em>xranges</em>, <em>yrange</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.BrokenBarHCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.collections.PolyCollection" title="matplotlib.collections.PolyCollection"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.collections.PolyCollection</span></tt></a></p>
<p>A collection of horizontal bars spanning <em>yrange</em> with a sequence of
<em>xranges</em>.</p>
<dl class="docutils">
<dt><em>xranges</em></dt>
<dd>sequence of (<em>xmin</em>, <em>xwidth</em>)</dd>
<dt><em>yrange</em></dt>
<dd><p class="first"><em>ymin</em>, <em>ywidth</em></p>
<p>Valid Collection keyword arguments:</p>
<blockquote>
<div><ul class="simple">
<li><em>edgecolors</em>: None</li>
<li><em>facecolors</em>: None</li>
<li><em>linewidths</em>: None</li>
<li><em>antialiaseds</em>: None</li>
<li><em>offsets</em>: None</li>
<li><em>transOffset</em>: transforms.IdentityTransform()</li>
<li><em>norm</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
<li><em>cmap</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
</ul>
</div></blockquote>
<p><em>offsets</em> and <em>transOffset</em> are used to translate the patch after
rendering (default no offsets)</p>
<p class="last">If any of <em>edgecolors</em>, <em>facecolors</em>, <em>linewidths</em>, <em>antialiaseds</em>
are None, they default to their <tt class="xref py py-data docutils literal"><span class="pre">matplotlib.rcParams</span></tt> patch
setting, in sequence form.</p>
</dd>
</dl>
<dl class="staticmethod">
<dt id="matplotlib.collections.BrokenBarHCollection.span_where">
<em class="property">static </em><tt class="descname">span_where</tt><big>(</big><em>x</em>, <em>ymin</em>, <em>ymax</em>, <em>where</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.BrokenBarHCollection.span_where" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a BrokenBarHCollection to plot horizontal bars from
over the regions in <em>x</em> where <em>where</em> is True. The bars range
on the y-axis from <em>ymin</em> to <em>ymax</em></p>
<p>A <a class="reference internal" href="#matplotlib.collections.BrokenBarHCollection" title="matplotlib.collections.BrokenBarHCollection"><tt class="xref py py-class docutils literal"><span class="pre">BrokenBarHCollection</span></tt></a> is returned. <em>kwargs</em> are
passed on to the collection.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.collections.CircleCollection">
<em class="property">class </em><tt class="descclassname">matplotlib.collections.</tt><tt class="descname">CircleCollection</tt><big>(</big><em>sizes</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.CircleCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.collections.Collection</span></tt></a></p>
<p>A collection of circles, drawn using splines.</p>
<p><em>sizes</em>
Gives the area of the circle in points^2</p>
<p>Valid Collection keyword arguments:</p>
<blockquote>
<div><ul class="simple">
<li><em>edgecolors</em>: None</li>
<li><em>facecolors</em>: None</li>
<li><em>linewidths</em>: None</li>
<li><em>antialiaseds</em>: None</li>
<li><em>offsets</em>: None</li>
<li><em>transOffset</em>: transforms.IdentityTransform()</li>
<li><em>norm</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
<li><em>cmap</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
</ul>
</div></blockquote>
<p><em>offsets</em> and <em>transOffset</em> are used to translate the patch after
rendering (default no offsets)</p>
<p>If any of <em>edgecolors</em>, <em>facecolors</em>, <em>linewidths</em>, <em>antialiaseds</em>
are None, they default to their <tt class="xref py py-data docutils literal"><span class="pre">matplotlib.rcParams</span></tt> patch
setting, in sequence form.</p>
<dl class="method">
<dt id="matplotlib.collections.CircleCollection.draw">
<tt class="descname">draw</tt><big>(</big><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.CircleCollection.draw" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.CircleCollection.get_sizes">
<tt class="descname">get_sizes</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.CircleCollection.get_sizes" title="Permalink to this definition">¶</a></dt>
<dd><p>return sizes of circles</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.collections.Collection">
<em class="property">class </em><tt class="descclassname">matplotlib.collections.</tt><tt class="descname">Collection</tt><big>(</big><em>edgecolors=None</em>, <em>facecolors=None</em>, <em>linewidths=None</em>, <em>linestyles='solid'</em>, <em>antialiaseds=None</em>, <em>offsets=None</em>, <em>transOffset=None</em>, <em>norm=None</em>, <em>cmap=None</em>, <em>pickradius=5.0</em>, <em>hatch=None</em>, <em>urls=None</em>, <em>offset_position='screen'</em>, <em>zorder=1</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.artist.Artist</span></tt></a>, <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a></p>
<p>Base class for Collections. Must be subclassed to be usable.</p>
<p>All properties in a collection must be sequences or scalars;
if scalars, they will be converted to sequences. The
property of the ith element of the collection is:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">prop</span><span class="p">[</span><span class="n">i</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">props</span><span class="p">)]</span>
</pre></div>
</div>
<p>Keyword arguments and default values:</p>
<blockquote>
<div><ul class="simple">
<li><em>edgecolors</em>: None</li>
<li><em>facecolors</em>: None</li>
<li><em>linewidths</em>: None</li>
<li><em>antialiaseds</em>: None</li>
<li><em>offsets</em>: None</li>
<li><em>transOffset</em>: transforms.IdentityTransform()</li>
<li><em>offset_position</em>: ‘screen’ (default) or ‘data’</li>
<li><em>norm</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
<li><em>cmap</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
<li><em>hatch</em>: None</li>
<li><em>zorder</em>: 1</li>
</ul>
</div></blockquote>
<p><em>offsets</em> and <em>transOffset</em> are used to translate the patch after
rendering (default no offsets). If offset_position is ‘screen’
(default) the offset is applied after the master transform has
been applied, that is, the offsets are in screen coordinates. If
offset_position is ‘data’, the offset is applied before the master
transform, i.e., the offsets are in data coordinates.</p>
<p>If any of <em>edgecolors</em>, <em>facecolors</em>, <em>linewidths</em>, <em>antialiaseds</em>
are None, they default to their <tt class="xref py py-data docutils literal"><span class="pre">matplotlib.rcParams</span></tt> patch
setting, in sequence form.</p>
<p>The use of <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">ScalarMappable</span></tt></a> is optional. If
the <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">ScalarMappable</span></tt></a> matrix _A is not None
(ie a call to set_array has been made), at draw time a call to
scalar mappable will be made to set the face colors.</p>
<p>Create a Collection</p>
<p>%(Collection)s</p>
<dl class="method">
<dt id="matplotlib.collections.Collection.contains">
<tt class="descname">contains</tt><big>(</big><em>mouseevent</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the mouse event occurred in the collection.</p>
<p>Returns True | False, <tt class="docutils literal"><span class="pre">dict(ind=itemlist)</span></tt>, where every
item in itemlist contains the event.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.draw">
<tt class="descname">draw</tt><big>(</big><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.draw" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_dashes">
<tt class="descname">get_dashes</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_dashes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_datalim">
<tt class="descname">get_datalim</tt><big>(</big><em>transData</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_datalim" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_edgecolor">
<tt class="descname">get_edgecolor</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_edgecolor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_edgecolors">
<tt class="descname">get_edgecolors</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_edgecolors" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_facecolor">
<tt class="descname">get_facecolor</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_facecolor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_facecolors">
<tt class="descname">get_facecolors</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_facecolors" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_hatch">
<tt class="descname">get_hatch</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_hatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the current hatching pattern</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_linestyle">
<tt class="descname">get_linestyle</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_linestyle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_linestyles">
<tt class="descname">get_linestyles</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_linestyles" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_linewidth">
<tt class="descname">get_linewidth</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_linewidth" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_linewidths">
<tt class="descname">get_linewidths</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_linewidths" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_offset_position">
<tt class="descname">get_offset_position</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_offset_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns how offsets are applied for the collection. If
<em>offset_position</em> is ‘screen’, the offset is applied after the
master transform has been applied, that is, the offsets are in
screen coordinates. If offset_position is ‘data’, the offset
is applied before the master transform, i.e., the offsets are
in data coordinates.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_offset_transform">
<tt class="descname">get_offset_transform</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_offset_transform" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_offsets">
<tt class="descname">get_offsets</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_offsets" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the offsets for the collection.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_paths">
<tt class="descname">get_paths</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_paths" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_pickradius">
<tt class="descname">get_pickradius</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_pickradius" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_transforms">
<tt class="descname">get_transforms</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_transforms" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_urls">
<tt class="descname">get_urls</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_urls" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.get_window_extent">
<tt class="descname">get_window_extent</tt><big>(</big><em>renderer</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_alpha">
<tt class="descname">set_alpha</tt><big>(</big><em>alpha</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the alpha tranparencies of the collection. <em>alpha</em> must be
a float or <em>None</em>.</p>
<p>ACCEPTS: float or None</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_antialiased">
<tt class="descname">set_antialiased</tt><big>(</big><em>aa</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_antialiased" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the antialiasing state for rendering.</p>
<p>ACCEPTS: Boolean or sequence of booleans</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_antialiaseds">
<tt class="descname">set_antialiaseds</tt><big>(</big><em>aa</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_antialiaseds" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for set_antialiased</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_color">
<tt class="descname">set_color</tt><big>(</big><em>c</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_color" title="Permalink to this definition">¶</a></dt>
<dd><p>Set both the edgecolor and the facecolor.</p>
<p>ACCEPTS: matplotlib color arg or sequence of rgba tuples</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="#matplotlib.collections.Collection.set_facecolor" title="matplotlib.collections.Collection.set_facecolor"><tt class="xref py py-meth docutils literal"><span class="pre">set_facecolor()</span></tt></a>, <a class="reference internal" href="#matplotlib.collections.Collection.set_edgecolor" title="matplotlib.collections.Collection.set_edgecolor"><tt class="xref py py-meth docutils literal"><span class="pre">set_edgecolor()</span></tt></a></dt>
<dd>For setting the edge or face color individually.</dd>
</dl>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_dashes">
<tt class="descname">set_dashes</tt><big>(</big><em>ls</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_dashes" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for set_linestyle</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_edgecolor">
<tt class="descname">set_edgecolor</tt><big>(</big><em>c</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_edgecolor" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the edgecolor(s) of the collection. <em>c</em> can be a
matplotlib color arg (all patches have same color), or a
sequence of rgba tuples; if it is a sequence the patches will
cycle through the sequence.</p>
<p>If <em>c</em> is ‘face’, the edge color will always be the same as
the face color. If it is ‘none’, the patch boundary will not
be drawn.</p>
<p>ACCEPTS: matplotlib color arg or sequence of rgba tuples</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_edgecolors">
<tt class="descname">set_edgecolors</tt><big>(</big><em>c</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_edgecolors" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for set_edgecolor</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_facecolor">
<tt class="descname">set_facecolor</tt><big>(</big><em>c</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_facecolor" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the facecolor(s) of the collection. <em>c</em> can be a
matplotlib color arg (all patches have same color), or a
sequence of rgba tuples; if it is a sequence the patches will
cycle through the sequence.</p>
<p>If <em>c</em> is ‘none’, the patch will not be filled.</p>
<p>ACCEPTS: matplotlib color arg or sequence of rgba tuples</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_facecolors">
<tt class="descname">set_facecolors</tt><big>(</big><em>c</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_facecolors" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for set_facecolor</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_hatch">
<tt class="descname">set_hatch</tt><big>(</big><em>hatch</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_hatch" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the hatching pattern</p>
<p><em>hatch</em> can be one of:</p>
<div class="highlight-python"><pre>/ - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
+ - crossed
x - crossed diagonal
o - small circle
O - large circle
. - dots
* - stars</pre>
</div>
<p>Letters can be combined, in which case all the specified
hatchings are done. If same letter repeats, it increases the
density of hatching of that pattern.</p>
<p>Hatching is supported in the PostScript, PDF, SVG and Agg
backends only.</p>
<p>Unlike other properties such as linewidth and colors, hatching
can only be specified for the collection as a whole, not separately
for each member.</p>
<p>ACCEPTS: [ ‘/’ | ‘\’ | ‘|’ | ‘-‘ | ‘+’ | ‘x’ | ‘o’ | ‘O’ | ‘.’ | ‘*’ ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_linestyle">
<tt class="descname">set_linestyle</tt><big>(</big><em>ls</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_linestyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the linestyle(s) for the collection.</p>
<p>ACCEPTS: [‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ |
(offset, on-off-dash-seq) ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_linestyles">
<tt class="descname">set_linestyles</tt><big>(</big><em>ls</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_linestyles" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for set_linestyle</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_linewidth">
<tt class="descname">set_linewidth</tt><big>(</big><em>lw</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_linewidth" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the linewidth(s) for the collection. <em>lw</em> can be a scalar
or a sequence; if it is a sequence the patches will cycle
through the sequence</p>
<p>ACCEPTS: float or sequence of floats</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_linewidths">
<tt class="descname">set_linewidths</tt><big>(</big><em>lw</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_linewidths" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for set_linewidth</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_lw">
<tt class="descname">set_lw</tt><big>(</big><em>lw</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_lw" title="Permalink to this definition">¶</a></dt>
<dd><p>alias for set_linewidth</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_offset_position">
<tt class="descname">set_offset_position</tt><big>(</big><em>offset_position</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_offset_position" title="Permalink to this definition">¶</a></dt>
<dd><p>Set how offsets are applied. If <em>offset_position</em> is ‘screen’
(default) the offset is applied after the master transform has
been applied, that is, the offsets are in screen coordinates.
If offset_position is ‘data’, the offset is applied before the
master transform, i.e., the offsets are in data coordinates.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_offsets">
<tt class="descname">set_offsets</tt><big>(</big><em>offsets</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_offsets" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the offsets for the collection. <em>offsets</em> can be a scalar
or a sequence.</p>
<p>ACCEPTS: float or sequence of floats</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_paths">
<tt class="descname">set_paths</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_paths" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_pickradius">
<tt class="descname">set_pickradius</tt><big>(</big><em>pr</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_pickradius" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.set_urls">
<tt class="descname">set_urls</tt><big>(</big><em>urls</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.set_urls" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.update_from">
<tt class="descname">update_from</tt><big>(</big><em>other</em><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.update_from" title="Permalink to this definition">¶</a></dt>
<dd><p>copy properties from other to self</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.Collection.update_scalarmappable">
<tt class="descname">update_scalarmappable</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.Collection.update_scalarmappable" title="Permalink to this definition">¶</a></dt>
<dd><p>If the scalar mappable array is not none, update colors
from scalar data</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.collections.EllipseCollection">
<em class="property">class </em><tt class="descclassname">matplotlib.collections.</tt><tt class="descname">EllipseCollection</tt><big>(</big><em>widths</em>, <em>heights</em>, <em>angles</em>, <em>units='points'</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EllipseCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.collections.Collection</span></tt></a></p>
<p>A collection of ellipses, drawn using splines.</p>
<dl class="docutils">
<dt><em>widths</em>: sequence</dt>
<dd>lengths of first axes (e.g., major axis lengths)</dd>
<dt><em>heights</em>: sequence</dt>
<dd>lengths of second axes</dd>
<dt><em>angles</em>: sequence</dt>
<dd>angles of first axes, degrees CCW from the X-axis</dd>
</dl>
<p><em>units</em>: [‘points’ | ‘inches’ | ‘dots’ | ‘width’ | ‘height’
| ‘x’ | ‘y’ | ‘xy’]</p>
<blockquote>
<div>units in which majors and minors are given; ‘width’ and
‘height’ refer to the dimensions of the axes, while ‘x’
and ‘y’ refer to the <em>offsets</em> data units. ‘xy’ differs
from all others in that the angle as plotted varies with
the aspect ratio, and equals the specified angle only when
the aspect ratio is unity. Hence it behaves the same as
the <a class="reference internal" href="artist_api.html#matplotlib.patches.Ellipse" title="matplotlib.patches.Ellipse"><tt class="xref py py-class docutils literal"><span class="pre">Ellipse</span></tt></a> with
axes.transData as its transform.</div></blockquote>
<p>Additional kwargs inherited from the base <a class="reference internal" href="#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><tt class="xref py py-class docutils literal"><span class="pre">Collection</span></tt></a>:</p>
<blockquote>
<div><p>Valid Collection keyword arguments:</p>
<blockquote>
<div><ul class="simple">
<li><em>edgecolors</em>: None</li>
<li><em>facecolors</em>: None</li>
<li><em>linewidths</em>: None</li>
<li><em>antialiaseds</em>: None</li>
<li><em>offsets</em>: None</li>
<li><em>transOffset</em>: transforms.IdentityTransform()</li>
<li><em>norm</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
<li><em>cmap</em>: None (optional for
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</li>
</ul>
</div></blockquote>
<p><em>offsets</em> and <em>transOffset</em> are used to translate the patch after
rendering (default no offsets)</p>
<p>If any of <em>edgecolors</em>, <em>facecolors</em>, <em>linewidths</em>, <em>antialiaseds</em>
are None, they default to their <tt class="xref py py-data docutils literal"><span class="pre">matplotlib.rcParams</span></tt> patch
setting, in sequence form.</p>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.collections.EllipseCollection.draw">
<tt class="descname">draw</tt><big>(</big><em>artist</em>, <em>renderer</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EllipseCollection.draw" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.collections.EventCollection">
<em class="property">class </em><tt class="descclassname">matplotlib.collections.</tt><tt class="descname">EventCollection</tt><big>(</big><em>positions</em>, <em>orientation=None</em>, <em>lineoffset=0</em>, <em>linelength=1</em>, <em>linewidth=None</em>, <em>color=None</em>, <em>linestyle='solid'</em>, <em>antialiased=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.collections.LineCollection" title="matplotlib.collections.LineCollection"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.collections.LineCollection</span></tt></a></p>
<p>A collection of discrete events.</p>
<p>An event is a 1-dimensional value, usually the position of something along
an axis, such as time or length. Events do not have an amplitude. They
are displayed as v</p>
<dl class="docutils">
<dt><em>positions</em></dt>
<dd>a sequence of numerical values or a 1D numpy array. Can be None</dd>
<dt><em>orientation</em> [ ‘horizontal’ | ‘vertical’ | None ]</dt>
<dd>defaults to ‘horizontal’ if not specified or None</dd>
<dt><em>lineoffset</em></dt>
<dd>a single numerical value, corresponding to the offset of the center
of the markers from the origin</dd>
<dt><em>linelength</em></dt>
<dd>a single numerical value, corresponding to the total height of the
marker (i.e. the marker stretches from lineoffset+linelength/2 to
lineoffset-linelength/2). Defaults to 1</dd>
<dt><em>linewidth</em></dt>
<dd>a single numerical value</dd>
<dt><em>color</em></dt>
<dd>must be a sequence of RGBA tuples (eg arbitrary color
strings, etc, not allowed).</dd>
</dl>
<p><em>linestyle</em> [ ‘solid’ | ‘dashed’ | ‘dashdot’ | ‘dotted’ ]</p>
<dl class="docutils">
<dt><em>antialiased</em></dt>
<dd>1 or 2</dd>
</dl>
<p>If <em>linewidth</em>, <em>color</em>, or <em>antialiased</em> is None, they
default to their rcParams setting, in sequence form.</p>
<dl class="docutils">
<dt><em>norm</em></dt>
<dd>None (optional for <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</dd>
<dt><em>cmap</em></dt>
<dd>None (optional for <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</dd>
</dl>
<p><em>pickradius</em> is the tolerance for mouse clicks picking a line.
The default is 5 pt.</p>
<p>The use of <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">ScalarMappable</span></tt></a> is optional.
If the <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">ScalarMappable</span></tt></a> array
<tt class="xref py py-attr docutils literal"><span class="pre">_A</span></tt> is not None (ie a call to
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable.set_array" title="matplotlib.cm.ScalarMappable.set_array"><tt class="xref py py-meth docutils literal"><span class="pre">set_array()</span></tt></a> has been made), at
draw time a call to scalar mappable will be made to set the colors.</p>
<p><strong>Example:</strong></p>
<p>(<a class="reference external" href="../mpl_examples/pylab_examples/eventcollection_demo.py">Source code</a>, <a class="reference external" href="../mpl_examples/pylab_examples/eventcollection_demo.png">png</a>, <a class="reference external" href="../mpl_examples/pylab_examples/eventcollection_demo.hires.png">hires.png</a>, <a class="reference external" href="../mpl_examples/pylab_examples/eventcollection_demo.pdf">pdf</a>)</p>
<div class="figure">
<img alt="../_images/eventcollection_demo.png" src="../_images/eventcollection_demo.png" />
</div>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.add_positions">
<tt class="descname">add_positions</tt><big>(</big><em>position</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.add_positions" title="Permalink to this definition">¶</a></dt>
<dd><p>add one or more events at the specified positions</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.append_positions">
<tt class="descname">append_positions</tt><big>(</big><em>position</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.append_positions" title="Permalink to this definition">¶</a></dt>
<dd><p>add one or more events at the specified positions</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.extend_positions">
<tt class="descname">extend_positions</tt><big>(</big><em>position</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.extend_positions" title="Permalink to this definition">¶</a></dt>
<dd><p>add one or more events at the specified positions</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.get_color">
<tt class="descname">get_color</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.get_color" title="Permalink to this definition">¶</a></dt>
<dd><p>get the color of the lines used to mark each event</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.get_linelength">
<tt class="descname">get_linelength</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.get_linelength" title="Permalink to this definition">¶</a></dt>
<dd><p>get the length of the lines used to mark each event</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.get_lineoffset">
<tt class="descname">get_lineoffset</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.get_lineoffset" title="Permalink to this definition">¶</a></dt>
<dd><p>get the offset of the lines used to mark each event</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.get_linestyle">
<tt class="descname">get_linestyle</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.get_linestyle" title="Permalink to this definition">¶</a></dt>
<dd><p>get the style of the lines used to mark each event
[ ‘solid’ | ‘dashed’ | ‘dashdot’ | ‘dotted’ ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.get_linewidth">
<tt class="descname">get_linewidth</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.get_linewidth" title="Permalink to this definition">¶</a></dt>
<dd><p>get the width of the lines used to mark each event</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.get_orientation">
<tt class="descname">get_orientation</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.get_orientation" title="Permalink to this definition">¶</a></dt>
<dd><p>get the orientation of the event line, may be:
[ ‘horizontal’ | ‘vertical’ ]</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.get_positions">
<tt class="descname">get_positions</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.get_positions" title="Permalink to this definition">¶</a></dt>
<dd><p>return an array containing the floating-point values of the positions</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.is_horizontal">
<tt class="descname">is_horizontal</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.is_horizontal" title="Permalink to this definition">¶</a></dt>
<dd><p>True if the eventcollection is horizontal, False if vertical</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.set_linelength">
<tt class="descname">set_linelength</tt><big>(</big><em>linelength</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.set_linelength" title="Permalink to this definition">¶</a></dt>
<dd><p>set the length of the lines used to mark each event</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.set_lineoffset">
<tt class="descname">set_lineoffset</tt><big>(</big><em>lineoffset</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.set_lineoffset" title="Permalink to this definition">¶</a></dt>
<dd><p>set the offset of the lines used to mark each event</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.set_orientation">
<tt class="descname">set_orientation</tt><big>(</big><em>orientation=None</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.set_orientation" title="Permalink to this definition">¶</a></dt>
<dd><p>set the orientation of the event line
[ ‘horizontal’ | ‘vertical’ | None ]
defaults to ‘horizontal’ if not specified or None</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.set_positions">
<tt class="descname">set_positions</tt><big>(</big><em>positions</em><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.set_positions" title="Permalink to this definition">¶</a></dt>
<dd><p>set the positions of the events to the specified value</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.EventCollection.switch_orientation">
<tt class="descname">switch_orientation</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.EventCollection.switch_orientation" title="Permalink to this definition">¶</a></dt>
<dd><p>switch the orientation of the event line, either from vertical to
horizontal or vice versus</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.collections.LineCollection">
<em class="property">class </em><tt class="descclassname">matplotlib.collections.</tt><tt class="descname">LineCollection</tt><big>(</big><em>segments</em>, <em>linewidths=None</em>, <em>colors=None</em>, <em>antialiaseds=None</em>, <em>linestyles='solid'</em>, <em>offsets=None</em>, <em>transOffset=None</em>, <em>norm=None</em>, <em>cmap=None</em>, <em>pickradius=5</em>, <em>zorder=2</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.LineCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.collections.Collection</span></tt></a></p>
<p>All parameters must be sequences or scalars; if scalars, they will
be converted to sequences. The property of the ith line
segment is:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">prop</span><span class="p">[</span><span class="n">i</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">props</span><span class="p">)]</span>
</pre></div>
</div>
<p>i.e., the properties cycle if the <tt class="docutils literal"><span class="pre">len</span></tt> of props is less than the
number of segments.</p>
<dl class="docutils">
<dt><em>segments</em></dt>
<dd><p class="first">a sequence of (<em>line0</em>, <em>line1</em>, <em>line2</em>), where:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">linen</span> <span class="o">=</span> <span class="p">(</span><span class="n">x0</span><span class="p">,</span> <span class="n">y0</span><span class="p">),</span> <span class="p">(</span><span class="n">x1</span><span class="p">,</span> <span class="n">y1</span><span class="p">),</span> <span class="o">...</span> <span class="p">(</span><span class="n">xm</span><span class="p">,</span> <span class="n">ym</span><span class="p">)</span>
</pre></div>
</div>
<p class="last">or the equivalent numpy array with two columns. Each line
can be a different length.</p>
</dd>
<dt><em>colors</em></dt>
<dd>must be a sequence of RGBA tuples (eg arbitrary color
strings, etc, not allowed).</dd>
<dt><em>antialiaseds</em></dt>
<dd>must be a sequence of ones or zeros</dd>
<dt><em>linestyles</em> [ ‘solid’ | ‘dashed’ | ‘dashdot’ | ‘dotted’ ]</dt>
<dd><p class="first">a string or dash tuple. The dash tuple is:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">(</span><span class="n">offset</span><span class="p">,</span> <span class="n">onoffseq</span><span class="p">),</span>
</pre></div>
</div>
<p class="last">where <em>onoffseq</em> is an even length tuple of on and off ink
in points.</p>
</dd>
</dl>
<p>If <em>linewidths</em>, <em>colors</em>, or <em>antialiaseds</em> is None, they
default to their rcParams setting, in sequence form.</p>
<p>If <em>offsets</em> and <em>transOffset</em> are not None, then
<em>offsets</em> are transformed by <em>transOffset</em> and applied after
the segments have been transformed to display coordinates.</p>
<p>If <em>offsets</em> is not None but <em>transOffset</em> is None, then the
<em>offsets</em> are added to the segments before any transformation.
In this case, a single offset can be specified as:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">offsets</span><span class="o">=</span><span class="p">(</span><span class="n">xo</span><span class="p">,</span><span class="n">yo</span><span class="p">)</span>
</pre></div>
</div>
<p>and this value will be added cumulatively to each successive
segment, so as to produce a set of successively offset curves.</p>
<dl class="docutils">
<dt><em>norm</em></dt>
<dd>None (optional for <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</dd>
<dt><em>cmap</em></dt>
<dd>None (optional for <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.cm.ScalarMappable</span></tt></a>)</dd>
</dl>
<p><em>pickradius</em> is the tolerance for mouse clicks picking a line.
The default is 5 pt.</p>
<dl class="docutils">
<dt><em>zorder</em></dt>
<dd>The zorder of the LineCollection. Default is 2</dd>
</dl>
<p>The use of <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">ScalarMappable</span></tt></a> is optional.
If the <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">ScalarMappable</span></tt></a> array
<tt class="xref py py-attr docutils literal"><span class="pre">_A</span></tt> is not None (ie a call to
<a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable.set_array" title="matplotlib.cm.ScalarMappable.set_array"><tt class="xref py py-meth docutils literal"><span class="pre">set_array()</span></tt></a> has been made), at
draw time a call to scalar mappable will be made to set the colors.</p>
<dl class="method">
<dt id="matplotlib.collections.LineCollection.color">
<tt class="descname">color</tt><big>(</big><em>c</em><big>)</big><a class="headerlink" href="#matplotlib.collections.LineCollection.color" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the color(s) of the line collection. <em>c</em> can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence</p>
<p>ACCEPTS: matplotlib color arg or sequence of rgba tuples</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.LineCollection.get_color">
<tt class="descname">get_color</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.LineCollection.get_color" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.LineCollection.get_colors">
<tt class="descname">get_colors</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.LineCollection.get_colors" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.LineCollection.get_segments">
<tt class="descname">get_segments</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.collections.LineCollection.get_segments" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.LineCollection.set_color">
<tt class="descname">set_color</tt><big>(</big><em>c</em><big>)</big><a class="headerlink" href="#matplotlib.collections.LineCollection.set_color" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the color(s) of the line collection. <em>c</em> can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
cycle through the sequence.</p>
<p>ACCEPTS: matplotlib color arg or sequence of rgba tuples</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.collections.LineCollection.set_paths">
<tt class="descname">set_paths</tt><big>(</big><em>segments</em><big>)</big><a class="headerlink" href="#matplotlib.collections.LineCollection.set_paths" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.LineCollection.set_segments">
<tt class="descname">set_segments</tt><big>(</big><em>segments</em><big>)</big><a class="headerlink" href="#matplotlib.collections.LineCollection.set_segments" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.collections.LineCollection.set_verts">
<tt class="descname">set_verts</tt><big>(</big><em>segments</em><big>)</big><a class="headerlink" href="#matplotlib.collections.LineCollection.set_verts" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.collections.PatchCollection">
<em class="property">class </em><tt class="descclassname">matplotlib.collections.</tt><tt class="descname">PatchCollection</tt><big>(</big><em>patches</em>, <em>match_original=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.collections.PatchCollection" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.collections.Collection</span></tt></a></p>
<p>A generic collection of patches.</p>
<p>This makes it easier to assign a color map to a heterogeneous
collection of patches.</p>
<p>This also may improve plotting speed, since PatchCollection will
draw faster than a large number of patches.</p>
<dl class="docutils">
<dt><em>patches</em></dt>
<dd>a sequence of Patch objects. This list may include
a heterogeneous assortment of different patch types.</dd>
<dt><em>match_original</em></dt>
<dd>If True, use the colors and linewidths of the original
patches. If False, new colors may be assigned by
providing the standard collection arguments, facecolor,
edgecolor, linewidths, norm or cmap.</dd>
</dl>
<p>If any of <em>edgecolors</em>, <em>facecolors</em>, <em>linewidths</em>,
<em>antialiaseds</em> are None, they default to their
<tt class="xref py py-data docutils literal"><span class="pre">matplotlib.rcParams</span></tt> patch setting, in sequence form.</p>
<p>The use of <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">ScalarMappable</span></tt></a> is optional.
If the <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><tt class="xref py py-class docutils literal"><span class="pre">ScalarMappable</span></tt></a> matrix _A is not