Spec-Zone.ru › Matplotlib 3.7

matplotlib.patches.FancyArrowPatch

classmatplotlib.patches.FancyArrowPatch(posA=None, posB=None, *, path=None, arrowstyle='simple', connectionstyle='arc3', patchA=None, patchB=None, shrinkA=2, shrinkB=2, mutation_scale=1, mutation_aspect=1, **kwargs)[source]

Bases: Patch

Изменённый патч стрелки.

Рисует стрелку, используя ArrowStyle. В основном используется методом annotate. Для большинства целей используйте метод annotate для рисования стрелок.

Координаты начала и конца стрелки фиксированы, но размер и форма (в координатах отображения) стрелки не изменяются при перемещении или масштабировании оси.

Существует два способа определения стрелки:

  • Если заданы posA и posB, создаётся путь, соединяющий две точки, в соответствии с connectionstyle. Этот путь будет обрезан с помощью patchA и patchB и дополнительно уменьшен на shrinkA и shrinkB. Стрелка рисуется вдоль этого результата с использованием параметра arrowstyle.
  • В качестве альтернативы, если указан path, стрелка рисуется вдоль этого пути, и patchA, patchB, shrinkA и shrinkB игнорируются.
Параметры:
posA, posB(float, float), по умолчанию: None

(x, y) координаты хвоста и головки стрелки соответственно.

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

Если указано, стрелка рисуется вдоль этого пути, и patchA, patchB, shrinkA и shrinkB игнорируются.

arrowstyleстрока или ArrowStyle, по умолчанию: 'simple'

Стиль стрелки ArrowStyle для рисования стрелки. Если строка, она должна быть одним из доступных имён стилей стрелки с необязательными параметрами, разделёнными запятыми. Необязательные параметры предназначены для масштабирования с помощью mutation_scale. Доступны следующие стили стрелок:

Класс

Имя

Атрибуты

Кривая

-

None

КриваяA

<-

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

КриваяB

->

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

КриваяAB

<->

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

Заполненная криваяA

<|-

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

Заполненная криваяB

-|>

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

Заполненная криваяAB

<|-|>

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

СкобаA

]-

widthA=1.0, lengthA=0.2, angleA=0

СкобаB

-[

widthB=1.0, lengthB=0.2, angleB=0

СкобаAB

]-[

widthA=1.0, lengthA=0.2, angleA=0, widthB=1.0, lengthB=0.2, angleB=0

БлокAB

|-|

widthA=1.0, angleA=0, widthB=1.0, angleB=0

Кривая скоба

]->

widthA=1.0, lengthA=0.2, angleA=None

Скоба кривая

