matplotlib.github.com/3.1.1/api/table_api.html at gh-pages · matplotlib/matplotlib.github.com

893 lines (831 loc) · 70.9 KB
<!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">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>matplotlib.table &mdash; Matplotlib 3.1.2 documentation</title>
    <link rel="stylesheet" href="../_static/mpl.css?v3.1.1-79-g90d53b526"
type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
    <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
    <link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
    <link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../_static/jquery.js"></script>
        <script type="text/javascript" src="../_static/underscore.js"></script>
        <script type="text/javascript" src="../_static/doctools.js"></script>
        <script type="text/javascript" src="../_static/language_data.js"></script>
        <script type="text/javascript" src="../_static/clipboard.min.js"></script>
        <script type="text/javascript" src="../_static/copybutton.js"></script>
        <script type="text/javascript">var copybuttonSkipText = '>>> ';</script>
        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Matplotlib 3.1.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.1.2 documentation" href="../index.html" />
    <link rel="up" title="API Overview" href="index.html" />
    <link rel="next" title="matplotlib.testing" href="testing_api.html" />
    <link rel="prev" title="matplotlib.style" href="style_api.html" />
    <link rel="canonical" href="https://matplotlib.org/stable/api/table_api.html" />
<div id="unreleased-message"> You are reading an old version of the documentation (v3.1.1).  For the latest version see <a href="https://matplotlib.org/stable/api/table_api.html">https://matplotlib.org/stable/api/table_api.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
    <div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.1.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>
<nav class="main-nav">
    <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>
    <div class="related">
      <h3>Navigation</h3>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="testing_api.html" title="matplotlib.testing"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="style_api.html" title="matplotlib.style"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">home</a>|&nbsp;</li>
        <li><a href="../contents.html">contents</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">API Overview</a> &raquo;</li> 
      </ul>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
  <li><a href="../contents.html">Documentation overview</a><ul>
  <li><a href="index.html">API Overview</a><ul>
      <li>Previous: <a href="style_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.style</span></code></a></li>
      <li>Next: <a href="testing_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.testing</span></code></a></li>
  </ul></li>
  </ul></li>
  <div id="sidebar-pagesource" role="note" aria-label="source link"
    style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
  <a href="../_sources/api/table_api.rst.txt"
     style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
        </div>
      </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
  <div class="section" id="module-matplotlib.table">
