Текст

matplotlib.text

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

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

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

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

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

Параметры:

s : str Текст аннотации xy : iterable Последовательность длиной 2, определяющая точку (x,y) для аннотации xytext : iterable, optional Последовательность длиной 2, определяющая точку (x,y) для размещения текста. Если None, по умолчанию используется xy. xycoords : str, Artist, Transform, callable or tuple, optional Система координат, в которой указана точка xy. Для str допустимые значения: Свойство Описание ‘figure points’ точки от нижнего левого угла графика ‘figure pixels’ пиксели от нижнего левого угла графика ‘figure fraction’ доля графика от нижнего левого угла ‘axes points’ точки от нижнего левого угла осей ‘axes pixels’ пиксели от нижнего левого угла осей ‘axes fraction’ доля осей от нижнего левого угла ‘data’ используется система координат объекта, который аннотируется (по умолчанию) ‘polar’ (theta,r) если не родные координаты ‘data’ Если передан объект Artist, единицы измерения — доля от его области. Если передан объект Transform, используется этот объект для преобразования xy в экранные координаты Если callable, он должен принять объект RendererBase в качестве входных данных и вернуть объект Transform или Bbox Если tuple, должен быть кортежем длиной 2 из str, Artist, Transform или callable объектов. Первое преобразование используется для координаты x, а второе — для y. См. Дополнительные аннотации для получения более подробной информации. По умолчанию 'data' textcoords : str, Artist, Transform, callable или кортеж, optional Система координат, в которой указана точка xytext (может отличаться от системы координат, используемой для xy). Все xycoords значения действительны, а также следующие строки: Свойство Описание ‘offset points’ смещение (в пунктах) от значения xy ‘offset pixels’ смещение (в пикселях) от значения xy по умолчанию используется вход xycoords arrowprops : dict, optional Если не None, свойства, используемые для рисования стрелки 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_clip : bool, optional Управляет видимостью аннотации, когда она выходит за область осей. Если True, аннотация будет отображаться только если xy находится внутри осей. Если False, аннотация всегда будет отображаться независимо от ее положения. По умолчанию None, что ведет себя как True только если xycoords равно “data”.

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

Аннотация

anncoords

contains(event)

draw(renderer)

Отображает объект Annotation на заданном renderer.

get_window_extent(renderer=None)

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

renderer по умолчанию устанавливается как _renderer атрибут объекта текста. Он не присваивается до первого выполнения draw(), поэтому вам нужно использовать этот параметр, если вы хотите вызвать get_window_extent() до первого draw(). Для получения областей веб-страницы проще вызвать метод после сохранения графика. Значение dpi по умолчанию равно self.figure.dpi; разрешение рендерера не имеет значения.

set_figure(fig)

update_positions(renderer)

«Обновляет пиксельные координаты аннотированной точки и текста.

xyann

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

Bases: object

Утилитарный класс для работы с Annotation

Параметры:

artist : Artist, BboxBase, или Transform Объект, относительно которого вычисляется смещение. ref_coord : последовательность длиной 2 Если artist является Artist или BboxBase, это значение — положение начала смещения в долях от artist границ. Если artist является преобразованием, начало смещения — результат применения преобразования к этому значению. unit : {‘points’, ‘pixels’} Единицы измерения смещения (точки или пиксели) на экране.

get_unit()

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

set_unit(unit)

Единицы измерения входных данных для преобразования, используемого __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)

Основы: matplotlib.artist.Artist

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

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

Допустимые значения kwargs:

