You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
<divid="unreleased-message"> You are reading an old version of the documentation (v3.2.0). 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>
<pclass="warning">Inheritance diagram of matplotlib.mathtext</p></object></div>
<spanclass="target" id="module-matplotlib.mathtext"></span><p><aclass="reference internal" href="#module-matplotlib.mathtext" title="matplotlib.mathtext"><codeclass="xref py py-mod docutils literal notranslate"><spanclass="pre">mathtext</span></code></a> is a module for parsing a subset of the
TeX math syntax and drawing them 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="http://pyparsing.wikispaces.com/">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="class">
<dtid="matplotlib.mathtext.Accent">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Accent</code><spanclass="sig-paren">(</span><em>c</em>, <em>state</em>, <em>math=True</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Accent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Accent" title="Permalink to this definition">¶</a></dt>
<p>The font metrics need to be dealt with differently for accents,
since they are already offset correctly from the baseline in
TrueType fonts.</p>
<dlclass="method">
<dtid="matplotlib.mathtext.Accent.grow">
<codeclass="descname">grow</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Accent.grow"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Accent.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Accent.render">
<codeclass="descname">render</code><spanclass="sig-paren">(</span><em>self</em>, <em>x</em>, <em>y</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Accent.render"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Accent.render" title="Permalink to this definition">¶</a></dt>
<dd><p>Render the character to the canvas.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Accent.shrink">
<codeclass="descname">shrink</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Accent.shrink"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Accent.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.AutoHeightChar">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">AutoHeightChar</code><spanclass="sig-paren">(</span><em>c</em>, <em>height</em>, <em>depth</em>, <em>state</em>, <em>always=False</em>, <em>factor=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#AutoHeightChar"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.AutoHeightChar" title="Permalink to this definition">¶</a></dt>
<p><aclass="reference internal" href="#matplotlib.mathtext.AutoHeightChar" title="matplotlib.mathtext.AutoHeightChar"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AutoHeightChar</span></code></a> will create a character as close to the
given height and depth as possible. When using a font with
multiple height versions of some characters (such as the BaKoMa
fonts), the correct glyph will be selected, otherwise this will
always just return a scaled version of the glyph.</p>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.AutoWidthChar">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">AutoWidthChar</code><spanclass="sig-paren">(</span><em>c</em>, <em>width</em>, <em>state</em>, <em>always=False</em>, <em>char_class=<class 'matplotlib.mathtext.Char'></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#AutoWidthChar"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.AutoWidthChar" title="Permalink to this definition">¶</a></dt>
<p><aclass="reference internal" href="#matplotlib.mathtext.AutoWidthChar" title="matplotlib.mathtext.AutoWidthChar"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AutoWidthChar</span></code></a> will create a character as close to the
given width as possible. When using a font with multiple width
versions of some characters (such as the BaKoMa fonts), the
correct glyph will be selected, otherwise this will always just
return a scaled version of the glyph.</p>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.BakomaFonts">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">BakomaFonts</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#BakomaFonts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.BakomaFonts" title="Permalink to this definition">¶</a></dt>
<p>Use the Bakoma TrueType fonts for rendering.</p>
<p>Symbols are strewn about a number of font files, each of which has
its own proprietary 8-bit encoding.</p>
<p><em>default_font_prop</em>: A
<aclass="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FontProperties</span></code></a> object to use
for the default non-math font, or the base font for Unicode
(generic) font rendering.</p>
<p><em>mathtext_backend</em>: A subclass of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MathTextBackend</span></code>
used to delegate the actual rendering.</p>
<dlclass="attribute">
<dtid="matplotlib.mathtext.BakomaFonts.alias">
<codeclass="descname">alias</code><emclass="property"> = '\\]'</em><aclass="headerlink" href="#matplotlib.mathtext.BakomaFonts.alias" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_sized_alternatives_for_symbol</code><spanclass="sig-paren">(</span><em>self</em>, <em>fontname</em>, <em>sym</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#BakomaFonts.get_sized_alternatives_for_symbol"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.BakomaFonts.get_sized_alternatives_for_symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>Override if your font provides multiple sizes of the same
symbol. Should return a list of symbols matching <em>sym</em> in
various sizes. The expression renderer will select the most
appropriate size for a given situation from this list.</p>
</dd></dl>
<dlclass="attribute">
<dtid="matplotlib.mathtext.BakomaFonts.target">
<codeclass="descname">target</code><emclass="property"> = ']'</em><aclass="headerlink" href="#matplotlib.mathtext.BakomaFonts.target" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.Box">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Box</code><spanclass="sig-paren">(</span><em>width</em>, <em>height</em>, <em>depth</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Box"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Box" title="Permalink to this definition">¶</a></dt>
<p>Represents any node with a physical location.</p>
<dlclass="method">
<dtid="matplotlib.mathtext.Box.grow">
<codeclass="descname">grow</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Box.grow"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Box.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Box.render">
<codeclass="descname">render</code><spanclass="sig-paren">(</span><em>self</em>, <em>x1</em>, <em>y1</em>, <em>x2</em>, <em>y2</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Box.render"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Box.render" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Box.shrink">
<codeclass="descname">shrink</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Box.shrink"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Box.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.Char">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Char</code><spanclass="sig-paren">(</span><em>c</em>, <em>state</em>, <em>math=True</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Char"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Char" title="Permalink to this definition">¶</a></dt>
<p>Represents a single character. Unlike TeX, the font information
and metrics are stored with each <aclass="reference internal" href="#matplotlib.mathtext.Char" title="matplotlib.mathtext.Char"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Char</span></code></a> to make it easier
to lookup the font metrics when needed. Note that TeX boxes have
a width, height, and depth, unlike Type1 and Truetype which use a
full bounding box and an advance in the x-direction. The metrics
must be converted to the TeX way, and the advance (if different
from width) must be converted into a <aclass="reference internal" href="#matplotlib.mathtext.Kern" title="matplotlib.mathtext.Kern"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Kern</span></code></a> node when the
<aclass="reference internal" href="#matplotlib.mathtext.Char" title="matplotlib.mathtext.Char"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Char</span></code></a> is added to its parent <aclass="reference internal" href="#matplotlib.mathtext.Hlist" title="matplotlib.mathtext.Hlist"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Hlist</span></code></a>.</p>
<dlclass="method">
<dtid="matplotlib.mathtext.Char.get_kerning">
<codeclass="descname">get_kerning</code><spanclass="sig-paren">(</span><em>self</em>, <em>next</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Char.get_kerning"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Char.get_kerning" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the amount of kerning between this and the given
character. Called when characters are strung together into
<codeclass="descname">grow</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Char.grow"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Char.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Char.is_slanted">
<codeclass="descname">is_slanted</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Char.is_slanted"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Char.is_slanted" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Char.render">
<codeclass="descname">render</code><spanclass="sig-paren">(</span><em>self</em>, <em>x</em>, <em>y</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Char.render"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Char.render" title="Permalink to this definition">¶</a></dt>
<dd><p>Render the character to the canvas</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Char.shrink">
<codeclass="descname">shrink</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Char.shrink"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Char.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">ComputerModernFontConstants</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#ComputerModernFontConstants"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">delta</code><emclass="property"> = 0.075</em><aclass="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.delta" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">delta_integral</code><emclass="property"> = 0.3</em><aclass="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.delta_integral" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">delta_slanted</code><emclass="property"> = 0.3</em><aclass="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.delta_slanted" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">script_space</code><emclass="property"> = 0.075</em><aclass="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.script_space" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">sub1</code><emclass="property"> = 0.2</em><aclass="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.sub1" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">sub2</code><emclass="property"> = 0.3</em><aclass="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.sub2" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">subdrop</code><emclass="property"> = 0.2</em><aclass="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.subdrop" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">sup1</code><emclass="property"> = 0.45</em><aclass="headerlink" href="#matplotlib.mathtext.ComputerModernFontConstants.sup1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.DejaVuFonts">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">DejaVuFonts</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#DejaVuFonts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.DejaVuFonts" title="Permalink to this definition">¶</a></dt>
<aclass="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FontProperties</span></code></a> object to use
for the default non-math font, or the base font for Unicode
(generic) font rendering.</p>
<p><em>mathtext_backend</em>: A subclass of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MathTextBackend</span></code>
used to delegate the actual rendering.</p>
<dlclass="attribute">
<dtid="matplotlib.mathtext.DejaVuFonts.use_cmex">
<codeclass="descname">use_cmex</code><emclass="property"> = False</em><aclass="headerlink" href="#matplotlib.mathtext.DejaVuFonts.use_cmex" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">DejaVuSansFontConstants</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#DejaVuSansFontConstants"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.DejaVuSansFontConstants" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">DejaVuSansFonts</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#DejaVuSansFonts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.DejaVuSansFonts" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">DejaVuSerifFontConstants</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#DejaVuSerifFontConstants"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.DejaVuSerifFontConstants" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">DejaVuSerifFonts</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#DejaVuSerifFonts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.DejaVuSerifFonts" title="Permalink to this definition">¶</a></dt>
<p>A font handling class for the DejaVu Serif fonts</p>
<p>If a glyph is not found it will fallback to Stix Serif</p>
<p><em>default_font_prop</em>: A
<aclass="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FontProperties</span></code></a> object to use
for the default non-math font, or the base font for Unicode
(generic) font rendering.</p>
<p><em>mathtext_backend</em>: A subclass of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MathTextBackend</span></code>
used to delegate the actual rendering.</p>
</dd></dl>
<dlclass="function">
<dtid="matplotlib.mathtext.Error">
<codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Error</code><spanclass="sig-paren">(</span><em>msg</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Error"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Error" title="Permalink to this definition">¶</a></dt>
<dd><p>Helper class to raise parser errors.</p>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.Fil">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Fil</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fil"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fil" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Fill</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fill"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fill" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Filll</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Filll"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Filll" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">FontConstantsBase</code><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#FontConstantsBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.FontConstantsBase" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">delta</code><emclass="property"> = 0.025</em><aclass="headerlink" href="#matplotlib.mathtext.FontConstantsBase.delta" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">delta_integral</code><emclass="property"> = 0.1</em><aclass="headerlink" href="#matplotlib.mathtext.FontConstantsBase.delta_integral" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">delta_slanted</code><emclass="property"> = 0.2</em><aclass="headerlink" href="#matplotlib.mathtext.FontConstantsBase.delta_slanted" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">script_space</code><emclass="property"> = 0.05</em><aclass="headerlink" href="#matplotlib.mathtext.FontConstantsBase.script_space" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">sub1</code><emclass="property"> = 0.3</em><aclass="headerlink" href="#matplotlib.mathtext.FontConstantsBase.sub1" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">sub2</code><emclass="property"> = 0.5</em><aclass="headerlink" href="#matplotlib.mathtext.FontConstantsBase.sub2" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">subdrop</code><emclass="property"> = 0.4</em><aclass="headerlink" href="#matplotlib.mathtext.FontConstantsBase.subdrop" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">sup1</code><emclass="property"> = 0.7</em><aclass="headerlink" href="#matplotlib.mathtext.FontConstantsBase.sup1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.Fonts">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Fonts</code><spanclass="sig-paren">(</span><em>default_font_prop</em>, <em>mathtext_backend</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fonts" title="Permalink to this definition">¶</a></dt>
<p>An abstract base class for a system of fonts to use for mathtext.</p>
<p>The class must be able to take symbol keys and font file names and
return the character metrics. It also delegates to a backend class
to do the actual drawing.</p>
<p><em>default_font_prop</em>: A
<aclass="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FontProperties</span></code></a> object to use
for the default non-math font, or the base font for Unicode
(generic) font rendering.</p>
<p><em>mathtext_backend</em>: A subclass of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MathTextBackend</span></code>
used to delegate the actual rendering.</p>
<dlclass="method">
<dtid="matplotlib.mathtext.Fonts.destroy">
<codeclass="descname">destroy</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.destroy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fonts.destroy" title="Permalink to this definition">¶</a></dt>
<dd><p>Fix any cyclical references before the object is about
to be destroyed.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Fonts.get_kern">
<codeclass="descname">get_kern</code><spanclass="sig-paren">(</span><em>self</em>, <em>font1</em>, <em>fontclass1</em>, <em>sym1</em>, <em>fontsize1</em>, <em>font2</em>, <em>fontclass2</em>, <em>sym2</em>, <em>fontsize2</em>, <em>dpi</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_kern"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fonts.get_kern" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the kerning distance for font between <em>sym1</em> and <em>sym2</em>.</p>
<p><em>sym</em>: a symbol in raw TeX form. e.g., '1', 'x' or 'sigma'</p>
<p><em>fontsize</em>: font size in points</p>
<p><em>dpi</em>: current dots-per-inch</p>
<p><em>math</em>: whether sym is a math character</p>
<p>Returns an object with the following attributes:</p>
<blockquote>
<div><ulclass="simple">
<li><em>advance</em>: The advance distance (in points) of the glyph.</li>
<li><em>height</em>: The height of the glyph in points.</li>
<li><em>width</em>: The width of the glyph in points.</li>
<li><em>xmin</em>, <em>xmax</em>, <em>ymin</em>, <em>ymax</em> - the ink rectangle of the glyph</li>
<li><em>iceberg</em> - the distance from the baseline to the top of
the glyph. This corresponds to TeX's definition of
"height".</li>
</ul>
</div></blockquote>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Fonts.get_results">
<codeclass="descname">get_results</code><spanclass="sig-paren">(</span><em>self</em>, <em>box</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_results"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fonts.get_results" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the data needed by the backend to render the math
expression. The return value is backend-specific.</p>
<codeclass="descname">get_sized_alternatives_for_symbol</code><spanclass="sig-paren">(</span><em>self</em>, <em>fontname</em>, <em>sym</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_sized_alternatives_for_symbol"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fonts.get_sized_alternatives_for_symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>Override if your font provides multiple sizes of the same
symbol. Should return a list of symbols matching <em>sym</em> in
various sizes. The expression renderer will select the most
appropriate size for a given situation from this list.</p>
<codeclass="descname">get_used_characters</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_used_characters"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fonts.get_used_characters" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the set of characters that were used in the math
expression. Used by backends that need to subset fonts so
they know which glyphs to include.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Fonts.get_xheight">
<codeclass="descname">get_xheight</code><spanclass="sig-paren">(</span><em>self</em>, <em>font</em>, <em>fontsize</em>, <em>dpi</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.get_xheight"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fonts.get_xheight" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the xheight for the given <em>font</em> and <em>fontsize</em>.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Fonts.render_glyph">
<codeclass="descname">render_glyph</code><spanclass="sig-paren">(</span><em>self</em>, <em>ox</em>, <em>oy</em>, <em>facename</em>, <em>font_class</em>, <em>sym</em>, <em>fontsize</em>, <em>dpi</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.render_glyph"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fonts.render_glyph" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw a glyph at</p>
<blockquote>
<div><ulclass="simple">
<li><em>ox</em>, <em>oy</em>: position</li>
<li><em>facename</em>: One of the TeX face names</li>
<li><em>font_class</em>:</li>
<li><em>sym</em>: TeX symbol name or single character</li>
<codeclass="descname">set_canvas_size</code><spanclass="sig-paren">(</span><em>self</em>, <em>w</em>, <em>h</em>, <em>d</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Fonts.set_canvas_size"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Fonts.set_canvas_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the size of the buffer used to render the math expression.
Only really necessary for the bitmap backends.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.Glue">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Glue</code><spanclass="sig-paren">(</span><em>glue_type</em>, <em>copy=False</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Glue"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Glue" title="Permalink to this definition">¶</a></dt>
<p>Most of the information in this object is stored in the underlying
<aclass="reference internal" href="#matplotlib.mathtext.GlueSpec" title="matplotlib.mathtext.GlueSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">GlueSpec</span></code></a> class, which is shared between multiple glue objects.
(This is a memory optimization which probably doesn't matter anymore, but
it's easier to stick to what TeX does.)</p>
<dlclass="method">
<dtid="matplotlib.mathtext.Glue.grow">
<codeclass="descname">grow</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Glue.grow"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Glue.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Glue.shrink">
<codeclass="descname">shrink</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Glue.shrink"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Glue.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.GlueSpec">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">GlueSpec</code><spanclass="sig-paren">(</span><em>width=0.0</em>, <em>stretch=0.0</em>, <em>stretch_order=0</em>, <em>shrink=0.0</em>, <em>shrink_order=0</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>
<codeclass="descname">copy</code><spanclass="sig-paren">(</span><em>self</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="method">
<dtid="matplotlib.mathtext.GlueSpec.factory">
<emclass="property">classmethod </em><codeclass="descname">factory</code><spanclass="sig-paren">(</span><em>glue_type</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="class">
<dtid="matplotlib.mathtext.HCentered">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">HCentered</code><spanclass="sig-paren">(</span><em>elements</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#HCentered"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.HCentered" title="Permalink to this definition">¶</a></dt>
<p>A convenience class to create an <aclass="reference internal" href="#matplotlib.mathtext.Hlist" title="matplotlib.mathtext.Hlist"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Hlist</span></code></a> whose contents are
centered within its enclosing box.</p>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.Hbox">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Hbox</code><spanclass="sig-paren">(</span><em>width</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Hbox"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Hbox" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">hpack</code><spanclass="sig-paren">(</span><em>self</em>, <em>w=0.0</em>, <em>m='additional'</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Hlist.hpack"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Hlist.hpack" title="Permalink to this definition">¶</a></dt>
<dd><p>The main duty of <aclass="reference internal" href="#matplotlib.mathtext.Hlist.hpack" title="matplotlib.mathtext.Hlist.hpack"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">hpack()</span></code></a> is to compute the dimensions of
the resulting boxes, and to adjust the glue if one of those
dimensions is pre-specified. The computed sizes normally
enclose all of the material inside the new box; but some items
may stick out if negative glue is used, if the box is
overfull, or if a <codeclass="docutils literal notranslate"><spanclass="pre">\vbox</span></code> includes other boxes that have
been shifted left.</p>
<blockquote>
<div><ulclass="simple">
<li><em>w</em>: specifies a width</li>
<li><em>m</em>: is either 'exactly' or 'additional'.</li>
</ul>
</div></blockquote>
<p>Thus, <codeclass="docutils literal notranslate"><spanclass="pre">hpack(w,</span><spanclass="pre">'exactly')</span></code> produces a box whose width is
exactly <em>w</em>, while <codeclass="docutils literal notranslate"><spanclass="pre">hpack(w,</span><spanclass="pre">'additional')</span></code> yields a box
whose width is the natural width plus <em>w</em>. The default values
produce a box with the natural width.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Hlist.kern">
<codeclass="descname">kern</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Hlist.kern"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Hlist.kern" title="Permalink to this definition">¶</a></dt>
<dd><p>Insert <aclass="reference internal" href="#matplotlib.mathtext.Kern" title="matplotlib.mathtext.Kern"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Kern</span></code></a> nodes between <aclass="reference internal" href="#matplotlib.mathtext.Char" title="matplotlib.mathtext.Char"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Char</span></code></a> nodes to set
kerning. The <aclass="reference internal" href="#matplotlib.mathtext.Char" title="matplotlib.mathtext.Char"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Char</span></code></a> nodes themselves determine the
amount of kerning they need (in <aclass="reference internal" href="#matplotlib.mathtext.Char.get_kerning" title="matplotlib.mathtext.Char.get_kerning"><codeclass="xref py py-meth docutils literal notranslate"><spanclass="pre">get_kerning()</span></code></a>),
and this function just creates the linked list in the correct
way.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.Hrule">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Hrule</code><spanclass="sig-paren">(</span><em>state</em>, <em>thickness=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Hrule"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Hrule" title="Permalink to this definition">¶</a></dt>
<p>Convenience class to create a horizontal rule.</p>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.Kern">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">Kern</code><spanclass="sig-paren">(</span><em>width</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Kern"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Kern" title="Permalink to this definition">¶</a></dt>
<p>A <aclass="reference internal" href="#matplotlib.mathtext.Kern" title="matplotlib.mathtext.Kern"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Kern</span></code></a> node has a width field to specify a (normally
negative) amount of spacing. This spacing correction appears in
horizontal lists between letters like A and V when the font
designer said that it looks better to move them closer together or
further apart. A kern node can also appear in a vertical list,
when its <em>width</em> denotes additional spacing in the vertical
direction.</p>
<dlclass="attribute">
<dtid="matplotlib.mathtext.Kern.depth">
<codeclass="descname">depth</code><emclass="property"> = 0</em><aclass="headerlink" href="#matplotlib.mathtext.Kern.depth" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Kern.grow">
<codeclass="descname">grow</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Kern.grow"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Kern.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dlclass="attribute">
<dtid="matplotlib.mathtext.Kern.height">
<codeclass="descname">height</code><emclass="property"> = 0</em><aclass="headerlink" href="#matplotlib.mathtext.Kern.height" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.Kern.shrink">
<codeclass="descname">shrink</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#Kern.shrink"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.Kern.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.List">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">List</code><spanclass="sig-paren">(</span><em>elements</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#List"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.List" title="Permalink to this definition">¶</a></dt>
<p>A list of nodes (either horizontal or vertical).</p>
<dlclass="method">
<dtid="matplotlib.mathtext.List.grow">
<codeclass="descname">grow</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#List.grow"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.List.grow" title="Permalink to this definition">¶</a></dt>
<dd><p>Grows one level larger. There is no limit to how big
something can get.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.mathtext.List.shrink">
<codeclass="descname">shrink</code><spanclass="sig-paren">(</span><em>self</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/mathtext.html#List.shrink"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.mathtext.List.shrink" title="Permalink to this definition">¶</a></dt>
<dd><p>Shrinks one level smaller. There are only three levels of
sizes, after which things will no longer get smaller.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.mathtext.MathTextParser">
<emclass="property">class </em><codeclass="descclassname">matplotlib.mathtext.</code><codeclass="descname">MathTextParser</code><spanclass="sig-paren">(</span><em>output</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>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>
</dd></dl>
</dd></dl>
<dlclass="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. The
purpose of <aclass="reference internal" href="#matplotlib.mathtext.MathtextBackend" title="matplotlib.mathtext.MathtextBackend"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MathtextBackend</span></code></a> subclasses is to interface
between mathtext and a specific matplotlib graphics backend.</p>
<codeclass="descname">get_hinting_type</code><spanclass="sig-paren">(</span><em>self</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>self</em>, <em>box</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>self</em>, <em>w</em>, <em>h</em>, <em>d</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>Dimension the drawing canvas</p>
</dd></dl>
</dd></dl>
<dlclass="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>self</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>self</em>, <em>box</em>, <em>used_characters</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><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>self</em>, <em>box</em>, <em>used_characters</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