Spec-Zone.ru › Matplotlib 3.4

matplotlib.pyplot.annotate

matplotlib.pyplot.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 или вызываемый объект или (float, float), по умолчанию: 'data'

Система координат, в которой заданы значения xy. Поддерживаются следующие типы значений:

  • Одно из следующих строк:

    Значение Описание
    'figure points' Точки от левого нижнего угла фигуры
    'figure pixels' Пиксели от левого нижнего угла фигуры
    'figure fraction' Доля фигуры от левого нижнего угла
    'subfigure points' Точки от левого нижнего угла подрисунка
    'subfigure pixels' Пиксели от левого нижнего угла подрисунка
    'subfigure fraction' Доля подрисунка от левого нижнего угла
    'axes points' Точки от левого нижнего угла осей
    'axes pixels' Пиксели от левого нижнего угла осей
    'axes fraction' Доля осей от левого нижнего угла
    '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 должны быть одного из вышеописанных типов.

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

textcoordsstr или Artist или Transform или вызываемый объект или (float, float), по умолчанию: значение xycoords

Система координат, в которой заданы значения xytext.

Все значения xycoords также допустимы, а также следующие строки:

Значение Описание
'offset points' Смещение (в пунктах) от значения xy
'offset pixels' Смещение (в пикселях) от значения xy
arrowpropsdict, необязательно

Свойства, используемые для рисования стрелки FancyArrowPatch между позициями xy и xytext. Обратите внимание, что край стрелки, указывающей на xytext, будет центрирован по самому тексту и может не указывать непосредственно на координаты, заданные в 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 или None, по умолчанию: None

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

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

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

Возвращает:
Annotation

См. также

Дополнительные аннотации

Примеры использования matplotlib.pyplot.annotate

Mathtext Examples

Примеры Mathtext

Pyplot tutorial

Учебник Pyplot

Annotations

Аннотации

© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/_as_gen/matplotlib.pyplot.annotate.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API