matplotlib.mathtext

A module for parsing a subset of the TeX math syntax and rendering it to a Matplotlib backend.

For a tutorial of its usage, see Writing mathematical expressions. This document is primarily concerned with implementation details.

The module uses pyparsing to parse the TeX expression.

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.

class matplotlib.mathtext.Accent(c, state, math=True)

Bases: matplotlib.mathtext.Char

The font metrics need to be dealt with differently for accents, since they are already offset correctly from the baseline in TrueType fonts.

grow(self)

Grows one level larger. There is no limit to how big something can get.

render(self, x, y)

Render the character to the canvas.

shrink(self)

Shrinks one level smaller. There are only three levels of sizes, after which things will no longer get smaller.

class matplotlib.mathtext.AutoHeightChar(c, height, depth, state, always=False, factor=None)

Bases: matplotlib.mathtext.Hlist

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.

class matplotlib.mathtext.AutoWidthChar(c, width, state, always=False, char_class=<class 'matplotlib.mathtext.Char'>)

Bases: matplotlib.mathtext.Hlist

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.

class matplotlib.mathtext.BakomaFonts(*args, **kwargs)

Bases: matplotlib.mathtext.TruetypeFonts

Use the Bakoma TrueType fonts for rendering.

Symbols are strewn about a number of font files, each of which has its own proprietary 8-bit encoding.

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

alias = '\\]'

get_sized_alternatives_for_symbol(self, fontname, sym)

Override if your font provides multiple sizes of the same symbol. Should return a list of symbols matching sym in various sizes. The expression renderer will select the most appropriate size for a given situation from this list.

target = ']'

class matplotlib.mathtext.Box(width, height, depth)

Bases: matplotlib.mathtext.Node

A node with a physical location.

grow(self)

Grows one level larger. There is no limit to how big something can get.

render(self, x1, y1, x2, y2)

shrink(self)

Shrinks one level smaller. There are only three levels of sizes, after which things will no longer get smaller.

class matplotlib.mathtext.Char(c, state, math=True)

Bases: matplotlib.mathtext.Node

A single character.

Unlike TeX, the font information and metrics are stored with each Char 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 model, and the advance (if different from width) must be converted into a Kern node when the Char is added to its parent Hlist.

get_kerning(self, next)

Return the amount of kerning between this and the given character.

This method is called when characters are strung together into Hlist to create Kern nodes.

grow(self)

Grows one level larger. There is no limit to how big something can get.

is_slanted(self)

render(self, x, y)

Render the character to the canvas

shrink(self)

Shrinks one level smaller. There are only three levels of sizes, after which things will no longer get smaller.

class matplotlib.mathtext.ComputerModernFontConstants

Bases: matplotlib.mathtext.FontConstantsBase

delta = 0.075

delta_integral = 0.3

delta_slanted = 0.3

script_space = 0.075

sub1 = 0.2

sub2 = 0.3

subdrop = 0.2

sup1 = 0.45

class matplotlib.mathtext.DejaVuFonts(*args, **kwargs)

Bases: matplotlib.mathtext.UnicodeFonts

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

use_cmex = False

class matplotlib.mathtext.DejaVuSansFontConstants

Bases: matplotlib.mathtext.FontConstantsBase

class matplotlib.mathtext.DejaVuSansFonts(*args, **kwargs)

Bases: matplotlib.mathtext.DejaVuFonts

A font handling class for the DejaVu Sans fonts

If a glyph is not found it will fallback to Stix Sans

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

class matplotlib.mathtext.DejaVuSerifFontConstants

Bases: matplotlib.mathtext.FontConstantsBase

class matplotlib.mathtext.DejaVuSerifFonts(*args, **kwargs)

Bases: matplotlib.mathtext.DejaVuFonts

A font handling class for the DejaVu Serif fonts

If a glyph is not found it will fallback to Stix Serif

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

matplotlib.mathtext.Error(msg)

Helper class to raise parser errors.

class matplotlib.mathtext.Fil(**kwargs)

Bases: matplotlib.mathtext.Glue

[Deprecated]

Notes

Deprecated since version 3.3:

class matplotlib.mathtext.Fill(**kwargs)

Bases: matplotlib.mathtext.Glue

[Deprecated]

Notes

Deprecated since version 3.3:

class matplotlib.mathtext.Filll(**kwargs)

Bases: matplotlib.mathtext.Glue

[Deprecated]

Notes

Deprecated since version 3.3:

class matplotlib.mathtext.FontConstantsBase

Bases: object

