matplotlib.axes.Axes.annotate
- Axes.annotate(text, xy, *args, **kwargs)[source]
-
Добавить аннотацию к точке xy с текстом text.
В самом простом случае текст размещается в точке xy.
По желанию, текст можно отобразить в другом месте xytext. Стрелка, указывающая от текста к аннотируемой точке xy, может быть добавлена, задав arrowprops.
- Параметры
-
- textstr
-
Текст аннотации.
- xy(float, float)
-
Точка (x, y) для аннотации. Система координат определяется параметром xycoords.
- xytext(float, float), по умолчанию: xy
-
Позиция (x, y) для размещения текста. Система координат определяется параметром textcoords.
-
xycoordsstr или
ArtistилиTransformили callable или (float, float), по умолчанию: 'data' -
Система координат, в которой заданы значения xy. Поддерживаются следующие типы значений:
-
Одна из следующих строк:
Значение
Описание
'figure points'
Точки от нижнего левого угла фигуры
'figure pixels'
Пиксели от нижнего левого угла фигуры
'figure fraction'
Доля фигуры от нижнего левого угла
'subfigure points'
Точки от нижнего левого угла подрисунка
'subfigure pixels'
Пиксели от нижнего левого угла подрисунка
'subfigure fraction'
Доля подрисунка от нижнего левого угла
'axes points'
Точки от нижнего левого угла области построения
'axes pixels'
Пиксели от нижнего левого угла области построения
'axes fraction'
Доля области построения от нижнего левого угла
'data'
Используется система координат объекта, к которому добавляется аннотация (по умолчанию)
'polar'
(угол, радиус) если координаты не родные '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 должны быть одного из описанных выше типов.
См. Дополнительные аннотации для получения более подробной информации.
-
-
textcoordsstr или
ArtistилиTransformили callable или (float, float), по умолчанию: значение xycoords -
Система координат, в которой заданы значения xytext.
Все значения xycoords допустимы, а также следующие строки:
Значение
Описание
'offset points'
Смещение (в пунктах) от значения xy
'offset pixels'
Смещение (в пикселях) от значения xy
- arrowpropsdict, необязательно
-
Свойства, используемые для рисования стрелки
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 или None, по умолчанию: None
-
Определяет, рисовать ли аннотацию, когда точка аннотации xy находится вне области построения.
- Если True, аннотация рисуется только когда xy находится в области построения.
- Если False, аннотация всегда рисуется.
- Если None, аннотация рисуется только когда xy находится в области построения и xycoords равняется 'data'.
- **kwargs
-
Дополнительные параметры передаются в
Text.
- Возвращает
-
Annotation
См. также
Примеры использования matplotlib.axes.Axes.annotate
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/_as_gen/matplotlib.axes.Axes.annotate.html