Spec-Zone.ru › Matplotlib

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)[исходный код]

Базовые классы: AnchoredOffsetbox

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

Параметры:
transformTransform

Объект преобразования для используемой системы координат, то есть matplotlib.axes.Axes.transData.

sizefloat

Горизонтальная длина масштабной линейки, заданная в координатах transform.

labelstr

Отображаемая подпись.

locstr

Расположение масштабной линейки. Допустимые значения: 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center', 'lower right'. Для обратной совместимости также принимаются числовые значения. Подробности см. в описании параметра loc класса Legend.

padfloat, по умолчанию: 0.1

Отступ вокруг подписи и масштабной линейки, в долях размера шрифта.

borderpadfloat, по умолчанию: 0.1

Отступ от границы, в долях размера шрифта.

sepfloat, по умолчанию: 2

Расстояние между подписью и масштабной линейкой, в пунктах.

frameonbool, по умолчанию: True

Если True, рисует рамку вокруг горизонтальной линейки и подписи.

size_verticalfloat, по умолчанию: 0

Вертикальная длина масштабной линейки, заданная в координатах transform.

colorstr, по умолчанию: 'black'

Цвет масштабной линейки и подписи.

label_topbool, по умолчанию: False

Если True, подпись будет расположена над масштабной линейкой.

fontpropertiesFontProperties, необязательный

Свойства шрифта текста подписи.

fill_barbool, необязательный

Если True и size_vertical не равно нулю, масштабная линейка будет залита указанным для неё цветом. По умолчанию принимает значение True, если size_vertical больше нуля, и False в противном случае.

**kwargs

Именованные аргументы, передаваемые классу AnchoredOffsetbox.

Атрибуты:
size_barAuxTransformBox

Контейнер для масштабной линейки.

txt_labelTextArea

Контейнер для подписи масштабной линейки.

Примечания

Если prop передан как именованный аргумент, а fontproperties не указан, предполагается, что в качестве fontproperties нужно использовать prop. Одновременное использование 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)
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>)[исходный код]

Задать несколько свойств одновременно.

Поддерживаются следующие свойства:

Свойство

Описание

agg_filter

функция фильтрации, принимающая массив float размером (m, n, 3) и значение dpi и возвращающая массив размером (m, n, 3) и два смещения от нижнего левого угла изображения

alpha

float или None

animated

bool

bbox_to_anchor

неизвестно

child

неизвестно

clip_box

BboxBase или None

clip_on

bool

clip_path

Patch или (Path, Transform) или None

figure

Figure

gid

str

height

float

in_layout

bool

label

object

mouseover

bool

offset

(float, float) или callable

path_effects

список AbstractPathEffect

picker

None, bool, float или callable

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool или None

transform

Transform

url

str

visible

bool

width

float

zorder

float

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

Демонстрация локатора вставки 2

Демонстрация локатора вставки 2

Простые привязанные художники

Простые привязанные художники

© 2012–2026 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/stable/api/_as_gen/mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API