<divid="unreleased-message"> You are reading an old version of the documentation (v3.4.2). For the latest version see <ahref="https://matplotlib.org/stable/api/mathtext_api.html">https://matplotlib.org/stable/api/mathtext_api.html</a></div>
<h1><codeclass="docutils literal notranslate"><spanclass="pre">matplotlib.mathtext</span></code><aclass="headerlink" href="#matplotlib-mathtext" title="Permalink to this headline">¶</a></h1>
<divclass="graphviz"><imgsrc="../_images/inheritance-75a20bb8fc6537f7a657c05e74d6803bf610225a.png" alt="Inheritance diagram of matplotlib.mathtext" usemap="#inheritance0ca9968ee0" class="inheritance graphviz" /></div>
<areashape="rect" id="node14" href="#matplotlib.mathtext.MathtextBackend" target="_top" title="The base class for the mathtext backend-specific code.  `MathtextBackend`" alt="" coords="11,133,175,160"/>
<areashape="rect" id="node15" href="#matplotlib.mathtext.MathtextBackendAgg" target="_top" title="Render glyphs and rectangles to an FTImage buffer, which is later" alt="" coords="262,19,460,46"/>
<areashape="rect" id="node17" href="#matplotlib.mathtext.MathtextBackendCairo" target="_top" title="[*Deprecated*] Store information to write a mathtext rendering to the Cairo" alt="" coords="258,65,465,92"/>
<areashape="rect" id="node18" href="#matplotlib.mathtext.MathtextBackendPath" target="_top" title="Store information to write a mathtext rendering to the text path" alt="" coords="261,110,462,137"/>
<areashape="rect" id="node19" href="#matplotlib.mathtext.MathtextBackendPdf" target="_top" title="[*Deprecated*] Store information to write a mathtext rendering to the PDF backend." alt="" coords="265,156,457,183"/>
<areashape="rect" id="node20" href="#matplotlib.mathtext.MathtextBackendPs" target="_top" title="[*Deprecated*] Store information to write a mathtext rendering to the PostScript backend." alt="" coords="270,202,452,229"/>
<areashape="rect" id="node21" href="#matplotlib.mathtext.MathtextBackendSvg" target="_top" title="[*Deprecated*] Store information to write a mathtext rendering to the SVG" alt="" coords="263,248,459,275"/>
</map><spanclass="target" id="module-matplotlib.mathtext"></span><p>A module for parsing a subset of the TeX math syntax and rendering it to a
Matplotlib backend.</p>
<p>For a tutorial of its usage, see <aclass="reference internal" href="../tutorials/text/mathtext.html"><spanclass="doc">Writing mathematical expressions</span></a>. This
document is primarily concerned with implementation details.</p>
<p>The module uses <aclass="reference external" href="https://pypi.org/project/pyparsing/">pyparsing</a> to parse the TeX expression.</p>
<p>The Bakoma distribution of the TeX Computer Modern fonts, and STIX
fonts are supported. There is experimental support for using
arbitrary fonts, but results may vary without proper tweaking and
metrics for those fonts.</p>
<dlclass="py class">
<dtid="matplotlib.mathtext.GlueSpec">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">GlueSpec</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#GlueSpec"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.GlueSpec" title="Permalink to this definition">¶</a></dt>
<p>[<em>Deprecated</em>] See <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Glue</span></code>.</p>
<pclass="rubric">Notes</p>
<divclass="deprecated">
<p><spanclass="versionmodified deprecated">Deprecated since version 3.3.</span></p>
</div>
<dlclass="py method">
<dtid="matplotlib.mathtext.GlueSpec.copy">
<codeclass="descname">copy</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#GlueSpec.copy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.GlueSpec.copy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="matplotlib.mathtext.GlueSpec.factory">
<emclass="property">classmethod </em><codeclass="descname">factory</code><spanclass="sig-paren">(</span><em><spanclass="n">glue_type</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#GlueSpec.factory"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.GlueSpec.factory" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.mathtext.MathTextParser">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathTextParser</code><spanclass="sig-paren">(</span><em><spanclass="n">output</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextParser"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathTextParser" title="Permalink to this definition">¶</a></dt>
<dt><strong>dpi</strong><spanclass="classifier">float</span></dt><dd><p>The dots-per-inch setting used to render the text.</p>
</dd>
</dl>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><dlclass="first last docutils">
<dt>int</dt><dd><p>Offset of the baseline from the bottom of the image, in pixels.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<divclass="deprecated">
<p><spanclass="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
</dd></dl>
<dlclass="py method">
<dtid="matplotlib.mathtext.MathTextParser.parse">
<codeclass="descname">parse</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">s</span></em>, <em><spanclass="n">dpi</span><spanclass="o">=</span><spanclass="default_value">72</span></em>, <em><spanclass="n">prop</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <em><spanclass="o">*</span></em>, <em><spanclass="n">_force_standard_ps_fonts</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextParser.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathTextParser.parse" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse the given math expression <em>s</em> at the given <em>dpi</em>. If <em>prop</em> is
provided, it is a <aclass="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">FontProperties</span></code></a> object specifying the "default"
font to use in the math expression, used for all non-math text.</p>
<p>The results are cached, so multiple calls to <aclass="reference internal" href="#matplotlib.mathtext.MathTextParser.parse" title="matplotlib.mathtext.MathTextParser.parse"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">parse</span></code></a>
<dt><strong>color</strong><spanclass="classifier">color</span></dt><dd><p>The text color.</p>
</dd>
<dt><strong>dpi</strong><spanclass="classifier">float</span></dt><dd><p>The dots-per-inch setting used to render the text.</p>
</dd>
<dt><strong>fontsize</strong><spanclass="classifier">int</span></dt><dd><p>The font size in points.</p>
</dd>
</dl>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>array</strong><spanclass="classifier">(M, N, 4) array</span></dt><dd><p>RGBA color values of rasterized tex, colorized with <em>color</em>.</p>
</dd>
<dt><strong>depth</strong><spanclass="classifier">int</span></dt><dd><p>Offset of the baseline from the bottom of the image, in pixels.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<divclass="deprecated">
<p><spanclass="versionmodified deprecated">Deprecated since version 3.4.</span></p>
</div>
</dd></dl>
</dd></dl>
<dlclass="py exception">
<dtid="matplotlib.mathtext.MathTextWarning">
<emclass="property">exception </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathTextWarning</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathTextWarning"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathTextWarning" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathtextBackend</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackend"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackend" title="Permalink to this definition">¶</a></dt>
<p>The base class for the mathtext backend-specific code. <aclass="reference internal" href="#matplotlib.mathtext.MathtextBackend" title="matplotlib.mathtext.MathtextBackend"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">MathtextBackend</span></code></a>
subclasses interface between mathtext and specific Matplotlib graphics
<codeclass="descname">get_hinting_type</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackend.get_hinting_type"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackend.get_hinting_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the FreeType hinting type to use with this particular
<codeclass="descname">get_results</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">box</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackend.get_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackend.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
<codeclass="descname">set_canvas_size</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">w</span></em>, <em><spanclass="n">h</span></em>, <em><spanclass="n">d</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackend.set_canvas_size"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackend.set_canvas_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the dimension of the drawing canvas.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.mathtext.MathtextBackendAgg">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathtextBackendAgg</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendAgg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendAgg" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_hinting_type</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendAgg.get_hinting_type"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendAgg.get_hinting_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the FreeType hinting type to use with this particular
<codeclass="descname">get_results</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">box</span></em>, <em><spanclass="n">used_characters</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendAgg.get_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendAgg.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathtextBackendBitmap</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendBitmap"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendBitmap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_results</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">box</span></em>, <em><spanclass="n">used_characters</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendBitmap.get_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendBitmap.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
all processing is done.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.mathtext.MathtextBackendCairo">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathtextBackendCairo</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendCairo"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendCairo" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_results</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">box</span></em>, <em><spanclass="n">used_characters</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendCairo.get_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendCairo.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
<codeclass="descname">render_rect_filled</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">x1</span></em>, <em><spanclass="n">y1</span></em>, <em><spanclass="n">x2</span></em>, <em><spanclass="n">y2</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendCairo.render_rect_filled"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendCairo.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.mathtext.MathtextBackendPath">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathtextBackendPath</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPath"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendPath" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_results</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">box</span></em>, <em><spanclass="n">used_characters</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPath.get_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendPath.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
<codeclass="descname">render_rect_filled</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">x1</span></em>, <em><spanclass="n">y1</span></em>, <em><spanclass="n">x2</span></em>, <em><spanclass="n">y2</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPath.render_rect_filled"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendPath.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.mathtext.MathtextBackendPdf">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathtextBackendPdf</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPdf"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendPdf" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_results</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">box</span></em>, <em><spanclass="n">used_characters</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPdf.get_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendPdf.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
<codeclass="descname">render_rect_filled</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">x1</span></em>, <em><spanclass="n">y1</span></em>, <em><spanclass="n">x2</span></em>, <em><spanclass="n">y2</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPdf.render_rect_filled"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendPdf.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.mathtext.MathtextBackendPs">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathtextBackendPs</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendPs" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_results</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">box</span></em>, <em><spanclass="n">used_characters</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPs.get_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendPs.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
<codeclass="descname">render_rect_filled</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">x1</span></em>, <em><spanclass="n">y1</span></em>, <em><spanclass="n">x2</span></em>, <em><spanclass="n">y2</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendPs.render_rect_filled"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendPs.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.mathtext.MathtextBackendSvg">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathtextBackendSvg</code><spanclass="sig-paren">(</span><em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendSvg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendSvg" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_results</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">box</span></em>, <em><spanclass="n">used_characters</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendSvg.get_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendSvg.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a backend-specific tuple to return to the backend after
<codeclass="descname">render_rect_filled</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">x1</span></em>, <em><spanclass="n">y1</span></em>, <em><spanclass="n">x2</span></em>, <em><spanclass="n">y2</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#MathtextBackendSvg.render_rect_filled"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.MathtextBackendSvg.render_rect_filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a filled black rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>).</p>
</dd></dl>
</dd></dl>
<dlclass="py function">
<dtid="matplotlib.mathtext.get_unicode_index">
<codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">get_unicode_index</code><spanclass="sig-paren">(</span><em><spanclass="n">symbol</span></em>, <em><spanclass="n">math</span><spanclass="o">=</span><spanclass="default_value">True</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.mathtext.get_unicode_index" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the integer index (from the Unicode table) of <em>symbol</em>.</p>
<dt><strong>format</strong><spanclass="classifier">str, optional</span></dt><dd><p>The output format, e.g., 'svg', 'pdf', 'ps' or 'png'. If not set, the
format is determined as for <aclass="reference internal" href="figure_api.html#matplotlib.figure.Figure.savefig" title="matplotlib.figure.Figure.savefig"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Figure.savefig</span></code></a>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="py function">
<dtid="matplotlib.mathtext.ship">
<codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">ship</code><spanclass="sig-paren">(</span><em><spanclass="n">ox</span></em>, <em><spanclass="n">oy</span></em>, <em><spanclass="n">box</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#ship"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.ship" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<pclass="rubric">Notes</p>
<divclass="deprecated">
<p><spanclass="versionmodified deprecated">Deprecated since version 3.4: </span></p>