matplotlib.text

Классы для включения текста в график.

class matplotlib.text.Annotation(text, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)[source]

Bases: matplotlib.text.Text, matplotlib.text._AnnotationBase

Аннотация — это Text, которая может ссылаться на определённую позицию xy. Дополнительно может быть нарисована стрелка, указывающая от текста к xy.

Атрибуты:	xy Позиция, к которой делается аннотация. xycoords Система координат для xy. arrow_patch FancyArrowPatch для рисования стрелки от xytext к xy.

Аннотирует точку xy текстом text.

В самом простом виде, текст размещается в позиции xy.

Дополнительно, текст может быть размещён в другой позиции xytext. Стрелка, указывающая от текста к аннотируемой точке xy, может быть добавлена, задав параметр arrowprops.

Параметры:

textstr Текст аннотации. xy(float, float) Точка (x, y), подлежащая аннотации. Система координат определяется параметром xycoords. xytext(float, float), по умолчанию: xy Позиция (x, y) для размещения текста. Система координат определяется параметром textcoords. xycoordsстрока или Artist или Transform или вызываемая функция или (float, float), по умолчанию: 'data' Система координат, в которой задано значение xy. Поддерживаются следующие типы значений: Одна из следующих строк: Значение Описание 'figure points' Точки от левого нижнего угла фигуры 'figure pixels' Пиксели от левого нижнего угла фигуры 'figure fraction' Доля фигуры от левого нижнего угла 'subfigure points' Точки от левого нижнего угла подфигуры 'subfigure pixels' Пиксели от левого нижнего угла подфигуры 'subfigure fraction' Доля подфигуры от левого нижнего угла 'axes points' Точки от левого нижнего угла области построения 'axes pixels' Пиксели от левого нижнего угла области построения 'axes fraction' Доля области построения от левого нижнего угла 'data' Использовать систему координат объекта, к которому применяется аннотация (по умолчанию) 'polar' (theta, r), если координаты не являются координатами «data» Обратите внимание, что 'subfigure pixels' и 'figure pixels' идентичны для родительской фигуры, поэтому пользователи, желающие использовать код в подфигуре, могут использовать 'subfigure pixels'. Объект Artist: xy интерпретируется как доля Bbox объекта. Например, (0, 0) — это нижний левый угол, а (0.5, 1) — центр верхней части ограничивающего прямоугольника. Преобразование Transform для преобразования xy в экранные координаты. Функция с одной из следующих сигнатур: def transform(renderer) -> Bbox def transform(renderer) -> Transform где renderer — подкласс RendererBase. Результат функции интерпретируется как в случаях Artist и Transform выше. Кортеж (xcoords, ycoords), задающий отдельные системы координат для x и y. xcoords и ycoords должны быть одного из описанных выше типов. Для получения дополнительной информации см. Дополнительные аннотации. textcoordsстрока или Artist или Transform или вызываемая функция или (float, float), по умолчанию: значение xycoords Система координат, в которой задано значение xytext. Все значения xycoords также допустимы, а также следующие строки: Значение Описание 'offset points' Смещение (в пунктах) от значения xy 'offset pixels' Смещение (в пикселях) от значения xy arrowpropsdict, необязательно Свойства, используемые для рисования стрелки FancyArrowPatch между позициями xy и xytext. Обратите внимание, что край стрелки, указывающей на xytext, будет центрирован на самом тексте и может не указывать непосредственно на координаты, заданные в xytext. Если arrowprops не содержит ключ 'arrowstyle', допустимые ключи: Ключ Описание width Ширина стрелки в пунктах headwidth Ширина основания стрелки в пунктах headlength Длина стрелки в пунктах shrink Доля общей длины, уменьшаемая с обеих сторон ? Любой ключ для matplotlib.patches.FancyArrowPatch Если arrowprops содержит ключ 'arrowstyle', вышеперечисленные ключи запрещены. Допустимые значения 'arrowstyle': Имя Атрибуты '-' None '->' head_length=0.4,head_width=0.2 '-[' widthB=1.0,lengthB=0.2,angleB=None '|-|' widthA=1.0,widthB=1.0 '-|>' head_length=0.4,head_width=0.2 '<-' head_length=0.4,head_width=0.2 '<->' head_length=0.4,head_width=0.2 '<|-' head_length=0.4,head_width=0.2 '<|-|>' head_length=0.4,head_width=0.2 'fancy' head_length=0.4,head_width=0.4,tail_width=0.4 'simple' head_length=0.5,head_width=0.5,tail_width=0.2 'wedge' tail_width=0.3,shrink_factor=0.5 Допустимые ключи для FancyArrowPatch: Ключ Описание arrowstyle стиль стрелки connectionstyle стиль соединения relpos по умолчанию (0.5, 0.5) patchA по умолчанию ограничивающий прямоугольник текста patchB по умолчанию None shrinkA по умолчанию 2 пункта shrinkB по умолчанию 2 пункта mutation_scale по умолчанию размер шрифта (в пунктах) mutation_aspect по умолчанию 1. ? любой ключ для matplotlib.patches.PathPatch По умолчанию None, т.е. стрелка не рисуется. annotation_clipbool или None, по умолчанию: None Определяет, рисовать ли аннотацию, когда точка аннотации xy находится за пределами области построения. Если True, аннотация рисуется только тогда, когда xy находится внутри области построения. Если False, аннотация всегда рисуется. Если None, аннотация рисуется только тогда, когда xy находится внутри области построения, а xycoords равно 'data'. **kwargs Дополнительные kwargs передаются в Text.

