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)[исходный код]

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

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

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

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

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

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

Свойство	Описание
`agg_filter`	функция-фильтр, принимающая массив float размерности (m, n, 3) и значение dpi, а возвращающая массив (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	float или None
`animated`	bool
`antialiased`	bool
`backgroundcolor`	цвет
`bbox`	словарь со свойствами для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или `c`	цвет
`figure`	`Figure` или `SubFigure`
`fontfamily` или `family` или `fontname`	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties` или `font` или `font_properties`	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize` или `size`	float или {'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`	object
`linespacing`	float (кратное размеру шрифта)
`math_fontfamily`	str
`mouseover`	bool
`multialignment` или `ma`	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	список объектов `AbstractPathEffect`
`picker`	None, bool, float или вызываемый объект
`position`	(float, float)
`rasterized`	bool
`rotation`	float или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`text`	object
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	str
`usetex`	bool, по умолчанию: `rcParams["text.usetex"]` (по умолчанию: `False`)
`verticalalignment` или `va`	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
`visible`	bool
`wrap`	bool
`x`	float
`y`	float
`zorder`	float

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

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

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

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

Параметры:

rendererподкласс RendererBase.

Примечания

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

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

get_bbox_patch()[исходный код]: Возвращает патч bbox или None, если patches.FancyBboxPatch не создан.

get_c()[исходный код]: Псевдоним для get_color.

get_color()[исходный код]: Возвращает цвет текста.

get_family()[исходный код]: Псевдоним для get_fontfamily.

get_font()[исходный код]: Псевдоним для get_fontproperties.

get_font_properties()[исходный код]: Псевдоним для get_fontproperties.

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

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

См. также

font_manager.FontProperties.get_family

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

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

См. также

font_manager.FontProperties.get_name

get_fontproperties()[исходный код]: Возвращает font_manager.FontProperties.

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

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

См. также

font_manager.FontProperties.get_size_in_points

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

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

См. также

font_manager.FontProperties.get_style

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

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

См. также

font_manager.FontProperties.get_variant

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

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

См. также

font_manager.FontProperties.get_weight

get_ha()[исходный код]: Псевдоним для get_horizontalalignment.

get_horizontalalignment()[исходный код]: Возвращает горизонтальное выравнивание в виде строки. Возможные значения: 'left', 'center' или 'right'.

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

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

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

См. также

set_math_fontfamily

get_name()[исходный код]: Псевдоним для get_fontname.

get_parse_math()[исходный код]: Возвращает, выполняется ли разбор mathtext для этого объекта Text.

get_position()[исходный код]: Возвращает положение текста (x, y).

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

get_rotation_mode()[исходный код]: Возвращает режим поворота текста.

get_size()[исходный код]: Псевдоним для get_fontsize.

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

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

См. также

font_manager.FontProperties.get_stretch

get_style()[исходный код]: Псевдоним для get_fontstyle.

get_text()[исходный код]: Возвращает текстовую строку.

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

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

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

get_va()[исходный код]: Псевдоним для get_verticalalignment.

get_variant()[исходный код]: Псевдоним для get_fontvariant.

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

get_weight()[исходный код]: Псевдоним для get_fontweight.

get_window_extent(renderer=None, dpi=None)[исходный код]

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

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

Параметры:

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

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

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>)[исходный код]

Задаёт несколько свойств одновременно.

Поддерживаются следующие свойства:

Свойство	Описание
`agg_filter`	функция фильтра, принимающая массив чисел с плавающей точкой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	float или None
`animated`	bool
`antialiased`	bool
`backgroundcolor`	цвет
`bbox`	словарь свойств для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color`	цвет
`figure`	`Figure` или `SubFigure`
`fontfamily` или `fontname`	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties`	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize`	float или {'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`	object
`linespacing`	float (кратное размера шрифта)
`math_fontfamily`	str
`mouseover`	bool
`multialignment`	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	список объектов `AbstractPathEffect`
`picker`	None, bool, float или callable
`position`	(float, float)
`rasterized`	bool
`rotation`	float или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`text`	object
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	str
`usetex`	bool, по умолчанию: `rcParams["text.usetex"]` (значение по умолчанию: `False`)
`verticalalignment`	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
`visible`	bool
`wrap`	bool
`x`	float
`y`	float
`zorder`	float

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

Задаёт, следует ли использовать сглаживание при отрисовке.

Параметры:

antialiasedbool

Примечания

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

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

Задаёт цвет фона текста, обновляя ограничивающую рамку.

Параметры:

colorцвет

См. также

set_bbox: Чтобы изменить положение ограничивающей рамки

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

Рисует ограничивающую рамку вокруг объекта.

Параметры:

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

Примеры

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

set_c(color)[исходный код]: Псевдоним для set_color.

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

Задаёт область отсечения художника Bbox.

Параметры:

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

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

Задаёт, следует ли применять отсечение к художнику.

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

Параметры:

bbool

set_clip_path(path, transform=None)[источник]

Задать контур отсечения графического объекта.

Параметры:

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

Примечания

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

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

set_color(color)[источник]

Задать цвет текста переднего плана

Параметры:

colorцвет

set_family(fontname)[источник]: Псевдоним для set_fontfamily.

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

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

set_fontfamily(fontname)[источник]

Задать семейство шрифтов. Можно указать одну строку или список строк в порядке убывания приоритета. Каждая строка может быть названием существующего шрифта или названием обобщённого класса шрифтов. В последнем случае конкретные названия шрифтов будут взяты из соответствующих rcParams.

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

Параметры:

fontname{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

См. также

font_manager.FontProperties.set_family

set_fontname(fontname)[источник]

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

Односторонний псевдоним: геттер отличается.

Параметры:

fontname{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

См. также

font_manager.FontProperties.set_family

set_fontproperties(fp)[источник]

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

Параметры:

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

set_fontsize(fontsize)[источник]

Задать размер шрифта.

Параметры:

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

См. также

font_manager.FontProperties.set_size

set_fontstretch(stretch)[источник]

Задать ширину шрифта (горизонтальное сжатие или растяжение).

Параметры:

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)[источник]

Задать начертание шрифта.

Параметры:

fontstyle{'normal', 'italic', 'oblique'}

См. также

font_manager.FontProperties.set_style

set_fontvariant(variant)[источник]

Задать вариант шрифта.

Параметры:

variant{'normal', 'small-caps'}

См. также

font_manager.FontProperties.set_variant

set_fontweight(weight)[источник]

Задать насыщенность шрифта.

Параметры:

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)[источник]

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

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

Параметры:

align{'left', 'center', 'right'}

set_linespacing(spacing)[источник]

Задать межстрочный интервал как множитель размера шрифта.

Межстрочный интервал по умолчанию равен 1.2.

Параметры:

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

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

set_math_fontfamily(fontfamily)[источник]

Задать семейство шрифтов для математического текста, отображаемого Matplotlib.

Это влияет только на собственный механизм отображения математических выражений Matplotlib. При отображении с помощью TeX эффекта нет (usetex=True).

Параметры:

fontfamilystr

Название семейства шрифтов.

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

См. также

get_math_fontfamily

set_multialignment(align)[источник]

Задать выравнивание текста в многострочных надписях.

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

Параметры:

align{'left', 'right', 'center'}

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

set_parse_math(parse_math)[источник]

Переопределить переключатель, отключающий разбор mathtext для этого объекта Text.

Параметры:

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

set_position(xy)[источник]

Задать положение текста (x, y).

Параметры:

xy(float, float)

set_rotation(s)[источник]

Задать угол поворота текста.

Параметры:

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

set_rotation_mode(m)[источник]

Задать режим поворота текста.

Параметры:

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

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

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

set_style(fontstyle)[источник]: Псевдоним для set_fontstyle.

set_text(s)[источник]

Задать текстовую строку s.

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

Параметры:

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

set_transform_rotates_text(t)[источник]

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

Параметры:

tbool

set_usetex(usetex)[источник]

Параметры:

usetexbool или None: Использовать ли TeX для отображения; None означает использовать rcParams["text.usetex"] (по умолчанию: False).

set_va(align)[источник]: Псевдоним для set_verticalalignment.

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

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

Задать вертикальное выравнивание относительно опорной точки.

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

Параметры:

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

set_weight(weight)[исходный код]: Псевдоним для set_fontweight.

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

Задать, можно ли переносить текст.

Перенос гарантирует, что текст будет ограничен областью фигуры или подфигуры. При этом другие объекты не учитываются.

Параметры:

wrapbool

Примечания

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

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

Задать положение текста по оси x.

Параметры:

xfloat

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

Задать положение текста по оси y.

Параметры:

yfloat

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

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

Параметры:

propsdict

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

Обновить положение и размер ограничивающей рамки.

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

update_from(other)[исходный код]: Скопировать свойства из other в self.

zorder=3

classmatplotlib.text.Annotation(text, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)[исходный код]

Базовые классы: Text, _AnnotationBase

Annotation — это 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), default: xy

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