<-[

widthB=1.0, lengthB=0.2, angleB=None

Простой

simple

head_length=0.5, head_width=0.5, tail_width=0.2

Изменённый

fancy

head_length=0.4, head_width=0.4, tail_width=0.4

Клиновидный

wedge

tail_width=0.3, shrink_factor=0.5

connectionstyleстрока или ConnectionStyle или None, необязательно, по умолчанию: 'arc3'

Стиль соединения ConnectionStyle для соединения posA и posB. Если строка, она должна быть одним из доступных имён стилей соединения с необязательными параметрами, разделёнными запятыми. Доступные стили соединения:

Класс

Имя

Атрибуты

Arc3

arc3

rad=0.0

Angle3

angle3

angleA=90, angleB=0

Угол

angle

angleA=90, angleB=0, rad=0.0

Дуга

arc

angleA=0, angleB=0, armA=None, armB=None, rad=0.0

Блок

bar

armA=0.0, armB=0.0, fraction=0.3, angle=None

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

Патчи начала и конца соответственно.

shrinkA, shrinkBfloat, по умолчанию: 2

Коэффициент уменьшения хвоста и головки стрелки соответственно.

mutation_scalefloat, по умолчанию: 1

Значение, с которым масштабируются атрибуты arrowstyle (например, head_length).

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

Высота прямоугольника будет сжата на это значение до мутации, а изменённый прямоугольник будет растянут в обратном ему значении.

Другие параметры:
END_OF_DOCUMENT_MARKER
**kwargsPatch свойства, необязательно

Вот список доступных свойств Patch:

Свойство

Описание

agg_filter

функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, а возвращает массив чисел с плавающей точкой (m, n, 3) и два смещения от нижнего левого угла изображения

alpha

неизвестно

animated

bool

antialiased или aa

bool или None

capstyle

CapStyle или {'butt', 'projecting', 'round'}

clip_box

Bbox

clip_on

bool

clip_path

Patch или (Path, Transform) или None

color

цвет

edgecolor или ec

цвет или None

facecolor или fc

цвет или None

figure

Figure

fill

bool

gid

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или ls

{'-', '--', '-.', ':', '', (смещение, последовательность включений-выключений), ...}

linewidth или lw

число с плавающей точкой или None

mouseover

bool

path_effects

AbstractPathEffect

picker

None или bool или число с плавающей точкой или вызываемая функция

rasterized

bool

sketch_params

(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)

snap

bool или None

transform

Transform

url

строка

visible

bool

zorder

число с плавающей точкой

В отличие от других фигур, значения по умолчанию capstyle и joinstyle для FancyArrowPatch установлены в "round".

draw(renderer)[source]

Отрисовка элемента Artist (и его дочерних элементов) с помощью указанного отрисовщика.

Это не имеет эффекта, если элемент Artist не отображается (Artist.get_visible возвращает False).

Параметры:
rendererRendererBase подкласс.

Примечания

Этот метод переопределён в подклассах Artist.

get_arrowstyle()[source]

Возвращает объект arrowstyle.

get_connectionstyle()[source]

Возвращает используемую ConnectionStyle.

get_mutation_aspect()[source]

Возвращает коэффициент масштабирования области.

get_mutation_scale()[source]

Возвращает масштаб мутации.

Возвращает:
скаляр
get_path()[source]

Возвращает путь стрелки в координатах данных.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, arrowstyle=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, connectionstyle=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, mutation_aspect=<UNSET>, mutation_scale=<UNSET>, patchA=<UNSET>, patchB=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, positions=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

Установить несколько свойств сразу.

Поддерживаемые свойства:

Свойство

Описание

agg_filter

функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения

alpha

скаляр или None

animated

bool

antialiased или aa

bool или None

arrowstyle

строка или ArrowStyle

capstyle

CapStyle или {'butt', 'projecting', 'round'}

clip_box

Bbox

clip_on

bool

clip_path

Patch или (Path, Transform) или None

color

цвет

connectionstyle

[ 'arc3' | 'angle3' | 'angle' | 'arc' | 'bar' ]

edgecolor или ec

цвет или None

facecolor или fc

цвет или None

figure

Figure

fill

bool

gid

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или ls

{'-', '--', '-.', ':', '', (смещение, последовательность включений/выключений), ...}

linewidth или lw

число с плавающей точкой или None

mouseover

bool

mutation_aspect

число с плавающей точкой

mutation_scale

число с плавающей точкой

patchA

patches.Patch

patchB

patches.Patch

path_effects

AbstractPathEffect

picker

None или bool или число с плавающей точкой или вызываемая функция

positions

неизвестно

rasterized

bool

sketch_params

(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)

snap

bool или None

transform

Transform

url

строка

visible

bool

zorder

число с плавающей точкой

set_arrowstyle(arrowstyle=None, **kwargs)[source]

Установите стиль стрелки, возможно, с дополнительными атрибутами.

Атрибуты из предыдущего стиля стрелки не используются повторно.

Без аргумента (или с arrowstyle=None) доступные стили блоков возвращаются в виде читаемой строкой.

Параметры:
arrowstylestr или ArrowStyle

Стиль стрелки: либо экземпляр ArrowStyle, либо строка, являющаяся именем стиля и, необязательно, отделёнными запятыми атрибутами (например, "Fancy,head_length=0.2"). Такая строка используется для построения объекта ArrowStyle, как описано в этом классе.

Доступны следующие стили стрелок:

%(ArrowStyle:table_and_accepts)s

**kwargs

Дополнительные атрибуты для стиля стрелки. Поддерживаемые параметры см. в таблице выше.

Примеры

set_arrowstyle("Fancy,head_length=0.2")
set_arrowstyle("fancy", head_length=0.2)
set_connectionstyle(connectionstyle=None, **kwargs)[source]

Установите стиль соединения, возможно, с дополнительными атрибутами.

Атрибуты из предыдущего стиля соединения не используются повторно.

Без аргумента (или с connectionstyle=None) доступные стили блоков возвращаются в виде читаемой строкой.

Параметры:
connectionstylestr или ConnectionStyle

Стиль соединения: либо экземпляр ConnectionStyle, либо строка, являющаяся именем стиля и, необязательно, отделёнными запятыми атрибутами (например, "Arc,armA=30,rad=10"). Такая строка используется для построения объекта ConnectionStyle, как описано в этом классе.

Доступные стили соединения:

Класс

Имя

Атрибуты

Arc3

arc3

rad=0.0

Angle3

angle3

angleA=90, angleB=0

Angle

angle

angleA=90, angleB=0, rad=0.0

Arc

arc

angleA=0, angleB=0, armA=None, armB=None, rad=0.0

Bar

bar

armA=0.0, armB=0.0, fraction=0.3, angle=None

**kwargs

Дополнительные атрибуты для стиля соединения. Поддерживаемые параметры см. в таблице выше.

Примеры

set_connectionstyle("Arc,armA=30,rad=10")
set_connectionstyle("arc", armA=30, rad=10)
set_mutation_aspect(aspect)[source]

Установите соотношение сторон мутации рамки.

Параметры:
aspectfloat
set_mutation_scale(scale)[source]

Установите масштаб мутации.

Параметры:
scalefloat
set_patchA(patchA)[source]

Установите хвостовую рамку.

Параметры:
patchApatches.Patch
set_patchB(patchB)[source]

Установите головную рамку.

Параметры:
patchBpatches.Patch
set_positions(posA, posB)[source]

Установите начальные и конечные позиции соединительного пути.

Параметры:
posA, posBNone, tuple

(x, y) координаты хвоста и головки стрелки соответственно. Если None используется текущее значение.

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

Диаграмма «столбец в виде круговой»

Диаграмма «столбец в виде круговой»

Углы аннотаций на скобочных стрелках

Углы аннотаций на скобочных стрелках

Руководство по стрелкам

Руководство по стрелкам

Анимация нескольких осей

Анимация нескольких осей

Подключить Simple01

Подключить Simple01

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

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

Аннотации

Аннотации

© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.7.5/api/_as_gen/matplotlib.patches.FancyArrowPatch.html

Spec-Zone.ru

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