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_axes
matplotlib.axes.Axes -
Область, в которую помещается вставная область.
- width, heightfloat или str
-
Размер вставной области. Если указано число, это размер в дюймах, например, width=1.3. Если указана строка, это размер в относительных единицах, например, width='40%'. По умолчанию, то есть если не указаны bbox_to_anchor или bbox_transform, они относительны к parent_axes. В противном случае они должны интерпретироваться относительно указанной области bbox_to_anchor.
- 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кортеж или
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_transform
Transform, необязательно -
Преобразование для области, содержащей вставную область. Если None, используется
transforms.IdentityTransform. Значение bbox_to_anchor (или возвращаемое значение его метода get_points) преобразуется с помощью bbox_transform и затем интерпретируется как точки в координатах пикселей (зависит от dpi). Вы можете указать bbox_to_anchor в некоторых нормализованных координатах и предоставить соответствующее преобразование (например, parent_axes.transAxes). -
axes_class
Axesтип, по умолчанию:HostAxes -
Тип вновь созданной вставной области.
- axes_kwargsdict, необязательно
-
Ключевые параметры для передачи в конструктор вставной области. Допустимые параметры включают:
-
parent_axes
Свойство
Описание
{'box', 'datalim'}
функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
скаляр или None
(float, float) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
bool
{'auto', 'equal'} или float
bool
неизвестно
неизвестно
Callable[[Axes, Renderer], Bbox]
bool или 'line'
float или None
BboxBaseили Nonebool
Patch или (Path, Transform) или None
facecolorили fcцвет
bool
str
bool
объект
bool
bool
неизвестно
список
AbstractPathEffectNone или bool или float или вызываемый объект
[левый, нижний, ширина, высота] или
Bboxfloat или None
bool
(масштаб: float, длина: float, случайность: float)
bool или None
неизвестно
str
str
bool
(нижний: float, верхний: float)
str
(левый: float, правый: float)
float больше, чем -0.5
неизвестно
неизвестно
неизвестно
(нижняя граница: число с плавающей запятой, верхняя граница: число с плавающей запятой)
строка
(нижняя граница: число с плавающей запятой, верхняя граница: число с плавающей запятой)
число с плавающей запятой больше -0,5
неизвестно
неизвестно
неизвестно
число с плавающей запятой
- borderpadfloat, default: 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 (по умолчанию — Identity transform) и затем интерпретируется как точки в пиксельных координатах (что зависит от разрешения).
Таким образом, следующие три вызова идентичны и создают вставленную ось относительно 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
Управление положением и размером цветовых шкал с помощью вставленных осей
© 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.inset_locator.inset_axes.html