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]

Bases: matplotlib.offsetbox.AnchoredOffsetbox

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

Параметры:

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

Демонстрация размещения вставок

Простые привязанные элементы