Spec-Zone.ru › Matplotlib 3.1

matplotlib.axes.Axes.annotate

Axes.annotate(self, s, xy, *args, **kwargs) [source]

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

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

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

Параметры:
text : str

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

xy : (float, float)

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

xytext : (float, float), optional

Позиция (x,y) для размещения текста. Если None, по умолчанию используется xy.

xycoords : str, Artist, Transform, callable or tuple, optional

Система координат, в которой заданы значения 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 должны быть одного из вышеописанных типов.

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

По умолчанию 'data'.

textcoords : str, Artist, Transform, callable or tuple, optional

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

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

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

По умолчанию значение xycoords, т.е. используйте одну и ту же систему координат для точки аннотации и позиции текста.

arrowprops : dict, 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_clip : bool or None, optional

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

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

По умолчанию None.

**kwargs

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

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

См. также

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

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

../../_images/sphx_glr_barchart_thumb.png

Группированная гистограмма с метками

../../_images/sphx_glr_timeline_thumb.png

Создание временной шкалы с линиями, датами и текстом

../../_images/sphx_glr_barchart_demo_thumb.png

Процентили как горизонтальная гистограмма

../../_images/sphx_glr_annotate_transform_thumb.png

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

END_OF_DOCUMENT_MARKER
../../_images/sphx_glr_annotation_basic_thumb.png

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

../../_images/sphx_glr_annotation_polar_thumb.png

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

../../_images/sphx_glr_text_commands_thumb.png

Команды Текста

../../_images/sphx_glr_whats_new_98_4_fancy_thumb.png

Новинки 0.98.4 Изящно

../../_images/sphx_glr_donut_thumb.png

Ммм, пончики!!!

../../_images/sphx_glr_connectionstyle_demo_thumb.png

Демонстрация стилей соединения

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

Spec-Zone.ru

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