Spec-Zone.ru › Matplotlib 3.0

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=3)

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

Параметры:
parent_axes : matplotlib.axes.Axes

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

width, height : float or str

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

loc : int or string, optional, default to 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 : tuple or matplotlib.transforms.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_transform : matplotlib.transforms.Transform, optional

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

axes_class : matplotlib.axes.Axes type, optional

Если указано, созданная вставная область будет создана с помощью конструктора этого класса.

axes_kwargs : dict, optional

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

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

Отступ между вставленным графиком и bbox_to_anchor. По умолчанию 0,5. Единицы - размер шрифта графика, т.е. для стандартного размера шрифта 10 пунктов borderpad = 0.5 эквивалентен отступу в 5 пунктов.

Возвращает:
inset_axes : axes_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

../../_images/sphx_glr_demo_colorbar_of_inset_axes_thumb.png

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

../../_images/sphx_glr_demo_colorbar_with_inset_locator_thumb.png

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

../../_images/sphx_glr_inset_locator_demo_thumb.png

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

../../_images/sphx_glr_inset_locator_demo_thumb.png

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

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

Spec-Zone.ru

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