Spec-Zone.ru › Matplotlib

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), default: None

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

pathPath, default: None

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

arrowstylestr or ArrowStyle, default: '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 or ConnectionStyle or None, optional, default: '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, default: None

Заплатки головки и хвоста соответственно.

shrinkA, shrinkBfloat, default: 2

Величина сжатия, в пунктах, хвоста и головки стрелки соответственно.

mutation_scalefloat, default: 1

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

mutation_aspectNone or float, default: None

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

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

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

Свойство

Описание

agg_filter

функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (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 (и его дочерних элементов) с помощью указанного рендерера.

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

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

Примечания

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

get_arrowstyle()[source]

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

get_connectionstyle()[source]

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

get_mutation_aspect()[source]

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

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/stable/api/_as_gen/matplotlib.patches.FancyArrowPatch.html

Spec-Zone.ru

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