mpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows

class mpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows(transform, label_x, label_y, length=0.15, fontsize=0.08, loc=2, angle=0, aspect_ratio=1, pad=0.4, borderpad=0.4, frameon=False, color='w', alpha=1, sep_x=0.01, sep_y=0, fontproperties=None, back_length=0.15, head_width=10, head_length=15, tail_width=2, text_props=None, arrow_props=None, **kwargs) [source]

Bases: matplotlib.offsetbox.AnchoredOffsetbox

Отображает две перпендикулярные стрелки для указания направлений.

Параметры:

transformmatplotlib.transforms.Transform Объект преобразования для используемой системы координат, т. е. matplotlib.axes.Axes.transAxes. label_x, label_ystr Текст меток для стрелок x и y. lengthfloat, default: 0.15 Длина стрелки, заданная в координатах transform. fontsizefloat, default: 0.08 Размер текстовых строк, заданный в координатах transform. locint, default: 2 Расположение стрелок направления. Допустимые коды расположения: 'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4, 'right' : 5, 'center left' : 6, 'center right' : 7, 'lower center' : 8, 'upper center' : 9, 'center' : 10 anglefloat, default: 0 Угол стрелок в градусах. aspect_ratiofloat, default: 1 Соотношение длины стрелок arrow_x и arrow_y. Отрицательные числа могут быть использованы для изменения направления. padfloat, default: 0.4 Отступ вокруг меток и стрелок, в долях размера шрифта. borderpadfloat, default: 0.4 Отступ границы, в долях размера шрифта. frameonbool, default: False Если True, рисуется рамка вокруг стрелок и меток. colorstr, default: 'white' Цвет стрелок и меток. alphafloat, default: 1 Значения альфа-канала стрелок и меток. sep_x, sep_yfloat, default: 0.01 and 0 respectively Расстояние между стрелками и метками в координатах transform. fontpropertiesmatplotlib.font_manager.FontProperties, optional Свойства шрифта для текста метки. back_lengthfloat, default: 0.15 Доля стрелки позади пересечения стрелки. head_widthfloat, default: 10 Ширина головки стрелки, передаваемая в ArrowStyle. head_lengthfloat, default: 15 Длина головки стрелки, передаваемая в ArrowStyle. tail_widthfloat, default: 2 Ширина хвоста стрелки, передаваемая в ArrowStyle. text_props, arrow_propsdict Свойства текста и стрелок, передаваемые в textpath.TextPath и patches.FancyArrowPatch. **kwargs Ключевые аргументы для передачи в matplotlib.offsetbox.AnchoredOffsetbox.

Примечания

Если prop передан в качестве ключевого аргумента, но fontproperties нет, то prop считается предполагаемым fontproperties. Использование как prop, так и fontproperties не поддерживается.

Примеры

>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> from mpl_toolkits.axes_grid1.anchored_artists import (
...     AnchoredDirectionArrows)
>>> fig, ax = plt.subplots()
>>> ax.imshow(np.random.random((10, 10)))
>>> arrows = AnchoredDirectionArrows(ax.transAxes, '111', '110')
>>> ax.add_artist(arrows)
>>> fig.show()

Использование нескольких необязательных параметров, создание стрелок, направленных вниз, и меток с высоким контрастом.

>>> import matplotlib.font_manager as fm
>>> fontprops = fm.FontProperties(family='monospace')
>>> arrows = AnchoredDirectionArrows(ax.transAxes, 'East', 'South',
...                                  loc='lower left', color='k',
...                                  aspect_ratio=-1, sep_x=0.02,
...                                  sep_y=-0.01,
...                                  text_props={'ec':'w', 'fc':'k'},
...                                  fontproperties=fontprops)

Атрибуты:	arrow_x, arrow_ymatplotlib.patches.FancyArrowPatch Стрелки x и y text_path_x, text_path_ymatplotlib.textpath.TextPath Путь для меток стрелок. p_x, p_ymatplotlib.patches.PathPatch Объект-патч для меток стрелок. boxmatplotlib.offsetbox.AuxTransformBox Контейнер для стрелок и меток.

