matplotlib.mathtext

Модуль для разбора подмножества синтаксиса TeX для математических выражений и его рендеринга для бэкенда Matplotlib.

Для ознакомления с руководством по его использованию см. Написание математических выражений. Данный документ в основном посвящен деталям реализации.

Модуль использует pyparsing для разбора выражения TeX.

Поддерживаются шрифты Computer Modern от Bakoma и STIX. Существует экспериментальная поддержка использования произвольных шрифтов, но результаты могут варьироваться без соответствующей настройки и метрик для этих шрифтов.

classmatplotlib.mathtext.MathTextParser(output)[source]

Bases: object

Создает MathTextParser для данного бэкенда output.

Parameters:

output{"path", "agg"}

Определяет, возвращать VectorParse ("path") или RasterParse ("agg", или его синоним "macosx").

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

Парсит заданное математическое выражение s при заданном dpi. Если prop указан, это объект FontProperties, задающий "стандартный" шрифт для использования в математическом выражении, применяемый для всего текста, не относящегося к математике.

Результаты кешируются, поэтому несколько вызовов parse с одинаковым выражением должны быть быстрыми.

В зависимости от типа output, возвращается либо VectorParse, либо RasterParse.

exceptionmatplotlib.mathtext.MathTextWarning(*args, **kwargs)[source]

Bases: Warning

[Устарело]

Примечания

Устарело начиная с версии 3.6:

classmatplotlib.mathtext.MathtextBackend[source]

Bases: object

[Устарело] Базовый класс для кода, специфичного для бэкенда mathtext. Подклассы MathtextBackend обеспечивают интерфейс между mathtext и конкретными графическими бэкендами Matplotlib.

Подклассы должны переопределить следующее:

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

И необязательно, если вам нужно использовать стиль указания начертания FreeType:

• get_hinting_type()

Примечания

Устарело начиная с версии 3.6.

get_hinting_type()[source]

Возвращает тип начертания FreeType для использования с данным бэкендом.

get_results(box)[source]

Возвращает специфичный для бэкенда кортеж, который должен быть возвращен бэкенду после завершения всех операций.

render_glyph(ox, oy, info)[source]

Отрисовывает глиф, описанный info, в точке отсчета (ox, oy).

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

Отрисовывает заполненный черный прямоугольник от (x1, y1) до (x2, y2).

set_canvas_size(w, h, d)[source]

Устанавливает размеры холста для отрисовки.

classmatplotlib.mathtext.MathtextBackendAgg[source]

Bases: MathtextBackend

[Устарело] Отображает глифы и прямоугольники в буфере FTImage, который затем передаётся в изображение Agg бэкэндом.

Примечания

Устарело начиная с версии 3.6.

get_hinting_type()[source]

Получить тип подсказки FreeType, используемый с данным бэкэндом.

get_results(box)[source]

Возвращает кортеж, специфичный для бэкэнда, который будет возвращён бэкэнду после завершения всех операций.

render_glyph(ox, oy, info)[source]

Отрисовать глиф, описанный в info, в точке отсчёта (ox, oy).

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

Отрисовать заполненный чёрный прямоугольник от (x1, y1) до (x2, y2).

set_canvas_size(w, h, d)[source]

Установить размеры холста для отрисовки.

classmatplotlib.mathtext.MathtextBackendPath[source]

Bases: MathtextBackend

[Устарело] Сохраняет информацию для записи отрисовки mathtext в механизм путей текста.

Примечания

Устарело начиная с версии 3.6.

get_results(box)[source]

Возвращает кортеж, специфичный для бэкэнда, который будет возвращён бэкэнду после завершения всех операций.

render_glyph(ox, oy, info)[source]

Отрисовать глиф, описанный в info, в точке отсчёта (ox, oy).

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

Отрисовать заполненный чёрный прямоугольник от (x1, y1) до (x2, y2).

classmatplotlib.mathtext.RasterParse(ox, oy, width, height, depth, image)[source]

Bases: tuple

Тип кортежа, возвращаемый MathTextParser("agg").parse(...).

Этот кортеж содержит глобальные метрики (width, height, depth) и растровое изображение image. Сдвиги ox, oy всегда равны нулю.

Создать новый экземпляр RasterParse(ox, oy, width, height, depth, image)

depth

Псевдоним для поля с номером 4

height

Псевдоним для поля с номером 3

image

Псевдоним для поля с номером 5

ox

Псевдоним для поля с номером 0

oy

Псевдоним для поля с номером 1

width

Псевдоним для поля с номером 2

classmatplotlib.mathtext.VectorParse(width, height, depth, glyphs, rects)[source]

Bases: tuple

Тип кортежа, возвращаемый MathTextParser("path").parse(...).

Этот кортеж содержит глобальные метрики (width, height, depth), список глифов (включая их позиции) и прямоугольников.

Создать новый экземпляр VectorParse(width, height, depth, glyphs, rects)

depth

Псевдоним для поля с номером 2

glyphs

Псевдоним для поля с номером 3

height

Псевдоним для поля с номером 1

rects

Псевдоним для поля с номером 4

width

Псевдоним для поля с номером 0

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

Возвращает целочисленный индекс (из таблицы Юникода) символа symbol.

Параметры:

symbolstr

Один символ (Юникод), команда TeX (например, r'pi') или имя символа Type1 (например, 'phi').

mathbool, по умолчанию: False

Если True (устаревший параметр), заменяет ASCII дефис на Unicode минус.

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

Преобразует математическое выражение в изображение в ограниченной области.

Параметры:

sstr

Математическое выражение. Математическая часть должна быть заключена в знаки доллара.

filename_or_objstr или path-like или file-like

Куда записать данные изображения.

propFontProperties, необязательно

Размер и стиль текста.

dpifloat, необязательно

Значение dpi вывода. Если не задано, dpi определяется как для Figure.savefig.

formatstr, необязательно

Формат вывода, например, 'svg', 'pdf', 'ps' или 'png'. Если не задано, формат определяется как для Figure.savefig.

colorstr, необязательно

Цвет переднего плана, по умолчанию rcParams["text.color"] (значение по умолчанию: 'black').