matplotlib.patches.ArrowStyle

классmatplotlib.patches.ArrowStyle(stylename, **kwargs)[исходный код]

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

ArrowStyle — это класс-контейнер, определяющий несколько классов стилей стрелок, которые используются для создания контура стрелки вдоль заданного пути. В основном они используются с FancyArrowPatch.

Объект стиля стрелки можно создать следующим образом:

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
CurveA	<-	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveB	->	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveAB	<->	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveFilledA	<|-	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveFilledB	-|>	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
CurveFilledAB	<|-|>	head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None
BracketA	]-	widthA=1.0, lengthA=0.2, angleA=0
BracketB	-[	widthB=1.0, lengthB=0.2, angleB=0
BracketAB	]-[	widthA=1.0, lengthA=0.2, angleA=0, widthB=1.0, lengthB=0.2, angleB=0
BarAB	|-|	widthA=1.0, angleA=0, widthB=1.0, angleB=0
BracketCurve	]->	widthA=1.0, lengthA=0.2, angleA=None
CurveBracket	<-[	widthB=1.0, lengthB=0.2, angleB=None
Simple	simple	head_length=0.5, head_width=0.5, tail_width=0.2
Fancy	fancy	head_length=0.4, head_width=0.4, tail_width=0.4
Wedge	wedge	tail_width=0.3, shrink_factor=0.5

Обзор внешнего вида см. в разделе Справочник по стилям стрелок для аннотаций.

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

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

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

Примечания

angleA и angleB задают ориентацию скобки как угол по часовой стрелке или против неё, в зависимости от типа стрелки. Угол 0 градусов означает перпендикулярное положение относительно линии, соединяющей наконечник и хвост стрелки.

(Source code, 2x.png, png)

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

classBarAB(widthA=1.0, angleA=0, widthB=1.0, angleB=0)[исходный код]

Базовые классы: _Curve

Стрелка с вертикальными чертами | на обоих концах.

Параметры:

widthA, widthBfloat, по умолчанию: 1.0

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

angleA, angleBfloat, по умолчанию: 0 градусов

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

arrow='|-|'

classBracketA(widthA=1.0, lengthA=0.2, angleA=0)[исходный код]

Базовые классы: _Curve

Стрелка с выступающей квадратной скобкой в начале.

Параметры:

widthAfloat, по умолчанию: 1.0

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

lengthAfloat, по умолчанию: 0.2

Длина скобки.

angleAfloat, по умолчанию: 0 градусов

Ориентация скобки, заданная углом против часовой стрелки. Угол 0 градусов означает перпендикулярное линии положение.

arrow=']-'

classBracketAB(widthA=1.0, lengthA=0.2, angleA=0, widthB=1.0, lengthB=0.2, angleB=0)[исходный код]

Базовые классы: _Curve

Стрелка с выступающими квадратными скобками на обоих концах.

Параметры:

widthA, widthBfloat, по умолчанию: 1.0

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

lengthA, lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleA, angleBfloat, по умолчанию: 0 градусов

Ориентация скобки, заданная углом против часовой стрелки. Угол 0 градусов означает перпендикулярное линии положение.

arrow=']-['

classBracketB(widthB=1.0, lengthB=0.2, angleB=0)[исходный код]

Базовые классы: _Curve

Стрелка с выступающей квадратной скобкой в конце.

Параметры:

widthBfloat, по умолчанию: 1.0

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

lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleBfloat, по умолчанию: 0 градусов

Ориентация скобки, заданная углом против часовой стрелки. Угол 0 градусов означает перпендикулярное линии положение.

arrow='-['

classBracketCurve(widthA=1.0, lengthA=0.2, angleA=None)[исходный код]

Базовые классы: _Curve

Стрелка с выступающей квадратной скобкой в начале и наконечником в конце.

Параметры:

widthAfloat, по умолчанию: 1.0

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

lengthAfloat, по умолчанию: 0.2

Длина скобки.

angleAfloat, по умолчанию: 0 градусов

Ориентация скобки, заданная углом против часовой стрелки. Угол 0 градусов означает перпендикулярное линии положение.

arrow=']->'

classCurve[исходный код]

Bases: _Curve

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

Параметры:

head_lengthfloat, по умолчанию: 0.4

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

head_widthfloat, по умолчанию: 0.2

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

widthA, widthBfloat, по умолчанию: 1.0

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

lengthA, lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleA, angleBfloat, по умолчанию: 0

Ориентация скобки, заданная углом против часовой стрелки. Угол 0 градусов означает, что скобка перпендикулярна линии.

scaleA, scaleBfloat, по умолчанию: mutation_size

Масштаб скобок.

classCurveA(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[исходный код]

Bases: _Curve

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

Параметры:

head_lengthfloat, по умолчанию: 0.4

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

head_widthfloat, по умолчанию: 0.2

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

widthA, widthBfloat, по умолчанию: 1.0

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

lengthA, lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleA, angleBfloat, по умолчанию: 0

Ориентация скобки, заданная углом против часовой стрелки. Угол 0 градусов означает, что скобка перпендикулярна линии.

scaleA, scaleBfloat, по умолчанию: mutation_size

Масштаб скобок.

arrow='<-'

classCurveAB(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[исходный код]

Bases: _Curve

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

Параметры:

head_lengthfloat, по умолчанию: 0.4

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

head_widthfloat, по умолчанию: 0.2

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

widthA, widthBfloat, по умолчанию: 1.0

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

lengthA, lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleA, angleBfloat, по умолчанию: 0

Ориентация скобки, заданная углом против часовой стрелки. Угол 0 градусов означает, что скобка перпендикулярна линии.

scaleA, scaleBfloat, по умолчанию: mutation_size

Масштаб скобок.

arrow='<->'

classCurveB(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[исходный код]

Базовые классы: _Curve

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

Параметры:

head_lengthfloat, по умолчанию: 0.4

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

head_widthfloat, по умолчанию: 0.2

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

widthA, widthBfloat, по умолчанию: 1.0

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

lengthA, lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleA, angleBfloat, по умолчанию: 0

Ориентация скобки, задаваемая углом против часовой стрелки. Угол 0 градусов означает, что скобка перпендикулярна линии.

scaleA, scaleBfloat, по умолчанию: mutation_size

Масштаб скобок.

arrow='->'

classCurveBracket(widthB=1.0, lengthB=0.2, angleB=None)[исходный код]

Базовые классы: _Curve

Стрелка с выступающей квадратной скобкой в конечной точке и наконечником в начальной точке.

Параметры:

widthBfloat, по умолчанию: 1.0

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

lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleBfloat, по умолчанию: 0 градусов

Ориентация скобки, задаваемая углом против часовой стрелки. Угол 0 градусов означает, что скобка перпендикулярна линии.

arrow='<-['

classCurveFilledA(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[источник]

Базовые классы: _Curve

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

Параметры:

head_lengthfloat, по умолчанию: 0.4

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

head_widthfloat, по умолчанию: 0.2

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

widthA, widthBfloat, по умолчанию: 1.0

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

lengthA, lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleA, angleBfloat, по умолчанию: 0

Ориентация скобки, заданная углом против часовой стрелки. Угол 0 градусов означает, что скобка перпендикулярна линии.

scaleA, scaleBfloat, по умолчанию: mutation_size

Масштаб скобок.

arrow='<|-'

classCurveFilledAB(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[источник]

Базовые классы: _Curve

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

Параметры:

head_lengthfloat, по умолчанию: 0.4

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

head_widthfloat, по умолчанию: 0.2

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

widthA, widthBfloat, по умолчанию: 1.0

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

lengthA, lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleA, angleBfloat, по умолчанию: 0

Ориентация скобки, заданная углом против часовой стрелки. Угол 0 градусов означает, что скобка перпендикулярна линии.

scaleA, scaleBfloat, по умолчанию: mutation_size

Масштаб скобок.

arrow='<|-|>'

classCurveFilledB(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[источник]

Базовые классы: _Curve

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

Параметры:

head_lengthfloat, по умолчанию: 0.4

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

head_widthfloat, по умолчанию: 0.2

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

widthA, widthBfloat, по умолчанию: 1.0

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

lengthA, lengthBfloat, по умолчанию: 0.2

Длина скобки.

angleA, angleBfloat, по умолчанию: 0

Ориентация скобки, задаваемая углом против часовой стрелки. Угол 0 градусов означает, что скобка перпендикулярна линии.

scaleA, scaleBfloat, по умолчанию: mutation_size

Масштаб скобок.

arrow='-|>'

classFancy(head_length=0.4, head_width=0.4, tail_width=0.4)[источник]

Базовые классы: _Base

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

Параметры:

head_lengthfloat, по умолчанию: 0.4

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

head_widthfloat, по умолчанию: 0.4

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

tail_widthfloat, по умолчанию: 0.4

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

transmute(path, mutation_size, linewidth)[источник]

Метод transmute — основа класса ArrowStyle, поэтому его необходимо переопределять в подклассах. Он принимает объект path, вдоль которого будет нарисована стрелка, и mutation_size, с помощью которого будет масштабирован наконечник стрелки и другие элементы. Параметр linewidth можно использовать для корректировки пути, чтобы он не выходил за заданные точки. Метод возвращает кортеж из экземпляра Path и логического значения. Логическое значение указывает, можно ли закрасить путь. Возвращаемым значением также может быть список путей и список логических значений той же длины.

classSimple(head_length=0.5, head_width=0.5, tail_width=0.2)[исходный код]

Базовый класс: _Base

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

Параметры:

head_lengthfloat, по умолчанию: 0.5

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

head_widthfloat, по умолчанию: 0.5

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

tail_widthfloat, по умолчанию: 0.2

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

transmute(path, mutation_size, linewidth)[исходный код]

Метод transmute — основа класса ArrowStyle; он должен переопределяться в подклассах. Метод получает объект path, вдоль которого будет нарисована стрелка, и значение mutation_size, задающее масштаб наконечника стрелки и других элементов. Параметр linewidth можно использовать для корректировки пути, чтобы он не выходил за заданные точки. Метод возвращает кортеж из экземпляра Path и логического значения. Логическое значение указывает, можно ли залить путь. Также возвращаемым значением может быть список путей и список логических значений той же длины.

classWedge(tail_width=0.3, shrink_factor=0.5)[исходный код]

Базовый класс: _Base

Форма клина (?). Работает только с квадратичной кривой Безье. Ширина начальной точки равна tail_width, а ширина конечной точки равна 0. В середине ширина равна shrink_factor*x*tail_width.

Параметры:

tail_widthfloat, по умолчанию: 0.3

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

shrink_factorfloat, по умолчанию: 0.5

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

transmute(path, mutation_size, linewidth)[исходный код]

Метод transmute — основа класса ArrowStyle; он должен переопределяться в подклассах. Метод получает объект path, вдоль которого будет нарисована стрелка, и значение mutation_size, задающее масштаб наконечника стрелки и других элементов. Параметр linewidth можно использовать для корректировки пути, чтобы он не выходил за заданные точки. Метод возвращает кортеж из экземпляра Path и логического значения. Логическое значение указывает, можно ли залить путь. Также возвращаемым значением может быть список путей и список логических значений той же длины.

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

Угловые аннотации на стрелках со скобками

Угловые аннотации на стрелках со скобками

Справочник по стилям стрелок для аннотаций

Справочник по стилям стрелок для аннотаций