Spec-Zone.ru › Matplotlib 3.2

matplotlib.patches.ArrowStyle

class matplotlib.patches.ArrowStyle(stylename, **kw) [source]

Базовые классы: matplotlib.patches._Style

ArrowStyle является контейнерным классом, который определяет несколько классов arrowstyle, используемых для создания пути стрелки вдоль заданного пути. Они в основном используются с FancyArrowPatch.

Объект arrowstyle может быть создан как:

ArrowStyle.Fancy(head_length=.4, head_width=.4, tail_width=.4)

или:

ArrowStyle("Fancy", head_length=.4, head_width=.4, tail_width=.4)

или:

ArrowStyle("Fancy, head_length=.4, head_width=.4, tail_width=.4")

Определены следующие классы

Класс Имя Атрибуты
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

Экземпляр любого класса стиля стрелки является вызываемым объектом, сигнатура вызова которого:

__call__(self, path, mutation_size, linewidth, aspect_ratio=1.)

и он возвращает кортеж из экземпляра Path и булевого значения. path - это экземпляр Path, вдоль которого будет нарисована стрелка. mutation_size и aspect_ratio имеют то же значение, что и в BoxStyle. linewidth - это ширина линии для обводки. Предполагается, что это используется для коррекции местоположения головки, чтобы она не перекрывала конечную точку, но не все классы поддерживают это.

Возвращает экземпляр подкласса с заданным именем стиля.

class BarAB(widthA=1.0, angleA=None, widthB=1.0, angleB=None) [source]

Базовые классы: matplotlib.patches.ArrowStyle._Bracket

Стрелка с чертой (|) на обоих концах.

Параметры:
widthAfloat, optional, default

Ширина скобки

angleAfloat, optional, default

Угол между скобкой и линией

widthBfloat, optional, default

Ширина скобки

angleBfloat, optional, default

Угол между скобкой и линией

class BracketA(widthA=1.0, lengthA=0.2, angleA=None) [source]

Базовые классы: matplotlib.patches.ArrowStyle._Bracket

Стрелка со скобкой (]) на конце.

Параметры:
widthAfloat, optional, default

Ширина скобки

lengthAfloat, optional, default

Длина скобки

angleAfloat, optional, default

Угол между скобкой и линией

class BracketAB(widthA=1.0, lengthA=0.2, angleA=None, widthB=1.0, lengthB=0.2, angleB=None) [source]

Базовые классы: matplotlib.patches.ArrowStyle._Bracket

Стрелка со скобками (]) на обоих концах.

Параметры:
widthAfloat, optional, default

Ширина скобки

lengthAfloat, optional, default

Длина скобки

angleAfloat, optional, default

Угол между скобкой и линией

widthBfloat, optional, default

Ширина скобки

lengthBfloat, optional, default

Длина скобки

angleBfloat, optional, default

Угол между скобкой и линией

class BracketB(widthB=1.0, lengthB=0.2, angleB=None) [source]

Базовые классы: matplotlib.patches.ArrowStyle._Bracket

