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]

Базы: matplotlib.offsetbox.AnchoredOffsetbox

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

Параметры:

transformmatplotlib.transforms.Transform Объект преобразования для используемой системы координат, т.е., matplotlib.axes.Axes.transData. sizefloat Горизонтальная длина шкалы, заданная в координатах transform. labelstr Текст подписи. locint Положение шкалы. Допустимые значения: '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 padfloat, по умолчанию: 0.1 Отступ вокруг подписи и шкалы, в долях размера шрифта. borderpadfloat, по умолчанию: 0.1 Отступ от границы, в долях размера шрифта. sepfloat, по умолчанию: 2 Отступ между подписью и шкалой, в пунктах. frameonbool, по умолчанию: True Если True, рисуется рамка вокруг шкалы и подписи. size_verticalfloat, по умолчанию: 0 Вертикальная длина шкалы, заданная в координатах transform. colorstr, по умолчанию: 'black' Цвет шкалы и подписи. label_topbool, по умолчанию: False Если True, подпись будет над шкалой. fontpropertiesmatplotlib.font_manager.FontProperties, необязательно Свойства шрифта для текста подписи. fill_barbool, необязательно Если True и если size_vertical не равно нулю, шкала будет залита цветом, указанным для шкалы. По умолчанию True, если size_vertical больше нуля, и False в противном случае. **kwargs Аргументы ключевого слова для передачи в matplotlib.offsetbox.AnchoredOffsetbox.

Примечания

Если prop передан в качестве аргумента ключевого слова, но fontproperties нет, тогда prop будет предположен как intended 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 Контейнер для подписи шкалы.

__init__(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]

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

Параметры:

transformmatplotlib.transforms.Transform Объект преобразования для используемой системы координат, т.е., matplotlib.axes.Axes.transData. sizefloat Горизонтальная длина шкалы, заданная в координатах transform. labelstr Текст подписи. locint Положение шкалы. Допустимые значения: '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 padfloat, по умолчанию: 0.1 Отступ вокруг подписи и шкалы, в долях размера шрифта. borderpadfloat, по умолчанию: 0.1 Отступ от границы, в долях размера шрифта. sepfloat, по умолчанию: 2 Отступ между подписью и шкалой, в пунктах. frameonbool, по умолчанию: True Если True, рисуется рамка вокруг шкалы и подписи. size_verticalfloat, по умолчанию: 0 Вертикальная длина шкалы, заданная в координатах transform. colorstr, по умолчанию: 'black' Цвет шкалы и подписи. label_topbool, по умолчанию: False Если True, подпись будет над шкалой. fontpropertiesmatplotlib.font_manager.FontProperties, необязательно Свойства шрифта для текста подписи. fill_barbool, необязательно Если True и если size_vertical не равно нулю, шкала будет залита цветом, указанным для шкалы. По умолчанию True, если size_vertical больше нуля, и False в противном случае. **kwargs Аргументы ключевого слова для передачи в matplotlib.offsetbox.AnchoredOffsetbox.

Примечания

Если prop передан в качестве аргумента ключевого слова, но fontproperties нет, тогда prop будет предположен как intended 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 Контейнер для подписи шкалы.

__module__ = 'mpl_toolkits.axes_grid1.anchored_artists'

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

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

Простые закрепленные элементы