Возвращает:

Annotation

См. также

Расширенные аннотации

свойство anncoords

Система координат для Annotation.xyann.

contains(event)[source]

Возвращает, произошло ли событие мыши внутри прямоугольной области текста.

draw(renderer)[source]

Отрисовка элемента (и его дочерних элементов) с помощью указанного рендерера.

Не оказывает влияния, если элемент не отображается (Artist.get_visible возвращает False).

Параметры:	rendererRendererBase подкласс.

Примечания

Этот метод переопределен в подклассах элементов.

get_anncoords()[source]

Возвращает систему координат для Annotation.xyann.

См. также xycoords в Annotation.

get_tightbbox(renderer)[source]

Аналогично Artist.get_window_extent, но включает любые обрезки.

Параметры:	rendererRendererBase подкласс рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())
Возвращает:	Bbox Охватывающая прямоугольная область (в пикселях координат фигуры).

get_window_extent(renderer=None)[source]

Возвращает Bbox ограничивающую текст и стрелку в единицах отображения.

Параметры:	rendererРендерер, необязательно Требуется рендерер для вычисления прямоугольной области. Если элемент уже был нарисован, рендерер кэшируется; поэтому этот аргумент необходимо передавать только при вызове get_window_extent до первой отрисовки draw. На практике обычно проще вызвать отрисовку предварительно (например, сохранив фигуру).

set_anncoords(coords)[source]

Устанавливает систему координат для Annotation.xyann.

См. также xycoords в Annotation.

set_figure(fig)[source]

Устанавливает экземпляр Figure, к которому принадлежит элемент.

Параметры:	figFigure

update_positions(renderer)[source]

Обновляет пиксельные позиции текста аннотации и стрелочного патча.

свойство xyann

Позиция текста.

См. также xytext в Annotation.

свойство xycoords

класс matplotlib.text.OffsetFrom(artist, ref_coord, unit='points')[source]

Базы: object

Вспомогательный вызываемый класс для работы с Annotation.

Параметры:

artistArtist или BboxBase или Transform Объект, от которого вычисляется смещение. ref_coord(float, float) Если artist является Artist или BboxBase, это значения, определяющие положение начала смещения в долях рамки artist. Если artist является преобразованием, начало смещения — это преобразование, применённое к этому значению. unit{'points', 'pixels'}, по умолчанию: 'points' Единицы измерения на экране (пиксели или точки) для входного смещения.

get_unit()[source]

Возвращает единицы измерения для входных данных в преобразование, используемое __call__.

set_unit(unit)[source]

Устанавливает единицы измерения для входных данных в преобразование, используемое __call__.

Параметры:	unit{'points', 'pixels'}

класс matplotlib.text.Text(x=0, y=0, text='', color=None, verticalalignment='baseline', horizontalalignment='left', multialignment=None, fontproperties=None, rotation=None, linespacing=None, rotation_mode=None, usetex=None, wrap=False, transform_rotates_text=False, **kwargs)[source]

Базы: matplotlib.artist.Artist

Обработка хранения и отрисовки текста в координатах окна или данных.

Создайте экземпляр Text в точке x, y со строкой text.

Допустимые ключевые аргументы:

Свойство	Описание
agg_filter	Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha	скаляр или None
animated	bool
backgroundcolor	цвет
bbox	словарь свойств для patches.FancyBboxPatch
clip_box	Bbox
clip_on	bool
clip_path	Объект Patch или (Path, Transform) или None
color или c	цвет
contains	неизвестно
figure	Figure
fontfamily или family	{НАИМЕНОВАНИЕ_ШРИФТА, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties или font или font_properties	font_manager.FontProperties или str или pathlib.Path
fontsize или size	числовое значение или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch или stretch	{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle или style	{'normal', 'italic', 'oblique'}
fontvariant или variant	{'normal', 'small-caps'}
fontweight или weight	{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
gid	строка
horizontalalignment или ha	{'center', 'right', 'left'}
in_layout	bool
label	объект
linespacing	числовое значение (кратное размеру шрифта)
math_fontfamily	строка
multialignment или ma	{'left', 'right', 'center'}
path_effects	AbstractPathEffect
picker	None или bool или число или вызываемая функция
position	(число, число)
rasterized	bool
rotation	числовое значение или {'vertical', 'horizontal'}
rotation_mode	{None, 'default', 'anchor'}
sketch_params	(масштаб: число, длина: число, случайность: число)
snap	bool или None
text	объект
transform	Transform
transform_rotates_text	bool
url	строка
usetex	bool или None
verticalalignment или va	{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
visible	bool
wrap	bool
x	число
y	число
zorder	число

contains(mouseevent)[source]

Возвращает значение, указывающее, произошёл ли событие мыши внутри прямоугольника с отсечкой текста.

draw(renderer)[source]

Отрисовывает элемент (и его дочерние элементы) с использованием заданного рендерера.

Не имеет эффекта, если элемент невидим (Artist.get_visible возвращает False).

Параметры:	rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах элементов.

get_bbox_patch()[source]

Возвращает объект Patch области, или None, если patches.FancyBboxPatch не создан.

get_c()

Псевдоним для get_color.

get_color()[source]

Возвращает цвет текста.

get_family()

Псевдоним для get_fontfamily.

get_font()

Псевдоним для get_fontproperties.

get_font_properties()

Псевдоним для get_fontproperties.

get_fontfamily()[source]

Возвращает список семейств шрифтов, используемых для поиска шрифтов.

См. также

font_manager.FontProperties.get_family

get_fontname()[source]

Возвращает имя шрифта как строку.

См. также

font_manager.FontProperties.get_name

get_fontproperties()[source]

Возвращает font_manager.FontProperties.

get_fontsize()[source]

Возвращает размер шрифта как целое число.

См. также

font_manager.FontProperties.get_size_in_points

get_fontstyle()[source]

Возвращает стиль шрифта как строку.

См. также

font_manager.FontProperties.get_style

get_fontvariant()[source]

Возвращает вариант шрифта как строку.

См. также

font_manager.FontProperties.get_variant

get_fontweight()[source]

Возвращает вес шрифта как строку или число.

См. также

font_manager.FontProperties.get_weight

get_ha()

Псевдоним для get_horizontalalignment.

get_horizontalalignment()[source]

Возвращает выравнивание по горизонтали как строку. Будет 'left', 'center' или 'right'.

get_math_fontfamily()[source]

Возвращает имя семейства шрифтов для математического текста, отрисованного Matplotlib.

Значение по умолчанию — rcParams["mathtext.fontset"] (по умолчанию: 'dejavusans').

См. также

set_math_fontfamily

get_name()

Псевдоним для get_fontname.

get_position()[source]

Возвращает позицию (x, y) текста.

get_prop_tup(renderer=None)[source]

Возвращает хешируемую кортеж свойств.

Не предназначен для восприятия человеком, но полезен для бэкендов, которые хотят кэшировать производные данные о тексте (например, макеты) и должны знать, изменился ли текст.

get_rotation()[source]

Возвращает угол текста в градусах в диапазоне от 0 до 360.

get_rotation_mode()[source]

Возвращает режим поворота текста.

get_size()

Псевдоним для get_fontsize.

get_stretch()[source]

Возвращает расширение шрифта в виде строки или числа.

См. также

font_manager.FontProperties.get_stretch

get_style()

Псевдоним для get_fontstyle.

get_text()[source]

Возвращает строку текста.

get_transform_rotates_text()[source]

Возвращает, влияют ли повороты преобразования на направление текста.

get_unitless_position()[source]

Возвращает безразмерные (x, y) координаты текста.

get_usetex()[source]

Возвращает, использует ли данный объект Text TeX для рендеринга.

get_va()

Псевдоним для get_verticalalignment.

get_variant()

Псевдоним для get_fontvariant.

get_verticalalignment()[source]

Возвращает вертикальное выравнивание в виде строки. Будет одним из 'top', 'center', 'bottom', 'baseline' или 'center_baseline'.

get_weight()

Псевдоним для get_fontweight.

get_window_extent(renderer=None, dpi=None)[source]

Возвращает Bbox ограничивающий текст, в единицах отображения.

Помимо внутреннего использования, это полезно для определения нажимаемых областей в файле png на веб-странице.

Параметры:

rendererRenderer, необязательно Для вычисления области необходимо указание рендерера. Если элемент уже был отрисован, рендерер кэшируется; следовательно, этот аргумент необходимо передавать только при вызове get_window_extent до первого draw. На практике, обычно проще вызвать отрисовку сначала (например, сохранив рисунок). dpifloat, необязательно Значение dpi для вычисления области, по умолчанию self.figure.dpi (не dpi рендерера); следует задавать, например, для соответствия областям с рисунком, сохранённым с пользовательским значением dpi.

get_wrap()[source]

Возвращает, может ли текст быть переносим на другую строку.

set_backgroundcolor(color)[source]

Устанавливает цвет фона текста, обновляя область.

Параметры:	colorцвет

См. также

set_bbox

Для изменения положения области

set_bbox(rectprops)[source]

Рисует область вокруг себя.

Параметры:	rectpropsсловарь свойств для patches.FancyBboxPatch Стиль рамки по умолчанию — 'square'. Масштаб изменения patches.FancyBboxPatch устанавливается равным размеру шрифта.

Примеры

t.set_bbox(dict(facecolor='red', alpha=0.5))

set_c(color)

Псевдоним для set_color.

set_clip_box(clipbox)[source]

Установить область обрезки элемента.Bbox.

Параметры:	clipboxBbox

set_clip_on(b)[source]

Установить, используется ли обрезка для элемента.

Если значение False, элементы будут отображаться за пределами осей, что может привести к неожиданным результатам.

Параметры:	bbool

set_clip_path(path, transform=None)[source]

Установить обрезку элемента по пути.

Параметры:	pathPatch или Path или TransformedPath или None Путь обрезки. Если задан Path, необходимо также указать transform. Если None, ранее заданный путь обрезки удаляется. transformTransform, необязательно Используется только если path — Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path — Rectangle, этот метод установит область обрезки на соответствующий прямоугольник и установит путь обрезки на None.

По техническим причинам (поддержка set) также принимается кортеж (path, transform) в качестве единственного позиционного параметра.

set_color(color)[source]

Установить цвет текста.

Параметры:	colorцвет

set_family(fontname)

Псевдоним для set_fontfamily.

set_font(fp)

Псевдоним для set_fontproperties.

set_font_properties(fp)

Псевдоним для set_fontproperties.

set_fontfamily(fontname)[source]

Установить семейство шрифтов. Может быть либо одной строкой, либо списком строк в порядке убывания приоритета. Каждая строка может быть либо реальным именем шрифта, либо общим именем класса шрифта. Если это последнее, то конкретные имена шрифтов будут найдены в соответствующих rcParams.

Если экземпляр Text создан с fontfamily=None, то шрифт устанавливается на rcParams["font.family"] (по умолчанию ['sans-serif']), и то же самое выполняется при вызове set_fontfamily() для существующего экземпляра Text.

Параметры:	fontname{ИМЯ_ШРИФТА, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

См. также

font_manager.FontProperties.set_family

set_fontname(fontname)[source]

Псевдоним для set_family.

Только односторонний псевдоним: получение значения отличается.

Параметры:	fontname{ИМЯ_ШРИФТА, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

См. также

font_manager.FontProperties.set_family

set_fontproperties(fp)[source]

Установить свойства шрифта, управляющие текстом.

Параметры:	fpfont_manager.FontProperties или str или pathlib.Path Если str, интерпретируется как шаблон fontconfig, анализируемый FontProperties. Если pathlib.Path, интерпретируется как абсолютный путь к файлу шрифта.

set_fontsize(fontsize)[source]

Установить размер шрифта.

Параметры:	fontsizefloat или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} Если float, размер шрифта в пунктах. Строковые значения обозначают размеры относительно размера шрифта по умолчанию.

См. также

font_manager.FontProperties.set_size

set_fontstretch(stretch)[source]

Установить расширение шрифта (горизонтальное сжатие или расширение).

Параметры:	stretch{числовое значение в диапазоне от 0 до 1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}

См. также

font_manager.FontProperties.set_stretch

set_fontstyle(fontstyle)[source]

Установить стиль шрифта.

Параметры:	fontstyle{'normal', 'italic', 'oblique'}

См. также

font_manager.FontProperties.set_style

set_fontvariant(variant)[source]

Установить вариант шрифта.

Параметры:	variant{'normal', 'small-caps'}

См. также

font_manager.FontProperties.set_variant

set_fontweight(weight)[source]

Установить начертание шрифта.

Параметры:	weight{числовое значение в диапазоне от 0 до 1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}

См. также

font_manager.FontProperties.set_weight

set_ha(align)

Псевдоним для set_horizontalalignment.

set_horizontalalignment(align)[source]

Установить горизонтальное выравнивание по одному из

Параметры:	align{'center', 'right', 'left'}

set_linespacing(spacing)[source]

Установить интервал строк как кратное размеру шрифта.

Интервал строк по умолчанию равен 1,2.

Параметры:	spacingfloat (кратное размеру шрифта)

set_ma(align)

Псевдоним для set_multialignment.

set_math_fontfamily(fontfamily)[source]

Установить семейство шрифтов для математического текста, отрисовываемого Matplotlib.

Это влияет только на собственный математический рендер Matplotlib. Это не влияет при рендеринге с TeX (usetex=True).

Параметры:	fontfamilystr Название семейства шрифтов. Доступные семейства шрифтов определены в файле matplotlibrc.template.

См. также

get_math_fontfamily

set_multialignment(align)[source]

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

Макет рамки ограничительной области всех строк определяется свойствами horizontalalignment и verticalalignment. Это свойство контролирует выравнивание строк текста в пределах этой рамки.

Параметры:	align{'left', 'right', 'center'}

set_name(fontname)

Псевдоним для set_fontname.

set_position(xy)[source]

Установить (x, y) координаты текста.

Параметры:	xy(float, float)

set_rotation(s)[source]

Установить угол поворота текста.

Параметры:	sfloat или {'vertical', 'horizontal'} Угол поворота в градусах в математически положительном направлении (против часовой стрелки). 'horizontal' равно 0, 'vertical' равно 90.

set_rotation_mode(m)[source]

Установить режим поворота текста.

Параметры:	m{None, 'default', 'anchor'} Если None или "default", текст будет сначала повернут, а затем выровнен по горизонтали и вертикали. Если "anchor", выравнивание происходит до поворота.

set_size(fontsize)

Псевдоним для set_fontsize.

set_stretch(stretch)

Псевдоним для set_fontstretch.

set_style(fontstyle)

Псевдоним для set_fontstyle.

set_text(s)[source]

Установить строку текста s.

Может содержать новые строки (\n) или математические выражения в формате LaTeX.

Параметры:	sобъект Любой объект преобразуется в его строковое представление str, за исключением None, который преобразуется в пустую строку.

set_transform_rotates_text(t)[source]

Определяет, влияют ли повороты преобразования на направление текста.

Параметры:	tbool

set_usetex(usetex)[source]

Параметры:	usetexbool или None Включает отображение с помощью TeX, None означает использование rcParams["text.usetex"] (по умолчанию: False).

set_va(align)

Псевдоним для set_verticalalignment.

set_variant(variant)

Псевдоним для set_fontvariant.

set_verticalalignment(align)[source]

Установить вертикальное выравнивание.

Параметры:	align{'center', 'top', 'bottom', 'baseline', 'center_baseline'}

set_weight(weight)

Псевдоним для set_fontweight.

set_wrap(wrap)[source]

Установить возможность переноса текста по строкам.

Параметры:	wrapbool

Примечания

Перенос по строкам не работает вместе с savefig(..., bbox_inches='tight') (который также используется внутри %matplotlib inline в IPython/Jupyter). Настройка 'tight' перемасштабирует холст для размещения всего содержимого и выполняется до переноса по строкам.

set_x(x)[source]

Установить координату x текста.

Параметры:	xfloat

set_y(y)[source]

Установить координату y текста.

Параметры:	yfloat

update(kwargs)[source]

Обновить свойства этого объекта от словаря props.

Параметры:	propsdict

update_bbox_position_size(renderer)[source]

Обновить расположение и размер области.

Этот метод необходимо использовать, когда расположение и размер области нужно обновить перед фактическим отрисовкой.

update_from(other)[source]

Скопировать свойства из other в self.

zorder = 3

matplotlib.text.get_rotation(rotation)[source]

Возвращает rotation, нормализованный к углу между 0 и 360 градусами.

Параметры:	rotationfloat или {None, 'horizontal', 'vertical'} Угол поворота в градусах. None и 'horizontal' равны 0, 'vertical' равно 90.
Возвращает:	float