A set of constants that controls how certain things, such as sub- and superscripts are laid out. These are all metrics that can't be reliably retrieved from the font metrics in the font itself.

delta = 0.025

delta_integral = 0.1

delta_slanted = 0.2

script_space = 0.05

sub1 = 0.3

sub2 = 0.5

subdrop = 0.4

sup1 = 0.7

class matplotlib.mathtext.Fonts(default_font_prop, mathtext_backend)

Bases: object

An abstract base class for a system of fonts to use for mathtext.

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.

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

destroy(self)

Fix any cyclical references before the object is about to be destroyed.

get_kern(self, font1, fontclass1, sym1, fontsize1, font2, fontclass2, sym2, fontsize2, dpi)

Get the kerning distance for font between sym1 and sym2.

fontX: one of the TeX font names:

tt, it, rm, cal, sf, bf or default/regular (non-math)

fontclassX: TODO

symX: a symbol in raw TeX form. e.g., '1', 'x' or 'sigma'

fontsizeX: the fontsize in points

dpi: the current dots-per-inch

get_metrics(self, font, font_class, sym, fontsize, dpi, math=True)

font: one of the TeX font names:

tt, it, rm, cal, sf, bf or default/regular (non-math)

font_class: TODO

sym: a symbol in raw TeX form. e.g., '1', 'x' or 'sigma'

fontsize: font size in points

dpi: current dots-per-inch

math: whether sym is a math character

Returns an object with the following attributes:

• advance: The advance distance (in points) of the glyph.
• height: The height of the glyph in points.
• width: The width of the glyph in points.
• xmin, xmax, ymin, ymax - the ink rectangle of the glyph
• iceberg - the distance from the baseline to the top of the glyph. This corresponds to TeX's definition of "height".

get_results(self, box)

Get the data needed by the backend to render the math expression. The return value is backend-specific.

get_sized_alternatives_for_symbol(self, fontname, sym)

Override if your font provides multiple sizes of the same symbol. Should return a list of symbols matching sym in various sizes. The expression renderer will select the most appropriate size for a given situation from this list.

get_underline_thickness(self, font, fontsize, dpi)

Get the line thickness that matches the given font. Used as a base unit for drawing lines such as in a fraction or radical.

get_used_characters(self)

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.

get_xheight(self, font, fontsize, dpi)

Get the xheight for the given font and fontsize.

render_glyph(self, ox, oy, facename, font_class, sym, fontsize, dpi)

Draw a glyph at

• ox, oy: position
• facename: One of the TeX face names
• font_class:
• sym: TeX symbol name or single character
• fontsize: fontsize in points
• dpi: The dpi to draw at.

render_rect_filled(self, x1, y1, x2, y2)

Draw a filled rectangle from (x1, y1) to (x2, y2).

set_canvas_size(self, w, h, d)

Set the size of the buffer used to render the math expression. Only really necessary for the bitmap backends.

class matplotlib.mathtext.Glue(glue_type, copy=<deprecated parameter>)

Bases: matplotlib.mathtext.Node

Most of the information in this object is stored in the underlying _GlueSpec 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.)

property glue_subtype

grow(self)

Grows one level larger. There is no limit to how big something can get.

shrink(self)

Shrinks one level smaller. There are only three levels of sizes, after which things will no longer get smaller.

class matplotlib.mathtext.GlueSpec(**kwargs)

Bases: object

[Deprecated] See Glue.

Notes

Deprecated since version 3.3.

copy(self)

classmethod factory(glue_type)

class matplotlib.mathtext.HCentered(elements)

Bases: matplotlib.mathtext.Hlist

A convenience class to create an Hlist whose contents are centered within its enclosing box.

class matplotlib.mathtext.Hbox(width)

Bases: matplotlib.mathtext.Box

A box with only width (zero height and depth).

class matplotlib.mathtext.Hlist(elements, w=0.0, m='additional', do_kern=True)

Bases: matplotlib.mathtext.List

A horizontal list of boxes.

hpack(self, w=0.0, m='additional')

Compute the dimensions of the resulting boxes, and 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 \vbox includes other boxes that have been shifted left.

Parameters:

wfloat, default: 0

A width.

m{'exactly', 'additional'}, default: 'additional'

Whether to produce a box whose width is 'exactly' w; or a box with the natural width of the contents, plus w ('additional').

Notes

The defaults produce a box with the natural width of the contents.

kern(self)

Insert Kern nodes between Char nodes to set kerning.

