matplotlib.pyplot.annotate

matplotlib.pyplot.annotate(text, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)[исходный код]

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

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

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

Параметры:

textstr

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

xy(float, float)

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

xytext(float, float), по умолчанию: xy

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

xycoordsстрока, пара строк или 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строка, пара строк или 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