<span id="matplotlib-table"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.table</span></code><a class="headerlink" href="#module-matplotlib.table" title="Permalink to this headline">¶</a></h1>
<p>This module provides functionality to add a table to a plot.</p>
<p>Use the factory function <a class="reference internal" href="#matplotlib.table.table" title="matplotlib.table.table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">table</span></code></a> to create a ready-made
table from texts. If you need more control, use the <a class="reference internal" href="#matplotlib.table.Table" title="matplotlib.table.Table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Table</span></code></a> class and its
methods.</p>
<p>The table consists of a grid of cells, which are indexed by (row, column).
The cell (0, 0) is positioned at the top left.</p>
<p>Thanks to John Gill for providing the class and table.</p>
<dl class="class">
<dt id="matplotlib.table.Cell">
<em class="property">class </em><code class="descclassname">matplotlib.table.</code><code class="descname">Cell</code><span class="sig-paren">(</span><em>xy</em>, <em>width</em>, <em>height</em>, <em>edgecolor='k'</em>, <em>facecolor='w'</em>, <em>fill=True</em>, <em>text=''</em>, <em>loc=None</em>, <em>fontproperties=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.patches.Rectangle</span></code></a></p>
<p>A cell is a <a class="reference internal" href="_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Rectangle</span></code></a> with some associated <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>xy</strong> <span class="classifier-delimiter">:</span> <span class="classifier">2-tuple</span></dt>
<dd><p class="first last">The position of the bottom left corner of the cell.</p>
<dt><strong>width</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd><p class="first last">The cell width.</p>
<dt><strong>height</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd><p class="first last">The cell height.</p>
<dt><strong>edgecolor</strong> <span class="classifier-delimiter">:</span> <span class="classifier">color spec</span></dt>
<dd><p class="first last">The color of the cell border.</p>
<dt><strong>facecolor</strong> <span class="classifier-delimiter">:</span> <span class="classifier">color spec</span></dt>
<dd><p class="first last">The cell facecolor.</p>
<dt><strong>fill</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">Whether the cell background is filled.</p>
<dt><strong>text</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">The cell text.</p>
<dt><strong>loc</strong> <span class="classifier-delimiter">:</span> <span class="classifier">{'left', 'center', 'right'}, default: 'right'</span></dt>
<dd><p class="first last">The alignment of the text within the cell.</p>
<dt><strong>fontproperties</strong> <span class="classifier-delimiter">:</span> <span class="classifier">dict</span></dt>
<dd><p class="first last">A dict defining the font properties of the text. Supported keys and
values are the keyword arguments accepted by <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a>.</p>
<dl class="attribute">
<dt id="matplotlib.table.Cell.PAD">
<code class="descname">PAD</code><em class="property"> = 0.1</em><a class="headerlink" href="#matplotlib.table.Cell.PAD" title="Permalink to this definition">¶</a></dt>
<dd><p>Padding between text and rectangle.</p>
<dl class="method">
<dt id="matplotlib.table.Cell.auto_set_font_size">
<code class="descname">auto_set_font_size</code><span class="sig-paren">(</span><em>self</em>, <em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.auto_set_font_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.auto_set_font_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrink font size until the text fits into the cell width.</p>
<dl class="method">
<dt id="matplotlib.table.Cell.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>self</em>, <em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the <code class="xref py py-class docutils literal notranslate"><span class="pre">Patch</span></code> to the given <em>renderer</em>.</p>
<dl class="method">
<dt id="matplotlib.table.Cell.get_fontsize">
<code class="descname">get_fontsize</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.get_fontsize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.get_fontsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the cell fontsize.</p>
<dl class="method">
<dt id="matplotlib.table.Cell.get_required_width">
<code class="descname">get_required_width</code><span class="sig-paren">(</span><em>self</em>, <em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.get_required_width"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.get_required_width" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the minimal required width for the cell.</p>
<dl class="method">
<dt id="matplotlib.table.Cell.get_text">
<code class="descname">get_text</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.get_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.get_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the cell <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a> instance.</p>
<dl class="method">
<dt id="matplotlib.table.Cell.get_text_bounds">
<code class="descname">get_text_bounds</code><span class="sig-paren">(</span><em>self</em>, <em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.get_text_bounds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.get_text_bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the text bounds as <em>(x, y, width, height)</em> in table coordinates.</p>
<dl class="method">
<dt id="matplotlib.table.Cell.set_figure">
<code class="descname">set_figure</code><span class="sig-paren">(</span><em>self</em>, <em>fig</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.set_figure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> instance the artist belongs to.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>fig</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt>
<dl class="method">
<dt id="matplotlib.table.Cell.set_fontsize">
<code class="descname">set_fontsize</code><span class="sig-paren">(</span><em>self</em>, <em>size</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.set_fontsize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.set_fontsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the text fontsize.</p>
<dl class="method">
<dt id="matplotlib.table.Cell.set_text_props">
<code class="descname">set_text_props</code><span class="sig-paren">(</span><em>self</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.set_text_props"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.set_text_props" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the text properties.</p>
<p>Valid kwargs are</p>
<blockquote>
<div><table border="1" class="property-table docutils">
<col width="32%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">agg_filter</span></code></a></td>
<td>a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal notranslate"><span class="pre">alpha</span></code></a></td>
<td>float</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal notranslate"><span class="pre">animated</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_backgroundcolor" title="matplotlib.text.Text.set_backgroundcolor"><code class="xref py py-meth docutils literal notranslate"><span class="pre">backgroundcolor</span></code></a></td>
<td>color</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_bbox" title="matplotlib.text.Text.set_bbox"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bbox</span></code></a></td>
<td>dict with properties for <a class="reference internal" href="_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" title="matplotlib.patches.FancyBboxPatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">patches.FancyBboxPatch</span></code></a></td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_clip_box" title="matplotlib.text.Text.set_clip_box"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_box</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a></td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_clip_on" title="matplotlib.text.Text.set_clip_on"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_on</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_clip_path" title="matplotlib.text.Text.set_clip_path"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_path</span></code></a></td>
<td>[(<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a>) | <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Patch</span></code></a> | None]</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_color" title="matplotlib.text.Text.set_color"><code class="xref py py-meth docutils literal notranslate"><span class="pre">color</span></code></a> or c</td>
<td>color</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal notranslate"><span class="pre">contains</span></code></a></td>
<td>callable</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal notranslate"><span class="pre">figure</span></code></a></td>
<td><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontfamily" title="matplotlib.text.Text.set_fontfamily"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontfamily</span></code></a> or family</td>
<td>{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontproperties" title="matplotlib.text.Text.set_fontproperties"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontproperties</span></code></a> or font_properties</td>
<td><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">font_manager.FontProperties</span></code></a></td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontsize" title="matplotlib.text.Text.set_fontsize"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontsize</span></code></a> or size</td>
<td>{size in points, 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontstretch" title="matplotlib.text.Text.set_fontstretch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontstretch</span></code></a> or stretch</td>
<td>{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontstyle" title="matplotlib.text.Text.set_fontstyle"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontstyle</span></code></a> or style</td>
<td>{'normal', 'italic', 'oblique'}</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontvariant" title="matplotlib.text.Text.set_fontvariant"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontvariant</span></code></a> or variant</td>
<td>{'normal', 'small-caps'}</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontweight" title="matplotlib.text.Text.set_fontweight"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontweight</span></code></a> or weight</td>
<td>{a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_gid.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal notranslate"><span class="pre">gid</span></code></a></td>
<td>str</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_horizontalalignment" title="matplotlib.text.Text.set_horizontalalignment"><code class="xref py py-meth docutils literal notranslate"><span class="pre">horizontalalignment</span></code></a> or ha</td>
<td>{'center', 'right', 'left'}</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_in_layout.html#matplotlib.artist.Artist.set_in_layout" title="matplotlib.artist.Artist.set_in_layout"><code class="xref py py-meth docutils literal notranslate"><span class="pre">in_layout</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_label.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal notranslate"><span class="pre">label</span></code></a></td>
<td>object</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_linespacing" title="matplotlib.text.Text.set_linespacing"><code class="xref py py-meth docutils literal notranslate"><span class="pre">linespacing</span></code></a></td>
<td>float (multiple of font size)</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_multialignment" title="matplotlib.text.Text.set_multialignment"><code class="xref py py-meth docutils literal notranslate"><span class="pre">multialignment</span></code></a> or ma</td>
<td>{'left', 'right', 'center'}</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_path_effects.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal notranslate"><span class="pre">path_effects</span></code></a></td>
<td><a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AbstractPathEffect</span></code></a></td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal notranslate"><span class="pre">picker</span></code></a></td>
<td>None or bool or float or callable</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_position" title="matplotlib.text.Text.set_position"><code class="xref py py-meth docutils literal notranslate"><span class="pre">position</span></code></a></td>
<td>(float, float)</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rasterized</span></code></a></td>
<td>bool or None</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_rotation" title="matplotlib.text.Text.set_rotation"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotation</span></code></a></td>
<td>{angle in degrees, 'vertical', 'horizontal'}</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_rotation_mode" title="matplotlib.text.Text.set_rotation_mode"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotation_mode</span></code></a></td>
<td>{None, 'default', 'anchor'}</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sketch_params</span></code></a></td>
<td>(scale: float, length: float, randomness: float)</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_snap.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal notranslate"><span class="pre">snap</span></code></a></td>
<td>bool or None</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_text" title="matplotlib.text.Text.set_text"><code class="xref py py-meth docutils literal notranslate"><span class="pre">text</span></code></a></td>
<td>object</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a></td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_url.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">url</span></code></a></td>
<td>str</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_usetex" title="matplotlib.text.Text.set_usetex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">usetex</span></code></a></td>
<td>bool or None</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_verticalalignment" title="matplotlib.text.Text.set_verticalalignment"><code class="xref py py-meth docutils literal notranslate"><span class="pre">verticalalignment</span></code></a> or va</td>
<td>{'center', 'top', 'bottom', 'baseline', 'center_baseline'}</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_visible.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal notranslate"><span class="pre">visible</span></code></a></td>
<td>bool</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_wrap" title="matplotlib.text.Text.set_wrap"><code class="xref py py-meth docutils literal notranslate"><span class="pre">wrap</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_x" title="matplotlib.text.Text.set_x"><code class="xref py py-meth docutils literal notranslate"><span class="pre">x</span></code></a></td>
<td>float</td>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_y" title="matplotlib.text.Text.set_y"><code class="xref py py-meth docutils literal notranslate"><span class="pre">y</span></code></a></td>
<td>float</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_zorder.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">zorder</span></code></a></td>
<td>float</td>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.table.Cell.set_transform">
<code class="descname">set_transform</code><span class="sig-paren">(</span><em>self</em>, <em>trans</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Cell.set_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Cell.set_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the artist transform.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>t</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a></span></dt>
<dl class="class">
<dt id="matplotlib.table.CustomCell">
<em class="property">class </em><code class="descclassname">matplotlib.table.</code><code class="descname">CustomCell</code><span class="sig-paren">(</span><em>*args</em>, <em>visible_edges</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#CustomCell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.CustomCell" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.table.Cell" title="matplotlib.table.Cell"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.table.Cell</span></code></a></p>
<p>A <a class="reference internal" href="#matplotlib.table.Cell" title="matplotlib.table.Cell"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Cell</span></code></a> subclass with configurable edge visibility.</p>
<dl class="method">
<dt id="matplotlib.table.CustomCell.get_path">
<code class="descname">get_path</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#CustomCell.get_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.CustomCell.get_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a> for the <a class="reference internal" href="#matplotlib.table.CustomCell.visible_edges" title="matplotlib.table.CustomCell.visible_edges"><code class="xref py py-obj docutils literal notranslate"><span class="pre">visible_edges</span></code></a>.</p>
<dl class="attribute">
<dt id="matplotlib.table.CustomCell.visible_edges">
<code class="descname">visible_edges</code><a class="headerlink" href="#matplotlib.table.CustomCell.visible_edges" title="Permalink to this definition">¶</a></dt>
<dd><p>The cell edges to be drawn with a line.</p>
<p>Reading this property returns a substring of 'BRTL' (bottom, right,
top, left').</p>
<p>When setting this property, you can use a substring of 'BRTL' or one
of {'open', 'closed', 'horizontal', 'vertical'}.</p>
<dl class="class">
<dt id="matplotlib.table.Table">
<em class="property">class </em><code class="descclassname">matplotlib.table.</code><code class="descname">Table</code><span class="sig-paren">(</span><em>ax</em>, <em>loc=None</em>, <em>bbox=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.artist.Artist</span></code></a></p>
<p>A table of cells.</p>
<p>The table consists of a grid of cells, which are indexed by (row, column).</p>
<p>For a simple table, you'll have a full grid of cells with indices from
(0, 0) to (num_rows-1, num_cols-1), in which the cell (0, 0) is positioned
at the top left. However, you can also add cells with negative indices.
You don't have to add a cell to every grid position, so you can create
tables that have holes.</p>
<p><em>Note</em>: You'll usually not create an empty table from scratch. Instead use
<a class="reference internal" href="#matplotlib.table.table" title="matplotlib.table.table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">table</span></code></a> to create a table from data.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>ax</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a></span></dt>
<dd><p class="first last">The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> to plot the table into.</p>
<dt><strong>loc</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
<dd><p class="first last">The position of the cell with respect to <em>ax</em>. This must be one of
the <a class="reference internal" href="#matplotlib.table.Table.codes" title="matplotlib.table.Table.codes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">codes</span></code></a>.</p>
<dt><strong>bbox</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a> or None</span></dt>
<dd><p class="first last">A bounding box to draw the table into. If this is not <em>None</em>, this
overrides <em>loc</em>.</p>
<tr class="field-even field"><th class="field-name">Other Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>**kwargs</strong></dt>
<dd><p class="first last"><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code></a> properties.</p>
<dl class="attribute">
<dt id="matplotlib.table.Table.AXESPAD">
<code class="descname">AXESPAD</code><em class="property"> = 0.02</em><a class="headerlink" href="#matplotlib.table.Table.AXESPAD" title="Permalink to this definition">¶</a></dt>
<dd><p>The border between the Axes and the table edge in Axes units.</p>
<dl class="attribute">
<dt id="matplotlib.table.Table.FONTSIZE">
<code class="descname">FONTSIZE</code><em class="property"> = 10</em><a class="headerlink" href="#matplotlib.table.Table.FONTSIZE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.table.Table.add_cell">
<code class="descname">add_cell</code><span class="sig-paren">(</span><em>self</em>, <em>row</em>, <em>col</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.add_cell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.add_cell" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a cell and add it to the table.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>row</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
<dd><p class="first last">Row index.</p>
<dt><strong>col</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
<dd><p class="first last">Column index.</p>
<dt><strong>*args, **kwargs</strong></dt>
<dd><p class="first last">All other parameters are passed on to <a class="reference internal" href="#matplotlib.table.Cell" title="matplotlib.table.Cell"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Cell</span></code></a>.</p>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>cell</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="#matplotlib.table.CustomCell" title="matplotlib.table.CustomCell"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomCell</span></code></a></span></dt>
<dd><p class="first last">The created cell.</p>
<dl class="method">
<dt id="matplotlib.table.Table.auto_set_column_width">
<code class="descname">auto_set_column_width</code><span class="sig-paren">(</span><em>self</em>, <em>col</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.auto_set_column_width"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.auto_set_column_width" title="Permalink to this definition">¶</a></dt>
<dd><p>Automatically set the widths of given columns to optimal sizes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>col</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int or sequence of ints</span></dt>
<dd><p class="first last">The indices of the columns to auto-scale.</p>
<dl class="method">
<dt id="matplotlib.table.Table.auto_set_font_size">
<code class="descname">auto_set_font_size</code><span class="sig-paren">(</span><em>self</em>, <em>value=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.auto_set_font_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.auto_set_font_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Automatically set font size.</p>
<dl class="attribute">
<dt id="matplotlib.table.Table.codes">
<code class="descname">codes</code><em class="property"> = {'best': 0, 'bottom': 17, 'bottom left': 12, 'bottom right': 13, 'center': 9, 'center left': 5, 'center right': 6, 'left': 15, 'lower center': 7, 'lower left': 3, 'lower right': 4, 'right': 14, 'top': 16, 'top left': 11, 'top right': 10, 'upper center': 8, 'upper left': 2, 'upper right': 1}</em><a class="headerlink" href="#matplotlib.table.Table.codes" title="Permalink to this definition">¶</a></dt>
<dd><p>Possible values where to place the table relative to the Axes.</p>
<dl class="method">
<dt id="matplotlib.table.Table.contains">
<code class="descname">contains</code><span class="sig-paren">(</span><em>self</em>, <em>mouseevent</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.contains"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the artist contains the mouse event.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>mouseevent</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.MouseEvent" title="matplotlib.backend_bases.MouseEvent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.backend_bases.MouseEvent</span></code></a></span></dt>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>contains</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">Whether any values are within the radius.</p>
<dt><strong>details</strong> <span class="classifier-delimiter">:</span> <span class="classifier">dict</span></dt>
<dd><p class="first last">An artist-specific dictionary of details of the event context,
such as which points are contained in the pick radius. See the
individual Artist subclasses for details.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_contains</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">get_contains</span></code></dt>
<dl class="method">
<dt id="matplotlib.table.Table.draw">
<code class="descname">draw</code><span class="sig-paren">(</span><em>self</em>, <em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.draw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the Artist using the given renderer.</p>
<p>This method will be overridden in the Artist subclasses. Typically,
it is implemented to not have any effect if the Artist is not visible
(<a class="reference internal" href="_as_gen/matplotlib.artist.Artist.get_visible.html#matplotlib.artist.Artist.get_visible" title="matplotlib.artist.Artist.get_visible"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist.get_visible</span></code></a> is <em>False</em>).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>renderer</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RendererBase</span></code></a> subclass.</span></dt>
<dl class="attribute">
<dt id="matplotlib.table.Table.edges">
<code class="descname">edges</code><a class="headerlink" href="#matplotlib.table.Table.edges" title="Permalink to this definition">¶</a></dt>
<dd><p>The default value of <a class="reference internal" href="#matplotlib.table.CustomCell.visible_edges" title="matplotlib.table.CustomCell.visible_edges"><code class="xref py py-obj docutils literal notranslate"><span class="pre">visible_edges</span></code></a> for newly added
cells using <a class="reference internal" href="#matplotlib.table.Table.add_cell" title="matplotlib.table.Table.add_cell"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_cell</span></code></a>.</p>
<p class="rubric">Notes</p>
<p>This setting does currently only affect newly created cells using
<a class="reference internal" href="#matplotlib.table.Table.add_cell" title="matplotlib.table.Table.add_cell"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_cell</span></code></a>.</p>
<p>To change existing cells, you have to set their edges explicitly:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">tab</span><span class="o">.</span><span class="n">get_celld</span><span class="p">()</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">visible_edges</span> <span class="o">=</span> <span class="s1">&#39;horizontal&#39;</span>
</pre></div>
<dl class="method">
<dt id="matplotlib.table.Table.get_celld">
<code class="descname">get_celld</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.get_celld"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.get_celld" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dict of cells in the table mapping <em>(row, column)</em> to
<a class="reference internal" href="#matplotlib.table.Cell" title="matplotlib.table.Cell"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Cell</span></code></a>s.</p>
<p class="rubric">Notes</p>
<p>You can also directly index into the Table object to access individual
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cell</span> <span class="o">=</span> <span class="n">table</span><span class="p">[</span><span class="n">row</span><span class="p">,</span> <span class="n">col</span><span class="p">]</span>
</pre></div>
<dl class="method">
<dt id="matplotlib.table.Table.get_child_artists">
<code class="descname">get_child_artists</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.table.Table.get_child_artists" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>] Return the Artists contained by the table.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 3.0.</span></p>
<dl class="method">
<dt id="matplotlib.table.Table.get_children">
<code class="descname">get_children</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.get_children"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the Artists contained by the table.</p>
<dl class="method">
<dt id="matplotlib.table.Table.get_window_extent">
<code class="descname">get_window_extent</code><span class="sig-paren">(</span><em>self</em>, <em>renderer</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.get_window_extent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the bounding box of the table in window coords.</p>
<dl class="method">
<dt id="matplotlib.table.Table.scale">
<code class="descname">scale</code><span class="sig-paren">(</span><em>self</em>, <em>xscale</em>, <em>yscale</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.scale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.scale" title="Permalink to this definition">¶</a></dt>
<dd><p>Scale column widths by <em>xscale</em> and row heights by <em>yscale</em>.</p>
<dl class="method">
<dt id="matplotlib.table.Table.set_fontsize">
<code class="descname">set_fontsize</code><span class="sig-paren">(</span><em>self</em>, <em>size</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#Table.set_fontsize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.Table.set_fontsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font size, in points, of the cell text.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>size</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<p class="rubric">Notes</p>
<p>As long as auto font size has not been disabled, the value will be
clipped such that the text fits horizontally into the cell.</p>
<p>You can disable this behavior using <a class="reference internal" href="#matplotlib.table.Table.auto_set_font_size" title="matplotlib.table.Table.auto_set_font_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">auto_set_font_size</span></code></a>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">the_table</span><span class="o">.</span><span class="n">auto_set_font_size</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">the_table</span><span class="o">.</span><span class="n">set_fontsize</span><span class="p">(</span><span class="mi">20</span><span class="p">)</span>
</pre></div>
<p>However, there is no automatic scaling of the row height so that the
text may exceed the cell boundary.</p>
<dl class="function">
<dt id="matplotlib.table.table">
<code class="descclassname">matplotlib.table.</code><code class="descname">table</code><span class="sig-paren">(</span><em>ax</em>, <em>cellText=None</em>, <em>cellColours=None</em>, <em>cellLoc='right'</em>, <em>colWidths=None</em>, <em>rowLabels=None</em>, <em>rowColours=None</em>, <em>rowLoc='left'</em>, <em>colLabels=None</em>, <em>colColours=None</em>, <em>colLoc='center'</em>, <em>loc='bottom'</em>, <em>bbox=None</em>, <em>edges='closed'</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/table.html#table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.table.table" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a table to an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a>.</p>
<p>At least one of <em>cellText</em> or <em>cellColours</em> must be specified. These
parameters must be 2D lists, in which the outer lists define the rows and
the inner list define the column values per row. Each row must have the
same number of elements.</p>
<p>The table can optionally have row and column headers, which are configured
using <em>rowLabels</em>, <em>rowColours</em>, <em>rowLoc</em> and <em>colLabels</em>, <em>colColours</em>,
<em>colLoc</em> respectively.</p>
<p>For finer grained control over tables, use the <a class="reference internal" href="#matplotlib.table.Table" title="matplotlib.table.Table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Table</span></code></a> class and add it to
the axes with <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.add_table.html#matplotlib.axes.Axes.add_table" title="matplotlib.axes.Axes.add_table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes.add_table</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>cellText</strong> <span class="classifier-delimiter">:</span> <span class="classifier">2D list of str, optional</span></dt>
<dd><p class="first">The texts to place into the table cells.</p>
<p class="last"><em>Note</em>: Line breaks in the strings are currently not accounted for and
will result in the text exceeding the cell boundaries.</p>
<dt><strong>cellColours</strong> <span class="classifier-delimiter">:</span> <span class="classifier">2D list of matplotlib color specs, optional</span></dt>
<dd><p class="first last">The background colors of the cells.</p>
<dt><strong>cellLoc</strong> <span class="classifier-delimiter">:</span> <span class="classifier">{'left', 'center', 'right'}, default: 'right'</span></dt>
<dd><p class="first last">The alignment of the text within the cells.</p>
<dt><strong>colWidths</strong> <span class="classifier-delimiter">:</span> <span class="classifier">list of float, optional</span></dt>
<dd><p class="first last">The column widths in units of the axes. If not given, all columns will
have a width of <em>1 / ncols</em>.</p>
<dt><strong>rowLabels</strong> <span class="classifier-delimiter">:</span> <span class="classifier">list of str, optional</span></dt>
<dd><p class="first last">The text of the row header cells.</p>
<dt><strong>rowColours</strong> <span class="classifier-delimiter">:</span> <span class="classifier">list of matplotlib color specs, optional</span></dt>
<dd><p class="first last">The colors of the row header cells.</p>
<dt><strong>rowLoc</strong> <span class="classifier-delimiter">:</span> <span class="classifier">{'left', 'center', 'right'}, optional, default: 'left'</span></dt>
<dd><p class="first last">The text alignment of the row header cells.</p>
<dt><strong>colLabels</strong> <span class="classifier-delimiter">:</span> <span class="classifier">list of str, optional</span></dt>
<dd><p class="first last">The text of the column header cells.</p>
<dt><strong>colColours</strong> <span class="classifier-delimiter">:</span> <span class="classifier">list of matplotlib color specs, optional</span></dt>
<dd><p class="first last">The colors of the column header cells.</p>
<dt><strong>colLoc</strong> <span class="classifier-delimiter">:</span> <span class="classifier">{'left', 'center', 'right'}, optional, default: 'left'</span></dt>
<dd><p class="first last">The text alignment of the column header cells.</p>
<dt><strong>loc</strong> <span class="classifier-delimiter">:</span> <span class="classifier">str, optional</span></dt>
<dd><p class="first last">The position of the cell with respect to <em>ax</em>. This must be one of
the <a class="reference internal" href="#matplotlib.table.Table.codes" title="matplotlib.table.Table.codes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">codes</span></code></a>.</p>
<dt><strong>bbox</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a>, optional</span></dt>
<dd><p class="first last">A bounding box to draw the table into. If this is not <em>None</em>, this
overrides <em>loc</em>.</p>
<dt><strong>edges</strong> <span class="classifier-delimiter">:</span> <span class="classifier">substring of 'BRTL' or {'open', 'closed', 'horizontal', 'vertical'}</span></dt>
<dd><p class="first last">The cell edges to be drawn with a line. See also
<a class="reference internal" href="#matplotlib.table.CustomCell.visible_edges" title="matplotlib.table.CustomCell.visible_edges"><code class="xref py py-obj docutils literal notranslate"><span class="pre">visible_edges</span></code></a>.</p>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first docutils">
<dt><strong>table</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="#matplotlib.table.Table" title="matplotlib.table.Table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Table</span></code></a></span></dt>
<dd><p class="first last">The created table.</p>
<tr class="field-odd field"><th class="field-name">Other Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>**kwargs</strong></dt>
<dd><p class="first"><a class="reference internal" href="#matplotlib.table.Table" title="matplotlib.table.Table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Table</span></code></a> properties.</p>
<table border="1" class="property-table last docutils">
<col width="40%" />
<col width="60%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">agg_filter</span></code></a></td>
<td>a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal notranslate"><span class="pre">alpha</span></code></a></td>
<td>float</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal notranslate"><span class="pre">animated</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_clip_box.html#matplotlib.artist.Artist.set_clip_box" title="matplotlib.artist.Artist.set_clip_box"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_box</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a></td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_clip_on.html#matplotlib.artist.Artist.set_clip_on" title="matplotlib.artist.Artist.set_clip_on"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_on</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_clip_path.html#matplotlib.artist.Artist.set_clip_path" title="matplotlib.artist.Artist.set_clip_path"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_path</span></code></a></td>
<td>[(<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a>) | <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Patch</span></code></a> | None]</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal notranslate"><span class="pre">contains</span></code></a></td>
<td>callable</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal notranslate"><span class="pre">figure</span></code></a></td>
<td><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></td>
<tr class="row-even"><td><a class="reference internal" href="#matplotlib.table.Table.set_fontsize" title="matplotlib.table.Table.set_fontsize"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontsize</span></code></a></td>
<td>float</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_gid.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal notranslate"><span class="pre">gid</span></code></a></td>
<td>str</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_in_layout.html#matplotlib.artist.Artist.set_in_layout" title="matplotlib.artist.Artist.set_in_layout"><code class="xref py py-meth docutils literal notranslate"><span class="pre">in_layout</span></code></a></td>
<td>bool</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_label.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal notranslate"><span class="pre">label</span></code></a></td>
<td>object</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_path_effects.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal notranslate"><span class="pre">path_effects</span></code></a></td>
<td><a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AbstractPathEffect</span></code></a></td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal notranslate"><span class="pre">picker</span></code></a></td>
<td>None or bool or float or callable</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rasterized</span></code></a></td>
<td>bool or None</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sketch_params</span></code></a></td>
<td>(scale: float, length: float, randomness: float)</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_snap.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal notranslate"><span class="pre">snap</span></code></a></td>
<td>bool or None</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a></td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_url.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">url</span></code></a></td>
<td>str</td>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_visible.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal notranslate"><span class="pre">visible</span></code></a></td>
<td>bool</td>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_zorder.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">zorder</span></code></a></td>
<td>float</td>
          </div>
        </div>
      </div>
      <div class="clearer"></div>
    <div class="footer">
        &copy; 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 Jan 05, 2020.
	Created using
	<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
	Doc version v3.1.1-79-g90d53b526.
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  ga('create', 'UA-55954603-1', 'auto');
  ga('send', 'pageview');
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

table_api.html

Latest commit

History

table_api.html

File metadata and controls