__init__(self, transform, label_x, label_y, length=0.15, fontsize=0.08, loc=2, angle=0, aspect_ratio=1, pad=0.4, borderpad=0.4, frameon=False, color='w', alpha=1, sep_x=0.01, sep_y=0, fontproperties=None, back_length=0.15, head_width=10, head_length=15, tail_width=2, text_props=None, arrow_props=None, **kwargs) [source]

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

Параметры:

transformmatplotlib.transforms.Transform Объект преобразования для используемой системы координат, т.е. matplotlib.axes.Axes.transAxes. label_x, label_ystr Текст метки для стрелок по осям x и y. lengthfloat, default: 0.15 Длина стрелки, заданная в координатах transform. fontsizefloat, default: 0.08 Размер текстовых меток, заданный в координатах transform. locint, default: 2 Расположение стрелок. Допустимые значения: 'upper right' : 1, 'upper left' : 2, 'lower left' : 3, 'lower right' : 4, 'right' : 5, 'center left' : 6, 'center right' : 7, 'lower center' : 8, 'upper center' : 9, 'center' : 10 anglefloat, default: 0 Угол стрелок в градусах. aspect_ratiofloat, default: 1 Соотношение длин стрелок arrow_x и arrow_y. Отрицательные значения могут быть использованы для изменения направления. padfloat, default: 0.4 Отступ вокруг меток и стрелок, в долях размера шрифта. borderpadfloat, default: 0.4 Отступ границы, в долях размера шрифта. frameonbool, default: False Если True, отобразить рамку вокруг стрелок и меток. colorstr, default: 'white' Цвет стрелок и меток. alphafloat, default: 1 Значения alpha для стрелок и меток. sep_x, sep_yfloat, default: 0.01 and 0 respectively Расстояние между стрелками и метками в координатах transform. fontpropertiesmatplotlib.font_manager.FontProperties, optional Свойства шрифта для текстовых меток. back_lengthfloat, default: 0.15 Доля стрелки, находящейся за пересечением. head_widthfloat, default: 10 Ширина головки стрелки, передается в ArrowStyle. head_lengthfloat, default: 15 Длина головки стрелки, передается в ArrowStyle. tail_widthfloat, default: 2 Ширина хвоста стрелки, передается в ArrowStyle. text_props, arrow_propsdict Свойства текста и стрелок, передаются в textpath.TextPath и patches.FancyArrowPatch. **kwargs Ключевые аргументы для передачи в matplotlib.offsetbox.AnchoredOffsetbox.

Примечания

Если prop передаётся в качестве ключевого аргумента, но fontproperties нет, то prop считается предполагаемым fontproperties. Использование как prop, так и fontproperties не поддерживается.

Примеры

>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> from mpl_toolkits.axes_grid1.anchored_artists import (
...     AnchoredDirectionArrows)
>>> fig, ax = plt.subplots()
>>> ax.imshow(np.random.random((10, 10)))
>>> arrows = AnchoredDirectionArrows(ax.transAxes, '111', '110')
>>> ax.add_artist(arrows)
>>> fig.show()

Использование нескольких необязательных параметров, создание стрелки вниз и высококонтрастных меток текста.

>>> import matplotlib.font_manager as fm
>>> fontprops = fm.FontProperties(family='monospace')
>>> arrows = AnchoredDirectionArrows(ax.transAxes, 'East', 'South',
...                                  loc='lower left', color='k',
...                                  aspect_ratio=-1, sep_x=0.02,
...                                  sep_y=-0.01,
...                                  text_props={'ec':'w', 'fc':'k'},
...                                  fontproperties=fontprops)

Атрибуты:	arrow_x, arrow_ymatplotlib.patches.FancyArrowPatch Стрелки по осям x и y. text_path_x, text_path_ymatplotlib.textpath.TextPath Путь для меток стрелок. p_x, p_ymatplotlib.patches.PathPatch Объект для меток стрелок. boxmatplotlib.offsetbox.AuxTransformBox Контейнер для стрелок и меток.

__module__ = 'mpl_toolkits.axes_grid1.anchored_artists'

Примеры использования mpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows

Демонстрация привязанной стрелки направления