xycoordssingle or two-tuple of str or Artist or Transform or callable, default: 'data'

Система координат, в которой задано xy. Поддерживаются следующие типы значений:

Одна из следующих строк:

Значение	Описание
'figure points'	Точки отсчёта от нижнего левого угла фигуры
'figure pixels'	Пиксели отсчитываются от нижнего левого угла фигуры
'figure fraction'	Доля фигуры, отсчитываемая от нижнего левого угла
'subfigure points'	Точки отсчёта от нижнего левого угла подфигуры
'subfigure pixels'	Пиксели отсчитываются от нижнего левого угла подфигуры
'subfigure fraction'	Доля подфигуры, отсчитываемая от нижнего левого угла
'axes points'	Точки отсчёта от нижнего левого угла области Axes
'axes pixels'	Пиксели отсчитываются от нижнего левого угла области Axes
'axes fraction'	Доля области Axes, отсчитываемая от нижнего левого угла
'data'	Использовать систему координат аннотируемого объекта (по умолчанию)
'polar'	(theta, r), если используются не исходные координаты 'data'

Обратите внимание: для родительской фигуры 'subfigure pixels' и 'figure pixels' совпадают, поэтому для кода, который будет использоваться в подфигуре, можно указывать 'subfigure pixels'.

Artist: xy интерпретируется как доля Bbox объекта Artist. Например, (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 должны иметь один из описанных выше типов.

Дополнительные сведения см. в разделе Расширенные аннотации.

textcoordssingle or two-tuple of str or Artist or Transform or callable, default: value of xycoords

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

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

Значение	Описание
'offset points'	Смещение в точках относительно значения xy
'offset pixels'	Смещение в пикселях относительно значения xy
'offset fontsize'	Смещение относительно размера шрифта от значения xy

arrowpropsdict, optional

Свойства, используемые для рисования стрелки 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 points
shrinkB	В точках. Значение по умолчанию — 2 points
mutation_scale	По умолчанию — размер текста (в точках)
mutation_aspect	По умолчанию — 1
?	Любое свойство `FancyArrowPatch`

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

annotation_clipbool or None, default: None

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

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

**kwargs

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

Возвращает:

Annotation

См. также

Аннотации

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

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

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

Нарисовать объект Artist (и его дочерние объекты) с помощью указанного средства визуализации.

Если объект Artist невидим (метод Artist.get_visible возвращает False), этот метод ничего не делает.

Параметры:

rendererподкласс RendererBase.

Примечания

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

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

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

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

get_tightbbox(renderer=None)[исходный код]

Как Artist.get_window_extent, но с учётом обрезки.

Параметры:

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

Возвращает:

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

get_window_extent(renderer=None)[исходный код]

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

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

Параметры:

rendererнеобязательное средство визуализации: Для вычисления ограничивающей рамки требуется средство визуализации. Если объект Artist уже был отрисован, средство визуализации кэшируется; поэтому этот аргумент нужно передавать только при вызове get_window_extent до первой отрисовки. На практике обычно проще сначала инициировать отрисовку, например вызвав draw_without_rendering или plt.show().
dpiнеобязательное значение float: Значение dpi для вычисления ограничивающей рамки; по умолчанию используется self.get_figure(root=True).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>)[источник]

