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)[源代码]

基类：matplotlib.offsetbox.AnchoredOffsetbox

画一个水平比例尺，下面有一个居中对齐的标签。

参数:
转型 ： matplotlib.transforms.Transformmatplotlib.transforms.Transform

正在使用的坐标系的转换对象，即， matplotlib.axes.Axes.transData .

size浮动

尺寸栏的水平长度，以坐标表示 转型 .

labelSTR

要显示的标签。

loc利息

此尺寸栏的位置。有效的位置代码为：

'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浮点，默认值：0.1

在标签和大小栏周围填充，以字体大小的分数表示。

borderpad浮点，默认值：0.1

边框填充，以字体大小的分数表示。

sep浮动，默认值：2

标签和尺寸栏之间的分隔，以点为单位。

frameonbool，默认值：True

如果为True，则在水平条和标签周围绘制一个框。

size_vertical浮点，默认值：0

尺寸栏的垂直长度，以坐标表示 转型 .

colorstr，默认值：'黑色'

尺寸栏和标签的颜色。

label_topbool，默认值：False

如果为True，则标签将位于尺寸栏上方。

字体属性 ： matplotlib.font_manager.FontProperties 可选matplotlib.font_manager.fontproperties，可选

标签文本的字体属性。

fill_bar可选的布尔

如果为“真”，并且“垂直大小”不为零，则尺寸栏将填充尺寸栏指定的颜色。默认为true if size_vertical 大于零，否则为假。

**kwargs

要传递给的关键字参数 matplotlib.offsetbox.AnchoredOffsetbox .

笔记

如果 prop 作为关键字参数传递，但 字体属性 不是，那么 prop 假定为预期 字体属性 . 同时使用 prop 和 字体属性 不支持。

实例

>>> 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.AuxTransformBoxmatplotlib.offsetbox.AuxTransformBox

大小栏的容器。

txt_label ： matplotlib.offsetbox.TextAreamatplotlib.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)[源代码]

画一个水平比例尺，下面有一个居中对齐的标签。

参数:
转型 ： matplotlib.transforms.Transformmatplotlib.transforms.Transform

正在使用的坐标系的转换对象，即， matplotlib.axes.Axes.transData .

size浮动

尺寸栏的水平长度，以坐标表示 转型 .

labelSTR

要显示的标签。

loc利息

此尺寸栏的位置。有效的位置代码为：

'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浮点，默认值：0.1

在标签和大小栏周围填充，以字体大小的分数表示。

borderpad浮点，默认值：0.1

边框填充，以字体大小的分数表示。

sep浮动，默认值：2

标签和尺寸栏之间的分隔，以点为单位。

frameonbool，默认值：True

如果为True，则在水平条和标签周围绘制一个框。

size_vertical浮点，默认值：0

尺寸栏的垂直长度，以坐标表示 转型 .

colorstr，默认值：'黑色'

尺寸栏和标签的颜色。

label_topbool，默认值：False

如果为True，则标签将位于尺寸栏上方。

字体属性 ： matplotlib.font_manager.FontProperties 可选matplotlib.font_manager.fontproperties，可选

标签文本的字体属性。

fill_bar可选的布尔

如果为“真”，并且“垂直大小”不为零，则尺寸栏将填充尺寸栏指定的颜色。默认为true if size_vertical 大于零，否则为假。

**kwargs

要传递给的关键字参数 matplotlib.offsetbox.AnchoredOffsetbox .

笔记

如果 prop 作为关键字参数传递，但 字体属性 不是，那么 prop 假定为预期 字体属性 . 同时使用 prop 和 字体属性 不支持。

实例

>>> 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.AuxTransformBoxmatplotlib.offsetbox.AuxTransformBox

大小栏的容器。

txt_label ： matplotlib.offsetbox.TextAreamatplotlib.offsetbox.TextArea

大小栏标签的容器。
__module__ = 'mpl_toolkits.axes_grid1.anchored_artists'

使用实例 mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar