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:
AnchoredOffsetboxОтображает горизонтальную шкалу с подписью, выровненной по центру под ней.
- Параметры:
-
-
transform
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, по умолчанию: 'black'
-
Цвет шкалы и подписи.
- label_topbool, по умолчанию: False
-
Если True, подпись будет над шкалой.
-
fontproperties
FontProperties, необязательно -
Свойства шрифта для текста подписи.
- fill_barbool, необязательно
-
Если True и size_vertical не равно нулю, шкала будет заполнена цветом, указанным для шкалы. По умолчанию True, если size_vertical больше нуля и False в противном случае.
- **kwargs
-
Ключевые параметры, передаваемые в
AnchoredOffsetbox.
-
transform
- Атрибуты:
-
-
size_bar
AuxTransformBox -
Контейнер для шкалы.
-
txt_label
TextArea -
Контейнер для подписи шкалы.
-
size_bar
Примечания
Если 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)
- 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>, mouseover=<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]
-
Установка нескольких свойств сразу.
Поддерживаемые свойства:
Свойство
Описание
функция фильтра, которая принимает (m, n, 3) массив с плавающей точкой и значение dpi и возвращает (m, n, 3) массив и два смещения от нижнего левого угла изображения
скаляр или None
булево значение
неизвестно
неизвестно
BboxBaseили Noneбулево значение
объект Patch или (Path, Transform) или None
строка
число с плавающей точкой
булево значение
объект
булево значение
(число с плавающей точкой, число с плавающей точкой) или вызываемый объект
список объектов
AbstractPathEffectNone или булево значение или число с плавающей точкой или вызываемый объект
булево значение
(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
булево значение или None
строка
булево значение
число с плавающей точкой
число с плавающей точкой
Примеры использования mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar
© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/stable/api/_as_gen/mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar.html