Spec-Zone.ru › Matplotlib 3.4

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, по умолчанию: 0.15

Длина стрелки, заданная в координатах transform.

fontsizefloat, по умолчанию: 0.08

Размер строк меток, заданный в координатах transform.

locint, по умолчанию: 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, по умолчанию: 0

Угол стрелок в градусах.

aspect_ratiofloat, по умолчанию: 1

Соотношение длины стрелки arrow_x и arrow_y. Отрицательные числа могут использоваться для изменения направления.

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

Отступ вокруг меток и стрелок, в долях размера шрифта.

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

Отступ границы, в долях размера шрифта.

frameonbool, по умолчанию: False

Если True, рисует рамку вокруг стрелок и меток.

colorstr, по умолчанию: 'white'

Цвет стрелок и меток.

alphafloat, по умолчанию: 1

Значения альфа-канала стрелок и меток.

sep_x, sep_yfloat, по умолчанию: 0.01 и 0 соответственно

Отступ между стрелками и метками в координатах transform.

fontpropertiesmatplotlib.font_manager.FontProperties, необязательно

Свойства шрифта для текста метки.

back_lengthfloat, по умолчанию: 0.15

Доля стрелки позади пересечения стрелок.

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

Ширина головки стрелки, отправленная в ArrowStyle.

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

Длина головки стрелки, отправленная в ArrowStyle.

tail_widthfloat, по умолчанию: 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

Контейнер для стрелок и меток.

END_OF_DOCUMENT_MARKER ```
__init__(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, по умолчанию: 0.15

Длина стрелки, заданная в координатах transform.

fontsizefloat, по умолчанию: 0.08

Размер текстовых строк, заданный в координатах transform.

locint, по умолчанию: 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, по умолчанию: 0

Угол стрелок в градусах.

aspect_ratiofloat, по умолчанию: 1

Соотношение длины стрелки по оси X и оси Y. Отрицательные значения могут изменить направление.

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

Отступ вокруг меток и стрелок, в долях размера шрифта.

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

Отступ по границам, в долях размера шрифта.

frameonbool, по умолчанию: False

Если True, рисуется рамка вокруг стрелок и меток.

colorstr, по умолчанию: 'white'

Цвет стрелок и меток.

alphafloat, по умолчанию: 1

Значения альфы для стрелок и меток

sep_x, sep_yfloat, по умолчанию: 0.01 и 0 соответственно

Отступ между стрелками и метками в координатах transform.

fontpropertiesmatplotlib.font_manager.FontProperties, необязательно

Свойства шрифта для текстовых меток.

back_lengthfloat, по умолчанию: 0.15

Доля стрелки, находящейся позади пересекающейся стрелки.

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

Ширина головки стрелки, передаваемая в ArrowStyle.

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

Длина головки стрелки, передаваемая в ArrowStyle.

tail_widthfloat, по умолчанию: 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

Стрелка направления, закреплённая в позиции

Стрелка направления, закреплённая в позиции

© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/_as_gen/mpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows.html

Spec-Zone.ru

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