{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathtable.html
More file actions
824 lines (675 loc) · 103 KB
/
Copy pathtable.html
File metadata and controls
824 lines (675 loc) · 103 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
<!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>matplotlib.table — Matplotlib 3.0.2 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" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.0.2 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 3.0.2 documentation" href="../../index.html" />
<link rel="up" title="matplotlib" href="../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/_modules/matplotlib/table.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 (v3.0.2). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</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 3.0.2</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><a href="../../index.html">home</a>| </li>
<li><a href="../../gallery/index.html">examples</a>| </li>
<li><a href="../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../../api/api_overview.html">API</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../matplotlib.html" accesskey="U">matplotlib</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><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
<li><a href="../matplotlib.html">matplotlib</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for matplotlib.table</h1><div class="highlight"><pre>
<span></span><span class="sd">"""</span>
<span class="sd">Place a table below the x-axis at location loc.</span>
<span class="sd">The table consists of a grid of cells.</span>
<span class="sd">The grid need not be rectangular and can have holes.</span>
<span class="sd">Cells are added by specifying their row and column.</span>
<span class="sd">For the purposes of positioning the cell at (0, 0) is</span>
<span class="sd">assumed to be at the top left and the cell at (max_row, max_col)</span>
<span class="sd">is assumed to be at bottom right.</span>
<span class="sd">You can add additional cells outside this range to have convenient</span>
<span class="sd">ways of positioning more interesting grids.</span>
<span class="sd">Author : John Gill <jng@europe.renre.com></span>
<span class="sd">Copyright : 2004 John Gill and John Hunter</span>
<span class="sd">License : matplotlib license</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="k">import</span> <span class="n">artist</span><span class="p">,</span> <span class="n">cbook</span><span class="p">,</span> <span class="n">docstring</span>
<span class="kn">from</span> <span class="nn">.artist</span> <span class="k">import</span> <span class="n">Artist</span><span class="p">,</span> <span class="n">allow_rasterization</span>
<span class="kn">from</span> <span class="nn">.patches</span> <span class="k">import</span> <span class="n">Rectangle</span>
<span class="kn">from</span> <span class="nn">.text</span> <span class="k">import</span> <span class="n">Text</span>
<span class="kn">from</span> <span class="nn">.transforms</span> <span class="k">import</span> <span class="n">Bbox</span>
<span class="kn">from</span> <span class="nn">.path</span> <span class="k">import</span> <span class="n">Path</span>
<div class="viewcode-block" id="Cell"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell">[docs]</a><span class="k">class</span> <span class="nc">Cell</span><span class="p">(</span><span class="n">Rectangle</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A cell is a `.Rectangle` with some associated text.</span>
<span class="sd"> """</span>
<span class="n">PAD</span> <span class="o">=</span> <span class="mf">0.1</span> <span class="c1"># padding between text and rectangle</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xy</span><span class="p">,</span> <span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="p">,</span>
<span class="n">edgecolor</span><span class="o">=</span><span class="s1">'k'</span><span class="p">,</span> <span class="n">facecolor</span><span class="o">=</span><span class="s1">'w'</span><span class="p">,</span>
<span class="n">fill</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">text</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span>
<span class="n">loc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">fontproperties</span><span class="o">=</span><span class="kc">None</span>
<span class="p">):</span>
<span class="c1"># Call base</span>
<span class="n">Rectangle</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xy</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="n">height</span><span class="p">,</span>
<span class="n">edgecolor</span><span class="o">=</span><span class="n">edgecolor</span><span class="p">,</span> <span class="n">facecolor</span><span class="o">=</span><span class="n">facecolor</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_clip_on</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="c1"># Create text object</span>
<span class="k">if</span> <span class="n">loc</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">loc</span> <span class="o">=</span> <span class="s1">'right'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="o">=</span> <span class="n">loc</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span> <span class="o">=</span> <span class="n">Text</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">xy</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">y</span><span class="o">=</span><span class="n">xy</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">text</span><span class="o">=</span><span class="n">text</span><span class="p">,</span>
<span class="n">fontproperties</span><span class="o">=</span><span class="n">fontproperties</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">set_clip_on</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<div class="viewcode-block" id="Cell.set_transform"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.set_transform">[docs]</a> <span class="k">def</span> <span class="nf">set_transform</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trans</span><span class="p">):</span>
<span class="n">Rectangle</span><span class="o">.</span><span class="n">set_transform</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trans</span><span class="p">)</span>
<span class="c1"># the text does not get the transform!</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Cell.set_figure"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.set_figure">[docs]</a> <span class="k">def</span> <span class="nf">set_figure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">):</span>
<span class="n">Rectangle</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fig</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="n">fig</span><span class="p">)</span></div>
<div class="viewcode-block" id="Cell.get_text"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.get_text">[docs]</a> <span class="k">def</span> <span class="nf">get_text</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return the cell `.Text` instance."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_text</span></div>
<div class="viewcode-block" id="Cell.set_fontsize"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.set_fontsize">[docs]</a> <span class="k">def</span> <span class="nf">set_fontsize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">size</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">set_fontsize</span><span class="p">(</span><span class="n">size</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Cell.get_fontsize"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.get_fontsize">[docs]</a> <span class="k">def</span> <span class="nf">get_fontsize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return the cell fontsize."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">get_fontsize</span><span class="p">()</span></div>
<div class="viewcode-block" id="Cell.auto_set_font_size"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.auto_set_font_size">[docs]</a> <span class="k">def</span> <span class="nf">auto_set_font_size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="sd">""" Shrink font size until text fits. """</span>
<span class="n">fontsize</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_fontsize</span><span class="p">()</span>
<span class="n">required</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_required_width</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="k">while</span> <span class="n">fontsize</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">required</span> <span class="o">></span> <span class="bp">self</span><span class="o">.</span><span class="n">get_width</span><span class="p">():</span>
<span class="n">fontsize</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_fontsize</span><span class="p">(</span><span class="n">fontsize</span><span class="p">)</span>
<span class="n">required</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_required_width</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="k">return</span> <span class="n">fontsize</span></div>
<div class="viewcode-block" id="Cell.draw"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.draw">[docs]</a> <span class="nd">@allow_rasterization</span>
<span class="k">def</span> <span class="nf">draw</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_visible</span><span class="p">():</span>
<span class="k">return</span>
<span class="c1"># draw the rectangle</span>
<span class="n">Rectangle</span><span class="o">.</span><span class="n">draw</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">)</span>
<span class="c1"># position the text</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_text_position</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">draw</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">False</span></div>
<span class="k">def</span> <span class="nf">_set_text_position</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="sd">""" Set text up so it draws in the right place.</span>
<span class="sd"> Currently support 'left', 'center' and 'right'</span>
<span class="sd"> """</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_window_extent</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="n">l</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">w</span><span class="p">,</span> <span class="n">h</span> <span class="o">=</span> <span class="n">bbox</span><span class="o">.</span><span class="n">bounds</span>
<span class="c1"># draw in center vertically</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">set_verticalalignment</span><span class="p">(</span><span class="s1">'center'</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">b</span> <span class="o">+</span> <span class="p">(</span><span class="n">h</span> <span class="o">/</span> <span class="mf">2.0</span><span class="p">)</span>
<span class="c1"># now position horizontally</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="o">==</span> <span class="s1">'center'</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">set_horizontalalignment</span><span class="p">(</span><span class="s1">'center'</span><span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">l</span> <span class="o">+</span> <span class="p">(</span><span class="n">w</span> <span class="o">/</span> <span class="mf">2.0</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="o">==</span> <span class="s1">'left'</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">set_horizontalalignment</span><span class="p">(</span><span class="s1">'left'</span><span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">l</span> <span class="o">+</span> <span class="p">(</span><span class="n">w</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">PAD</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">set_horizontalalignment</span><span class="p">(</span><span class="s1">'right'</span><span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">l</span> <span class="o">+</span> <span class="p">(</span><span class="n">w</span> <span class="o">*</span> <span class="p">(</span><span class="mf">1.0</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">PAD</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">set_position</span><span class="p">((</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">))</span>
<div class="viewcode-block" id="Cell.get_text_bounds"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.get_text_bounds">[docs]</a> <span class="k">def</span> <span class="nf">get_text_bounds</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="sd">""" Get text bounds in axes co-ordinates. """</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">get_window_extent</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="n">bboxa</span> <span class="o">=</span> <span class="n">bbox</span><span class="o">.</span><span class="n">inverse_transformed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_data_transform</span><span class="p">())</span>
<span class="k">return</span> <span class="n">bboxa</span><span class="o">.</span><span class="n">bounds</span></div>
<div class="viewcode-block" id="Cell.get_required_width"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.get_required_width">[docs]</a> <span class="k">def</span> <span class="nf">get_required_width</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="sd">""" Get width required for this cell. """</span>
<span class="n">l</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">w</span><span class="p">,</span> <span class="n">h</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_text_bounds</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="k">return</span> <span class="n">w</span> <span class="o">*</span> <span class="p">(</span><span class="mf">1.0</span> <span class="o">+</span> <span class="p">(</span><span class="mf">2.0</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">PAD</span><span class="p">))</span></div>
<div class="viewcode-block" id="Cell.set_text_props"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Cell.set_text_props">[docs]</a> <span class="k">def</span> <span class="nf">set_text_props</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="s1">'update the text properties with kwargs'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_text</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div></div>
<div class="viewcode-block" id="CustomCell"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.CustomCell">[docs]</a><span class="k">class</span> <span class="nc">CustomCell</span><span class="p">(</span><span class="n">Cell</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A subclass of Cell where the sides may be visibly toggled.</span>
<span class="sd"> """</span>
<span class="n">_edges</span> <span class="o">=</span> <span class="s1">'BRTL'</span>
<span class="n">_edge_aliases</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'open'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
<span class="s1">'closed'</span><span class="p">:</span> <span class="n">_edges</span><span class="p">,</span> <span class="c1"># default</span>
<span class="s1">'horizontal'</span><span class="p">:</span> <span class="s1">'BT'</span><span class="p">,</span>
<span class="s1">'vertical'</span><span class="p">:</span> <span class="s1">'RL'</span>
<span class="p">}</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">visible_edges</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">visible_edges</span> <span class="o">=</span> <span class="n">visible_edges</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">visible_edges</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_visible_edges</span>
<span class="nd">@visible_edges</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">visible_edges</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_visible_edges</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_edges</span>
<span class="k">elif</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_edge_aliases</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_visible_edges</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_edge_aliases</span><span class="p">[</span><span class="n">value</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">for</span> <span class="n">edge</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
<span class="k">if</span> <span class="n">edge</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_edges</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Invalid edge param </span><span class="si">{}</span><span class="s1">, must only be one '</span>
<span class="s1">'of </span><span class="si">{}</span><span class="s1"> or string of </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">value</span><span class="p">,</span>
<span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_edge_aliases</span><span class="p">),</span>
<span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_edges</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_visible_edges</span> <span class="o">=</span> <span class="n">value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span>
<div class="viewcode-block" id="CustomCell.get_path"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.CustomCell.get_path">[docs]</a> <span class="k">def</span> <span class="nf">get_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return a path where the edges specified by _visible_edges are drawn.</span>
<span class="sd"> """</span>
<span class="n">codes</span> <span class="o">=</span> <span class="p">[</span><span class="n">Path</span><span class="o">.</span><span class="n">MOVETO</span><span class="p">]</span>
<span class="k">for</span> <span class="n">edge</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_edges</span><span class="p">:</span>
<span class="k">if</span> <span class="n">edge</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_visible_edges</span><span class="p">:</span>
<span class="n">codes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Path</span><span class="o">.</span><span class="n">LINETO</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">codes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Path</span><span class="o">.</span><span class="n">MOVETO</span><span class="p">)</span>
<span class="k">if</span> <span class="n">Path</span><span class="o">.</span><span class="n">MOVETO</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">codes</span><span class="p">[</span><span class="mi">1</span><span class="p">:]:</span> <span class="c1"># All sides are visible</span>
<span class="n">codes</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">Path</span><span class="o">.</span><span class="n">CLOSEPOLY</span>
<span class="k">return</span> <span class="n">Path</span><span class="p">(</span>
<span class="p">[[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">],</span> <span class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">],</span> <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="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]],</span>
<span class="n">codes</span><span class="p">,</span>
<span class="n">readonly</span><span class="o">=</span><span class="kc">True</span>
<span class="p">)</span></div></div>
<div class="viewcode-block" id="Table"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table">[docs]</a><span class="k">class</span> <span class="nc">Table</span><span class="p">(</span><span class="n">Artist</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create a table of cells.</span>
<span class="sd"> Table can have (optional) row and column headers.</span>
<span class="sd"> Each entry in the table can be either text or patches.</span>
<span class="sd"> Column widths and row heights for the table can be specified.</span>
<span class="sd"> Return value is a sequence of text, line and patch instances that make</span>
<span class="sd"> up the table</span>
<span class="sd"> """</span>
<span class="n">codes</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'best'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'upper right'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="c1"># default</span>
<span class="s1">'upper left'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s1">'lower left'</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
<span class="s1">'lower right'</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
<span class="s1">'center left'</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span>
<span class="s1">'center right'</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
<span class="s1">'lower center'</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
<span class="s1">'upper center'</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
<span class="s1">'center'</span><span class="p">:</span> <span class="mi">9</span><span class="p">,</span>
<span class="s1">'top right'</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
<span class="s1">'top left'</span><span class="p">:</span> <span class="mi">11</span><span class="p">,</span>
<span class="s1">'bottom left'</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
<span class="s1">'bottom right'</span><span class="p">:</span> <span class="mi">13</span><span class="p">,</span>
<span class="s1">'right'</span><span class="p">:</span> <span class="mi">14</span><span class="p">,</span>
<span class="s1">'left'</span><span class="p">:</span> <span class="mi">15</span><span class="p">,</span>
<span class="s1">'top'</span><span class="p">:</span> <span class="mi">16</span><span class="p">,</span>
<span class="s1">'bottom'</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">FONTSIZE</span> <span class="o">=</span> <span class="mi">10</span>
<span class="n">AXESPAD</span> <span class="o">=</span> <span class="mf">0.02</span> <span class="c1"># the border between the axes and table edge</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ax</span><span class="p">,</span> <span class="n">loc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">bbox</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">Artist</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">loc</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">if</span> <span class="n">loc</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">codes</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Unrecognized location </span><span class="si">%s</span><span class="s1">. Falling back on '</span>
<span class="s1">'bottom; valid locations are</span><span class="se">\n</span><span class="si">%s</span><span class="se">\t</span><span class="s1">'</span> <span class="o">%</span>
<span class="p">(</span><span class="n">loc</span><span class="p">,</span> <span class="s1">'</span><span class="se">\n\t</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">codes</span><span class="p">)))</span>
<span class="n">loc</span> <span class="o">=</span> <span class="s1">'bottom'</span>
<span class="n">loc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">codes</span><span class="p">[</span><span class="n">loc</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">figure</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_axes</span> <span class="o">=</span> <span class="n">ax</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="o">=</span> <span class="n">loc</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_bbox</span> <span class="o">=</span> <span class="n">bbox</span>
<span class="c1"># use axes coords</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_transform</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">transAxes</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_texts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cells</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_edges</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_autoRows</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_autoColumns</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_autoFontsize</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_clip_on</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<div class="viewcode-block" id="Table.add_cell"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.add_cell">[docs]</a> <span class="k">def</span> <span class="nf">add_cell</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Add a cell to the table.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> row : int</span>
<span class="sd"> Row index.</span>
<span class="sd"> col : int</span>
<span class="sd"> Column index.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> `CustomCell`: Automatically created cell</span>
<span class="sd"> """</span>
<span class="n">xy</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="n">cell</span> <span class="o">=</span> <span class="n">CustomCell</span><span class="p">(</span><span class="n">xy</span><span class="p">,</span> <span class="n">visible_edges</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">edges</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="p">[</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">]</span> <span class="o">=</span> <span class="n">cell</span>
<span class="k">return</span> <span class="n">cell</span></div>
<span class="k">def</span> <span class="nf">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">position</span><span class="p">,</span> <span class="n">cell</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set a custom cell in a given position.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">CustomCell</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'Table only accepts CustomCell'</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">row</span><span class="p">,</span> <span class="n">col</span> <span class="o">=</span> <span class="n">position</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">position</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="s1">'Only tuples length 2 are accepted as coordinates'</span><span class="p">)</span>
<span class="n">cell</span><span class="o">.</span><span class="n">set_figure</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="p">)</span>
<span class="n">cell</span><span class="o">.</span><span class="n">set_transform</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_transform</span><span class="p">())</span>
<span class="n">cell</span><span class="o">.</span><span class="n">set_clip_on</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="p">[</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">]</span> <span class="o">=</span> <span class="n">cell</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">position</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Retrieve a custom cell from a given position.</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">row</span><span class="p">,</span> <span class="n">col</span> <span class="o">=</span> <span class="n">position</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">position</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="s1">'Only tuples length 2 are accepted as coordinates'</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="p">[</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">edges</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_edges</span>
<span class="nd">@edges</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">edges</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_edges</span> <span class="o">=</span> <span class="n">value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">def</span> <span class="nf">_approx_text_height</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">FONTSIZE</span> <span class="o">/</span> <span class="mf">72.0</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="o">.</span><span class="n">dpi</span> <span class="o">/</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_axes</span><span class="o">.</span><span class="n">bbox</span><span class="o">.</span><span class="n">height</span> <span class="o">*</span> <span class="mf">1.2</span><span class="p">)</span>
<div class="viewcode-block" id="Table.draw"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.draw">[docs]</a> <span class="nd">@allow_rasterization</span>
<span class="k">def</span> <span class="nf">draw</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="c1"># Need a renderer to do hit tests on mouseevent; assume the last one</span>
<span class="c1"># will do</span>
<span class="k">if</span> <span class="n">renderer</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">renderer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="o">.</span><span class="n">_cachedRenderer</span>
<span class="k">if</span> <span class="n">renderer</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">'No renderer defined'</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_visible</span><span class="p">():</span>
<span class="k">return</span>
<span class="n">renderer</span><span class="o">.</span><span class="n">open_group</span><span class="p">(</span><span class="s1">'table'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_positions</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">draw</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="n">renderer</span><span class="o">.</span><span class="n">close_group</span><span class="p">(</span><span class="s1">'table'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">False</span></div>
<span class="k">def</span> <span class="nf">_get_grid_bbox</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="sd">"""Get a bbox, in axes co-ordinates for the cells.</span>
<span class="sd"> Only include those in the range (0,0) to (maxRow, maxCol)"""</span>
<span class="n">boxes</span> <span class="o">=</span> <span class="p">[</span><span class="n">cell</span><span class="o">.</span><span class="n">get_window_extent</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="k">for</span> <span class="p">(</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">),</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
<span class="k">if</span> <span class="n">row</span> <span class="o">>=</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">col</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">]</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="n">Bbox</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="n">boxes</span><span class="p">)</span>
<span class="k">return</span> <span class="n">bbox</span><span class="o">.</span><span class="n">inverse_transformed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_transform</span><span class="p">())</span>
<div class="viewcode-block" id="Table.contains"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.contains">[docs]</a> <span class="k">def</span> <span class="nf">contains</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mouseevent</span><span class="p">):</span>
<span class="sd">"""Test whether the mouse event occurred in the table.</span>
<span class="sd"> Returns T/F, {}</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">callable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_contains</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_contains</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mouseevent</span><span class="p">)</span>
<span class="c1"># TODO: Return index of the cell containing the cursor so that the user</span>
<span class="c1"># doesn't have to bind to each one individually.</span>
<span class="n">renderer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">figure</span><span class="o">.</span><span class="n">_cachedRenderer</span>
<span class="k">if</span> <span class="n">renderer</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">boxes</span> <span class="o">=</span> <span class="p">[</span><span class="n">cell</span><span class="o">.</span><span class="n">get_window_extent</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="k">for</span> <span class="p">(</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">),</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
<span class="k">if</span> <span class="n">row</span> <span class="o">>=</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">col</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">]</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="n">Bbox</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="n">boxes</span><span class="p">)</span>
<span class="k">return</span> <span class="n">bbox</span><span class="o">.</span><span class="n">contains</span><span class="p">(</span><span class="n">mouseevent</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="n">mouseevent</span><span class="o">.</span><span class="n">y</span><span class="p">),</span> <span class="p">{}</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="p">{}</span></div>
<div class="viewcode-block" id="Table.get_children"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.get_children">[docs]</a> <span class="k">def</span> <span class="nf">get_children</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return the Artists contained by the table."""</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">values</span><span class="p">())</span></div>
<span class="n">get_child_artists</span> <span class="o">=</span> <span class="n">cbook</span><span class="o">.</span><span class="n">deprecated</span><span class="p">(</span><span class="s2">"3.0"</span><span class="p">)(</span><span class="n">get_children</span><span class="p">)</span>
<div class="viewcode-block" id="Table.get_window_extent"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.get_window_extent">[docs]</a> <span class="k">def</span> <span class="nf">get_window_extent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="sd">"""Return the bounding box of the table in window coords."""</span>
<span class="n">boxes</span> <span class="o">=</span> <span class="p">[</span><span class="n">cell</span><span class="o">.</span><span class="n">get_window_extent</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">values</span><span class="p">()]</span>
<span class="k">return</span> <span class="n">Bbox</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="n">boxes</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_do_cell_alignment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Calculate row heights and column widths.</span>
<span class="sd"> Position cells accordingly.</span>
<span class="sd"> """</span>
<span class="c1"># Calculate row/column widths</span>
<span class="n">widths</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">heights</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="p">(</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">),</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">height</span> <span class="o">=</span> <span class="n">heights</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">row</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">)</span>
<span class="n">heights</span><span class="p">[</span><span class="n">row</span><span class="p">]</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">height</span><span class="p">,</span> <span class="n">cell</span><span class="o">.</span><span class="n">get_height</span><span class="p">())</span>
<span class="n">width</span> <span class="o">=</span> <span class="n">widths</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">)</span>
<span class="n">widths</span><span class="p">[</span><span class="n">col</span><span class="p">]</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">width</span><span class="p">,</span> <span class="n">cell</span><span class="o">.</span><span class="n">get_width</span><span class="p">())</span>
<span class="c1"># work out left position for each column</span>
<span class="n">xpos</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">lefts</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">widths</span><span class="p">):</span>
<span class="n">lefts</span><span class="p">[</span><span class="n">col</span><span class="p">]</span> <span class="o">=</span> <span class="n">xpos</span>
<span class="n">xpos</span> <span class="o">+=</span> <span class="n">widths</span><span class="p">[</span><span class="n">col</span><span class="p">]</span>
<span class="n">ypos</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">bottoms</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">heights</span><span class="p">,</span> <span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="n">bottoms</span><span class="p">[</span><span class="n">row</span><span class="p">]</span> <span class="o">=</span> <span class="n">ypos</span>
<span class="n">ypos</span> <span class="o">+=</span> <span class="n">heights</span><span class="p">[</span><span class="n">row</span><span class="p">]</span>
<span class="c1"># set cell positions</span>
<span class="k">for</span> <span class="p">(</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">),</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">cell</span><span class="o">.</span><span class="n">set_x</span><span class="p">(</span><span class="n">lefts</span><span class="p">[</span><span class="n">col</span><span class="p">])</span>
<span class="n">cell</span><span class="o">.</span><span class="n">set_y</span><span class="p">(</span><span class="n">bottoms</span><span class="p">[</span><span class="n">row</span><span class="p">])</span>
<div class="viewcode-block" id="Table.auto_set_column_width"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.auto_set_column_width">[docs]</a> <span class="k">def</span> <span class="nf">auto_set_column_width</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">col</span><span class="p">):</span>
<span class="sd">""" Given column indexs in either List, Tuple or int. Will be able to</span>
<span class="sd"> automatically set the columns into optimal sizes.</span>
<span class="sd"> Here is the example of the input, which triger automatic adjustment on</span>
<span class="sd"> columns to optimal size by given index numbers.</span>
<span class="sd"> -1: the row labling</span>
<span class="sd"> 0: the 1st column</span>
<span class="sd"> 1: the 2nd column</span>
<span class="sd"> Args:</span>
<span class="sd"> col(List): list of indexs</span>
<span class="sd"> >>>table.auto_set_column_width([-1,0,1])</span>
<span class="sd"> col(Tuple): tuple of indexs</span>
<span class="sd"> >>>table.auto_set_column_width((-1,0,1))</span>
<span class="sd"> col(int): index integer</span>
<span class="sd"> >>>table.auto_set_column_width(-1)</span>
<span class="sd"> >>>table.auto_set_column_width(0)</span>
<span class="sd"> >>>table.auto_set_column_width(1)</span>
<span class="sd"> """</span>
<span class="c1"># check for col possibility on iteration</span>
<span class="k">try</span><span class="p">:</span>
<span class="nb">iter</span><span class="p">(</span><span class="n">col</span><span class="p">)</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">TypeError</span><span class="p">,</span> <span class="ne">AttributeError</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_autoColumns</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">col</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="n">col</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_autoColumns</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<span class="k">def</span> <span class="nf">_auto_set_column_width</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="sd">"""Automatically set width for column."""</span>
<span class="n">cells</span> <span class="o">=</span> <span class="p">[</span><span class="n">key</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span> <span class="k">if</span> <span class="n">key</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="n">col</span><span class="p">]</span>
<span class="c1"># find max width</span>
<span class="n">width</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="n">cells</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="p">[</span><span class="n">cell</span><span class="p">]</span>
<span class="n">width</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">get_required_width</span><span class="p">(</span><span class="n">renderer</span><span class="p">),</span> <span class="n">width</span><span class="p">)</span>
<span class="c1"># Now set the widths</span>
<span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="n">cells</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="p">[</span><span class="n">cell</span><span class="p">]</span><span class="o">.</span><span class="n">set_width</span><span class="p">(</span><span class="n">width</span><span class="p">)</span>
<div class="viewcode-block" id="Table.auto_set_font_size"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.auto_set_font_size">[docs]</a> <span class="k">def</span> <span class="nf">auto_set_font_size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">""" Automatically set font size. """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_autoFontsize</span> <span class="o">=</span> <span class="n">value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<span class="k">def</span> <span class="nf">_auto_set_font_size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">fontsize</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">values</span><span class="p">()))</span><span class="o">.</span><span class="n">get_fontsize</span><span class="p">()</span>
<span class="n">cells</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="c1"># ignore auto-sized columns</span>
<span class="k">if</span> <span class="n">key</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_autoColumns</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">size</span> <span class="o">=</span> <span class="n">cell</span><span class="o">.</span><span class="n">auto_set_font_size</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="n">fontsize</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">fontsize</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span>
<span class="n">cells</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span>
<span class="c1"># now set all fontsizes equal</span>
<span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">cell</span><span class="o">.</span><span class="n">set_fontsize</span><span class="p">(</span><span class="n">fontsize</span><span class="p">)</span>
<div class="viewcode-block" id="Table.scale"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.scale">[docs]</a> <span class="k">def</span> <span class="nf">scale</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xscale</span><span class="p">,</span> <span class="n">yscale</span><span class="p">):</span>
<span class="sd">""" Scale column widths by xscale and row heights by yscale. """</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">c</span><span class="o">.</span><span class="n">set_width</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">get_width</span><span class="p">()</span> <span class="o">*</span> <span class="n">xscale</span><span class="p">)</span>
<span class="n">c</span><span class="o">.</span><span class="n">set_height</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">get_height</span><span class="p">()</span> <span class="o">*</span> <span class="n">yscale</span><span class="p">)</span></div>
<div class="viewcode-block" id="Table.set_fontsize"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.set_fontsize">[docs]</a> <span class="k">def</span> <span class="nf">set_fontsize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">size</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the font size, in points, of the cell text.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> size : float</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">cell</span><span class="o">.</span><span class="n">set_fontsize</span><span class="p">(</span><span class="n">size</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<span class="k">def</span> <span class="nf">_offset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ox</span><span class="p">,</span> <span class="n">oy</span><span class="p">):</span>
<span class="sd">"""Move all the artists by ox, oy (axes coords)."""</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">get_x</span><span class="p">(),</span> <span class="n">c</span><span class="o">.</span><span class="n">get_y</span><span class="p">()</span>
<span class="n">c</span><span class="o">.</span><span class="n">set_x</span><span class="p">(</span><span class="n">x</span> <span class="o">+</span> <span class="n">ox</span><span class="p">)</span>
<span class="n">c</span><span class="o">.</span><span class="n">set_y</span><span class="p">(</span><span class="n">y</span> <span class="o">+</span> <span class="n">oy</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_update_positions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">renderer</span><span class="p">):</span>
<span class="c1"># called from renderer to allow more precise estimates of</span>
<span class="c1"># widths and heights with get_window_extent</span>
<span class="c1"># Do any auto width setting</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_autoColumns</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auto_set_column_width</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="n">renderer</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_autoFontsize</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auto_set_font_size</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="c1"># Align all the cells</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_do_cell_alignment</span><span class="p">()</span>
<span class="n">bbox</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_grid_bbox</span><span class="p">(</span><span class="n">renderer</span><span class="p">)</span>
<span class="n">l</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">w</span><span class="p">,</span> <span class="n">h</span> <span class="o">=</span> <span class="n">bbox</span><span class="o">.</span><span class="n">bounds</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bbox</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Position according to bbox</span>
<span class="n">rl</span><span class="p">,</span> <span class="n">rb</span><span class="p">,</span> <span class="n">rw</span><span class="p">,</span> <span class="n">rh</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bbox</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scale</span><span class="p">(</span><span class="n">rw</span> <span class="o">/</span> <span class="n">w</span><span class="p">,</span> <span class="n">rh</span> <span class="o">/</span> <span class="n">h</span><span class="p">)</span>
<span class="n">ox</span> <span class="o">=</span> <span class="n">rl</span> <span class="o">-</span> <span class="n">l</span>
<span class="n">oy</span> <span class="o">=</span> <span class="n">rb</span> <span class="o">-</span> <span class="n">b</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_do_cell_alignment</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Position using loc</span>
<span class="p">(</span><span class="n">BEST</span><span class="p">,</span> <span class="n">UR</span><span class="p">,</span> <span class="n">UL</span><span class="p">,</span> <span class="n">LL</span><span class="p">,</span> <span class="n">LR</span><span class="p">,</span> <span class="n">CL</span><span class="p">,</span> <span class="n">CR</span><span class="p">,</span> <span class="n">LC</span><span class="p">,</span> <span class="n">UC</span><span class="p">,</span> <span class="n">C</span><span class="p">,</span>
<span class="n">TR</span><span class="p">,</span> <span class="n">TL</span><span class="p">,</span> <span class="n">BL</span><span class="p">,</span> <span class="n">BR</span><span class="p">,</span> <span class="n">R</span><span class="p">,</span> <span class="n">L</span><span class="p">,</span> <span class="n">T</span><span class="p">,</span> <span class="n">B</span><span class="p">)</span> <span class="o">=</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">codes</span><span class="p">))</span>
<span class="c1"># defaults for center</span>
<span class="n">ox</span> <span class="o">=</span> <span class="p">(</span><span class="mf">0.5</span> <span class="o">-</span> <span class="n">w</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="o">-</span> <span class="n">l</span>
<span class="n">oy</span> <span class="o">=</span> <span class="p">(</span><span class="mf">0.5</span> <span class="o">-</span> <span class="n">h</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="o">-</span> <span class="n">b</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">UL</span><span class="p">,</span> <span class="n">LL</span><span class="p">,</span> <span class="n">CL</span><span class="p">):</span> <span class="c1"># left</span>
<span class="n">ox</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">AXESPAD</span> <span class="o">-</span> <span class="n">l</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">BEST</span><span class="p">,</span> <span class="n">UR</span><span class="p">,</span> <span class="n">LR</span><span class="p">,</span> <span class="n">R</span><span class="p">,</span> <span class="n">CR</span><span class="p">):</span> <span class="c1"># right</span>
<span class="n">ox</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="p">(</span><span class="n">l</span> <span class="o">+</span> <span class="n">w</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">AXESPAD</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">BEST</span><span class="p">,</span> <span class="n">UR</span><span class="p">,</span> <span class="n">UL</span><span class="p">,</span> <span class="n">UC</span><span class="p">):</span> <span class="c1"># upper</span>
<span class="n">oy</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="p">(</span><span class="n">b</span> <span class="o">+</span> <span class="n">h</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">AXESPAD</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">LL</span><span class="p">,</span> <span class="n">LR</span><span class="p">,</span> <span class="n">LC</span><span class="p">):</span> <span class="c1"># lower</span>
<span class="n">oy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">AXESPAD</span> <span class="o">-</span> <span class="n">b</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">LC</span><span class="p">,</span> <span class="n">UC</span><span class="p">,</span> <span class="n">C</span><span class="p">):</span> <span class="c1"># center x</span>
<span class="n">ox</span> <span class="o">=</span> <span class="p">(</span><span class="mf">0.5</span> <span class="o">-</span> <span class="n">w</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="o">-</span> <span class="n">l</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">CL</span><span class="p">,</span> <span class="n">CR</span><span class="p">,</span> <span class="n">C</span><span class="p">):</span> <span class="c1"># center y</span>
<span class="n">oy</span> <span class="o">=</span> <span class="p">(</span><span class="mf">0.5</span> <span class="o">-</span> <span class="n">h</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="o">-</span> <span class="n">b</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">TL</span><span class="p">,</span> <span class="n">BL</span><span class="p">,</span> <span class="n">L</span><span class="p">):</span> <span class="c1"># out left</span>
<span class="n">ox</span> <span class="o">=</span> <span class="o">-</span> <span class="p">(</span><span class="n">l</span> <span class="o">+</span> <span class="n">w</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">TR</span><span class="p">,</span> <span class="n">BR</span><span class="p">,</span> <span class="n">R</span><span class="p">):</span> <span class="c1"># out right</span>
<span class="n">ox</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="n">l</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">TR</span><span class="p">,</span> <span class="n">TL</span><span class="p">,</span> <span class="n">T</span><span class="p">):</span> <span class="c1"># out top</span>
<span class="n">oy</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="n">b</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_loc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">BL</span><span class="p">,</span> <span class="n">BR</span><span class="p">,</span> <span class="n">B</span><span class="p">):</span> <span class="c1"># out bottom</span>
<span class="n">oy</span> <span class="o">=</span> <span class="o">-</span> <span class="p">(</span><span class="n">b</span> <span class="o">+</span> <span class="n">h</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_offset</span><span class="p">(</span><span class="n">ox</span><span class="p">,</span> <span class="n">oy</span><span class="p">)</span>
<div class="viewcode-block" id="Table.get_celld"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.Table.get_celld">[docs]</a> <span class="k">def</span> <span class="nf">get_celld</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return a dict of cells in the table."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span></div></div>
<div class="viewcode-block" id="table"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.table.table">[docs]</a><span class="k">def</span> <span class="nf">table</span><span class="p">(</span><span class="n">ax</span><span class="p">,</span>
<span class="n">cellText</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">cellColours</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">cellLoc</span><span class="o">=</span><span class="s1">'right'</span><span class="p">,</span> <span class="n">colWidths</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">rowLabels</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">rowColours</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">rowLoc</span><span class="o">=</span><span class="s1">'left'</span><span class="p">,</span>
<span class="n">colLabels</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">colColours</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">colLoc</span><span class="o">=</span><span class="s1">'center'</span><span class="p">,</span>
<span class="n">loc</span><span class="o">=</span><span class="s1">'bottom'</span><span class="p">,</span> <span class="n">bbox</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">edges</span><span class="o">=</span><span class="s1">'closed'</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> TABLE(cellText=None, cellColours=None,</span>
<span class="sd"> cellLoc='right', colWidths=None,</span>
<span class="sd"> rowLabels=None, rowColours=None, rowLoc='left',</span>
<span class="sd"> colLabels=None, colColours=None, colLoc='center',</span>
<span class="sd"> loc='bottom', bbox=None, edges='closed')</span>
<span class="sd"> Factory function to generate a Table instance.</span>
<span class="sd"> Thanks to John Gill for providing the class and table.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">cellColours</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">cellText</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'At least one argument from "cellColours" or '</span>
<span class="s1">'"cellText" must be provided to create a table.'</span><span class="p">)</span>
<span class="c1"># Check we have some cellText</span>
<span class="k">if</span> <span class="n">cellText</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># assume just colours are needed</span>
<span class="n">rows</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">cellColours</span><span class="p">)</span>
<span class="n">cols</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">cellColours</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">cellText</span> <span class="o">=</span> <span class="p">[[</span><span class="s1">''</span><span class="p">]</span> <span class="o">*</span> <span class="n">cols</span><span class="p">]</span> <span class="o">*</span> <span class="n">rows</span>
<span class="n">rows</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">cellText</span><span class="p">)</span>
<span class="n">cols</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">cellText</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cellText</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">row</span><span class="p">)</span> <span class="o">!=</span> <span class="n">cols</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Each row in 'cellText' must have </span><span class="si">{}</span><span class="s2"> columns"</span>
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cols</span><span class="p">))</span>
<span class="k">if</span> <span class="n">cellColours</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cellColours</span><span class="p">)</span> <span class="o">!=</span> <span class="n">rows</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'cellColours' must have </span><span class="si">{}</span><span class="s2"> rows"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">rows</span><span class="p">))</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cellColours</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">row</span><span class="p">)</span> <span class="o">!=</span> <span class="n">cols</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Each row in 'cellColours' must have </span><span class="si">{}</span><span class="s2"> "</span>
<span class="s2">"columns"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">cols</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">cellColours</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'w'</span> <span class="o">*</span> <span class="n">cols</span><span class="p">]</span> <span class="o">*</span> <span class="n">rows</span>
<span class="c1"># Set colwidths if not given</span>
<span class="k">if</span> <span class="n">colWidths</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">colWidths</span> <span class="o">=</span> <span class="p">[</span><span class="mf">1.0</span> <span class="o">/</span> <span class="n">cols</span><span class="p">]</span> <span class="o">*</span> <span class="n">cols</span>
<span class="c1"># Fill in missing information for column</span>
<span class="c1"># and row labels</span>
<span class="n">rowLabelWidth</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">rowLabels</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">rowColours</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">rowLabels</span> <span class="o">=</span> <span class="p">[</span><span class="s1">''</span><span class="p">]</span> <span class="o">*</span> <span class="n">rows</span>
<span class="n">rowLabelWidth</span> <span class="o">=</span> <span class="n">colWidths</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">elif</span> <span class="n">rowColours</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">rowColours</span> <span class="o">=</span> <span class="s1">'w'</span> <span class="o">*</span> <span class="n">rows</span>
<span class="k">if</span> <span class="n">rowLabels</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">rowLabels</span><span class="p">)</span> <span class="o">!=</span> <span class="n">rows</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"'rowLabels' must be of length </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">rows</span><span class="p">))</span>
<span class="c1"># If we have column labels, need to shift</span>
<span class="c1"># the text and colour arrays down 1 row</span>
<span class="n">offset</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">colLabels</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">colColours</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">colLabels</span> <span class="o">=</span> <span class="p">[</span><span class="s1">''</span><span class="p">]</span> <span class="o">*</span> <span class="n">cols</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">elif</span> <span class="n">colColours</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">colColours</span> <span class="o">=</span> <span class="s1">'w'</span> <span class="o">*</span> <span class="n">cols</span>
<span class="c1"># Set up cell colours if not given</span>
<span class="k">if</span> <span class="n">cellColours</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">cellColours</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'w'</span> <span class="o">*</span> <span class="n">cols</span><span class="p">]</span> <span class="o">*</span> <span class="n">rows</span>
<span class="c1"># Now create the table</span>
<span class="n">table</span> <span class="o">=</span> <span class="n">Table</span><span class="p">(</span><span class="n">ax</span><span class="p">,</span> <span class="n">loc</span><span class="p">,</span> <span class="n">bbox</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">table</span><span class="o">.</span><span class="n">edges</span> <span class="o">=</span> <span class="n">edges</span>
<span class="n">height</span> <span class="o">=</span> <span class="n">table</span><span class="o">.</span><span class="n">_approx_text_height</span><span class="p">()</span>
<span class="c1"># Add the cells</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">rows</span><span class="p">):</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">cols</span><span class="p">):</span>
<span class="n">table</span><span class="o">.</span><span class="n">add_cell</span><span class="p">(</span><span class="n">row</span> <span class="o">+</span> <span class="n">offset</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span>
<span class="n">width</span><span class="o">=</span><span class="n">colWidths</span><span class="p">[</span><span class="n">col</span><span class="p">],</span> <span class="n">height</span><span class="o">=</span><span class="n">height</span><span class="p">,</span>
<span class="n">text</span><span class="o">=</span><span class="n">cellText</span><span class="p">[</span><span class="n">row</span><span class="p">][</span><span class="n">col</span><span class="p">],</span>
<span class="n">facecolor</span><span class="o">=</span><span class="n">cellColours</span><span class="p">[</span><span class="n">row</span><span class="p">][</span><span class="n">col</span><span class="p">],</span>
<span class="n">loc</span><span class="o">=</span><span class="n">cellLoc</span><span class="p">)</span>
<span class="c1"># Do column labels</span>
<span class="k">if</span> <span class="n">colLabels</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">cols</span><span class="p">):</span>
<span class="n">table</span><span class="o">.</span><span class="n">add_cell</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">col</span><span class="p">,</span>
<span class="n">width</span><span class="o">=</span><span class="n">colWidths</span><span class="p">[</span><span class="n">col</span><span class="p">],</span> <span class="n">height</span><span class="o">=</span><span class="n">height</span><span class="p">,</span>
<span class="n">text</span><span class="o">=</span><span class="n">colLabels</span><span class="p">[</span><span class="n">col</span><span class="p">],</span> <span class="n">facecolor</span><span class="o">=</span><span class="n">colColours</span><span class="p">[</span><span class="n">col</span><span class="p">],</span>
<span class="n">loc</span><span class="o">=</span><span class="n">colLoc</span><span class="p">)</span>
<span class="c1"># Do row labels</span>
<span class="k">if</span> <span class="n">rowLabels</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">rows</span><span class="p">):</span>
<span class="n">table</span><span class="o">.</span><span class="n">add_cell</span><span class="p">(</span><span class="n">row</span> <span class="o">+</span> <span class="n">offset</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="n">width</span><span class="o">=</span><span class="n">rowLabelWidth</span> <span class="ow">or</span> <span class="mf">1e-15</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="n">height</span><span class="p">,</span>
<span class="n">text</span><span class="o">=</span><span class="n">rowLabels</span><span class="p">[</span><span class="n">row</span><span class="p">],</span> <span class="n">facecolor</span><span class="o">=</span><span class="n">rowColours</span><span class="p">[</span><span class="n">row</span><span class="p">],</span>
<span class="n">loc</span><span class="o">=</span><span class="n">rowLoc</span><span class="p">)</span>
<span class="k">if</span> <span class="n">rowLabelWidth</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">table</span><span class="o">.</span><span class="n">auto_set_column_width</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">add_table</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
<span class="k">return</span> <span class="n">table</span></div>
<span class="n">docstring</span><span class="o">.</span><span class="n">interpd</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">Table</span><span class="o">=</span><span class="n">artist</span><span class="o">.</span><span class="n">kwdoc</span><span class="p">(</span><span class="n">Table</span><span class="p">))</span>
</pre></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 Nov 11, 2018.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.1.
Doc version v3.0.2-2-g91e2d00a8.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.