matplotlib.text

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

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

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

An Annotation is a Text that can refer to a specific position xy. Optionally an arrow pointing from the text to xy can be drawn.

Attributes

xy: Заданная позиция.
xycoords: Система координат для xy.
arrow_patch: A FancyArrowPatch to point from xytext to xy.

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

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

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

Parameters

textstr

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

xy(float, float)

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

xytext(float, float), default: xy

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

xycoordsstr or Artist or Transform or callable or (float, float), default: 'data'

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

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

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

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

An Artist: xy интерпретируется как доля Bbox элемента. Например, (0, 0) - это нижний левый угол области, а (0.5, 1) - верхний центр области.
A Transform для преобразования xy в экранные координаты.
Функция с одной из следующих сигнатур:
```
def transform(renderer) -> Bbox
def transform(renderer) -> Transform
```
где renderer является подклассом RendererBase.

Результат функции интерпретируется так же, как в случаях с Artist и Transform выше.
Кортеж (xcoords, ycoords), указывающий отдельные системы координат для x и y. xcoords и ycoords должны быть одного из описанных выше типов.

См. Расширенные аннотации для получения дополнительной информации.

textcoordsstr or Artist or Transform or callable or (float, float), default: value of xycoords

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

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

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

arrowpropsdict, optional

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

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

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

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

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

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

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

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

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

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

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

annotation_clipbool or None, default: None

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

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

**kwargs

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

Returns

Annotation

См. также

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

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

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

draw(renderer)[source]

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

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

Параметры

rendererRendererBase подкласс.

Примечания

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

get_anncoords()[source]

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

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

get_tightbbox(renderer)[source]

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

Параметры

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

Возвращает

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

get_window_extent(renderer=None)[source]

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

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

Параметры

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

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

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

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

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

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

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{'точки', 'пиксели'}, по умолчанию: 'точки'

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

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

set_unit(unit)[source]

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

Параметры

unit{'точки', 'пиксели'}

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

Базы: matplotlib.artist.Artist

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

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float размером (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`animated`	bool
`backgroundcolor`	цвет
`bbox`	словарь свойств для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или c	цвет
`figure`	`Figure`
`fontfamily` или family	{имя шрифта, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties` или font или font_properties	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize` или size	число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
`fontstretch` или stretch	{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
`fontstyle` или style	{'normal', 'italic', 'oblique'}
`fontvariant` или variant	{'normal', 'small-caps'}
`fontweight` или weight	{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
`gid`	str
`horizontalalignment` или ha	{'center', 'right', 'left'}
`in_layout`	bool
`label`	объект
`linespacing`	число (кратное размеру шрифта)
`math_fontfamily`	строка
`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`	строка
`usetex`	bool или None
`verticalalignment` или va	{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
`visible`	bool
`wrap`	bool
`x`	число с плавающей точкой
`y`	число с плавающей точкой
`zorder`	число с плавающей точкой

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

draw(renderer)[source]

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

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

Параметры

rendererRendererBase подкласс.

Примечания

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

get_bbox_patch()[source]: Возвращает объект области, или 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_prop_tup(renderer=None)[source]

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

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

Примечания

Устарело начиная с версии 3.5.

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

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, 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
`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`	строка
`horizontalalignment`	{'center', 'right', 'left'}
`in_layout`	bool
`label`	объект
`linespacing`	число с плавающей точкой (кратное размеру шрифта)
`math_fontfamily`	строка
`multialignment`	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемая функция
`position`	(число с плавающей точкой, число с плавающей точкой)
`rasterized`	bool
`rotation`	число с плавающей точкой или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	строка
`usetex`	bool или None
`verticalalignment`	{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
`visible`	bool
`wrap`	bool
`x`	число с плавающей точкой
`y`	число с плавающей точкой
`zorder`	число с плавающей точкой

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]

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

Параметры

clipboxBbox

set_clip_on(b)[source]

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

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

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

Замечания

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

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

set_color(color)[source]

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

Параметры

colorцвет

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

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

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

set_fontfamily(fontname)[source]

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

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

Параметры

fontname{НАЗВАНИЕ_ШРИФТА, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

См. также

font_manager.FontProperties.set_family

set_fontname(fontname)[source]

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

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

Параметры

fontname{НАЗВАНИЕ_ШРИФТА, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

См. также

font_manager.FontProperties.set_family

set_fontproperties(fp)[source]

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

Параметры

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

set_fontsize(fontsize)[source]

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

Параметры

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

См. также

font_manager.FontProperties.set_size

set_fontstretch(stretch)[source]

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

Параметры

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

См. также

font_manager.FontProperties.set_stretch

set_fontstyle(fontstyle)[source]

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

Параметры

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

См. также

font_manager.FontProperties.set_style

set_fontvariant(variant)[source]

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

Параметры

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

См. также

font_manager.FontProperties.set_variant

set_fontweight(weight)[source]

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

Параметры

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

См. также

font_manager.FontProperties.set_weight

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

set_horizontalalignment(align)[source]

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

Параметры

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

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

См. также

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'}: Если None или "default", текст сначала повернется, а затем выровняется в соответствии с их горизонтальным и вертикальным выравниванием. Если "anchor", выравнивание выполняется до поворота.

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

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

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

set_text(s)[source]

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

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

Параметры

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

set_transform_rotates_text(t)[source]

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

Параметры

tbool

set_usetex(usetex)[source]

Параметры

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

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

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

set_verticalalignment(align)[source]

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

Параметры

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

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

matplotlib.text.get_rotation(rotation)[source]

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

Параметры

rotationfloat или {None, 'horizontal', 'vertical'}: Угол поворота в градусах. None и 'horizontal' равно 0, 'vertical' равно 90.

Возвращает

float