{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathtable.html
More file actions
968 lines (801 loc) · 111 KB
/
Copy pathtable.html
File metadata and controls
968 lines (801 loc) · 111 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>matplotlib.table — Matplotlib 3.2.2 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css?v3.2.2-2-g137edd56a" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery-dataframe.css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.2.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.2.2 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/_modules/matplotlib/table.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<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.2.2). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>
<!--
<div id="annc-banner">
</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.2.2</span></div>
<img src="../../_static/logo2_compressed.svg" 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>
<nav class="main-nav">
<ul>
<li><a href="../../users/installing.html">Installation</a></li>
<li><a href="../../contents.html">Documentation</a></li>
<li><a href="../../gallery/index.html">Examples</a></li>
<li><a href="../../tutorials/index.html">Tutorials</a></li>
<li><a href="../../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<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="../../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>
<li class="nav-item nav-item-this"><a href="">matplotlib.table</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><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" role="main">
<h1>Source code for matplotlib.table</h1><div class="highlight"><pre>
<span></span><span class="c1"># Original code by:</span>
<span class="c1"># John Gill <jng@europe.renre.com></span>
<span class="c1"># Copyright 2004 John Gill and John Hunter</span>
<span class="c1">#</span>
<span class="c1"># Subsequent changes:</span>
<span class="c1"># The Matplotlib development team</span>
<span class="c1"># Copyright The Matplotlib development team</span>
<span class="sd">"""</span>
<span class="sd">This module provides functionality to add a table to a plot.</span>
<span class="sd">Use the factory function `~matplotlib.table.table` to create a ready-made</span>
<span class="sd">table from texts. If you need more control, use the `.Table` class and its</span>
<span class="sd">methods.</span>
<span class="sd">The table consists of a grid of cells, which are indexed by (row, column).</span>
<span class="sd">The cell (0, 0) is positioned at the top left.</span>
<span class="sd">Thanks to John Gill for providing the class and table.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">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="kn">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="kn">import</span> <span class="n">Rectangle</span>
<span class="kn">from</span> <span class="nn">.text</span> <span class="kn">import</span> <span class="n">Text</span>
<span class="kn">from</span> <span class="nn">.transforms</span> <span class="kn">import</span> <span class="n">Bbox</span>
<span class="kn">from</span> <span class="nn">.path</span> <span class="kn">import</span> <span class="n">Path</span>
<div class="viewcode-block" id="Cell"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.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"> .. note:</span>
<span class="sd"> As a user, you'll most likely not creates cells yourself. Instead, you</span>
<span class="sd"> should use either the `~matplotlib.table.table` factory function or</span>
<span class="sd"> `.Table.add_cell`.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> xy : 2-tuple</span>
<span class="sd"> The position of the bottom left corner of the cell.</span>
<span class="sd"> width : float</span>
<span class="sd"> The cell width.</span>
<span class="sd"> height : float</span>
<span class="sd"> The cell height.</span>
<span class="sd"> edgecolor : color</span>
<span class="sd"> The color of the cell border.</span>
<span class="sd"> facecolor : color</span>
<span class="sd"> The cell facecolor.</span>
<span class="sd"> fill : bool</span>
<span class="sd"> Whether the cell background is filled.</span>
<span class="sd"> text : str</span>
<span class="sd"> The cell text.</span>
<span class="sd"> loc : {'left', 'center', 'right'}, default: 'right'</span>
<span class="sd"> The alignment of the text within the cell.</span>
<span class="sd"> fontproperties : dict</span>
<span class="sd"> A dict defining the font properties of the text. Supported keys and</span>
<span class="sd"> values are the keyword arguments accepted by `.FontProperties`.</span>
<span class="sd"> """</span>
<span class="n">PAD</span> <span class="o">=</span> <span class="mf">0.1</span>
<span class="sd">"""Padding between text and rectangle."""</span>
<span class="k">def</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="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">fill</span><span class="o">=</span><span class="n">fill</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.axes.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.axes.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.axes.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.axes.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="sd">"""Set the text fontsize."""</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.axes.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.axes.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 the text fits into the cell width."""</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.axes.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.axes.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">"""</span>
<span class="sd"> Return the text bounds as *(x, y, width, height)* in table coordinates.</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">_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.axes.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">"""Return the minimal required width for the 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.axes.Cell.set_text_props">[docs]</a> <span class="nd">@docstring</span><span class="o">.</span><span class="n">dedent_interpd</span>
<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="sd">"""</span>
<span class="sd"> Update the text properties.</span>
<span class="sd"> Valid keyword arguments are:</span>
<span class="sd"> %(Text)s</span>
<span class="sd"> """</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.axes.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 `.Cell` subclass with configurable edge visibility.</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="fm">__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="sd">"""</span>
<span class="sd"> The cell edges to be drawn with a line.</span>
<span class="sd"> Reading this property returns a substring of 'BRTL' (bottom, right,</span>
<span class="sd"> top, left').</span>
<span class="sd"> When setting this property, you can use a substring of 'BRTL' or one</span>
<span class="sd"> of {'open', 'closed', 'horizontal', 'vertical'}.</span>
<span class="sd"> """</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">if</span> <span class="nb">any</span><span class="p">(</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="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">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 of '</span>
<span class="s1">'</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.axes.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">"""Return a `.Path` for the `.visible_edges`."""</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="n">codes</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
<span class="n">Path</span><span class="o">.</span><span class="n">LINETO</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="k">else</span> <span class="n">Path</span><span class="o">.</span><span class="n">MOVETO</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">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.axes.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"> A table of cells.</span>
<span class="sd"> The table consists of a grid of cells, which are indexed by (row, column).</span>
<span class="sd"> For a simple table, you'll have a full grid of cells with indices from</span>
<span class="sd"> (0, 0) to (num_rows-1, num_cols-1), in which the cell (0, 0) is positioned</span>
<span class="sd"> at the top left. However, you can also add cells with negative indices.</span>
<span class="sd"> You don't have to add a cell to every grid position, so you can create</span>
<span class="sd"> tables that have holes.</span>
<span class="sd"> *Note*: You'll usually not create an empty table from scratch. Instead use</span>
<span class="sd"> `~matplotlib.table.table` to create a table from data.</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="sd">"""Possible values where to place the table relative to the Axes."""</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="sd">"""The border between the Axes and the table edge in Axes units."""</span>
<span class="k">def</span> <span class="fm">__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="sd">"""</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> ax : `matplotlib.axes.Axes`</span>
<span class="sd"> The `~.axes.Axes` to plot the table into.</span>
<span class="sd"> loc : str</span>
<span class="sd"> The position of the cell with respect to *ax*. This must be one of</span>
<span class="sd"> the `~.Table.codes`.</span>
<span class="sd"> bbox : `.Bbox` or None</span>
<span class="sd"> A bounding box to draw the table into. If this is not *None*, this</span>
<span class="sd"> overrides *loc*.</span>
<span class="sd"> Other Parameters</span>
<span class="sd"> ----------------</span>
<span class="sd"> **kwargs</span>
<span class="sd"> `.Artist` properties.</span>
<span class="sd"> """</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">cbook</span><span class="o">.</span><span class="n">warn_deprecated</span><span class="p">(</span>
<span class="s2">"3.1"</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s2">"Unrecognized location </span><span class="si">{!r}</span><span class="s2">. Falling back "</span>
<span class="s2">"on 'bottom'; valid locations are</span><span class="se">\n\t</span><span class="si">{}</span><span class="se">\n</span><span class="s2">"</span>
<span class="s2">"This will raise an exception </span><span class="si">%(removal)s</span><span class="s2">."</span>
<span class="o">.</span><span class="n">format</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="n">ax</span><span class="o">.</span><span class="n">_unstale_viewLim</span><span class="p">()</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">_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">_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.axes.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"> Create a cell and add it 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"> *args, **kwargs</span>
<span class="sd"> All other parameters are passed on to `Cell`.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> cell : `.CustomCell`</span>
<span class="sd"> The 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="fm">__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="n">cbook</span><span class="o">.</span><span class="n">_check_isinstance</span><span class="p">(</span><span class="n">CustomCell</span><span class="p">,</span> <span class="n">cell</span><span class="o">=</span><span class="n">cell</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="fm">__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">"""Retrieve a custom cell from a given position."""</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">position</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="sd">"""</span>
<span class="sd"> The default value of `~.CustomCell.visible_edges` for newly added</span>
<span class="sd"> cells using `.add_cell`.</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> This setting does currently only affect newly created cells using</span>
<span class="sd"> `.add_cell`.</span>
<span class="sd"> To change existing cells, you have to set their edges explicitly::</span>
<span class="sd"> for c in tab.get_celld().values():</span>
<span class="sd"> c.visible_edges = 'horizontal'</span>
<span class="sd"> """</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.axes.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"># docstring inherited</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="n">gid</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_gid</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">"""</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="sd"> """</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.axes.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="c1"># docstring inherited</span>
<span class="n">inside</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default_contains</span><span class="p">(</span><span class="n">mouseevent</span><span class="p">)</span>
<span class="k">if</span> <span class="n">inside</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">inside</span><span class="p">,</span> <span class="n">info</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.axes.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>
<div class="viewcode-block" id="Table.get_window_extent"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.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="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="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">"""</span>
<span class="sd"> Calculate row heights and column widths; 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.axes.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">"""</span>
<span class="sd"> Automatically set the widths of given columns to optimal sizes.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> col : int or sequence of ints</span>
<span class="sd"> The indices of the columns to auto-scale.</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">cell</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="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="n">max_width</span> <span class="o">=</span> <span class="nb">max</span><span class="p">((</span><span class="n">cell</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">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="n">cells</span><span class="p">),</span>
<span class="n">default</span><span class="o">=</span><span class="mi">0</span><span class="p">)</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">cell</span><span class="o">.</span><span class="n">set_width</span><span class="p">(</span><span class="n">max_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.axes.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.axes.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.axes.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"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> As long as auto font size has not been disabled, the value will be</span>
<span class="sd"> clipped such that the text fits horizontally into the cell.</span>
<span class="sd"> You can disable this behavior using `.auto_set_font_size`.</span>
<span class="sd"> >>> the_table.auto_set_font_size(False)</span>
<span class="sd"> >>> the_table.set_fontsize(20)</span>
<span class="sd"> However, there is no automatic scaling of the row height so that the</span>
<span class="sd"> text may exceed the cell boundary.</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.axes.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="sa">r</span><span class="sd">"""</span>
<span class="sd"> Return a dict of cells in the table mapping *(row, column)* to</span>
<span class="sd"> `.Cell`\s.</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> You can also directly index into the Table object to access individual</span>
<span class="sd"> cells::</span>
<span class="sd"> cell = table[row, col]</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cells</span></div></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>
<div class="viewcode-block" id="table"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.table">[docs]</a><span class="nd">@docstring</span><span class="o">.</span><span class="n">dedent_interpd</span>
<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"> Add a table to an `~.axes.Axes`.</span>
<span class="sd"> At least one of *cellText* or *cellColours* must be specified. These</span>
<span class="sd"> parameters must be 2D lists, in which the outer lists define the rows and</span>
<span class="sd"> the inner list define the column values per row. Each row must have the</span>
<span class="sd"> same number of elements.</span>
<span class="sd"> The table can optionally have row and column headers, which are configured</span>
<span class="sd"> using *rowLabels*, *rowColours*, *rowLoc* and *colLabels*, *colColours*,</span>
<span class="sd"> *colLoc* respectively.</span>
<span class="sd"> For finer grained control over tables, use the `.Table` class and add it to</span>
<span class="sd"> the axes with `.Axes.add_table`.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> cellText : 2D list of str, optional</span>
<span class="sd"> The texts to place into the table cells.</span>
<span class="sd"> *Note*: Line breaks in the strings are currently not accounted for and</span>
<span class="sd"> will result in the text exceeding the cell boundaries.</span>
<span class="sd"> cellColours : 2D list of colors, optional</span>
<span class="sd"> The background colors of the cells.</span>
<span class="sd"> cellLoc : {'left', 'center', 'right'}, default: 'right'</span>
<span class="sd"> The alignment of the text within the cells.</span>
<span class="sd"> colWidths : list of float, optional</span>
<span class="sd"> The column widths in units of the axes. If not given, all columns will</span>
<span class="sd"> have a width of *1 / ncols*.</span>
<span class="sd"> rowLabels : list of str, optional</span>
<span class="sd"> The text of the row header cells.</span>
<span class="sd"> rowColours : list of colors, optional</span>
<span class="sd"> The colors of the row header cells.</span>
<span class="sd"> rowLoc : {'left', 'center', 'right'}, optional, default: 'left'</span>
<span class="sd"> The text alignment of the row header cells.</span>
<span class="sd"> colLabels : list of str, optional</span>
<span class="sd"> The text of the column header cells.</span>
<span class="sd"> colColours : list of colors, optional</span>
<span class="sd"> The colors of the column header cells.</span>
<span class="sd"> colLoc : {'left', 'center', 'right'}, optional, default: 'left'</span>
<span class="sd"> The text alignment of the column header cells.</span>
<span class="sd"> loc : str, optional</span>
<span class="sd"> The position of the cell with respect to *ax*. This must be one of</span>
<span class="sd"> the `~.Table.codes`.</span>
<span class="sd"> bbox : `.Bbox`, optional</span>
<span class="sd"> A bounding box to draw the table into. If this is not *None*, this</span>
<span class="sd"> overrides *loc*.</span>
<span class="sd"> edges : substring of 'BRTL' or {'open', 'closed', 'horizontal', 'vertical'}</span>
<span class="sd"> The cell edges to be drawn with a line. See also</span>
<span class="sd"> `~.CustomCell.visible_edges`.</span>
<span class="sd"> Other Parameters</span>
<span class="sd"> ----------------</span>
<span class="sd"> **kwargs</span>
<span class="sd"> `.Table` properties.</span>
<span class="sd"> %(Table)s</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> table : `~matplotlib.table.Table`</span>
<span class="sd"> The created 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>
</pre></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<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 Jun 17, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.
Doc version v3.2.2-2-g137edd56a.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.