mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar
-
class mpl_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] -
Отображение шкалы в виде горизонтальной полосы с центрированной подписью снизу.
Параметры: -
transform : matplotlib.transforms.Transform -
Объект преобразования для используемой системы координат, т.е.
matplotlib.axes.Axes.transData. -
size : int or float -
Горизонтальная длина полосы, заданная в координатах transform.
-
label : str -
Подпись для отображения.
-
loc : int -
Расположение шкалы. Допустимые коды расположения:
'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
-
pad : int or float, optional -
Отступ вокруг подписи и полосы, в долях размера шрифта. По умолчанию 0,1.
-
borderpad : int or float, optional -
Отступ по границе, в долях размера шрифта. По умолчанию 0,1.
-
sep : int or float, optional -
Расстояние между подписью и полосой, в пунктах. По умолчанию 2.
-
frameon : bool, optional -
Если True, рисует рамку вокруг горизонтальной полосы и подписи. По умолчанию True.
-
size_vertical : int or float, optional -
Вертикальная длина полосы, заданная в координатах transform. По умолчанию 0.
-
color : str, optional -
Цвет полосы и подписи. По умолчанию чёрный.
-
label_top : bool, optional -
Если True, подпись будет над полосой. По умолчанию False.
-
fontproperties : matplotlib.font_manager.FontProperties, optional -
Свойства шрифта для текста подписи.
-
fill_bar : bool, optional -
Если True и если size_vertical не равно нулю, полоса будет заполнена цветом, указанным для полосы. По умолчанию True, если
size_verticalбольше нуля, и False в противном случае. - **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 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 : matplotlib.offsetbox.AuxTransformBox -
Контейнер для полосы.
-
txt_label : matplotlib.offsetbox.TextArea -
Контейнер для подписи полосы.
-
Примеры использования mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/2.2.3/api/_as_gen/mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar.html