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.MathTextParser(output)[source]#

Bases: object

Create a MathTextParser for the given backend output.

Parameters:
output{"path", "agg"}

Whether to return a VectorParse ("path") or a RasterParse ("agg", or its synonym "macosx").

parse(s, dpi=72, prop=None)[source]#

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.

Depending on the output type, this returns either a VectorParse or a RasterParse.

exception matplotlib.mathtext.MathTextWarning(*args, **kwargs)[source]#

Bases: Warning

[Deprecated]

Notes

Deprecated since version 3.6:

class matplotlib.mathtext.MathtextBackend[source]#

Bases: object

[Deprecated] 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:

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

Notes

Deprecated since version 3.6.

get_hinting_type()[source]#

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

get_results(box)[source]#

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

render_glyph(ox, oy, info)[source]#

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

render_rect_filled(x1, y1, x2, y2)[source]#

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

set_canvas_size(w, h, d)[source]#

Set the dimension of the drawing canvas.

class matplotlib.mathtext.MathtextBackendAgg[source]#

Bases: MathtextBackend

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

Notes

Deprecated since version 3.6.

get_hinting_type()[source]#

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

get_results(box)[source]#

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

render_glyph(ox, oy, info)[source]#

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

render_rect_filled(x1, y1, x2, y2)[source]#

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

set_canvas_size(w, h, d)[source]#

Set the dimension of the drawing canvas.

class matplotlib.mathtext.MathtextBackendPath[source]#

Bases: MathtextBackend

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

Notes

Deprecated since version 3.6.

get_results(box)[source]#

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

render_glyph(ox, oy, info)[source]#

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

render_rect_filled(x1, y1, x2, y2)[source]#

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

class matplotlib.mathtext.RasterParse(ox, oy, width, height, depth, image)[source]#

Bases: tuple

The namedtuple type returned by MathTextParser("agg").parse(...).

This tuple contains the global metrics (width, height, depth), and a raster image. The offsets ox, oy are always zero.

Create new instance of RasterParse(ox, oy, width, height, depth, image)

depth#

Alias for field number 4

height#

Alias for field number 3

image#

Alias for field number 5

ox#

Alias for field number 0

oy#

Alias for field number 1

width#

Alias for field number 2

class matplotlib.mathtext.VectorParse(width, height, depth, glyphs, rects)[source]#

Bases: tuple

The namedtuple type returned by MathTextParser("path").parse(...).

This tuple contains the global metrics (width, height, depth), a list of glyphs (including their positions) and of rectangles.

Create new instance of VectorParse(width, height, depth, glyphs, rects)

depth#

Alias for field number 2

glyphs#

Alias for field number 3

height#

Alias for field number 1

rects#

Alias for field number 4

width#

Alias for field number 0

matplotlib.mathtext.get_unicode_index(symbol, math=<deprecated parameter>)[source]#

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: False

If True (deprecated), replace ASCII hyphen-minus by Unicode minus.

matplotlib.mathtext.math_to_image(s, filename_or_obj, prop=None, dpi=None, format=None, *, color=None)[source]#

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.

colorstr, optional

Foreground color, defaults to rcParams["text.color"] (default: 'black').