mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar

classmpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar(transform, size, label, loc, pad=0.1, borderpad=0.1, sep=2, frameon=True, size_vertical=0, color='black', label_top=False, fontproperties=None, fill_bar=None, **kwargs)[source]

Bases: matplotlib.offsetbox.AnchoredOffsetbox

Отобразить горизонтальную шкалу с центрированной подписью снизу.

Параметры

transformmatplotlib.transforms.Transform

Объект преобразования для используемой системы координат, т.е. matplotlib.axes.Axes.transData.

sizefloat

Горизонтальная длина шкалы, заданная в координатах transform.

labelstr

Текст для отображения.

locstr

Расположение. Допустимые расположения: 'верхний слева', 'верхний центр', 'верхний справа', 'центр слева', 'центр', 'центр справа', 'нижний слева', 'нижний центр', 'нижний справа'. Для обратной совместимости также принимаются числовые значения. См. параметр loc в Legend для получения подробностей.

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

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

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

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

sepfloat, по умолчанию: 2

Отступ между подписью и шкалой, в пунктах.

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

Если True, рисуется рамка вокруг горизонтальной шкалы и подписи.

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

Вертикальная длина шкалы, заданная в координатах transform.

colorstr, по умолчанию: 'черный'

Цвет шкалы и подписи.

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

Если True, подпись будет над шкалой.

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

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

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

Если True и если size_vertical не равно нулю, шкала будет заполнена цветом, указанным для шкалы. По умолчанию True, если size_vertical больше нуля, и False в противном случае.

**kwargs

Ключевые аргументы, передаваемые в AnchoredOffsetbox.

Примечания

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

Примеры

>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> from mpl_toolkits.axes_grid1.anchored_artists import (
...     AnchoredSizeBar)
>>> fig, ax = plt.subplots()
>>> ax.imshow(np.random.random((10, 10)))
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 data units', 4)
>>> ax.add_artist(bar)
>>> fig.show()

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

>>> import matplotlib.font_manager as fm
>>> fontprops = fm.FontProperties(size=14, family='monospace')
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 units', 4, pad=0.5,
...                       sep=5, borderpad=0.5, frameon=False,
...                       size_vertical=0.5, color='white',
...                       fontproperties=fontprops)

Атрибуты

size_barmatplotlib.offsetbox.AuxTransformBox

Контейнер для шкалы.

txt_labelmatplotlib.offsetbox.TextArea

Контейнер для подписи шкалы.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

Установка нескольких свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
agg_filter	функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив
alpha	скаляр или None
animated	булево значение
bbox_to_anchor	неизвестно
child	неизвестно
clip_box	Bbox
clip_on	булево значение
clip_path	объект Patch или (Path, Transform) или None
figure	Figure
gid	строка
height	вещественное число
in_layout	булево значение
label	объект
offset	(вещественное число, вещественное число) или вызываемый объект
path_effects	AbstractPathEffect
picker	None или bool или вещественное число или вызываемый объект
rasterized	булево значение
sketch_params	(масштаб: вещественное число, длина: вещественное число, случайность: вещественное число)
snap	булево значение или None
transform	Transform
url	строка
visible	булево значение
width	вещественное число
zorder	вещественное число

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