Свойство	Описание
agg_filter	неизвестно
alpha	вещественное число (от 0.0 — прозрачный до 1.0 — непрозрачный)
animated	[True | False]
backgroundcolor	любой цвет matplotlib
bbox	свойства FancyBboxPatch
clip_box	экземпляр matplotlib.transforms.Bbox
clip_on	[True | False]
clip_path	[ (Path, Transform) | Patch | None ]
color	любой цвет matplotlib
contains	вызываемая функция
family или fontfamily или fontname или name	[НАИМЕНОВАНИЕ_ШРИФТА | ‘serif’ | ‘sans-serif’ | ‘cursive’ | ‘fantasy’ | ‘monospace’ ]
figure	экземпляр matplotlib.figure.Figure
fontproperties или font_properties	экземпляр matplotlib.font_manager.FontProperties
gid	строка-идентификатор
horizontalalignment или ha	[ ‘center’ | ‘right’ | ‘left’ ]
label	строка или что-либо, что можно распечатать с помощью преобразования ‘%s’.
linespacing	вещественное число (кратное размеру шрифта)
multialignment	[‘left’ | ‘right’ | ‘center’ ]
path_effects	неизвестно
picker	[None|вещественное число|булево значение|вызываемая функция]
position	(x,y)
rasterized	[True | False | None]
rotation	[ угол в градусах | ‘vertical’ | ‘horizontal’ ]
rotation_mode	неизвестно
size или fontsize	[размер в пунктах | ‘xx-small’ | ‘x-small’ | ‘small’ | ‘medium’ | ‘large’ | ‘x-large’ | ‘xx-large’ ]
sketch_params	неизвестно
snap	неизвестно
stretch или fontstretch	[числовое значение в диапазоне 0-1000 | ‘ultra-condensed’ | ‘extra-condensed’ | ‘condensed’ | ‘semi-condensed’ | ‘normal’ | ‘semi-expanded’ | ‘expanded’ | ‘extra-expanded’ | ‘ultra-expanded’ ]
style или fontstyle	[ ‘normal’ | ‘italic’ | ‘oblique’]
text	строка или что-либо, что можно распечатать с помощью преобразования ‘%s’.
transform	экземпляр Transform
url	строка url
usetex	неизвестно
variant или fontvariant	[ ‘normal’ | ‘small-caps’ ]
verticalalignment или ma или va	[ ‘center’ | ‘top’ | ‘bottom’ | ‘baseline’ ]
visible	[True | False]
weight или fontweight	[числовое значение в диапазоне 0-1000 | ‘ultralight’ | ‘light’ | ‘normal’ | ‘regular’ | ‘book’ | ‘medium’ | ‘roman’ | ‘semibold’ | ‘demibold’ | ‘demi’ | ‘bold’ | ‘heavy’ | ‘extra bold’ | ‘black’ ]
wrap	неизвестно
x	вещественное число
y	вещественное число
zorder	любое число

contains(mouseevent)

Проверка, произошла ли событие мыши внутри области.

В случае с текстом попадание считается истинным в любой точке прямоугольника, содержащего текст.

Возвращает True или False.

draw(renderer)

Отрисовка объекта Text на заданном renderer.

get_bbox_patch()

Возвращает объект bbox Patch. Возвращает None, если FancyBboxPatch не создан.

get_color()

Возвращает цвет текста

get_family()

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

get_font_properties()

псевдоним для get_fontproperties

get_fontfamily()

псевдоним для get_family

get_fontname()

псевдоним для get_name

get_fontproperties()

Возвращает объект FontProperties

get_fontsize()

псевдоним для get_size

get_fontstretch()

псевдоним для get_stretch

get_fontstyle()

псевдоним для get_style

get_fontvariant()

псевдоним для get_variant

get_fontweight()

псевдоним для get_weight

get_ha()

псевдоним для get_horizontalalignment

get_horizontalalignment()

Возвращает горизонтальное выравнивание в виде строки. Будет одним из ‘left’, ‘center’ или ‘right’.

get_name()

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

get_position()

Возвращает позицию текста в виде кортежа (x, y)

get_prop_tup(renderer=None)

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

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

get_rotation()

возвращает угол текста в градусах в виде числа с плавающей точкой

get_rotation_mode()

получить режим поворота текста

get_size()

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

get_stretch()

Получить нажим шрифта как строку или число

get_style()

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

get_text()

Получить текст в виде строки

get_unitless_position()

Возвращает безразмерную позицию текста в виде кортежа (x, y)

