Spec-Zone.ru › Matplotlib 3.8

matplotlib.axes.Axes.annotate

Axes.annotate(text, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)[source]

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

В самом простом виде текст отображается в точке xy.

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

Параметры:
textstr

Текст аннотации.

xy(float, float)

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

xytext(float, float), по умолчанию: xy

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

xycoordsодиночный или двухэлементный кортеж из str или Artist или Transform или вызываемый объект, по умолчанию: '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 должны быть одного из описанных выше типов.

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

textcoordsодиночный или двухэлементный кортеж из str или Artist или Transform или вызываемый объект, по умолчанию: значение xycoords

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

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

Значение

Описание

'offset points'

Смещение в пунктах от значения xy

'offset pixels'

Смещение в пикселях от значения xy

'offset fontsize'

Смещение относительно размера шрифта от значения xy

arrowpropsdict, необязательно

Свойства, используемые для рисования стрелки FancyArrowPatch между позициями xy и xytext. По умолчанию None, т.е. стрелка не рисуется.

По историческим причинам существуют два различных способа определения стрелок: "простая" и "сложная":

Простая стрелка:

Если arrowprops не содержит ключ 'arrowstyle', допустимыми ключами являются:

Ключ

Описание

width

Ширина стрелки в пунктах

headwidth

Ширина основания головки стрелки в пунктах

headlength

Длина головки стрелки в пунктах

shrink

Дробь от общей длины, для уменьшения с обоих концов

?

Любое свойство FancyArrowPatch

Стрелка прикрепляется к краю текстовой области; точная позиция (углы или центры) зависит от направления.

Сложная стрелка:

Используется, если в arrowprops указан 'arrowstyle'.

Допустимыми ключами являются следующие параметры FancyArrowPatch:

Ключ

Описание

arrowstyle

Стиль стрелки

connectionstyle

Стиль соединения

relpos

См. ниже; по умолчанию (0.5, 0.5)

patchA

По умолчанию — область текста

patchB

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

shrinkA

По умолчанию — 2 пункта

shrinkB

По умолчанию — 2 пункта

mutation_scale

По умолчанию — размер текста (в пунктах)

mutation_aspect

По умолчанию — 1

?

Любое свойство FancyArrowPatch

Точная начальная точка стрелки определяется значением relpos. Это кортеж относительных координат текстовой области, где (0, 0) — нижний левый угол, а (1, 1) — верхний правый угол. Значения <0 и >1 поддерживаются и указывают на точки за пределами текстовой области. По умолчанию (0.5, 0.5), поэтому начальная точка находится в центре текстовой области.

annotation_clipbool или None, по умолчанию: None

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

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

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

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

См. также

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

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

Разрывные столбцы

Разрывные столбцы

График шляпы

График шляпы

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

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

Объединение двух подграфиков с помощью subplots и GridSpec

Объединение двух подграфиков с помощью subplots и GridSpec

Подпись пирогов и пончиков

Подпись пирогов и пончиков

Метка угла, инвариантная к масштабу

Метка угла, инвариантная к масштабу

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

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

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

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

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

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

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

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

Справочник по стилям стрелок аннотаций

Справочник по стилям стрелок аннотаций

Объединение объектов текста с различными свойствами

Объединение объектов текста с различными свойствами

Отображение математических уравнений с помощью TeX

Отображение математических уравнений с помощью TeX

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

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

Пончики!!!

Пончики!!!

Простой отступ оси

Простой отступ оси

XKCD

XKCD

Демонстрация эффекта пути

Демонстрация эффекта пути

Диаграмма Исикавы

Диаграмма Исикавы

Аннотация с единицами измерения

Аннотация с единицами измерения

Аннотировать объяснение

Аннотировать объяснение

Стили соединений для аннотаций

Стили соединений для аннотаций

Простая аннотация 01

Простая аннотация 01

Руководство по быстрому началу

Руководство по быстрому началу

Ускорение рендеринга с помощью blitting

Ускорение рендеринга с помощью blitting

Учебник по преобразованиям

Учебник по преобразованиям

Текст в Matplotlib

Текст в Matplotlib

Аннотации

Аннотации

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

Spec-Zone.ru

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