Spec-Zone.ru › Matplotlib 3.0

matplotlib.patches.FancyArrowPatch

class matplotlib.patches.FancyArrowPatch(posA=None, posB=None, path=None, arrowstyle='simple', arrow_transmuter=None, connectionstyle='arc3', connector=None, patchA=None, patchB=None, shrinkA=2, shrinkB=2, mutation_scale=1, mutation_aspect=None, dpi_cor=1, **kwargs) [source]

Bases: matplotlib.patches.Patch

A fancy arrow patch. It draws an arrow using the ArrowStyle.

The head and tail positions are fixed at the specified start and end points of the arrow, but the size and shape (in display coordinates) of the arrow does not change when the axis is moved or zoomed.

If posA and posB are given, a path connecting two points is created according to connectionstyle. The path will be clipped with patchA and patchB and further shrunken by shrinkA and shrinkB. An arrow is drawn along this resulting path using the arrowstyle parameter.

Alternatively if path is provided, an arrow is drawn along this path and patchA, patchB, shrinkA, and shrinkB are ignored.

Parameters:
posA, posB : None, tuple, optional (default: None)

(x,y) coordinates of arrow tail and arrow head respectively.

path : None, Path (default: None)

matplotlib.path.Path instance. If provided, an arrow is drawn along this path and patchA, patchB, shrinkA, and shrinkB are ignored.

arrowstyle : str or ArrowStyle, optional (default: 'simple')

Describes how the fancy arrow will be drawn. It can be string of the available arrowstyle names, with optional comma-separated attributes, or an ArrowStyle instance. The optional attributes are meant to be scaled with the mutation_scale. The following arrow styles are available:

Class Name Attrs
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
arrow_transmuter :

Игнорируется

connectionstyle : str, ConnectionStyle, or None, optional
(default: 'arc3')

Описывает, как posA и posB соединяются. Это может быть экземпляр класса ConnectionStyle или строка имени 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
connector :

Игнорируется

patchA, patchB : None, Patch, optional (default: None)

Соответствующие patch-объекты хвоста и головки стрелки. matplotlib.patch.Patch экземпляр.

shrinkA, shrinkB : scalar, optional (default: 2)

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

mutation_scale : scalar, optional (default: 1)

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

mutation_aspect : None, scalar, optional (default: None)

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

dpi_cor : scalar, optional (default: 1)

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

Notes

Valid kwargs are:

Свойство Описание
agg_filter функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3)
alpha число с плавающей точкой или None
animated булево значение
antialiased неизвестно
capstyle {'butt', 'round', 'projecting'}
clip_box Bbox
clip_on булево значение
clip_path [(Path, Transform) | Patch | None]
color цвет
contains вызываемый объект
edgecolor цвет или None или 'auto'
facecolor цвет или None
figure Figure
fill булево значение
gid строка
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout булево значение
joinstyle {'miter', 'round', 'bevel'}
label объект
linestyle {'-', '--', '-.', ':', '', (смещение, последовательность включений/выключений), ...}
linewidth число с плавающей точкой или None для значения по умолчанию
path_effects AbstractPathEffect
picker None или булево значение или число с плавающей точкой или вызываемый объект
rasterized булево значение или None
sketch_params (масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
snap булево значение или None
transform Transform
url строка
visible булево значение
zorder число с плавающей точкой
draw(renderer) [source]

Отрисовка Patch на заданном renderer.

get_arrowstyle() [source]

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

get_connectionstyle() [source]

Возвращает экземпляр ConnectionStyle.

get_dpi_cor() [source]

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

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

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

get_mutation_scale() [source]

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

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

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

get_path_in_displaycoord() [source]

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

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

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

Параметры:
arrowstyle : None, ArrowStyle, str, optional (default: None)

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

set_arrowstyle("Fancy,head_length=0.2")

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

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

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

Параметры:
connectionstyle : None, ConnectionStyle instance, or string

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

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_cor : scalar
set_mutation_aspect(aspect) [source]

Установить коэффициент масштаба мутации bbox.

Параметры:
aspect : scalar
set_mutation_scale(scale) [source]

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

Параметры:
scale : scalar
set_patchA(patchA) [source]

Установить хвостовую область.

Параметры:
patchA : Patch

matplotlib.patch.Patch экземпляр.

set_patchB(patchB) [source]

Установить головную область.

Параметры:
patchB : Patch

matplotlib.patch.Patch экземпляр.

set_positions(posA, posB) [source]

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

Параметры:
posA, posB : None, tuple

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

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

../../_images/sphx_glr_arrow_guide_thumb.png

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

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

Spec-Zone.ru

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