get_usetex()

Возвращает, будет ли этот объект Text отображаться с использованием TeX.

Если пользователь не задал это значение вручную, оно будет по умолчанию равно значению rcParams['text.usetex']

get_va()

псевдоним для getverticalalignment()

get_variant()

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

get_verticalalignment()

Возвращает вертикальное выравнивание в виде строки. Будет одним из ‘top’, ‘center’, ‘bottom’ или ‘baseline’.

get_weight()

Получить толщину шрифта как строку или число

get_window_extent(renderer=None, dpi=None)

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

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

renderer по умолчанию устанавливается в _renderer атрибут объекта текста. Это не назначено до первого выполнения draw(), поэтому вы должны использовать этот аргумент, если хотите вызвать get_window_extent() до первого draw(). Для получения областей веб-страницы проще вызвать метод после сохранения фигуры.

dpi по умолчанию устанавливается в self.figure.dpi; dpi рендерера не имеет значения. Для веб-приложения, если figure.dpi не равно значению, использованному при сохранении фигуры, то значение, которое было использовано, должно быть указано как аргумент dpi.

get_wrap()

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

static is_math_text(s, usetex=None)

Возвращает очищенную строку и флаг булевого типа. Флаг указывает, содержит ли данная строка s какой-либо математический текст, определяемый подсчетом неэкранированных знаков доллара. Если математического текста нет, очищенная строка имеет свои знаки доллара, неэкранированные. Если usetex включен, флаг всегда имеет значение “TeX”.

set_backgroundcolor(color)

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

См. также

set_bbox()

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

ПРИНИМАЕТ: любой цвет matplotlib

set_bbox(rectprops)

Отображает область вокруг self. rectprops — это любые устанавливаемые свойства для FancyBboxPatch, например, facecolor=’red’, alpha=0.5.

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

Стиль по умолчанию — ‘square’. Масштаб мутации FancyBboxPatch устанавливается в размер шрифта.

ПРИНИМАЕТ: dict свойств FancyBboxPatch

set_clip_box(clipbox)

Устанавливает область обрезки объекта художника Bbox.

ПРИНИМАЕТ: экземпляр matplotlib.transforms.Bbox

set_clip_on(b)

Устанавливает, использует ли художник обрезку.

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

ПРИНИМАЕТ: [True | False]

set_clip_path(path, transform=None)

Устанавливает путь обрезки художника, который может быть:

• экземпляр Patch (или подкласс)

• a Path instance, in which case

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

• None, чтобы удалить путь обрезки

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

ПРИНИМАЕТ: [ (Path, Transform) | Patch | None ]

set_color(color)

Устанавливает цвет текста

ПРИНИМАЕТ: любой цвет matplotlib

set_family(fontname)

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

ПРИНИМАЕТ: [ИМЯ_ШРИФТА | ‘serif’ | ‘sans-serif’ | ‘cursive’ | ‘fantasy’ |

‘monospace’ ]

set_font_properties(fp)

псевдоним для set_fontproperties

set_fontname(fontname)

псевдоним для set_family

set_fontproperties(fp)

Устанавливает свойства шрифта, которые управляют текстом. fp должен быть объектом matplotlib.font_manager.FontProperties.

ПРИНИМАЕТ: экземпляр matplotlib.font_manager.FontProperties

set_fontsize(fontsize)

псевдоним для set_size

set_fontstretch(stretch)

псевдоним для set_stretch

set_fontstyle(fontstyle)

псевдоним для set_style

set_fontvariant(variant)

псевдоним для set_variant

set_fontweight(weight)

псевдоним для set_weight

set_ha(align)

псевдоним для set_horizontalalignment

set_horizontalalignment(align)

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

ДОПУСКАЕТ: [‘center’ | ‘right’ | ‘left’]

set_linespacing(spacing)

Устанавливает интерлиньяж как кратное размеру шрифта. По умолчанию 1.2.

ДОПУСКАЕТ: float (кратное размеру шрифта)

set_ma(align)

