Spec-Zone.ru › Matplotlib 3.4

mpl_toolkits.axes_grid1.inset_locator.inset_axes

mpl_toolkits.axes_grid1.inset_locator.inset_axes(parent_axes, width, height, loc='верхний правый', 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=3)

создаёт вставные оси в левом нижнем углу 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. В противном случае они интерпретируются относительно заданного значения bbox_to_anchor.

locint или str, по умолчанию: 1

Местоположение для размещения вставных осей. Допустимые местоположения:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4,
'right'        : 5,
'center left'  : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center'       : 10
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 тип, необязательно

Если указано, создаваемые вставные оси будут созданы с конструктором этого класса.

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

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

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

Demo Colorbar of Inset Axes

Демонстрация полосы цвета вставленных осей

Controlling the position and size of colorbars with Inset Axes

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

Inset Locator Demo

Демонстрация Inset Locator

Overview of axes_grid1 toolkit

Обзор набора инструментов axes_grid1

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

Spec-Zone.ru

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