Spec-Zone.ru › Matplotlib 3.5

matplotlib.patches.FancyArrowPatch

классmatplotlib.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, dpi_cor=<deprecated parameter>, **kwargs)[исходный код]

Базовые классы: matplotlib.patches.Patch

Патч в виде стилизованной стрелки. Он рисует стрелку с помощью ArrowStyle.

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

Стрелку можно задать двумя способами:

  • Если заданы 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, используемый для рисования декоративной стрелки. Если задана строка, она должна содержать одно из доступных имён стиля стрелки и, при необходимости, атрибуты, разделённые запятыми. Значения необязательных атрибутов масштабируются с помощью 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. Если задана строка, она должна содержать одно из доступных имён стиля соединения и, при необходимости, атрибуты, разделённые запятыми. Доступны следующие стили соединения:

Класс

Имя

Атрибуты

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

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

dpi_corfloat, default: 1

В настоящее время dpi_cor используется для параметров, связанных с шириной линии, и коэффициента уменьшения. Он влияет на масштаб преобразования. Устарел.

Другие параметры
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

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

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)[источник]

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

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

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

Примечания

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

get_arrowstyle()[источник]

Возвращает объект стиля стрелки.

get_connectionstyle()[источник]

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

get_dpi_cor()[источник]

[Устаревший] dpi_cor в настоящее время используется для параметров, связанных с шириной линии, и коэффициента уменьшения. Это влияет на масштаб мутации.

Возвращает
скаляр

Примечания

Устарело начиная с версии 3.4.

get_mutation_aspect()[источник]

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

get_mutation_scale()[источник]

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

Возвращает
скаляр
get_path()[источник]

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

propertyget_path_in_displaycoord[источник]
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>, dpi_cor=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<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>)[источник]

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

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

Свойство

Описание

agg_filter

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

alpha

скаляр или None

animated

булево значение

antialiased или aa

булево значение или None

arrowstyle

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

capstyle

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

clip_box

Bbox

clip_on

булево значение

clip_path

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

color

цвет

connectionstyle

строка или ConnectionStyle или None, необязательно

dpi_cor

неизвестно

edgecolor или ec

цвет или None

facecolor или fc

цвет или None

figure

Figure

fill

булево значение

gid

строка

hatch

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

in_layout

булево значение

joinstyle

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

label

объект

linestyle или ls

{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

linewidth или lw

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

mutation_aspect

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

mutation_scale

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

patchA

patches.Patch

patchB

patches.Patch

path_effects

AbstractPathEffect

picker

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

positions

неизвестно

rasterized

булево значение

sketch_params

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

snap

булево значение или None

transform

Transform

url

строка

visible

булево значение

zorder

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

set_arrowstyle(arrowstyle=None, **kw)[исходный код]

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

Параметры
arrowstyleNone или ArrowStyle или строка, по умолчанию: None

Может быть строкой с именем стиля стрелки с необязательными разделителями запятых, например:

set_arrowstyle("Fancy,head_length=0.2")

Также атрибуты могут быть заданы в качестве ключевых слов, например:

set_arrowstyle("fancy", head_length=0.2)
set_connectionstyle(connectionstyle, **kw)[исходный код]

Установите стиль соединения. Старые атрибуты забываются.

Параметры
connectionstylestr или ConnectionStyle или None, необязательно

Может быть строкой с именем стиля соединения с необязательными атрибутами, разделёнными запятыми, например:

set_connectionstyle("arc,angleA=0,armA=30,rad=10")

В качестве альтернативы атрибуты можно указать в виде именованных аргументов, например:

set_connectionstyle("arc", angleA=0,armA=30,rad=10)

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

set_dpi_cor(dpi_cor)[исходный код]

[Устарело] dpi_cor в настоящее время используется для параметров, связанных с шириной линии, и в качестве коэффициента уменьшения. Масштаб мутации зависит от этого значения.

Параметры
dpi_corfloat

Примечания

Устарело начиная с версии 3.4.

set_mutation_aspect(aspect)[исходный код]

Установите соотношение сторон для мутации bbox.

Параметры
aspectfloat
set_mutation_scale(scale)[исходный код]

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

Параметры
scalefloat
set_patchA(patchA)[исходный код]

Установите патч хвоста.

Параметры
patchApatches.Patch
set_patchB(patchB)[исходный код]

Установите патч головки.

Параметры
patchBpatches.Patch
set_positions(posA, posB)[исходный код]

Установите начальную и конечную позиции соединяющей траектории.

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

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

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

Bar of pie

Столбиковая диаграмма с круговой диаграммой

Arrow guide

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

Connect Simple01

Соединить Simple01

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

Spec-Zone.ru

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