Spec-Zone.ru › Matplotlib 3.6

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.

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

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

  • Если заданы 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

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

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

Класс

Имя

Атрибуты

Arc3

arc3

rad=0.0

... ... ...
patchA, patchBPatch, по умолчанию: 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

str

hatch

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

in_layout

bool

joinstyle

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

label

объект

linestyle или ls

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

linewidth или lw

float или None

mouseover

bool

path_effects

AbstractPathEffect

picker

None или bool или float или вызываемый объект

rasterized

bool

sketch_params

(масштаб: float, длина: float, случайность: float)

snap

bool или None

transform

Transform

url

строка

visible

bool

zorder

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

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

draw(renderer)[source]

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

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

Parameters:
rendererRendererBase подкласс.

Примечания

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

get_arrowstyle()[source]

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

get_connectionstyle()[source]

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

get_mutation_aspect()[source]

Возвращает соотношение сторон изменения bbox.

get_mutation_scale()[source]

Возвращает масштаб изменения.

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

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

propertyget_path_in_displaycoord[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

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

alpha

скаляр или None

animated

bool

antialiased или aa

bool или None

arrowstyle

строка или matplotlib.patches.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 или matplotlib.patches.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 или matplotlib.patches.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

Диаграмма

Диаграмма "пирог-столбик"

Диаграмма "пирог-столбик"
Руководство по стрелкам

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

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

Connect Simple01

Connect Simple01

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

Spec-Zone.ru

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