Spec-Zone.ru › Matplotlib 2.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)

Фигурный патч стрелки. Он рисует стрелку, используя ArrowStyle.

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

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

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

Параметры:

posA, posB : None, кортеж, необязательно (по умолчанию: None)

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

path : None, Path (по умолчанию: None)

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

arrowstyle : строка или ArrowStyle, необязательно (по умолчанию: ‘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 : строка, ConnectionStyle или None, необязательно

(по умолчанию: ‘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, необязательно (по умолчанию: None)

Патч головки и хвоста соответственно. Экземпляр matplotlib.patch.Patch.

shrinkA, shrinkB : скаляр, необязательно (по умолчанию: 2)

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

mutation_scale : скаляр, необязательно (по умолчанию: 1)

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

mutation_aspect : None, скаляр, необязательно (по умолчанию: None)

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

dpi_cor : скаляр, необязательно (по умолчанию: 1)

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

Замечания

Допустимые аргументы kwargs:

Свойство Описание
agg_filter неизвестно
alpha число с плавающей точкой или None
animated [True | False]
antialiased или aa [True | False] или None для значения по умолчанию
capstyle [‘butt’ | ‘round’ | ‘projecting’]
clip_box экземпляр matplotlib.transforms.Bbox
clip_on [True | False]
clip_path [ (Path, Transform) | Patch | None ]
color спецификация цвета matplotlib
contains вызываемая функция
edgecolor или ec спецификация цвета mpl, None, ‘none’ или ‘auto’
facecolor или fc спецификация цвета mpl или None по умолчанию, или ‘none’ для отсутствия цвета
figure экземпляр matplotlib.figure.Figure
fill [True | False]
gid строка-идентификатор
hatch [‘/’ | ‘' | ‘|’ | ‘-‘ | ‘+’ | ‘x’ | ‘o’ | ‘O’ | ‘.’ | ‘*’]
joinstyle [‘miter’ | ‘round’ | ‘bevel’]
label строка или что-либо печатное с преобразованием ‘%s’
linestyle или ls [‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (смещение, последовательность выкл-вкл) | '-' | '--' | '-.' | ':' | 'None' | ' ' | '']
linewidth или lw число с плавающей точкой или None по умолчанию
path_effects неизвестно
picker [None|число с плавающей точкой|boolean|вызываемая функция]
rasterized [True | False | None]
sketch_params неизвестно
snap неизвестно
transform экземпляр Transform
url строка url
visible [True | False]
zorder любое число
draw(renderer)
get_arrowstyle()

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

get_connectionstyle()

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

get_dpi_cor()

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

Возвращает: dpi_cor : скаляр
get_mutation_aspect()

Возвращает коэффициент формы изменения bbox.

get_mutation_scale()

Возвращает масштаб изменения.

Возвращает: scale : скаляр
get_path()

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

get_path_in_displaycoord()

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

set_arrowstyle(arrowstyle=None, **kw)

Устанавливает стиль стрелки. Старые атрибуты забываются. Без аргументов (или с 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(connectionstyle, **kw)

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

Параметры:

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(dpi_cor)

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

Параметры: dpi_cor : скаляр
set_mutation_aspect(aspect)

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

Параметры: aspect : скаляр
set_mutation_scale(scale)

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

Параметры: scale : скаляр
set_patchA(patchA)

Устанавливает патч хвоста.

Параметры:

patchA : Patch

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

set_patchB(patchB)

Устанавливает патч головки.

Параметры:

patchB : Patch

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

set_positions(posA, posB)

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

Параметры:

posA, posB : None, кортеж

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

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

Spec-Zone.ru

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