Spec-Zone.ru › Matplotlib 3.3

matplotlib.pyplot.annotate

matplotlib.pyplot.annotate(text, xy, *args, **kwargs) [source]

Добавление аннотации к точке xy с текстом text.

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

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

Параметры:
textstr

Текст аннотации. s — устаревший синоним этого параметра.

xy(float, float)

Точка (x, y), к которой добавляется аннотация. Система координат определяется параметром xycoords.

xytext(float, float), default: xy

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

xycoordsstr or Artist or Transform or callable or (float, float), default: 'data'

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

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

    Значение Описание
    'figure points' Точки от нижнего левого угла фигуры
    'figure pixels' Пиксели от нижнего левого угла фигуры
    'figure fraction' Доля от нижнего левого угла фигуры
    'axes points' Точки от нижнего левого угла области построения
    'axes pixels' Пиксели от нижнего левого угла области построения
    'axes fraction' Доля от нижнего левого угла области построения
    'data' Используется система координат объекта, к которому добавляется аннотация (по умолчанию)
    'polar' (theta, r) если координаты не родные 'data'
  • Объект 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 or Artist or Transform or callable or (float, float), default: value of xycoords

Система координат для параметра xytext.

Поддерживаются все значения xycoords, а также следующие строки:

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

Свойства, используемые для рисования стрелки 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_clipbool or None, default: None

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

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

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

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

См. также

Расширенные аннотации

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

Grouped bar chart with labels

Группированные столбчатые диаграммы с метками

Percentiles as horizontal bar chart

Процентили в виде горизонтальной столбчатой диаграммы

Mathtext Examples

Примеры использования Mathtext

Annotate Transform

Аннотация с преобразованием

Annotating a plot

Аннотирование графика

Annotation Polar

Аннотация Полярная

Pyplot tutorial

Учебник Pyplot

Annotations

Аннотации

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

Spec-Zone.ru

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