Spec-Zone.ru › Matplotlib 3.8

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)[source]

Bases: AnchoredOffsetbox

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

Параметры:
transformTransform

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

sizefloat

Горизонтальная длина шкалы, заданная в координатах transform.

labelstr

Текст метки.

locstr

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

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

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

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

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

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

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

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

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

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

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

colorstr, по умолчанию: 'черный'

Цвет шкалы и метки.

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

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

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

Свойства шрифта для текста метки.

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

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

**kwargs

Ключевые аргументы, передаваемые в 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_barAuxTransformBox

Контейнер для шкалы.

txt_labelTextArea

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

END_OF_DOCUMENT_MARKER
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>)[source]

Устанавливает несколько свойств сразу.

Поддерживаемые свойства

Свойство

Описание

agg_filter

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

alpha

скаляр или None

animated

bool

bbox_to_anchor

неизвестно

child

неизвестно

clip_box

BboxBase или None

clip_on

bool

clip_path

Объект Patch или (Path, Transform) или None

figure

Figure

gid

строка

height

число с плавающей точкой

in_layout

bool

label

объект

mouseover

bool

offset

(число с плавающей точкой, число с плавающей точкой) или вызываемая функция

path_effects

список AbstractPathEffect

picker

None или bool или число с плавающей точкой или вызываемая функция

rasterized

bool

sketch_params

(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)

snap

bool или None

transform

Transform

url

строка

visible

bool

width

число с плавающей точкой

zorder

число с плавающей точкой

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

Демонстрация использования инсерта

Демонстрация использования инсерта

Простые привязанные объекты

Простые привязанные объекты

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

Spec-Zone.ru

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