The Char nodes themselves determine the amount of kerning they need (in get_kerning), and this function just creates the correct linked list.

class matplotlib.mathtext.Hrule(state, thickness=None)

Bases: matplotlib.mathtext.Rule

Convenience class to create a horizontal rule.

class matplotlib.mathtext.Kern(width)

Bases: matplotlib.mathtext.Node

A Kern 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 width denotes additional spacing in the vertical direction.

depth = 0

grow(self)

Grows one level larger. There is no limit to how big something can get.

height = 0

shrink(self)

Shrinks one level smaller. There are only three levels of sizes, after which things will no longer get smaller.

class matplotlib.mathtext.List(elements)

Bases: matplotlib.mathtext.Box

A list of nodes (either horizontal or vertical).

grow(self)

Grows one level larger. There is no limit to how big something can get.

shrink(self)

Shrinks one level smaller. There are only three levels of sizes, after which things will no longer get smaller.

class matplotlib.mathtext.MathTextParser(output)

Bases: object

Create a MathTextParser for the given backend output.

get_depth(self, texstr, dpi=120, fontsize=14)

Parameters:

texstrstr

A valid mathtext string, e.g., r'IQ: $sigma_i=15$'.

dpifloat

The dots-per-inch setting used to render the text.

Returns:

int

Offset of the baseline from the bottom of the image, in pixels.

parse(self, s, dpi=72, prop=None)

Parse the given math expression s at the given dpi. If prop is provided, it is a FontProperties object specifying the "default" font to use in the math expression, used for all non-math text.

The results are cached, so multiple calls to parse with the same expression should be fast.

to_mask(self, texstr, dpi=120, fontsize=14)

Parameters:

texstrstr

A valid mathtext string, e.g., r'IQ: $sigma_i=15$'.

dpifloat

The dots-per-inch setting used to render the text.

fontsizeint

The font size in points

Returns:

array2D uint8 alpha

Mask array of rasterized tex.

depthint

Offset of the baseline from the bottom of the image, in pixels.

to_png(self, filename, texstr, color='black', dpi=120, fontsize=14)

Render a tex expression to a PNG file.

Parameters:

filename

A writable filename or fileobject.

texstrstr

A valid mathtext string, e.g., r'IQ: $sigma_i=15$'.

colorcolor

The text color.

dpifloat

The dots-per-inch setting used to render the text.

fontsizeint

The font size in points.

Returns:

int

Offset of the baseline from the bottom of the image, in pixels.

to_rgba(self, texstr, color='black', dpi=120, fontsize=14)

Parameters:

texstrstr

A valid mathtext string, e.g., r'IQ: $sigma_i=15$'.

colorcolor

The text color.

dpifloat

The dots-per-inch setting used to render the text.

fontsizeint

The font size in points.

Returns:

array(M, N, 4) array

RGBA color values of rasterized tex, colorized with color.

depthint

Offset of the baseline from the bottom of the image, in pixels.

exception matplotlib.mathtext.MathTextWarning

Bases: Warning

class matplotlib.mathtext.MathtextBackend

Bases: object

The base class for the mathtext backend-specific code. MathtextBackend subclasses interface between mathtext and specific Matplotlib graphics backends.

Subclasses need to override the following:

• render_glyph()
• render_rect_filled()
• get_results()

And optionally, if you need to use a FreeType hinting style:

• get_hinting_type()

get_hinting_type(self)

Get the FreeType hinting type to use with this particular backend.

get_results(self, box)

Return a backend-specific tuple to return to the backend after all processing is done.

render_glyph(self, ox, oy, info)

Draw a glyph described by info to the reference point (ox, oy).

render_rect_filled(self, x1, y1, x2, y2)

Draw a filled black rectangle from (x1, y1) to (x2, y2).

set_canvas_size(self, w, h, d)

Set the dimension of the drawing canvas.

class matplotlib.mathtext.MathtextBackendAgg

Bases: matplotlib.mathtext.MathtextBackend

Render glyphs and rectangles to an FTImage buffer, which is later transferred to the Agg image by the Agg backend.

get_hinting_type(self)

Get the FreeType hinting type to use with this particular backend.

get_results(self, box, used_characters)

Return a backend-specific tuple to return to the backend after all processing is done.

render_glyph(self, ox, oy, info)

Draw a glyph described by info to the reference point (ox, oy).

render_rect_filled(self, x1, y1, x2, y2)

Draw a filled black rectangle from (x1, y1) to (x2, y2).

set_canvas_size(self, w, h, d)

Set the dimension of the drawing canvas.

