Spec-Zone.ru › Matplotlib 3.6

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строка или Artist или Transform или вызываемая функция или (float, float), по умолчанию: 'data'

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

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

    Значение

    Описание

    'figure points'

    Точки от левого нижнего угла фигуры

    'figure pixels'

    Пиксели от левого нижнего угла фигуры

    'figure fraction'

    Доля от левого нижнего угла фигуры

    'subfigure points'

    Точки от левого нижнего угла подрисунка

    'subfigure pixels'

    Пиксели от левого нижнего угла подрисунка

    'subfigure fraction'

    Доля от левого нижнего угла подрисунка

    'axes points'

    Точки от левого нижнего угла области построения

    'axes pixels'

    Пиксели от левого нижнего угла области построения

    'axes fraction'

    Доля от левого нижнего угла области построения

    'data'

    Используется система координат объекта, к которому добавляется аннотация (по умолчанию)

    'polar'

    (θ, r), если координаты не в формате 'data'

    Обратите внимание, что 'subfigure pixels' и 'figure pixels' совпадают для родительской фигуры, поэтому для кода, который можно использовать в подрисунке, можно использовать 'subfigure pixels'.

  • Объект Artist: xy интерпретируется как доля от Bbox объекта.
  • Преобразование Transform для преобразования xy в экранные координаты.
  • Функция с одним из следующих сигнатур:

    def transform(renderer) -> Bbox
    def transform(renderer) -> Transform
    

    где renderer — подкласс RendererBase.

    Результат функции интерпретируется так же, как в случаях с Artist и Transform.

  • Кортеж (xcoords, ycoords), определяющий отдельные системы координат для x и y. xcoords и ycoords должны быть одного из описанных выше типов.

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

textcoordsстрока или Artist или Transform или вызываемая функция или (float, float), по умолчанию: значение xycoords

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

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

Значение

Описание

'offset points'

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

'offset pixels'

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

arrowpropsсловарь, необязательно

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

По историческим причинам есть два способа задания стрелок, "простые" и "сложные":

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

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

Ключ

Описание

width

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

headwidth

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

headlength

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

shrink

Доля от общей длины, отступаемой с обеих сторон

?

Любой ключ для matplotlib.patches.FancyArrowPatch

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

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

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

Допустимые ключи — параметры FancyArrowPatch:

Ключ

Описание

arrowstyle

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

connectionstyle

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

relpos

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

patchA

по умолчанию — ограничивающая рамка текста

patchB

по умолчанию None

shrinkA

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

shrinkB

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

mutation_scale

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

mutation_aspect

по умолчанию 1.

?

любой ключ для matplotlib.patches.PathPatch

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

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

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

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

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

Возвращаемое значение:
Annotation

См. также

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

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

Broken Barh

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

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

График в виде шляпы

График в виде шляпы
Creating a timeline with lines, dates, and text

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

Создание временной шкалы с линиями, датами и текстом
Combining two subplots using subplots and GridSpec

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

Объединение двух подграфиков с использованием subplots и GridSpec
Labeling a pie and a donut

Подписи для круговой и донат-диаграмм

Подписи для круговой и донат-диаграмм
Scale invariant angle label

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

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

Аннотация графиков

Аннотация графиков
Annotation arrow style reference

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

Справочник стилей стрелок аннотации
Rendering math equations using TeX

Отрисовка математических уравнений с использованием TeX

Отрисовка математических уравнений с использованием TeX
Annotate Transform

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

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

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

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

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

Полярная аннотация
Text Commands

Команды для работы с текстом

Команды для работы с текстом
Mmh Donuts!!!

Донаты!!!

Донаты!!!
axis_direction demo

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

Демонстрация axis_direction
Simple Axis Pad

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

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

XKCD

XKCD
Patheffect Demo

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

Демонстрация эффектов траектории
Annotation with units

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

Аннотация с единицами
Annotate Explain

Аннотация Объяснить

Аннотация Объяснить
Annotate Simple01

Аннотация Simple01

Аннотация Simple01
Annotate Simple02

Аннотация Simple02

Аннотация Simple02
Annotate Simple03

Аннотация Simple03

Аннотация Simple03
Annotate Simple04

Аннотация Simple04

Аннотация Simple04
Annotate Simple Coord01

Аннотация Simple Coord01

Аннотация Simple Coord01
Annotate Simple Coord02

Аннотация Simple Coord02

Аннотация Simple Coord02
Annotate Simple Coord03

Аннотация Simple Coord03

Аннотация Simple Coord03
Connection styles for annotations

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

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

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

Простая аннотация01
Quick start guide

Быстрый старт

Быстрый старт
Faster rendering by using blitting

Ускорение отрисовки с помощью блиттинга

Ускорение отрисовки с помощью блиттинга
Transformations Tutorial

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

Учебник по преобразованиям
Text in Matplotlib Plots

Текст в графиках Matplotlib

Текст в графиках Matplotlib
Annotations

Аннотации

Аннотации

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

Spec-Zone.ru

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