matplotlib.text

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

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

Базы: matplotlib.text.Text, matplotlib.text._AnnotationBase

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

Атрибуты:	xy Анотируемая позиция. xycoords Система координат для xy. arrow_patch `FancyArrowPatch` для указания направления от xytext к xy.

Анотировать точку xy текстом text.

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

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

Параметры:

textstr

Текст анотации. s — устаревшее синоним этого параметра.

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'	Доля графика от левого нижнего угла
'axes points'	Точки от левого нижнего угла осей
'axes pixels'	Пиксели от левого нижнего угла осей
'axes fraction'	Доля осей от левого нижнего угла
'data'	Использовать систему координат объекта, который анотируется (по умолчанию)
'polar'	(theta, r) если не родные координаты 'data'

Объект 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 должны быть одного из перечисленных типов.

См. Подробные анотации для получения более подробной информации.

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.

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

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

Если arrowprops содержит ключ 'arrowstyle', вышеперечисленные ключи запрещены. Допустимые значения 'arrowstyle':

Название	Атрибуты
`'-'`	None
`'->'`	head_length=0.4,head_width=0.2
`'-['`	widthB=1.0,lengthB=0.2,angleB=None
`'\|-\|'`	widthA=1.0,widthB=1.0
`'-\|>'`	head_length=0.4,head_width=0.2
`'<-'`	head_length=0.4,head_width=0.2
`'<->'`	head_length=0.4,head_width=0.2
`'<\|-'`	head_length=0.4,head_width=0.2
`'<\|-\|>'`	head_length=0.4,head_width=0.2
`'fancy'`	head_length=0.4,head_width=0.4,tail_width=0.4
`'simple'`	head_length=0.5,head_width=0.5,tail_width=0.2
`'wedge'`	tail_width=0.3,shrink_factor=0.5

Допустимые ключи для FancyArrowPatch:

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

По умолчанию None, т.е. стрелка не рисуется.

annotation_clipbool or None, default: None

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

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

**kwargs

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

Возвращает:

Annotation

См. также

Подробные анотации

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

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

END_OF_DOCUMENT_MARKER

draw(self, renderer) [source]

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

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

Параметры:	`rendererRendererBase subclass.`

Примечания

Этот метод переопределён в подклассах элемента графического объекта.

get_anncoords(self) [source]

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

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

get_window_extent(self, renderer=None) [source]

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

Параметры:

Параметры:	`rendererRenderer, optional` Для вычисления рамки необходимо задать рендерер. Если графический объект уже был нарисован, рендерер кэшируется; таким образом, передавать этот аргумент необходимо только при вызове `get_window_extent` до первого вызова `draw`. На практике, обычно проще сначала вызвать отрисовку (например, сохранив рисунок).

rendererRenderer, optional: Для вычисления рамки необходимо задать рендерер. Если графический объект уже был нарисован, рендерер кэшируется; таким образом, передавать этот аргумент необходимо только при вызове get_window_extent до первого вызова draw. На практике, обычно проще сначала вызвать отрисовку (например, сохранив рисунок).

set_anncoords(self, coords) [source]

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

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

set_figure(self, fig) [source]

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

Параметры:	`figFigure`

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

property xyann

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

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

property xycoords

class matplotlib.text.OffsetFrom(artist, ref_coord, unit='points') [source]

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

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

Параметры:

Параметры:	`artistArtist or BboxBase or Transform` Объект, от которого вычисляется смещение. `ref_coord(float, float)` Если artist — это `Artist` или `BboxBase`, это значение — расположение начала смещения в долях рамки artist. Если artist — это преобразование, начало смещения — это преобразование, применённое к этому значению. `unit{'points, 'pixels'}, default: 'points'` Единицы экрана, которые следует использовать (пиксели или точки) для входных данных смещения.

artistArtist or BboxBase or Transform

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

ref_coord(float, float)

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

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

unit{'points, 'pixels'}, default: 'points'

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

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

set_unit(self, unit) [source]

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

Параметры:	`unit{'points', 'pixels'}`

class 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, **kwargs) [source]

Bases: matplotlib.artist.Artist

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

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

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

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

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

draw(self, renderer) [source]

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

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

Параметры:	`rendererRendererBase subclass.`

Примечания

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

get_bbox_patch(self) [source]: Возвращает объект bbox Patch, или None, если patches.FancyBboxPatch не создан.

get_c(self): Псевдоним для get_color.

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

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

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

get_font_properties(self): Псевдоним для get_fontproperties.

get_fontfamily(self) [source]

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

См. также

font_manager.FontProperties.get_family

get_fontname(self) [source]

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

См. также

font_manager.FontProperties.get_name

get_fontproperties(self) [source]: Возвращает font_manager.FontProperties.

get_fontsize(self) [source]

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

См. также

font_manager.FontProperties.get_size_in_points