class matplotlib.mathtext.MathtextBackendBitmap

Bases: matplotlib.mathtext.MathtextBackendAgg

get_results(self, box, used_characters)

Return a backend-specific tuple to return to the backend after all processing is done.

class matplotlib.mathtext.MathtextBackendCairo

Bases: matplotlib.mathtext.MathtextBackend

Store information to write a mathtext rendering to the Cairo backend.

get_results(self, box, used_characters)

Return a backend-specific tuple to return to the backend after all processing is done.

render_glyph(self, ox, oy, info)

Draw a glyph described by info to the reference point (ox, oy).

render_rect_filled(self, x1, y1, x2, y2)

Draw a filled black rectangle from (x1, y1) to (x2, y2).

class matplotlib.mathtext.MathtextBackendPath

Bases: matplotlib.mathtext.MathtextBackend

Store information to write a mathtext rendering to the text path machinery.

get_results(self, box, used_characters)

Return a backend-specific tuple to return to the backend after all processing is done.

render_glyph(self, ox, oy, info)

Draw a glyph described by info to the reference point (ox, oy).

render_rect_filled(self, x1, y1, x2, y2)

Draw a filled black rectangle from (x1, y1) to (x2, y2).

class matplotlib.mathtext.MathtextBackendPdf

Bases: matplotlib.mathtext.MathtextBackend

Store information to write a mathtext rendering to the PDF backend.

get_results(self, box, used_characters)

Return a backend-specific tuple to return to the backend after all processing is done.

render_glyph(self, ox, oy, info)

Draw a glyph described by info to the reference point (ox, oy).

render_rect_filled(self, x1, y1, x2, y2)

Draw a filled black rectangle from (x1, y1) to (x2, y2).

class matplotlib.mathtext.MathtextBackendPs

Bases: matplotlib.mathtext.MathtextBackend

Store information to write a mathtext rendering to the PostScript backend.

get_results(self, box, used_characters)

Return a backend-specific tuple to return to the backend after all processing is done.

render_glyph(self, ox, oy, info)

Draw a glyph described by info to the reference point (ox, oy).

render_rect_filled(self, x1, y1, x2, y2)

Draw a filled black rectangle from (x1, y1) to (x2, y2).

class matplotlib.mathtext.MathtextBackendSvg

Bases: matplotlib.mathtext.MathtextBackend

Store information to write a mathtext rendering to the SVG backend.

get_results(self, box, used_characters)

Return a backend-specific tuple to return to the backend after all processing is done.

render_glyph(self, ox, oy, info)

Draw a glyph described by info to the reference point (ox, oy).

render_rect_filled(self, x1, y1, x2, y2)

Draw a filled black rectangle from (x1, y1) to (x2, y2).

class matplotlib.mathtext.NegFil(**kwargs)

Bases: matplotlib.mathtext.Glue

[Deprecated]

Notes

Deprecated since version 3.3:

class matplotlib.mathtext.NegFill(**kwargs)

Bases: matplotlib.mathtext.Glue

[Deprecated]

Notes

Deprecated since version 3.3:

class matplotlib.mathtext.NegFilll(**kwargs)

Bases: matplotlib.mathtext.Glue

[Deprecated]

Notes

Deprecated since version 3.3:

class matplotlib.mathtext.Node

Bases: object

A node in the TeX box model.

get_kerning(self, next)

grow(self)

Grows one level larger. There is no limit to how big something can get.

render(self, x, y)

shrink(self)

Shrinks one level smaller. There are only three levels of sizes, after which things will no longer get smaller.

class matplotlib.mathtext.Parser

Bases: object

A pyparsing-based parser for strings containing math expressions.

Raw text may also appear outside of pairs of $.

The grammar is based directly on that in TeX, though it cuts a few corners.

class State(font_output, font, font_class, fontsize, dpi)

Bases: object

Stores the state of the parser.

States are pushed and popped from a stack as necessary, and the "current" state is always at the top of the stack.

copy(self)

property font

accent(self, s, loc, toks)

accentprefixed(self, s, loc, toks)

auto_delim(self, s, loc, toks)

binom(self, s, loc, toks)

c_over_c(self, s, loc, toks)

customspace(self, s, loc, toks)

dfrac(self, s, loc, toks)

end_group(self, s, loc, toks)

font(self, s, loc, toks)

frac(self, s, loc, toks)

function(self, s, loc, toks)

genfrac(self, s, loc, toks)

get_state(self)

Get the current State of the parser.

