Spec-Zone.ru › Matplotlib 3.6

mpl_toolkits.axes_grid1.inset_locator.inset_axes

mpl_toolkits.axes_grid1.inset_locator.inset_axes(parent_axes, width, height, loc='upper right', bbox_to_anchor=None, bbox_transform=None, axes_class=None, axes_kwargs=None, borderpad=0.5)[source]

Создать вставную область с заданной шириной и высотой.

Оба размера можно задать в дюймах или процентах. Например:

inset_axes(parent_axes, width='40%', height='30%', loc='lower left')

создаёт вставную область в левом нижнем углу parent_axes, которая занимает 30% по высоте и 40% по ширине от parent_axes. Поскольку использование inset_axes может стать немного сложным при выходе за рамки таких стандартных случаев, рекомендуется прочитать примеры.

Параметры:
parent_axesmatplotlib.axes.Axes

Область, в которую необходимо поместить вставную область.

width, heightfloat или str

Размер вставной области. Если указано число, то размер в дюймах, например, width=1.3. Если указана строка, то размер в относительных единицах, например, width='40%'. По умолчанию, если не заданы bbox_to_anchor или bbox_transform, они относятся к parent_axes. В противном случае они относятся к заданной прямоугольной области.

locstr, по умолчанию: 'upper right'

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

bbox_to_anchorкортеж или matplotlib.transforms.BboxBase, необязательно

Прямоугольная область, к которой будет привязана вставная область. Если None, используется кортеж (0, 0, 1, 1), если bbox_transform равен parent_axes.transAxes или parent_axes.figure.transFigure. В противном случае используется parent_axes.bbox. Если кортеж, может быть либо [left, bottom, width, height], либо [left, bottom]. Если параметры width и/или height заданы в относительных единицах, то 2-кортеж [left, bottom] использовать нельзя. Обратите внимание, что если bbox_transform не задан, единицы прямоугольной области интерпретируются в пикселях. При использовании bbox_to_anchor с кортежем, почти всегда имеет смысл также указать bbox_transform. Это часто может быть преобразование осей parent_axes.transAxes.

bbox_transformmatplotlib.transforms.Transform, необязательно

Преобразование для прямоугольной области, содержащей вставную область. Если None, используется transforms.IdentityTransform. Значение bbox_to_anchor (или возвращаемое значение его метода get_points) преобразуется с помощью bbox_transform и затем интерпретируется как координаты в пикселях (что зависит от dpi). Вы можете указать bbox_to_anchor в некоторых нормированных координатах и задать соответствующее преобразование (например, parent_axes.transAxes).

axes_classmatplotlib.axes.Axes тип, по умолчанию: HostAxes

Тип вновь созданной вставной области.

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

Ключевые аргументы для передачи в конструктор вставной области. Допустимые аргументы включают:

Свойство

Описание

adjustable

{'box', 'datalim'}

agg_filter

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

alpha

скаляр или None

anchor

(число, число) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated

bool

aspect

{'auto', 'equal'} или число

autoscale_on

bool

autoscalex_on

неизвестно

autoscaley_on

неизвестно

axes_locator

Callable[[Axes, Renderer], Bbox]

axisbelow

bool или 'line'

box_aspect

число или None

clip_box

Bbox

clip_on

bool

clip_path

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

facecolor или fc

цвет

figure

Figure

frame_on

bool

gid

строка

in_layout

bool

label

объект

mouseover

bool

navigate

bool

navigate_mode

неизвестно

path_effects

AbstractPathEffect

picker

None или bool или число или вызываемый объект

position

[левый, нижний, ширина, высота] или Bbox

prop_cycle

неизвестно

rasterization_zorder

число или None

rasterized

bool

sketch_params

(масштаб: число, длина: число, случайность: число)

snap

bool или None

title

строка

transform

Transform

url

строка

visible

bool

xbound

неизвестно

xlabel

строка

xlim

(нижняя граница: число, верхняя граница: число)

xmargin

число больше -0,5

xscale

неизвестно

xticklabels

неизвестно

xticks

неизвестно

ybound

неизвестно

ylabel

строка

ylim

(нижняя граница: float, верхняя граница: float)

ymargin

значение float, большее -0.5

yscale

неизвестно

yticklabels

неизвестно

yticks

неизвестно

zorder

float

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

Отступ между вставленными осями и прямоугольником bbox_to_anchor. Единицы — размер шрифта осей, т.е. для стандартного размера шрифта 10 пунктов borderpad = 0.5 соответствует отступу в 5 пунктов.

Возвращает:
inset_axesaxes_class

Созданный объект вставленных осей.

Примечания

Значения bbox_to_anchor и bbox_to_transform интерпретируются иначе, чем для легенды. Значение bbox_to_anchor (или результат его метода get_points; по умолчанию — parent_axes.bbox) преобразуется с помощью bbox_transform (по умолчанию — тождественное преобразование) и затем интерпретируется как точка в системе координат пикселей (зависит от dpi).

Следующие три вызова идентичны и создают вставленные оси относительно parent_axes:

axins = inset_axes(parent_axes, "30%", "40%")
axins = inset_axes(parent_axes, "30%", "40%",
                   bbox_to_anchor=parent_axes.bbox)
axins = inset_axes(parent_axes, "30%", "40%",
                   bbox_to_anchor=(0, 0, 1, 1),
                   bbox_transform=parent_axes.transAxes)

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

Adding a colorbar to inset axes

Добавление цветовой шкалы к вставленным осям

Добавление цветовой шкалы к вставленным осям
Controlling the position and size of colorbars with Inset Axes

Управление позицией и размером цветовых шкал с помощью вставленных осей

Управление позицией и размером цветовых шкал с помощью вставленных осей
Inset Locator Demo

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

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

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

Spec-Zone.ru

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