Spec-Zone.ru › Matplotlib 3.1

matplotlib.pyplot.annotate

matplotlib.pyplot.annotate(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

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

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

См. также

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

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

../../_images/sphx_glr_barchart_thumb.png

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

../../_images/sphx_glr_barchart_demo_thumb.png

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

../../_images/sphx_glr_mathtext_examples_thumb.png

Примеры Mathtext

../../_images/sphx_glr_usetex_demo_thumb.png

Демонстрация Usetex

END_OF_DOCUMENT_MARKER
../../_images/sphx_glr_annotate_transform_thumb.png

Аннотация Преобразования

../../_images/sphx_glr_annotation_basic_thumb.png

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

../../_images/sphx_glr_annotation_polar_thumb.png

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

../../_images/sphx_glr_pyplot_thumb.png

Учебник по Pyplot

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

Spec-Zone.ru

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