Spec-Zone.ru › Matplotlib 3.1

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

Настраиваемый объект стрелки. Рисует стрелку с использованием ArrowStyle.

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

Если заданы posA и posB, создаётся путь, соединяющий две точки, согласно connectionstyle. Путь будет обрезаться с помощью patchA и patchB и дополнительно уменьшен с помощью shrinkA и shrinkB. Стрелка рисуется вдоль этого получившегося пути с использованием параметра arrowstyle.

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

Параметры:
posA, posB : None, tuple, optional (default: None)

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

path : None, Path (default: None)

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

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

Описывает, как будет нарисована настраиваемая стрелка. Это может быть строка с именами доступных стилей стрелок с необязательными параметрами, разделёнными запятыми, или экземпляр 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
arrow_transmuter

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

connectionstyle : str, ConnectionStyle, or None, optional
(по умолчанию: 'arc3')

Описывает, как соединяются 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
connector

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

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

Патч головы и хвоста соответственно. Экземпляр класса 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 в настоящее время используется для вещей, связанных с шириной линии и коэффициентом уменьшения. Масштаб мутации зависит от этого.

Примечания

Допустимые значения kwargs:

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

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

get_arrowstyle(self) [source]

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

get_connectionstyle(self) [source]

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

get_dpi_cor(self) [source]

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

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

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

get_mutation_scale(self) [source]

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

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

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

get_path_in_displaycoord(self) [source]

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

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

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

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

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

set_arrowstyle("Fancy,head_length=0.2")

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

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

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

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

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

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

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

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

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

set_dpi_cor(self, dpi_cor) [source]

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

Параметры:
dpi_cor : scalar
set_mutation_aspect(self, aspect) [source]

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

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

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

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

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

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

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

set_patchB(self, patchB) [source]

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

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

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

set_positions(self, posA, posB) [source]

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

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

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

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

../../_images/sphx_glr_arrow_guide_thumb.png

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

../../_images/sphx_glr_connectionstyle_demo_thumb.png

Демонстрация стиля соединения

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

Spec-Zone.ru

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