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

Bases: Artist

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

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

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

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

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

Свойство	Описание
`agg_filter`	функция-фильтр, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	скаляр или None
`animated`	bool
`antialiased`	bool
`backgroundcolor`	цвет
`bbox`	словарь свойств для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или c	цвет
`figure`	`Figure`
`fontfamily` или family или fontname	{ШРИФТ, '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`	(масштаб: числовое значение, длина: числовое значение, случайность: числовое значение)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	str
`usetex`	bool или None
`verticalalignment` или va	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
`visible`	bool
`wrap`	bool
`x`	числовое значение

`y`	вещественное число
`zorder`	вещественное число

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

draw(renderer)[source]

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

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

Parameters:

rendererRendererBase подкласс.

Примечания

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

get_antialiased()[source]: Возвращает, используется ли антиалайзинг.

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]: Возвращает, учитывается ли обработка математического текста для этого 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 для вычисления прямоугольника, по умолчанию равно self.figure.dpi (не dpi рендерера); следует установить, например, для соответствия областей с фигурой, сохраненной со значением dpi по умолчанию.

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<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
`antialiased`	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`	строка
`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`	строка
`usetex`	bool или None
`verticalalignment`	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
`visible`	bool
`wrap`	bool
`x`	число с плавающей точкой

`y`	float
`zorder`	float

set_antialiased(antialiased)[source]

Установить, использовать ли антиалиасинг.

Параметры:

antialiasedbool

Примечания

Антиалиасинг будет определяться по rcParams["text.antialiased"] (по умолчанию: True) и параметр antialiased не будет иметь эффекта, если текст содержит математические выражения.

set_backgroundcolor(color)[source]

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

Параметры:

colorцвет

См. также

set_bbox: Для изменения положения области определения

set_bbox(rectprops)[source]

Отобразить область определения вокруг self.

Параметры:

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 или None: Обычно создаётся из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) является стандартной обрезкой для объекта, добавленного в Axes.

set_clip_on(b)[source]

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

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

Параметры:

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_fontfamily.

Односторонний псевдоним: функция получения отличается.

Параметры:

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]

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

Параметры:

fontsizeчисло с плавающей точкой или {'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(float, float)

set_rotation(s)[source]

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

Параметры:

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

set_rotation_mode(m)[source]

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

Параметры:

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

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{'baseline', 'bottom', '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]

Bases: Text, _AnnotationBase

А Annotation — это 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одиночный или двухэлементный кортеж из 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'	(θ, 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
'offset fontsize'	Смещение относительно размера шрифта от значения xy

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

**kwargs

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

Возвращаемое значение:

Annotation

См. также

Дополнительные аннотации

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

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

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

get_anncoords()[source]

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

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

get_tightbbox(renderer=None)[source]

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

Параметры:

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

Возвращаемое значение:

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

get_window_extent(renderer=None)[source]

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

Параметры:

rendererRenderer, необязательно: Для вычисления области необходим рендерер. Если объект уже отрисован, рендерер кешируется; следовательно, передавать этот аргумент необходимо только при вызове 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>, antialiased=<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`	логическое значение
`anncoords`	неизвестно
`annotation_clip`	логическое значение или None
`antialiased`	логическое значение
`backgroundcolor`	цвет
`bbox`	словарь со свойствами для `patches.FancyBboxPatch`
`clip_box`	`BboxBase` или None
`clip_on`	логическое значение
`clip_path`	Объект Patch или (Path, Transform) или None
`color` или c	цвет
`figure`	неизвестно
`fontfamily` или family или fontname	{НАЗВАНИЕ_ШРИФТА, '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	{'left', 'center', 'right'}
`in_layout`	логическое значение
`label`	объект
`linespacing`	число с плавающей точкой (кратное размеру шрифта)
`math_fontfamily`	строка
`mouseover`	логическое значение
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	логическое значение
`path_effects`	список `AbstractPathEffect`
`picker`	None или логическое значение или число с плавающей точкой или вызываемый объект
`position`	(число с плавающей точкой, число с плавающей точкой)
`rasterized`	логическое значение
`rotation`	число с плавающей точкой или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)
`snap`	логическое значение или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	логическое значение
`url`	строка
`usetex`	логическое значение или None
`verticalalignment` или va	{'baseline', 'bottom', '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'}

END_OF_DOCUMENT_MARKER

классmatplotlib.text.TextPath(xy, s, size=None, prop=None, _interpolation_steps=1, usetex=False)[source]

Базы: Path

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

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

Параметры:

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

Примеры

Следующее создаёт путь из строки "ABC" с шрифтом Helvetica; и другой путь из LaTeX-дроби 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: Возвращает кэшированный путь после обновления при необходимости.

классmatplotlib.text.TextToPath[source]

Базы: object

Класс для преобразования строк в пути.

DPI=72

FONT_SCALE=100.0

get_glyphs_mathtext(prop, s, glyph_map=None, return_new_glyphs_only=False)[source]: Обработать строку mathtext s и преобразовать её в пару (vertices, codes).

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_text_path(prop, s, ismath=False)[source]

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

Параметры:

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

Возвращает:

vertsсписок: Список массивов, содержащих координаты (x, y) вершин.
codesсписок: Список кодов пути.

Примеры

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

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

fp = FontProperties(family="Comic Neue", 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]