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 的左下角创建内嵌坐标系,其高度为 parent_axes 的 30%,宽度为 40%。由于 inset_axes 在超出此类标准情况时使用可能变得有些复杂,因此建议阅读 示例

参数:
parent_axesmatplotlib.axes.Axes

放置内嵌坐标系的坐标系。

width, height浮点数或字符串

要创建的内嵌坐标系的大小。如果提供的是浮点数,则表示以英寸为单位的大小,例如 width=1.3。如果提供的是字符串,则表示以相对单位表示的大小,例如 width='40%'。默认情况下,即如果未指定 bbox_to_anchorbbox_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' (右下)。为了向后兼容,也接受数字值。有关详细信息,请参见 Legendloc 参数。

bbox_to_anchor元组或 BboxBase,可选

内嵌坐标系将锚定到的边界框。如果为 None,则在 bbox_transform 设置为 parent_axes.transAxesparent_axes.figure.transFigure 时使用 (0, 0, 1, 1) 元组。否则,使用 parent_axes.bbox。如果为元组,可以是 [left, bottom, width, height] 或 [left, bottom]。如果 width 和/或 height 参数以相对单位指定,则不能使用 2-元组 [left, bottom]。请注意,除非设置了 bbox_transform,否则边界框的单位将被解释为像素坐标(这取决于 dpi)。当使用带有元组的 bbox_to_anchor 时,通常也需要指定 bbox_transform。这通常可以是坐标系变换 parent_axes.transAxes

bbox_transformTransform,可选

包含内嵌坐标系的边界框的变换。如果为 None,则使用 transforms.IdentityTransformbbox_to_anchor 的值(或其 get_points 方法的返回值)通过 bbox_transform 进行变换,然后被解释为像素坐标中的点(这取决于 dpi)。您可以提供一些归一化坐标中的 bbox_to_anchor,并提供一个适当的变换(例如,parent_axes.transAxes)。

axes_classAxes 类型,默认值: HostAxes

新创建的内嵌坐标系的类型。

axes_kwargs字典,可选

传递给内嵌坐标系构造函数的关键字参数。有效参数包括

属性

描述

adjustable (可调整的)

{'box', 'datalim'}

agg_filter (聚合过滤器)

一个过滤函数,它接受一个 (m, n, 3) 浮点数组和一个 dpi 值,并返回一个 (m, n, 3) 数组以及图像左下角的两个偏移量

alpha (透明度)

浮点数或 None

anchor

(float, float) 或 {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

animated (动画)

布尔值

aspect (长宽比)

{'auto', 'equal'} 或 float

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

color (颜色)

figure

FigureSubFigure

forward_navigation_events (转发导航事件)

bool 或 "auto"

frame_on (边框开启)

布尔值

gid

str (字符串)

in_layout (在布局中)

布尔值

label (标签)

object (对象)

mouseover (鼠标悬停)

布尔值

navigate (导航)

布尔值

navigate_mode (导航模式)

未知

path_effects

list of AbstractPathEffect (AbstractPathEffect 列表)

picker (拾取器)

None 或 布尔值 或 浮点数 或 可调用对象

position (位置)

[left, bottom, width, height] 或 Bbox

prop_cycle (属性循环器)

Cycler

rasterization_zorder (栅格化Z轴顺序)

浮点数或 None

rasterized (栅格化)

布尔值

sketch_params

(scale: 浮点数, length: 浮点数, randomness: 浮点数)

snap (对齐)

布尔值或 None

subplotspec

未知

title (标题)

str (字符串)

transform (变换)

变换

url

str (字符串)

visible (可见性)

布尔值

xbound

(lower: float, upper: float) (下限: 浮点数, 上限: 浮点数)

xlabel (X轴标签)

str (字符串)

xlim (X轴范围)

(left: float, right: float) (左: 浮点数, 右: 浮点数)

xmargin (X轴边距)

float 大于 -0.5

xscale (X轴刻度)

未知

xticklabels (X轴刻度标签)

未知

xticks (X轴刻度)

未知

ybound

(lower: float, upper: float) (下限: 浮点数, 上限: 浮点数)

ylabel (Y轴标签)

str (字符串)

ylim (Y轴范围)

(bottom: float, top: float) (下: 浮点数, 上: 浮点数)

ymargin (Y轴边距)

float 大于 -0.5

yscale (Y轴刻度)

未知

yticklabels (Y轴刻度标签)

未知

yticks (Y轴刻度)

未知

zorder (Z轴顺序)

浮点数

borderpadfloat, 默认值:0.5

内嵌坐标系与 bbox_to_anchor 之间的填充。单位是坐标系字体大小,即对于默认字体大小 10 磅,borderpad = 0.5 等效于 5 磅的填充。

返回:
inset_axesaxes_class

创建的内嵌坐标系对象。

备注

bbox_to_anchorbbox_to_transform 的含义与 legend 的解释不同。bbox_to_anchor 的值(或其 get_points 方法的返回值;默认是 parent_axes.bbox)通过 bbox_transform 进行变换(默认是 Identity 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 的示例#

使用插入坐标轴控制颜色条的位置和大小

使用插入坐标轴控制颜色条的位置和大小

插入定位器演示

插入定位器演示