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

Создаёт вставленные оси заданной ширины и высоты.

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

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

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

Параметры:

parent_axesmatplotlib.axes.Axes

Оси, в которые нужно поместить вставленные оси.

width, heightчисло с плавающей точкой или строка

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

locстрока, по умолчанию: 'upper right'

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

bbox_to_anchorкортеж или 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 заданы в относительных единицах, использовать кортеж из двух элементов [left, bottom] нельзя. Обратите внимание: если не задан bbox_transform, единицы измерения ограничивающей рамки интерпретируются в пиксельных координатах. При использовании кортежа в bbox_to_anchor почти всегда имеет смысл также указать bbox_transform. Часто это преобразование осей parent_axes.transAxes.

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

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

axes_classтип Axes, по умолчанию: HostAxes

Тип создаваемых вставленных осей.

axes_kwargsсловарь, необязательный

Именованные аргументы, передаваемые конструктору вставленных осей. Допустимые аргументы:

Свойство	Описание
adjustable	{'box', 'datalim'}
agg_filter	функция фильтра, принимающая массив чисел с плавающей точкой формы (m, n, 3) и значение dpi и возвращающая массив формы (m, n, 3) и два смещения от левого нижнего угла изображения
alpha	число с плавающей точкой или None
anchor	(число с плавающей точкой, число с плавающей точкой) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated	логическое значение
aspect	{'auto', 'equal'} или число с плавающей точкой
autoscale_on	логическое значение
autoscalex_on	неизвестно
autoscaley_on	неизвестно
axes_locator	Callable[[Axes, Renderer], Bbox]
axisbelow	логическое значение или 'line'
box_aspect	число с плавающей точкой или None
clip_box	BboxBase или None
clip_on	логическое значение
clip_path	Patch или (Path, Transform), или None
facecolor или fc	цвет
figure	Figure или SubFigure
forward_navigation_events	логическое значение или "auto"
frame_on	логическое значение
gid	строка
in_layout	логическое значение
label	объект
mouseover	логическое значение
navigate	логическое значение
navigate_mode	неизвестно
path_effects	список объектов AbstractPathEffect
picker	None, логическое значение, число с плавающей точкой или вызываемый объект
position	[left, bottom, width, height] или Bbox
prop_cycle	Cycler
rasterization_zorder	число с плавающей точкой или None
rasterized	логическое значение
sketch_params	(scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой)
snap	логическое значение или None
subplotspec	неизвестно
title	строка
transform	Transform
url	строка
visible	логическое значение
xbound	(lower: число с плавающей точкой, upper: число с плавающей точкой)
xlabel	строка
xlim	(left: число с плавающей точкой, right: число с плавающей точкой)
xmargin	число с плавающей точкой больше -0.5
xscale	неизвестно
xticklabels	неизвестно
xticks	неизвестно
ybound	(lower: число с плавающей точкой, upper: число с плавающей точкой)
ylabel	строка
ylim	(bottom: число с плавающей точкой, top: число с плавающей точкой)
ymargin	число с плавающей точкой больше -0.5
yscale	неизвестно
yticklabels	неизвестно
yticks	неизвестно
zorder	число с плавающей точкой

borderpadчисло с плавающей точкой, по умолчанию: 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

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

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

Демонстрация inset locator

Демонстрация inset locator