псевдоним для set_verticalalignment

set_multialignment(align)

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

ДОПУСКАЕТ: [‘left’ | ‘right’ | ‘center’]

set_name(fontname)

псевдоним для set_family

set_position(xy)

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

ДОПУСКАЕТ: (x,y)

set_rotation(s)

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

ДОПУСКАЕТ: [ угол в градусах | ‘vertical’ | ‘horizontal’ ]

set_rotation_mode(m)

устанавливает режим поворота текста. Если «anchor», не повернутый текст сначала выровняется по ha и va, а затем повернется с точкой привязки выравнивания как начальной точкой. Если None (по умолчанию), текст сначала повернется, а затем выровняется.

set_size(fontsize)

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

ДОПУСКАЕТ: [размер в пунктах | ‘xx-small’ | ‘x-small’ | ‘small’ |

‘medium’ | ‘large’ | ‘x-large’ | ‘xx-large’ ]

set_stretch(stretch)

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

ДОПУСКАЕТ: [числовое значение в диапазоне 0-1000 | ‘ultra-condensed’ |

‘extra-condensed’ | ‘condensed’ | ‘semi-condensed’ | ‘normal’ | ‘semi-expanded’ | ‘expanded’ | ‘extra-expanded’ | ‘ultra-expanded’ ]

set_style(fontstyle)

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

ДОПУСКАЕТ: [‘normal’ | ‘italic’ | ‘oblique’]

set_text(s)

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

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

ДОПУСКАЕТ: строка или что угодно, что можно вывести с использованием преобразования ‘%s’.

set_usetex(usetex)

Устанавливает для этого объекта Text отображение с использованием TeX (или нет).

Если задано None, параметр будет сброшен к значению rcParams['text.usetex']

set_va(align)

псевдоним для set_verticalalignment

set_variant(variant)

Устанавливает тип шрифта, либо ‘normal’, либо ‘small-caps’.

ДОПУСКАЕТ: [‘normal’ | ‘small-caps’]

set_verticalalignment(align)

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

ДОПУСКАЕТ: [‘center’ | ‘top’ | ‘bottom’ | ‘baseline’]

set_weight(weight)

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

ДОПУСКАЕТ: [числовое значение в диапазоне 0-1000 | ‘ultralight’ | ‘light’ |

‘normal’ | ‘regular’ | ‘book’ | ‘medium’ | ‘roman’ | ‘semibold’ | ‘demibold’ | ‘demi’ | ‘bold’ | ‘heavy’ | ‘extra bold’ | ‘black’ ]

set_wrap(wrap)

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

set_x(x)

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

ДОПУСКАЕТ: float

set_y(y)

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

ДОПУСКАЕТ: float

update(kwargs)

Обновляет свойства из словаря.

update_bbox_position_size(renderer)

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

update_from(other)

Копирует свойства из other в self

zorder = 3

class matplotlib.text.TextWithDash(x=0, y=0, text='', color=None, verticalalignment='center', horizontalalignment='center', multialignment=None, fontproperties=None, rotation=None, linespacing=None, dashlength=0.0, dashdirection=0, dashrotation=None, dashpad=3, dashpush=0)

Базы: matplotlib.text.Text

Это по сути Text с дефисом (нарисованным с помощью Line2D) перед/после него. Он предназначен для прямого замещения Text и должен вести себя идентично ему, когда dashlength = 0.0.

Дефис всегда находится между точкой, заданной set_position(), и текстом. Когда дефис существует, аргументы выравнивания текста (horizontalalignment, verticalalignment) игнорируются.

dashlength — длина дефиса в единицах холста. (по умолчанию = 0.0).

dashdirection — одно из значений 0 или 1, где 0 рисует дефис после текста, а 1 — перед. (по умолчанию = 0).

dashrotation задаёт поворот дефиса и, как правило, должен оставаться None. В этом случае get_dashrotation() возвращает get_rotation(). (т. е. дефис принимает свой поворот от поворота текста). Поскольку центр текста проецируется на дефис, значительные отклонения в повороте приводят к визуально непривлекательным результатам. (по умолчанию = None).