get_fontstyle(self) [source]

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

См. также

font_manager.FontProperties.get_style

get_fontvariant(self) [source]

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

См. также

font_manager.FontProperties.get_variant

get_fontweight(self) [source]

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

См. также

font_manager.FontProperties.get_weight

get_ha(self): Псевдоним для get_horizontalalignment.

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

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

get_position(self) [source]: Возвращает координаты (x, y) текста.

get_prop_tup(self, renderer=None) [source]

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

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

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

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

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

get_stretch(self) [source]

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

См. также

font_manager.FontProperties.get_stretch

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

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

get_unitless_position(self) [source]: Возвращает безразмерные координаты (x, y) текста.

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

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

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

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

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

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

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

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

Параметры:

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

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

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

set_backgroundcolor(self, color) [source]

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

Параметры:	`colorcolor`

См. также

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

set_bbox(self, rectprops) [source]

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

Параметры:	`rectpropsdict with properties for patches.FancyBboxPatch` Стиль по умолчанию области — 'square'. Масштаб мутации `patches.FancyBboxPatch` устанавливается в значение размера шрифта.

Примеры

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

set_c(self, color): Псевдоним для set_color.

set_clip_box(self, clipbox) [source]

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

Параметры:	`clipboxBbox`

set_clip_on(self, b) [source]

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

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

Параметры:	`bbool`

set_clip_path(self, path, transform=None) [source]

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

Параметры:

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

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

Примечания

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

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

set_color(self, color) [source]

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

Параметры:	`colorcolor`

set_family(self, fontname): Псевдоним для set_fontfamily.

set_font(self, fp): Псевдоним для set_fontproperties.

set_font_properties(self, fp): Псевдоним для set_fontproperties.

set_fontfamily(self, fontname) [source]

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

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

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

См. также

font_manager.FontProperties.set_family

set_fontname(self, fontname) [source]

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

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

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

См. также

font_manager.FontProperties.set_family

set_fontproperties(self, fp) [source]

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

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

set_fontsize(self, fontsize) [source]

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

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

См. также

font_manager.FontProperties.set_size

set_fontstretch(self, stretch) [source]

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

Parameters:	`stretch{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}`

См. также

font_manager.FontProperties.set_stretch

set_fontstyle(self, fontstyle) [source]

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

Parameters:	`fontstyle{'normal', 'italic', 'oblique'}`

См. также

font_manager.FontProperties.set_style

set_fontvariant(self, variant) [source]

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

Parameters:	`variant{'normal', 'small-caps'}`

См. также

font_manager.FontProperties.set_variant

set_fontweight(self, weight) [source]

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

Parameters:	`weight{a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}`

См. также

font_manager.FontProperties.set_weight

set_ha(self, align): Псевдоним для set_horizontalalignment.

set_horizontalalignment(self, align) [source]

Установить горизонтальное выравнивание на одно из

Parameters:	`align{'center', 'right', 'left'}`

set_linespacing(self, spacing) [source]

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

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

Parameters:	`spacingfloat (multiple of font size)`

set_ma(self, align): Псевдоним для set_multialignment.

set_multialignment(self, align) [source]

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

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

Parameters:	`align{'left', 'right', 'center'}`

set_name(self, fontname): Псевдоним для set_fontname.

set_position(self, xy) [source]

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

Параметры:	`xy(float, float)`

set_rotation(self, s) [source]

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

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

set_rotation_mode(self, m) [source]

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

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

set_size(self, fontsize): Псевдоним для set_fontsize.

set_stretch(self, stretch): Псевдоним для set_fontstretch.

set_style(self, fontstyle): Псевдоним для set_fontstyle.

set_text(self, s) [source]

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

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

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

set_usetex(self, usetex) [source]

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

set_va(self, align): Псевдоним для set_verticalalignment.

set_variant(self, variant): Псевдоним для set_fontvariant.

set_verticalalignment(self, align) [source]

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

Параметры:	`align{'center', 'top', 'bottom', 'baseline', 'center_baseline'}`

set_weight(self, weight): Псевдоним для set_fontweight.

set_wrap(self, wrap) [source]

Установите возможность обрезки текста.

Параметры:	`wrapbool`

set_x(self, x) [source]

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

Параметры:	`xfloat`

set_y(self, y) [source]

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

Параметры:	`yfloat`

update(self, kwargs) [source]

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

Параметры:	`propsdict`

update_bbox_position_size(self, renderer) [source]

Обновить расположение и размер области.

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

update_from(self, other) [source]: Скопировать свойства из other в self.

zorder = 3

matplotlib.text.get_rotation(rotation) [source]

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

Параметры:	`rotationfloat or {None, 'horizontal', 'vertical'}` Угол поворота в градусах. None и 'horizontal' равны 0, 'vertical' равно 90.
Возвращает:	float