matplotlib.text

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

classmatplotlib.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, parse_math=None, **kwargs)[source]

Bases: Artist

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

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

Текст выравнивается относительно точки якорной точки (x, y) в соответствии с horizontalalignment (по умолчанию: 'слева') и verticalalignment (по умолчанию: 'внизу'). См. также Выравнивание текста.

Хотя Text принимает ключевое слово 'label', по умолчанию оно не добавляется в метки легенды.

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, а возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	скаляр или None
`animated`	bool
`backgroundcolor`	цвет
`bbox`	словарь с свойствами для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или c	цвет
`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`	str
`horizontalalignment` или ha	{'left', 'center', 'right'}
`in_layout`	bool
`label`	объект
`linespacing`	вещественное число (кратное размеру шрифта)
`math_fontfamily`	str
`mouseover`	bool
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`position`	(вещественное число, вещественное число)
`rasterized`	bool
`rotation`	вещественное число или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: вещественное число, length: вещественное число, randomness: вещественное число)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	str
`usetex`	bool или None
`verticalalignment` или va	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
`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()[source]: Псевдоним для get_color.

get_color()[source]: Возвращает цвет текста.

get_family()[source]: Псевдоним для get_fontfamily.

get_font()[source]: Псевдоним для get_fontproperties.

get_font_properties()[source]: Псевдоним для 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()[source]: Псевдоним для get_horizontalalignment.

get_horizontalalignment()[source]: Возвращает выравнивание по горизонтали в виде строки. Будет одним из 'left', 'center' или 'right'.

get_math_fontfamily()[source]

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

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

См. также

set_math_fontfamily

get_name()[source]: Псевдоним для get_fontname.

get_parse_math()[source]: Возвращает, включена ли обработка математических формул mathtext для данного объекта Text.

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

get_rotation()[source]: Возвращает угол наклона текста в градусах от 0 до 360.

get_rotation_mode()[source]: Возвращает режим поворота текста.

get_size()[source]: Псевдоним для get_fontsize.

get_stretch()[source]

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

См. также

font_manager.FontProperties.get_stretch

get_style()[source]: Псевдоним для get_fontstyle.

get_text()[source]: Возвращает строку текста.

get_transform_rotates_text()[source]: Возвращает, влияют ли повороты преобразования на направление текста.

get_unitless_position()[source]: Возвращает бесразмерную позицию текста (x, y).

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

get_va()[source]: Псевдоним для get_verticalalignment.

get_variant()[source]: Псевдоним для get_fontvariant.

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

get_weight()[source]: Псевдоним для get_fontweight.

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

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

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

Параметры:

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

get_wrap()[source]: Возвращает, можно ли обрезать текст.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, mouseover=<UNSET>, multialignment=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)[source]

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

Поддерживаемые свойства:

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

zorder

вещественное число

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)[source]: Псевдоним для set_color.

set_clip_box(clipbox)[source]

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

Параметры:

clipboxBbox: Обычно создается из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) является стандартной областью обрезки для объекта, добавленного в Axes.

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)[source]: Псевдоним для set_fontfamily.

set_font(fp)[source]: Псевдоним для set_fontproperties.

set_font_properties(fp)[source]: Псевдоним для set_fontproperties.

set_fontfamily(fontname)[source]

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

Если экземпляр 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.

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

Параметры:

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'}: Если число с плавающей точкой, размер шрифта в пунктах. Строковые значения обозначают размеры, относительные к размеру шрифта по умолчанию.

См. также

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)[source]: Псевдоним для set_horizontalalignment.

set_horizontalalignment(align)[source]

Установите выравнивание по горизонтали относительно точки якорной точки.

См. также Выравнивание текста.

Параметры:

align{'слева', 'по центру', 'справа'}

set_linespacing(spacing)[source]

Установите межстрочный интервал как кратную величину размера шрифта.

Значение по умолчанию для межстрочного интервала равно 1.2.

Параметры:

spacingвещественное число (кратное размеру шрифта)

set_ma(align)[source]: Псевдоним для set_multialignment.

set_math_fontfamily(fontfamily)[source]

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

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

Параметры:

fontfamilystr

Имя начертания шрифта.

Доступные начертания шрифтов определены в файле matplotlibrc по умолчанию.

См. также

get_math_fontfamily

set_multialignment(align)[source]

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

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

Параметры:

align{'слева', 'справа', 'по центру'}

set_name(fontname)[source]: Псевдоним для set_fontname.

set_parse_math(parse_math)[source]

Переопределяет переключатель для отключения любого разбора mathtext для данного Text.

Параметры:

parse_mathbool: Если False, этот Text никогда не будет использовать mathtext. Если True, mathtext будет использоваться, если есть четное количество неэкранированных знаков доллара.

set_position(xy)[source]

Установите позицию (x, y) текста.

Параметры:

xy(вещественное число, вещественное число)

set_rotation(s)[source]

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

Параметры:

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

set_rotation_mode(m)[source]

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

Параметры:

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

set_size(fontsize)[source]: Псевдоним для set_fontsize.

set_stretch(stretch)[source]: Псевдоним для set_fontstretch.

set_style(fontstyle)[source]: Псевдоним для 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)[source]: Псевдоним для set_verticalalignment.

set_variant(variant)[source]: Псевдоним для set_fontvariant.

set_verticalalignment(align)[source]

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

См. также Выравнивание текста.

Параметры:

align{'bottom', 'baseline', 'center', 'center_baseline', 'top'}

set_weight(weight)[source]: Псевдоним для 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

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

Базы: Text, _AnnotationBase

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

Атрибуты:

xy: Помечаемая позиция.
xycoords: Система координат для xy.
arrow_patch: FancyArrowPatch для рисования стрелки от xytext к xy.

Добавить текст text к точке xy.

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

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

Параметры:

textstr

Текст аннотации.

xy(float, float)

Точка (x, y), которую нужно аннотировать. Система координат определяется параметром xycoords.

xytext(float, float), по умолчанию: xy

Позиция (x, y) для размещения текста. Система координат определяется параметром textcoords.

xycoordsодиночный или двумерный кортеж из str или Artist или Transform или вызываемая функция, по умолчанию: '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одиночный или двумерный кортеж из str или Artist или Transform или вызываемая функция, по умолчанию: значение xycoords

Система координат, в которой заданы координаты xytext.

Все значения xycoords являются допустимыми, а также следующие строки:

Значение	Описание
'offset points'	Смещение (в пунктах) от значения xy
'offset pixels'	Смещение (в пикселях) от значения xy

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

Свойства, используемые для рисования стрелки FancyArrowPatch между позициями xy и xytext. По умолчанию None, т.е. стрелка не рисуется.

По историческим причинам есть два способа задания стрелок, «простой» и «сложный»:

Простая стрелка:

Если arrowprops не содержит ключ 'arrowstyle', разрешенные ключи:

Ключ	Описание
width	Ширина стрелки в пунктах
headwidth	Ширина основания головки стрелки в пунктах
headlength	Длина головки стрелки в пунктах
shrink	Доля от общей длины, отступаемая с обоих концов
?	Любой ключ для `matplotlib.patches.FancyArrowPatch`

Стрелка прикрепляется к краю текстового поля, точное положение (углы или центры) зависит от направления.

Сложная стрелка:

Используется, если в arrowprops задан ключ 'arrowstyle'.

Допустимые ключи — параметры FancyArrowPatch:

Ключ	Описание
arrowstyle	стиль стрелки
connectionstyle	стиль соединения
relpos	см. ниже; значение по умолчанию (0.5, 0.5)
patchA	по умолчанию — область текста
patchB	по умолчанию — None
shrinkA	по умолчанию — 2 пункта
shrinkB	по умолчанию — 2 пункта
mutation_scale	по умолчанию — размер текста (в пунктах)
mutation_aspect	по умолчанию — 1.
?	любой ключ для `matplotlib.patches.PathPatch`

Точное начальное положение стрелки определяется параметром relpos. Это кортеж относительных координат текстового поля, где (0, 0) — левый нижний угол, а (1, 1) — правый верхний угол. Поддерживаются значения <0 и >1, которые задают точки за пределами текстового поля. По умолчанию (0.5, 0.5), поэтому начальная точка находится в центре текстового поля.

annotation_clipbool или None, по умолчанию: None

Определяет, нужно ли обрезать (т.е. не отображать) аннотацию, когда точка аннотации xy находится за пределами области построения.

Если True, аннотация будет обрезана, когда xy находится за пределами области построения.
Если False, аннотация всегда будет отображаться.
Если None, аннотация будет обрезана, когда xy находится за пределами области построения, и xycoords равно 'data'.

**kwargs

Дополнительные kwargs передаются методу Text.

Возвращает:

Annotation

См. также

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

propertyanncoords: Система координат для использования с Annotation.xyann.

contains(event)[source]: Определяет, произошло ли событие мыши внутри прямоугольника, описывающего текст.

draw(renderer)[source]

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

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

Parameters:

rendererRendererBase подкласс.

Примечания

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

get_anncoords()[source]

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

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

get_tightbbox(renderer=None)[source]

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

Parameters:

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки графиков (т.е. fig.canvas.get_renderer())

Returns:

Bbox: Охватывающая прямоугольная область (в пикселях координат изображения).

get_window_extent(renderer=None)[source]

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

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

Parameters:

rendererРендерер, необязательно: Для вычисления прямоугольной области нужен рендерер. Если элемент уже был нарисован, рендерер кэшируется; поэтому аргумент необходимо передавать только при вызове get_window_extent до первого вызова отрисовки. На практике обычно проще сначала выполнить отрисовку, например, вызвав draw_without_rendering или plt.show().
dpifloat, необязательно: Значение dpi для вычисления прямоугольника, по умолчанию self.figure.dpi (не dpi рендерера); должно быть установлено, например, для соответствия областям с изображением фигуры, сохраненной с пользовательским значением dpi.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, anncoords=<UNSET>, annotation_clip=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, mouseover=<UNSET>, multialignment=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)[source]

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

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, а возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	скаляр или None
`animated`	bool
`anncoords`	неизвестно
`annotation_clip`	bool или None
`backgroundcolor`	цвет
`bbox`	словарь со свойствами для `patches.FancyBboxPatch`
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	объект Patch или (Path, Transform) или None
`color` или c	цвет
`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`	str
`horizontalalignment` или ha	{'left', 'center', 'right'}
`in_layout`	bool
`label`	объект
`linespacing`	число с плавающей точкой (кратное размеру шрифта)
`math_fontfamily`	str
`mouseover`	bool
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`position`	(число с плавающей точкой, число с плавающей точкой)
`rasterized`	bool
`rotation`	число с плавающей точкой или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	str
`usetex`	bool или None
`verticalalignment` или va	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
`visible`	bool

`wrap`	bool
`x`	float
`y`	float
`zorder`	float

set_anncoords(coords)[source]

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

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

set_figure(fig)[source]

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

Параметры:

figFigure

update_positions(renderer)[source]: Обновить пиксельные позиции текста аннотации и патча стрелки.

propertyxyann

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

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

propertyxycoords

classmatplotlib.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.TextPath(xy, s, size=None, prop=None, _interpolation_steps=1, usetex=False)[source]

Основы: Path

Создать путь из текста.

Создать путь из текста. Обратите внимание, что это просто путь, а не объект. Вам нужно использовать PathPatch (или другие объекты) для отображения этого пути на холсте.

Параметры:

xyкортеж или массив из двух числовых значений: Позиция текста. Для отсутствия смещения, используйте xy=(0, 0).
sстрока: Текст для преобразования в путь.
sizeчисло, необязательно: Размер шрифта в пунктах. По умолчанию используется размер, заданный через свойства шрифта prop.
propFontProperties, необязательно: Свойства шрифта. Если не указано, будет использоваться стандартный FontProperties со значениями по умолчанию из rcParams.
_interpolation_stepsцелое число, необязательно: (В настоящее время игнорируется)
usetexбулево значение, по умолчанию: False: Использовать рендеринг tex.

Примеры

Следующее создает путь из строки "ABC" с шрифтом Helvetica; и другой путь из латексной дроби 1/2:

from matplotlib.text import TextPath
from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Helvetica", style="italic")
path1 = TextPath((12, 12), "ABC", size=12, prop=fp)
path2 = TextPath((0, 0), r"$\frac{1}{2}$", size=12, usetex=True)

См. также Использование текста в качестве пути.

свойствоcodes: Возвращает коды

get_size()[source]: Получить размер текста.

set_size(size)[source]: Установить размер текста.

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

classmatplotlib.text.TextToPath[source]

Bases: object

Класс, преобразующий строки в пути.

DPI=72

FONT_SCALE=100.0

get_glyphs_mathtext(prop, s, glyph_map=None, return_new_glyphs_only=False)[source]: Разбор строки s в формате mathtext и её преобразование в пару (вершины, коды).

get_glyphs_tex(prop, s, glyph_map=None, return_new_glyphs_only=False)[source]: Преобразование строки s в вершины и коды с использованием режима usetex.

get_glyphs_with_font(font, s, glyph_map=None, return_new_glyphs_only=False)[source]: Преобразование строки s в вершины и коды с использованием предоставенного шрифта ttf.

get_texmanager()[source]: [Устарело] Возвращает кэшированный экземпляр TexManager.

Примечания

Устарело начиная с версии 3.6: Используйте TexManager() вместо этого.

get_text_path(prop, s, ismath=False)[source]

Преобразование текста s в путь (кортеж вершин и кодов для matplotlib.path.Path).

Параметры:

propFontProperties: Свойства шрифта для текста.
sstr: Текст для преобразования.
ismath{False, True, "TeX"}: Если True, используется анализатор mathtext. Если "TeX", используется tex для рендеринга.

Возвращает:

vertslist: Список numpy массивов, содержащих координаты x и y вершин.
codeslist: Список кодов пути.

Примеры

Создайте список вершин и кодов из текста, а затем создайте Path на основе этих данных:

from matplotlib.path import Path
from matplotlib.text import TextToPath
from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Humor Sans", style="italic")
verts, codes = TextToPath().get_text_path(fp, "ABC")
path = Path(verts, codes, closed=False)

Также см. TextPath для более прямого способа создания пути из текста.

get_text_width_height_descent(s, prop, ismath)[source]