Spec-Zone.ru › Matplotlib 3.2

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]

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

Фигура стрелки с изменённой формой. Она рисует стрелку с помощью ArrowStyle.

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

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

  • Если заданы posA и posB, создаётся путь, соединяющий две точки в соответствии с connectionstyle. Путь будет обрезаться с помощью patchA и patchB и дополнительно сжиматься с помощью shrinkA и shrinkB. Стрелка рисуется вдоль этого получившегося пути с помощью параметра arrowstyle.
  • В качестве альтернативы, если задан path, стрелка рисуется вдоль этого пути, и patchA, patchB, shrinkA и shrinkB игнорируются.
Параметры:
posA, posB(float, float), optional (default: None)

(x, y) координаты начала и конца стрелки соответственно.

pathPath, optional (default: None)

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

arrowstylestr 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

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

connectionstylestr or ConnectionStyle or None, optional (default: '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, patchBPatch, optional (default: None)

Соответствующие фигуры начала и конца стрелки. Экземпляр класса matplotlib.patch.Patch.

shrinkA, shrinkBfloat, optional (default: 2)

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

mutation_scalefloat, optional (default: 1)

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

mutation_aspectNone or float, optional (default: None)

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

dpi_corfloat, optional (default: 1)

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

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

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

Свойство Описание
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 Patch или (Path, Transform) или 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 число с плавающей точкой

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

draw(self, renderer) [source]

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

get_arrowstyle(self) [source]

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

get_connectionstyle(self) [source]

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

get_dpi_cor(self) [source]

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

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

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

get_mutation_scale(self) [source]

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

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

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

get_path_in_displaycoord(self) [source]

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

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

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

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

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

set_arrowstyle("Fancy,head_length=0.2")

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

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

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

Параметры:
connectionstylestr or ConnectionStyle or None, optional

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

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_corscalar
set_mutation_aspect(self, aspect) [source]

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

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

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

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

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

Параметры:
patchAPatch

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

set_patchB(self, patchB) [source]

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

Параметры:
patchBPatch

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

set_positions(self, posA, posB) [source]

Установите начальные и конечные координаты соединительной траектории.

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

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

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

Столбик-пирог

Столбик-пирог

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

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

Connect Simple01

Connect Simple01

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

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

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

Spec-Zone.ru

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