matplotlib.quiver.QuiverKey

classmatplotlib.quiver.QuiverKey(Q, X, Y, U, label, *, angle=0, coordinates='axes', color=None, labelsep=0.1, labelpos='N', labelcolor=None, fontproperties=None, zorder=None, **kwargs)[исходный код]

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

Подписанная стрелка для использования в качестве ключа масштаба на графике векторного поля.

Добавляет ключ к графику векторного поля.

Положение ключа зависит от X, Y, coordinates и labelpos. Если labelpos равен 'N' или 'S', X и Y задают положение середины стрелки ключа. Если labelpos равен 'E', X и Y задают положение наконечника, а если labelpos равен 'W' — положение хвоста; в обоих случаях X и Y находятся примерно посередине объекта ключа, состоящего из стрелки и метки.

Параметры:

QQuiver

Объект Quiver, возвращаемый при вызове quiver().

X, Yfloat

Расположение ключа.

Ufloat

Длина ключа.

labelstr

Метка ключа (например, длина и единицы измерения ключа).

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

Угол стрелки ключа в градусах против часовой стрелки относительно горизонтальной оси.

coordinates{'axes', 'figure', 'data', 'inches'}, по умолчанию: 'axes'

Система координат и единицы измерения для X и Y: 'axes' и 'figure' — нормированные системы координат, в которых (0, 0) находится внизу слева, а (1, 1) — вверху справа; 'data' — координаты данных осей (используются для расположения векторов на самом графике векторного поля); 'inches' — положение на рисунке в дюймах, причём (0, 0) находится в левом нижнем углу.

colorцвет

Переопределяет цвета заливки и границы, заданные в Q.

labelpos{'N', 'S', 'E', 'W'}

Размещает метку соответственно над стрелкой, под ней, справа или слева от неё.

labelsepfloat, по умолчанию: 0.1

Расстояние в дюймах между стрелкой и меткой.

labelcolorцвет, по умолчанию: rcParams["text.color"] (по умолчанию: 'black')

Цвет метки.

fontpropertiesdict, необязательно

Словарь с именованными аргументами, принимаемыми инициализатором FontProperties: family, style, variant, size, weight.

zorderfloat

Порядок отрисовки ключа. По умолчанию он на 0.1 выше, чем у Q.

**kwargs

Любые дополнительные именованные аргументы используются для переопределения свойств векторов, унаследованных от Q.

contains(mouseevent)[исходный код]

Проверяет, содержит ли объект Artist событие мыши.

Параметры:

mouseeventMouseEvent

Возвращает:

containsbool

Находятся ли какие-либо значения в пределах радиуса.

detailsdict

Словарь сведений о контексте события, специфичный для объекта Artist, например о том, какие точки попадают в радиус выбора. Подробности см. в описании соответствующих подклассов Artist.

draw(renderer)[исходный код]

Отрисовывает объект Artist (и его дочерние объекты) с помощью указанного средства отрисовки.

Метод ничего не делает, если объект Artist не виден (метод Artist.get_visible возвращает False).

Параметры:

rendererподкласс RendererBase.

Примечания

Этот метод переопределён в подклассах Artist.

halign={'E': 'left', 'N': 'center', 'S': 'center', 'W': 'right'}

propertylabelsep

pivot={'E': 'tip', 'N': 'middle', 'S': 'middle', 'W': 'tail'}

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[исходный код]

Одновременно задаёт несколько свойств.

Поддерживаются следующие свойства:

Свойство	Описание
agg_filter	функция фильтра, принимающая массив float размером (m, n, 3) и значение dpi и возвращающая массив размером (m, n, 3) и два смещения от левого нижнего угла изображения
alpha	float или None
animated	bool
clip_box	BboxBase или None
clip_on	bool
clip_path	Patch или (Path, Transform), или None
figure	неизвестно
gid	str
in_layout	bool
label	object
mouseover	bool
path_effects	список объектов AbstractPathEffect
picker	None, bool, float или вызываемый объект
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool или None
transform	Transform
url	str
visible	bool
zorder	float

set_figure(fig)[исходный код]

Задаёт экземпляр Figure или SubFigure, которому принадлежит объект Artist.

Параметры:

figFigure или SubFigure

valign={'E': 'center', 'N': 'bottom', 'S': 'top', 'W': 'center'}

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

Расширенные функции quiver и quiverkey

Расширенные функции quiver и quiverkey