matplotlib.mathtext

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

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

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

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

классmatplotlib.mathtext.MathTextParser(output)[исходный код]

Базовые классы: object

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

Параметры:

output{"path", "agg"}

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

parse(s, dpi=72, prop=None)[исходный код]

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

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

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

исключениеmatplotlib.mathtext.MathTextWarning(*args, **kwargs)[исходный код]

Базовые классы: Warning

[Устаревшее]

Примечания

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

классmatplotlib.mathtext.MathtextBackend[исходный код]

Базовые классы: object

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

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

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

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

• get_hinting_type()

Примечания

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

get_hinting_type()[исходный код]

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

get_results(box)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

set_canvas_size(w, h, d)[исходный код]

Установить размер холста отображения.

классmatplotlib.mathtext.MathtextBackendAgg[исходный код]

Базовые классы: MathtextBackend

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

Примечания

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

get_hinting_type()[исходный код]

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

get_results(box)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

set_canvas_size(w, h, d)[исходный код]

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

классmatplotlib.mathtext.MathtextBackendPath[исходный код]

Базовые классы: MathtextBackend

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

Примечания

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

get_results(box)[исходный код]

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

render_glyph(ox, oy, info)[исходный код]

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

render_rect_filled(x1, y1, x2, y2)[исходный код]

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

классmatplotlib.mathtext.RasterParse(ox, oy, width, height, depth, image)[исходный код]

Базовые классы: 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

классmatplotlib.mathtext.VectorParse(width, height, depth, glyphs, rects)[исходный код]

Базовые классы: 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=<параметр устарел>)[исходный код]

Возвращает целочисленный индекс (из таблицы Юникод) символа 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)[исходный код]

Отображает математическое выражение в обрезающейся рамке на изображении.

Параметры:

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').