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`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от левого нижнего угла изображения
`alpha`	скаляр или None
`animated`	булево значение
`antialiased`	булево значение
`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`	строка
`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`	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
`snap`	булево значение или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	булево значение
`url`	строка
`usetex`	булево значение, по умолчанию: `rcParams["text.usetex"]` (по умолчанию: `False`)
`verticalalignment` или va	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}

END_OF_DOCUMENT_MARKER

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

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

draw(renderer)[source]

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

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

Parameters:

rendererRendererBase подкласс.

Примечания

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

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

get_bbox_patch()[source]: Возвращает объект области вывода, или 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 для вычисления ограничивающего прямоугольника, по умолчанию равно 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`	функция фильтра, которая принимает массив 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`	цвет
`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, по умолчанию: `rcParams["text.usetex"]` (по умолчанию: `False`)
`verticalalignment`	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}

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

set_antialiased(antialiased)[source]

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

Параметры:

antialiasedbool

Примечания

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

set_backgroundcolor(color)[source]

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

Параметры:

colorцвет

См. также

set_bbox: Изменить положение области bbox

set_bbox(rectprops)[source]

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

Параметры:

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

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{'left', 'center', 'right'}

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{'left', 'right', 'center'}

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 или {'vertical', 'horizontal'}: Угол поворота в градусах в математически положительном направлении (против часовой стрелки). 'horizontal' равно 0, 'vertical' равно 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(текст, xy, xytext=None, xycoords='данные', 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
'axes pixels'	Пиксели от нижнего левого угла области Axes
'axes fraction'	Доля области Axes от нижнего левого угла
'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
'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 находится за пределами области Axes.

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

**kwargs

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

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

Annotation

См. также

Аннотации

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

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

draw(renderer)[source]

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

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

Параметры:

rendererRendererBase подкласс.

Примечания

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

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 ограничивающий текст в единицах отображения.

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

Параметры:

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>, 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`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	скаляр или 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	{НАЗВАНИЕ_ШРИФТА, '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`	вещественное число или {'вертикаль', 'горизонталь'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`text`	объект
`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)[source]

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

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

set_figure(fig)[source]

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

Параметры:

figFigure

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

свойствоxyann

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

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

свойствоxycoords

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

Базы: object

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

Параметры:

artistArtist или BboxBase или Transform

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

ref_coord(float, float)

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

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

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

Единицы измерения экрана (пиксели или точки) для входных данных смещения.

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

set_unit(unit)[source]

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

Параметры:

unit{'points', 'pixels'}

classmatplotlib.text.TextPath(xy, s, size=None, prop=None, _interpolation_steps=1, usetex=False)[source]

Bases: Path

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

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

Parameters:

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

Примеры

Следующее создает путь из строки "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)

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

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

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

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

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

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]: Обработать строку mathtext s и преобразовать её в пару (вершины, коды).

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

Parameters:

propFontProperties: Свойства шрифта для текста.
sстрока: Текст, который требуется преобразовать.
ismath{False, True, "TeX"}: Если True, используется математический парсер. Если "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]