matplotlib.pyplot.annotate
- matplotlib.pyplot.annotate(text, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)[source]
-
Добавьте аннотацию к точке 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
-
Дополнительные kwargs передаются в
Text.
- Возвращаемое значение:
-
Annotation
См. также
Примечания
Примечание
Это обертка pyplot для
axes.Axes.annotate.
Примеры использования matplotlib.pyplot.annotate
© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.annotate.html