Spec-Zone.ru › Matplotlib 3.3

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=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), default: None

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

pathPath, default: None

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

arrowstylestr or ArrowStyle, 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
connectionstylestr or ConnectionStyle or None, optional, default: 'arc3'

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

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

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

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

Свойство Описание
agg_filter функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
alpha float или None
animated bool
antialiased или aa неизвестно
capstyle {'butt', 'round', 'projecting'}
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 строка
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle {'miter', 'round', 'bevel'}
label объект
linestyle или ls {'-', '--', '-.', ':', '', (смещение, последовательность включения/выключения), ...}
linewidth или lw float или None
path_effects AbstractPathEffect
picker None или bool или вызываемая функция
rasterized bool или None
sketch_params (масштаб: float, длина: float, случайность: float)
snap bool или None
transform Transform
url строка
visible bool
zorder float

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

__init__(self, posA=None, posB=None, path=None, arrowstyle='simple', connectionstyle='arc3', patchA=None, patchB=None, shrinkA=2, shrinkB=2, mutation_scale=1, mutation_aspect=None, dpi_cor=1, **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, с помощью которого рисуется стрелка. Если строка, то она должна быть одним из имеющихся имён стилей стрелки, с необязательными параметрами, разделёнными запятыми. Необязательные параметры предназначены для масштабирования с помощью 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. Если строка, то она должна быть одним из имеющихся имён стилей соединения, с необязательными параметрами, разделёнными запятыми. Доступны следующие стили соединения:

Класс Имя Атрибуты
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 функция фильтра, которая принимает массив чисел с плавающей точкой (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".

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

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

draw(self, renderer) [source]

Отрисовывает объект Artist (и его дочерние элементы) с помощью данного рендерера.

Это не имеет эффекта, если объект Artist не видим (Artist.get_visible возвращает False).

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

Примечания

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

get_arrowstyle(self) [source]

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

get_connectionstyle(self) [source]

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

get_dpi_cor(self) [source]

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

Возвращает:
скаляр
get_mutation_aspect(self) [source]

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

get_mutation_scale(self) [source]

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

Возвращает:
скаляр
get_path(self) [source]

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

get_path_in_displaycoord(self) [source]

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

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

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

Параметры:
arrowstyleNone or ArrowStyle or str, 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_corfloat
set_mutation_aspect(self, aspect) [source]

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

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

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

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

Устанавливает пластырь начала.

Параметры:
patchApatches.Patch
set_patchB(self, patchB) [source]

Устанавливает пластырь конца.

Параметры:
patchBpatches.Patch
set_positions(self, posA, posB) [source]

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

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

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

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

Диаграмма круга с баром

Диаграмма круга с баром

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

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

Подключить Simple01

Подключить Simple01

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

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

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

Spec-Zone.ru

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