group(self, s, loc, toks)

is_between_brackets(self, s, loc)

is_dropsub(self, nucleus)

is_overunder(self, nucleus)

is_slanted(self, nucleus)

main(self, s, loc, toks)

math(self, s, loc, toks)

math_string(self, s, loc, toks)

non_math(self, s, loc, toks)

operatorname(self, s, loc, toks)

overline(self, s, loc, toks)

parse(self, s, fonts_object, fontsize, dpi)

Parse expression s using the given fonts_object for output, at the given fontsize and dpi.

Returns the parse tree of Node instances.

pop_state(self)

Pop a State off of the stack.

push_state(self)

Push a new State onto the stack, copying the current state.

required_group(self, s, loc, toks)

simple_group(self, s, loc, toks)

space(self, s, loc, toks)

sqrt(self, s, loc, toks)

start_group(self, s, loc, toks)

subsuper(self, s, loc, toks)

symbol(self, s, loc, toks)

unknown_symbol(self, s, loc, toks)

class matplotlib.mathtext.Rule(width, height, depth, state)

Bases: matplotlib.mathtext.Box

A solid black rectangle.

It has width, depth, and height fields just as in an Hlist. However, if any of these dimensions is inf, the actual value will be determined by running the rule up to the boundary of the innermost enclosing box. This is called a "running dimension". The width is never running in an Hlist; the height and depth are never running in a Vlist.

render(self, x, y, w, h)

class matplotlib.mathtext.STIXFontConstants

Bases: matplotlib.mathtext.FontConstantsBase

delta = 0.05

delta_integral = 0.3

delta_slanted = 0.3

script_space = 0.1

sub2 = 0.6

sup1 = 0.8

class matplotlib.mathtext.STIXSansFontConstants

Bases: matplotlib.mathtext.FontConstantsBase

delta_integral = 0.3

delta_slanted = 0.6

script_space = 0.05

sup1 = 0.8

class matplotlib.mathtext.Ship

Bases: object

Ship boxes to output once they have been set up, this sends them to output.

Since boxes can be inside of boxes inside of boxes, the main work of Ship is done by two mutually recursive routines, hlist_out and vlist_out, which traverse the Hlist nodes and Vlist nodes inside of horizontal and vertical boxes. The global variables used in TeX to store state as it processes have become member variables here.

static clamp(value)

hlist_out(self, box)

vlist_out(self, box)

class matplotlib.mathtext.SsGlue(**kwargs)

Bases: matplotlib.mathtext.Glue

[Deprecated]

Notes

Deprecated since version 3.3:

class matplotlib.mathtext.StandardPsFonts(default_font_prop)

Bases: matplotlib.mathtext.Fonts

Use the standard postscript fonts for rendering to backend_ps

Unlike the other font classes, BakomaFont and UnicodeFont, this one requires the Ps backend.

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

basepath = '/usr/local/lib64/python3.8/site-packages/matplotlib/mpl-data/fonts/afm'

fontmap = {'cal': 'pzcmi8a', 'rm': 'pncr8a', 'tt': 'pcrr8a', 'it': 'pncri8a', 'sf': 'phvr8a', 'bf': 'pncb8a', None: 'psyr'}

get_kern(self, font1, fontclass1, sym1, fontsize1, font2, fontclass2, sym2, fontsize2, dpi)

Get the kerning distance for font between sym1 and sym2.

fontX: one of the TeX font names:

tt, it, rm, cal, sf, bf or default/regular (non-math)

fontclassX: TODO

symX: a symbol in raw TeX form. e.g., '1', 'x' or 'sigma'

fontsizeX: the fontsize in points

dpi: the current dots-per-inch

get_underline_thickness(self, font, fontsize, dpi)

Get the line thickness that matches the given font. Used as a base unit for drawing lines such as in a fraction or radical.

get_xheight(self, font, fontsize, dpi)

Get the xheight for the given font and fontsize.

class matplotlib.mathtext.StixFonts(*args, **kwargs)

Bases: matplotlib.mathtext.UnicodeFonts

A font handling class for the STIX fonts.

In addition to what UnicodeFonts provides, this class:

• supports "virtual fonts" which are complete alpha numeric character sets with different font styles at special Unicode code points, such as "Blackboard".
• handles sized alternative characters for the STIXSizeX fonts.

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

cm_fallback = False

get_sized_alternatives_for_symbol(self, fontname, sym)

Override if your font provides multiple sizes of the same symbol. Should return a list of symbols matching sym in various sizes. The expression renderer will select the most appropriate size for a given situation from this list.