Установить несколько свойств одновременно.

Поддерживаются следующие свойства:

Свойство	Описание
`agg_filter`	функция фильтрации, принимающая массив чисел с плавающей точкой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения относительно нижнего левого угла изображения
`alpha`	float или None
`animated`	bool
`anncoords`	неизвестно
`annotation_clip`	bool или None
`antialiased`	bool
`backgroundcolor`	цвет
`bbox`	словарь со свойствами для `patches.FancyBboxPatch`
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`color` или `c`	цвет
`figure`	неизвестно
`fontfamily` или `family` или `fontname`	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties` или `font` или `font_properties`	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize` или `size`	float или {'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`	object
`linespacing`	float (кратное размера шрифта)
`math_fontfamily`	str
`mouseover`	bool
`multialignment` или `ma`	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	список объектов `AbstractPathEffect`
`picker`	None, bool, float или вызываемый объект
`position`	(float, float)
`rasterized`	bool
`rotation`	float или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`text`	object
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	str
`usetex`	bool, по умолчанию: `rcParams["text.usetex"]` (значение по умолчанию: `False`)
`verticalalignment` или `va`	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
`visible`	bool
`wrap`	bool
`x`	float
`y`	float
`zorder`	float

set_anncoords(coords)[источник]

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

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

set_figure(fig)[источник]

Задать экземпляр Figure или SubFigure, которому принадлежит этот графический объект.

Параметры:

figFigure или SubFigure

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

propertyxyann

Положение текста.

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

propertyxycoords

classmatplotlib.text.OffsetFrom(artist, ref_coord, unit='points')[источник]

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

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

Параметры:

artistArtist или BboxBase или Transform

Объект, относительно которого вычисляется смещение.

ref_coord(float, float)

Если artist — это Artist или BboxBase, это значение задаёт расположение начала смещения в долях от ограничивающей рамки artist.

Если artist — это преобразование, начало смещения определяется результатом применения преобразования к этому значению.

unit{'points, 'pixels'}, по умолчанию: 'points'

Экранные единицы (пиксели или пункты), используемые для входного значения смещения.

get_unit()[источник]: Возвращает единицу измерения входных данных преобразования, используемого в __call__.

set_unit(unit)[источник]

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

Параметры:

unit{'points', 'pixels'}

classmatplotlib.text.TextPath(xy, s, size=None, prop=None, _interpolation_steps=1, usetex=False)[источник]

Базовый класс: Path

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

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

Параметры:

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

Примеры

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

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)

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

propertycodes: Возвращает коды

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

set_size(size)[источник]: Задать размер текста.

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

classmatplotlib.text.TextToPath[исходный код]

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

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

DPI=72

FONT_SCALE=100.0

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

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

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

get_text_path(prop, s, ismath=False)[исходный код]

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

Параметры:

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

Возвращает:

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

Примеры

Создайте список вершин и кодов из текста, а затем создайте 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)[исходный код]