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