Spec-Zone.ru › Matplotlib 3.4

matplotlib.patches.FancyArrowPatch

class 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)[source]

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

Класс Имя Атрибуты
Curve - None
CurveB -> head_length=0.4, head_width=0.2
BracketB -[ widthB=1.0, lengthB=0.2, angleB=None
CurveFilledB -|> head_length=0.4, head_width=0.2
CurveA <- head_length=0.4, head_width=0.2
CurveAB <-> head_length=0.4, head_width=0.2
CurveFilledA <|- head_length=0.4, head_width=0.2
CurveFilledAB <|-|> head_length=0.4, head_width=0.2
BracketA ]- widthA=1.0, lengthA=0.2, angleA=None
BracketAB ]-[ widthA=1.0, lengthA=0.2, angleA=None, widthB=1.0, lengthB=0.2, angleB=None
Fancy fancy head_length=0.4, head_width=0.4, tail_width=0.4
Simple simple head_length=0.5, head_width=0.5, tail_width=0.2
Wedge wedge tail_width=0.3, shrink_factor=0.5
BarAB |-| widthA=1.0, angleA=None, widthB=1.0, angleB=None
connectionstylestr or ConnectionStyle or None, optional, default: 'arc3'

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

Класс Имя Атрибуты
Angle angle angleA=90, angleB=0, rad=0.0
Angle3 angle3 angleA=90, angleB=0
Arc arc angleA=0, angleB=0, armA=None, armB=None, rad=0.0
Arc3 arc3 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 в настоящее время используется для вещей, связанных с шириной линии, и коэффициентом сжатия. Масштаб мутации зависит от этого. Устарело.

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

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

Свойство Описание
agg_filter функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha скаляр или None
animated bool
antialiased или aa неизвестно
capstyle CapStyle или {'butt', 'projecting', 'round'}
clip_box Bbox
clip_on bool
clip_path Patch или (Path, Transform) или None
color цвет
contains неизвестно
edgecolor или ec цвет или None или 'auto'
facecolor или fc цвет или None
figure Figure
fill bool
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle JoinStyle или {'miter', 'round', 'bevel'}
label объект
linestyle или ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth или lw float или None
path_effects AbstractPathEffect
picker None или bool или float или вызываемый объект
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool или None
transform Transform
url str
visible bool
zorder float

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

__init__(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)[source]

Есть два способа определения стрелки:

  • Если заданы 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
CurveB -> head_length=0.4, head_width=0.2
BracketB -[ widthB=1.0, lengthB=0.2, angleB=None
CurveFilledB -|> head_length=0.4, head_width=0.2
CurveA <- head_length=0.4, head_width=0.2
CurveAB <-> head_length=0.4, head_width=0.2
CurveFilledA <|- head_length=0.4, head_width=0.2
CurveFilledAB <|-|> head_length=0.4, head_width=0.2
BracketA ]- widthA=1.0, lengthA=0.2, angleA=None
BracketAB ]-[ widthA=1.0, lengthA=0.2, angleA=None, widthB=1.0, lengthB=0.2, angleB=None
Fancy fancy head_length=0.4, head_width=0.4, tail_width=0.4
Simple simple head_length=0.5, head_width=0.5, tail_width=0.2
Wedge wedge tail_width=0.3, shrink_factor=0.5
BarAB |-| widthA=1.0, angleA=None, widthB=1.0, angleB=None
connectionstylestr or ConnectionStyle or None, optional, default: 'arc3'

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

Класс Имя Атрибуты
Angle angle angleA=90, angleB=0, rad=0.0
Angle3 angle3 angleA=90, angleB=0
Arc arc angleA=0, angleB=0, armA=None, armB=None, rad=0.0
Arc3 arc3 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 в настоящее время используется для параметров, связанных с шириной линии, и коэффициентом уменьшения. Масштаб изменения от этого зависит. Устарело.

Другие параметры:
**kwargsPatch properties, optional

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

Свойство Описание
agg_filter функция фильтрации, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha скаляр или None
animated bool
antialiased or aa unknown
capstyle CapStyle or {'butt', 'projecting', 'round'}
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
color color
contains unknown
edgecolor or ec color or None or 'auto'
facecolor or fc color or None
figure Figure
fill bool
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle JoinStyle or {'miter', 'round', 'bevel'}
label object
linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth or lw float or None
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
zorder float

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

__module__ = 'matplotlib.patches'
__str__()[source]

Возвращает str(self).

draw(renderer)[source]

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

Это не оказывает никакого эффекта, если художник не виден (Artist.get_visible возвращает False).

Параметры:
rendererRendererBase subclass.

Примечания

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

get_arrowstyle()[source]

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

get_connectionstyle()[source]

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

get_dpi_cor()[source]

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

Возвращает:
scalar

Примечания

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

get_mutation_aspect()[source]

Возвращает коэффициент пропорций мутации bbox.

get_mutation_scale()[source]

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

Возвращает:
scalar
get_path()[source]

Возвращает путь стрелки в координатах данных. Используйте метод get_path_in_displaycoord() для получения пути стрелки в координатах отображения.

get_path_in_displaycoord()[source]

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

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

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

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

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

set_arrowstyle("Fancy,head_length=0.2")

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

set_arrowstyle("fancy", head_length=0.2)
set_connectionstyle(connectionstyle, **kw)[source]

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

Параметры:
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)[source]

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

Параметры:
dpi_corfloat

Примечания

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

set_mutation_aspect(aspect)[source]

Устанавливает коэффициент пропорций мутации bbox.

Параметры:
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

Bar of pie

Bar of pie

Arrow guide

Arrow guide

Connect Simple01

Connect Simple01

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

Spec-Zone.ru

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