dashpad — это длина отступа для добавления (или вычитания) пробела между текстом и дефисом в единицах холста. (по умолчанию = 3).

dashpush «отодвигает» дефис и текст от точки, заданной set_position(), на заданное значение в единицах холста. (по умолчанию = 0).

Примечание

Выравнивание двух объектов основано на области ограничивающей рамки Text, полученной с помощью get_window_extent(). Это, в свою очередь, похоже, зависит от метрик шрифта, заданных бэкендом отрисовки. Поэтому качество «центрирования» текста метки относительно дефиса варьируется в зависимости от используемого бэкенда.

Примечание

Не уверен, что правильно понял get_window_extent(), или достаточно ли этого для предоставления области ограничивающей рамки объекта.

draw(renderer)

Отрисуйте объект TextWithDash в заданном renderer.

get_dashdirection()

Получить направление дефиса. 1 — перед текстом, 0 — после.

get_dashlength()

Получить длину дефиса.

get_dashpad()

Получить дополнительное пространство между дефисом и текстом в единицах холста.

get_dashpush()

Получить дополнительное пространство между дефисом и указанной позицией текста в единицах холста.

get_dashrotation()

Получить угол поворота дефиса в градусах.

get_figure()

Возвращает экземпляр фигуры, к которой принадлежит элемент.

get_position()

Возвращает позицию текста как кортеж (x, y).

get_prop_tup(renderer=None)

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

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

get_unitless_position()

Возвращает безразмерную позицию текста как кортеж (x, y).

get_window_extent(renderer=None)

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

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

renderer по умолчанию устанавливается в атрибут _renderer объекта текста. Он не присваивается до первого выполнения draw(), поэтому вы должны использовать этот аргумент, если хотите вызвать get_window_extent() до первого draw(). Для получения областей веб-страницы проще вызвать метод после сохранения фигуры.

set_dashdirection(dd)

Установить направление дефиса, следующего за текстом. 1 — перед текстом, 0 — после. По умолчанию 0, что нужно для типичного случая меток под и слева от фигуры.

ПРИНИМАЕТ: целое число (1 — перед, 0 — после)

set_dashlength(dl)

Установить длину дефиса.

ПРИНИМАЕТ: число с плавающей запятой (единицы холста)

set_dashpad(dp)

Установить «отступ» TextWithDash, который представляет собой дополнительное пространство между дефисом и текстом в единицах холста.

ПРИНИМАЕТ: число с плавающей запятой (единицы холста)

set_dashpush(dp)

Установить «сдвиг» TextWithDash, который представляет собой дополнительное пространство между началом дефиса и указанной позицией.

ПРИНИМАЕТ: число с плавающей запятой (единицы холста)

set_dashrotation(dr)

Установить угол поворота дефиса в градусах.

ПРИНИМАЕТ: число с плавающей запятой (градусы)

set_figure(fig)

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

ПРИНИМАЕТ: экземпляр matplotlib.figure.Figure

set_position(xy)

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

ПРИНИМАЕТ: (x, y)

set_transform(t)

Установить экземпляр matplotlib.transforms.Transform, используемый этим элементом.

ПРИНИМАЕТ: экземпляр matplotlib.transforms.Transform

set_x(x)

Установить позицию x TextWithDash.

ПРИНИМАЕТ: число с плавающей запятой

set_y(y)

Установить позицию y TextWithDash.

ПРИНИМАЕТ: число с плавающей запятой

update_coords(renderer)

Вычисляет фактические координаты x, y для текста на основе входных x, y и dashlength. Поскольку поворот выполняется относительно координат фактического холста, нам нужно отображать их туда и обратно.

matplotlib.text.get_rotation(rotation)

Возвращает угол текста как число с плавающей запятой. Возвращаемый угол находится в диапазоне от 0 до 360 градусов.

rotation может быть ‘horizontal’, ‘vertical’ или числовым значением в градусах.