Spec-Zone.ru › Matplotlib 3.2

matplotlib.pyplot.annotate

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

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

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

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

Параметры:
textstr

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

xy(float, float)

Точка (x, y), к которой применяется аннотация.

xytext(float, float), optional

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

xycoordsstr, 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'.

textcoordsstr, Artist, Transform, callable or tuple, optional

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

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

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

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

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, optional

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

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

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

**kwargs

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

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

См. также

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

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

Grouped bar chart with labels

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

Percentiles as horizontal bar chart

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

Mathtext Examples

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

Usetex Demo

Демонстрация использования usetex

END_OF_DOCUMENT_MARKER
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.2.2/api/_as_gen/matplotlib.pyplot.annotate.html

Spec-Zone.ru

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