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 может стать несколько сложным при выходе за рамки стандартных случаев, рекомендуется ознакомиться с примерами.

Parameters:

parent_axesmatplotlib.axes.Axes

Ось, на которой будет размещена вставная ось.

width, heightfloat or str

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

locstr, default: 'upper right'

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

bbox_to_anchortuple or BboxBase, optional

Прямоугольник, к которому будет привязана вставная ось. Если 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_transformTransform, optional

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

axes_classAxes type, default: HostAxes

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

axes_kwargsdict, optional

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

Свойство	Описание
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
forward_navigation_events	логическое значение или "auto"
frame_on	логическое значение
gid	строка
in_layout	логическое значение
label	объект
mouseover	логическое значение
navigate	логическое значение
navigate_mode	неизвестно
path_effects	список из AbstractPathEffect
picker	None или логическое значение или число с плавающей точкой или вызываемая функция
position	[левый, нижний, ширина, высота] или Bbox
prop_cycle	Cycler
rasterization_zorder	число с плавающей точкой или None
rasterized	логическое значение
sketch_params	(масштаб: число, длина: число, случайность: число)
snap	логическое значение или None
subplotspec	неизвестно
title	строка
transform	Transform
url	строка
visible	логическое значение
xbound	(нижняя граница: число, верхняя граница: число)
xlabel	строка
xlim	(левый край: число, правый край: число)
xmargin	число, большее чем -0.5
xscale	неизвестно

xticklabels	неизвестно
xticks	неизвестно
ybound	(нижняя граница: число, верхняя граница: число)
ylabel	строка
ylim	(нижняя граница: число, верхняя граница: число)
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

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

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

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

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