Spec-Zone.ru › Matplotlib 3.8

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]

Базовые классы: 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 игнорируются.

arrowstylestr или ArrowStyle, значение по умолчанию: 'simple'

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

Класс

Имя

Атрибуты

Curve

-

None

CurveA

<-

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

CurveB

->

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

CurveAB

<->

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

CurveFilledA

<|-

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

CurveFilledB

-|>

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

CurveFilledAB

<|-|>

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

BracketA

]-

widthA=1.0, lengthA=0.2, angleA=0

BracketB

-[

widthB=1.0, lengthB=0.2, angleB=0

BracketAB

]-[

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

BarAB

|-|

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

BracketCurve

]->

widthA=1.0, lengthA=0.2, angleA=None

CurveBracket

<-[

widthB=1.0, lengthB=0.2, angleB=None

Simple

simple

head_length=0.5, head_width=0.5, tail_width=0.2

Fancy

fancy

head_length=0.4, head_width=0.4, tail_width=0.4

Wedge

wedge

tail_width=0.3, shrink_factor=0.5

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

ConnectionStyle, с помощью которого соединены posA и posB. Если строка, это должно быть одно из доступных имен 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

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

Заплатки начала и конца стрелки соответственно.

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

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

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

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

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

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

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

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

Свойство

Описание

agg_filter

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

alpha

неизвестно

animated

bool

antialiased или aa

bool или None

capstyle

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

clip_box

BboxBase или None

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.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

BboxBase или None

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, кортеж

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

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

Диаграмма "бар-пирог"

Диаграмма "бар-пирог"

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

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

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

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

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

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

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

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

Аннотации

Аннотации

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

Spec-Zone.ru

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