use_cmex = False

class matplotlib.mathtext.StixSansFonts(*args, **kwargs)

Bases: matplotlib.mathtext.StixFonts

A font handling class for the STIX fonts (that uses sans-serif characters by default).

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

class matplotlib.mathtext.SubSuperCluster

Bases: matplotlib.mathtext.Hlist

A hack to get around that fact that this code does a two-pass parse like TeX. This lets us store enough information in the hlist itself, namely the nucleus, sub- and super-script, such that if another script follows that needs to be attached, it can be reconfigured on the fly.

class matplotlib.mathtext.TruetypeFonts(default_font_prop, mathtext_backend)

Bases: matplotlib.mathtext.Fonts

A generic base class for all font setups that use Truetype fonts (through FT2Font).

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

destroy(self)

Fix any cyclical references before the object is about to be destroyed.

get_kern(self, font1, fontclass1, sym1, fontsize1, font2, fontclass2, sym2, fontsize2, dpi)

Get the kerning distance for font between sym1 and sym2.

fontX: one of the TeX font names:

tt, it, rm, cal, sf, bf or default/regular (non-math)

fontclassX: TODO

symX: a symbol in raw TeX form. e.g., '1', 'x' or 'sigma'

fontsizeX: the fontsize in points

dpi: the current dots-per-inch

get_underline_thickness(self, font, fontsize, dpi)

Get the line thickness that matches the given font. Used as a base unit for drawing lines such as in a fraction or radical.

get_xheight(self, fontname, fontsize, dpi)

Get the xheight for the given font and fontsize.

class matplotlib.mathtext.UnicodeFonts(*args, **kwargs)

Bases: matplotlib.mathtext.TruetypeFonts

An abstract base class for handling Unicode fonts.

While some reasonably complete Unicode fonts (such as DejaVu) may work in some situations, the only Unicode font I'm aware of with a complete set of math symbols is STIX.

This class will "fallback" on the Bakoma fonts when a required symbol can not be found in the font.

Parameters:

default_font_prop: `~.font_manager.FontProperties`

The default non-math font, or the base font for Unicode (generic) font rendering.

mathtext_backend: `MathtextBackend` subclass

Backend to which rendering is actually delegated.

get_sized_alternatives_for_symbol(self, fontname, sym)

Override if your font provides multiple sizes of the same symbol. Should return a list of symbols matching sym in various sizes. The expression renderer will select the most appropriate size for a given situation from this list.

use_cmex = True

class matplotlib.mathtext.VCentered(elements)

Bases: matplotlib.mathtext.Vlist

A convenience class to create a Vlist whose contents are centered within its enclosing box.

class matplotlib.mathtext.Vbox(height, depth)

Bases: matplotlib.mathtext.Box

A box with only height (zero width).

class matplotlib.mathtext.Vlist(elements, h=0.0, m='additional')

Bases: matplotlib.mathtext.List

A vertical list of boxes.

vpack(self, h=0.0, m='additional', l=inf)

Compute the dimensions of the resulting boxes, and to adjust the glue if one of those dimensions is pre-specified.

Parameters:

hfloat, default: 0

A height.

m{'exactly', 'additional'}, default: 'additional'

Whether to produce a box whose height is 'exactly' w; or a box with the natural height of the contents, plus w ('additional').

lfloat, default: np.inf

The maximum height.

Notes

The defaults produce a box with the natural height of the contents.

class matplotlib.mathtext.Vrule(state)

Bases: matplotlib.mathtext.Rule

Convenience class to create a vertical rule.

matplotlib.mathtext.get_unicode_index(symbol, math=True)

Return the integer index (from the Unicode table) of symbol.

Parameters:

symbolstr

A single unicode character, a TeX command (e.g. r'pi') or a Type1 symbol name (e.g. 'phi').

mathbool, default: True

If False, always treat as a single unicode character.

matplotlib.mathtext.math_to_image(s, filename_or_obj, prop=None, dpi=None, format=None)

Given a math expression, renders it in a closely-clipped bounding box to an image file.

Parameters:

sstr

A math expression. The math portion must be enclosed in dollar signs.

filename_or_objstr or path-like or file-like

Where to write the image data.

propFontProperties, optional

The size and style of the text.

dpifloat, optional

The output dpi. If not set, the dpi is determined as for Figure.savefig.

formatstr, optional

The output format, e.g., 'svg', 'pdf', 'ps' or 'png'. If not set, the format is determined as for Figure.savefig.