Стрелка со скобкой ([) на конце.

Параметры:
widthBfloat, optional, default

Ширина скобки

lengthBfloat, optional, default

Длина скобки

angleBfloat, optional, default

Угол между скобкой и линией

class Curve [source]

Базовые классы: matplotlib.patches.ArrowStyle._Curve

Простая кривая без наконечника стрелки.

Стрелки рисуются, если beginarrow и/или endarrow истинны. head_length и head_width определяют размер стрелки относительно масштаба мутации. Наконечник стрелки в начале (или конце) закрыт, если fillbegin (или fillend) истинно.

class CurveA(head_length=0.4, head_width=0.2) [source]

Базовые классы: matplotlib.patches.ArrowStyle._Curve

Стрелка с наконечником в начальной точке.

Параметры:
head_lengthfloat, optional, default

Длина наконечника стрелки

head_widthfloat, optional, default

Ширина наконечника стрелки

class CurveAB(head_length=0.4, head_width=0.2) [source]

Базовые классы: matplotlib.patches.ArrowStyle._Curve

Стрелка с наконечниками в начальной и конечной точках.

Параметры:
head_lengthfloat, optional, default

Длина наконечника стрелки

head_widthfloat, optional, default

Ширина наконечника стрелки

class CurveB(head_length=0.4, head_width=0.2) [source]

Базовые классы: matplotlib.patches.ArrowStyle._Curve

Стрелка с наконечником в конечной точке.

Параметры:
head_lengthfloat, optional, default

Длина наконечника стрелки

head_widthfloat, optional, default

Ширина наконечника стрелки

class CurveFilledA(head_length=0.4, head_width=0.2) [source]

Базовые классы: matplotlib.patches.ArrowStyle._Curve

Стрелка с заполненным треугольным наконечником в начале.

Параметры:
head_lengthfloat, optional, default

Длина наконечника стрелки

head_widthfloat, optional, default

Ширина наконечника стрелки

class CurveFilledAB(head_length=0.4, head_width=0.2) [source]

Базовые классы: matplotlib.patches.ArrowStyle._Curve

Стрелка с заполненными треугольными наконечниками на обоих концах.

Параметры:
head_lengthfloat, optional, default

Длина наконечника стрелки

head_widthfloat, optional, default

Ширина наконечника стрелки

class CurveFilledB(head_length=0.4, head_width=0.2) [source]

Bases: matplotlib.patches.ArrowStyle._Curve

Стрелка с заполненным треугольным наконечником в конце.

Параметры:
head_lengthfloat, optional, default

Длина наконечника стрелки

head_widthfloat, optional, default

Ширина наконечника стрелки

class Fancy(head_length=0.4, head_width=0.4, tail_width=0.4) [source]

Bases: matplotlib.patches.ArrowStyle._Base

Изящная стрелка. Работает только с квадратичной кривой Безье.

Параметры:
head_lengthfloat, optional, default

Длина наконечника стрелки

head_widthfloat, optional, default

Ширина наконечника стрелки

tail_widthfloat, optional, default

Ширина хвоста стрелки

transmute(self, path, mutation_size, linewidth) [source]

Метод transmute является ядром класса ArrowStyle и должен быть переопределён в подклассах. Он получает объект пути, по которому будет нарисована стрелка, и размер мутации, с которым будет масштабироваться наконечник стрелки и т.д. Ширина линии может использоваться для корректировки пути, чтобы он не выходил за заданные точки. Возвращает кортеж объекта Path и булево значение. Булево значение указывает, можно ли заполнить путь. Возвращаемое значение также может быть списком путей и списком булевых значений одинаковой длины.

class Simple(head_length=0.5, head_width=0.5, tail_width=0.2) [source]

Bases: matplotlib.patches.ArrowStyle._Base

Простая стрелка. Работает только с квадратичной кривой Безье.

Параметры:
head_lengthfloat, optional, default

Длина наконечника стрелки

head_widthfloat, optional, default

Ширина наконечника стрелки

tail_widthfloat, optional, default

Ширина хвоста стрелки

transmute(self, path, mutation_size, linewidth) [source]

Метод transmute является ядром класса ArrowStyle и должен быть переопределён в подклассах. Он получает объект пути, по которому будет нарисована стрелка, и размер мутации, с которым будет масштабироваться наконечник стрелки и т.д. Ширина линии может использоваться для корректировки пути, чтобы он не выходил за заданные точки. Возвращает кортеж объекта Path и булево значение. Булево значение указывает, можно ли заполнить путь. Возвращаемое значение также может быть списком путей и списком булевых значений одинаковой длины.

class Wedge(tail_width=0.3, shrink_factor=0.5) [source]

Bases: matplotlib.patches.ArrowStyle._Base

Форма клина. Работает только с квадратичной кривой Безье. Начальная точка имеет ширину хвоста, а конечная - ширину 0. В середине ширина уменьшается до shrink_factor * tail_width.

Параметры:
tail_widthfloat, optional, default

Ширина хвоста

shrink_factorfloat, optional, default

Доля ширины стрелки в средней точке

transmute(self, path, mutation_size, linewidth) [source]

Метод transmute является ядром класса ArrowStyle и должен быть переопределён в подклассах. Он получает объект пути, по которому будет нарисована стрелка, и размер мутации, с которым будет масштабироваться наконечник стрелки и т.д. Ширина линии может использоваться для корректировки пути, чтобы он не выходил за заданные точки. Возвращает кортеж объекта Path и булево значение. Булево значение указывает, можно ли заполнить путь. Возвращаемое значение также может быть списком путей и списком булевых значений одинаковой длины.

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

Fancyarrow Demo

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

© 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.ArrowStyle.html

Spec-Zone.ru

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