matplotlib.inset#

inset 模块定义了 InsetIndicator 类，该类用于绘制 Axes.indicate_inset 和 Axes.indicate_inset_zoom 所需的矩形和连接线。

class matplotlib.inset.InsetIndicator(bounds=None, inset_ax=None, zorder=None, **kwargs)[source]#

基类: Artist

用于突出显示感兴趣区域的艺术家对象（Artist）。

插图指示器（Inset indicator）是绘图上位于 bounds 所指位置的一个矩形，可选择性地包含连接该矩形与插图坐标轴（Axes.inset_axes）的连线。

自 3.10 版本新增。

参数:
bounds[x0, y0, width, height], 可选

待标记矩形的左下角坐标，及其宽度和高度。如果未设置，将根据必须提供的 inset_ax 的数据范围计算边界。

inset_axAxes, 可选

用于绘制连接线的可选插图坐标轴。绘制两条连接指示框与插图坐标轴的线，连接点位置的选择旨在避免与指示框重叠。

zorderfloat, 默认值: 4.99

矩形和连接线的绘图顺序。默认值 4.99 略低于插图坐标轴的默认层级。

**kwargs

其他关键字参数将传递给 Rectangle 补丁。

property axes#

Artist 所驻留的 Axes 实例，若无则为 None。

property connectors#
包含 4 个 patches.ConnectionPatch 或 None 的元组

连接至 inset_ax 四个角（左下、左上、右下、右上）的四条连接线。默认其中两条线的可见性设置为 False，但如果用户认为自动选择的结果不合适，可以将可见性设为 True。

draw(renderer)[source]#

使用给定的渲染器绘制 Artist（及其子对象）。

如果美工对象不可见（Artist.get_visible 返回 False），则此操作无效。

参数:
rendererRendererBase 子类。

备注

此方法在 Artist 子类中被覆盖。

property rectangle#

Rectangle: 指示器边框。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]#

一次性设置多个属性。

a.set(a=A, b=B, c=C)

等同于

a.set_a(A)
a.set_b(B)
a.set_c(C)

除全名属性外，还支持别名，例如 set(lw=2) 等同于 set(linewidth=2)，但同时传入两者会报错。

各个 setter 的调用顺序与 set() 中的参数顺序一致。然而，大多数属性并不相互依赖，因此顺序通常无关紧要。

支持的属性包括：

属性

描述

agg_filter

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

alpha

未知

animated

布尔值

clip_box

BboxBase 或 None

clip_on

布尔值

clip_path

Patch 或 (Path, Transform) 或 None

color

color

edgecolor

颜色 或 None

figure

Figure 或 SubFigure

gid

str

in_layout

布尔值

label

object

linestyle

{'-', '--', '-.', ':', '', ...} 或 (offset, on-off-seq)

linewidth

浮点数或 None

mouseover

布尔值

path_effects

AbstractPathEffect 的列表

picker

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

rasterized

布尔值

sketch_params

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

snap

布尔值或 None

transform

变换

url

str

visible

布尔值

zorder

浮点数
set_alpha(alpha)[source]#

设置用于混合的alpha值 - 不支持所有后端。

参数:
alpha浮点数或 None

alpha 必须在 0-1 范围内（包含 0 和 1）。

set_color(c)[source]#

设置矩形和连接线的边缘颜色（edgecolor），以及矩形的填充颜色（facecolor）。

参数:
c颜色
set_edgecolor(color)[source]#

设置矩形和连接线的边缘颜色。

参数:
color颜色 或 None
set_linestyle(ls)[source]#

设置矩形和连接线的线型。

参数:
ls{'-', '--', '-.', ':', '', ...} 或 (offset, on-off-seq)

可能的值

  • 字符串

    linestyle

    描述

    '-' 或 'solid'

    实线

    '--' 或 'dashed'

    虚线

    '-.' 或 'dashdot'

    点划线

    ':' 或 'dotted'

    点线

    '' 或 'none' (不推荐使用：'None', ' ')

    不绘制任何内容

  • 描述虚线和间隙开始位置及长度的元组

    (offset, onoffseq)

    其中

    • offset 是一个指定偏移量（以点为单位）的浮点数；即虚线模式偏移了多少。

    • onoffseq 是以点为单位的绘图和留白的序列。可以有任意数量的绘图和留白值对。

    示例：元组 (0, (10, 5, 1, 5)) 表示模式从线段起点开始。它绘制一条 10 点长的虚线，然后是 5 点的间隙，接着是一条 1 点长的虚线，随后是 5 点的间隙，然后循环重复。

有关示例，请参阅 线型 (Linestyles)。

set_linewidth(w)[source]#

设置矩形和连接线的线宽（以点为单位）。

参数:
wfloat 或 None
zorder = 4.99#