matplotlib.offsetbox

s 的容器类Artist。

OffsetBox

此模块中定义的所有容器艺术家的基础。

AnchoredOffsetbox,AnchoredText

Artist相对于父轴或特定锚点锚定和对齐任意文本或文本。

DrawingArea

具有固定宽度和高度的容器。儿童在容器内有固定位置，可能会被夹住。

HPacker,VPacker

用于垂直或水平布局其子级的容器。

PaddedBox

用于在 .周围添加填充的容器Artist。

TextArea

包含单个Text实例。

类 matplotlib.offsetbox。AnchoredOffsetbox ( loc , * , pad = 0.4 , borderpad = 0.5 , child = None , prop = None , frameon = True , bbox_to_anchor = None , bbox_transform = None , ** kwargs )

基地：OffsetBox

根据位置loc放置的偏移框。

AnchoredOffsetbox 有一个孩子。当需要多个孩子时，请使用额外的 OffsetBox 将它们括起来。默认情况下，偏移框锚定在其父轴上。您可以明确指定 bbox_to_anchor。

参数：

本地字符串

盒子位置。有效位置为“左上”、“中上”、“右上”、“左中”、“中”、“右中”、“左下”、“中下”、“右下”。为了向后兼容，也接受数值。详见参数loc。Legend

填充浮动，默认值：0.4

作为字体大小的一部分在孩子周围填充。

边框浮动，默认值：0.5

offsetbox 框架和bbox_to_anchor之间的填充。

孩子OffsetBox

将被锚定的框。

支柱FontProperties

这仅用作填充的参考。如果未给出， 则使用rcParams["legend.fontsize"]（默认值'medium'：）。

框架布尔

是否在框周围画一个框架。

bbox_to_anchor BboxBase、2 元组或 4 元组的浮点数

用于与loc一起定位图例的框。

bbox_transform无或matplotlib.transforms.Transform

边界框 ( bbox_to_anchor ) 的变换。

**kwargs

所有其他参数都传递给OffsetBox.

笔记

有关Legend锚定机制的详细说明，请参阅。

代码= {'center'：10，'center left'：6，'center right'：7，'lower center'：8，'lower left'：3，'lower right'：4，'right'：5，'中上': 9, '左上': 2, '右上': 1}

绘制（渲染器）

如有必要，更新子元素的位置并将它们绘制到给定的渲染器。

get_bbox_to_anchor ( )

返回框锚定到的 bbox。

get_child ( )

把孩子还回来。

get_children ( )

返回子列表。

get_extent (渲染器)

将框的范围返回为 (width, height, x, y)。

这是孩子加上填充的范围。

get_window_extent ( renderer = None )

在显示空间中获取艺术家的边界框。

边界框的宽度和高度是非负的。

子类应覆盖以包含在边界框“紧密”计算中。默认是在 0, 0 处返回一个空的边界框。

使用此功能时要小心，如果艺术家的艺术家窗口范围发生变化，结果将不会更新。由于变换堆栈中的任何更改，例如更改轴限制、图形大小或使用的画布（如保存图形时所做的那样），范围可能会发生变化。这可能会导致意外行为，其中交互式图形在屏幕上看起来很好，但会错误地保存。

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， bbox_to_anchor=<UNSET>， child=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET > , gid=<UNSET> , height=<UNSET> , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> ,光栅化=<UNSET> ,sketch_params=<UNSET> ,snap=<UNSET> , transform=<UNSET> , url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
bbox_to_anchor	未知
child	未知
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	(float, float) 或可调用
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	Transform
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

set_bbox_to_anchor ( bbox , transform = None )

设置框锚定到的 bbox。

bbox可以是一个 Bbox 实例，一个 [left, bottom, width, height] 的列表，或者一个 [left, bottom] 的列表，其中宽度和高度将被假定为零。bbox 将通过给定的变换变换为显示坐标。

set_child (孩子)

设置要锚定的孩子。

update_frame ( bbox , fontsize = None )

zorder = 5

类 matplotlib.offsetbox。AnchoredText ( s , loc , * , pad = 0.4 , borderpad = 0.5 , prop = None , ** kwargs )

基地：AnchoredOffsetbox

带有文本的锚定偏移框。

参数：

字符串_

文本。

本地字符串

位置代码。见AnchoredOffsetbox。

填充浮动，默认值：0.4

作为字体大小的一部分在文本周围填充。

边框浮动，默认值：0.5

offsetbox 框架和bbox_to_anchor之间的间距。

道具字典，可选

要传递给 Text包含在 AnchoredText 中的实例的关键字参数字典。

**kwargs

所有其他参数都传递给AnchoredOffsetbox.

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， bbox_to_anchor=<UNSET>， child=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET > , gid=<UNSET> , height=<UNSET> , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> ,光栅化=<UNSET> ,sketch_params=<UNSET> ,snap=<UNSET> , transform=<UNSET> , url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
bbox_to_anchor	未知
child	未知
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	(float, float) 或可调用
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	Transform
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

类 matplotlib.offsetbox。AnnotationBbox ( offsetbox , xy , xybox = None , * , xycoords = 'data' , boxcoords = None , frameon = True , pad = 0.4 , annotation_clip = None , box_alignment = (0.5, 0.5) , bboxprops = None , arrowprops = None ,字体大小=无, ** kwargs )

基地：Artist，_AnnotationBase

OffsetBox引用特定位置xy的容器。

可选地，可以绘制从偏移框指向xy的箭头。

这就像Annotation，但用OffsetBox而不是Text。

参数：

偏移框OffsetBox

xy （浮点数，浮点数）

要注释的点(x, y) 。坐标系由xycoords确定。

xybox （浮点数，浮点数），默认值：xy

放置文本的位置(x, y) 。坐标系由boxcoords确定。

xycoords str or Artistor or Transformor callable or (float, float)，默认值：'data'

xy给出 的坐标系。详细说明请参见参数xycoords。Annotation

boxcoords str or Artistor or Transformor callable or (float, float)，默认值：xycoords的值

xybox给出 的坐标系。详细说明见参数textcoords。Annotation

frameon布尔值，默认值：True

默认情况下，文本被白色包围FancyBboxPatch （可作为 的patch属性访问AnnotationBbox）。如果frameon设置为 False，则此补丁不可见。

填充浮动，默认值：0.4

偏移框周围的填充。

box_alignment （浮动，浮动）

两个浮点数的元组，用于与boxcoords对齐的偏移框的垂直和水平对齐。左下角是 (0, 0)，右上角是 (1, 1)。

**kwargs

其他参数与 相同Annotation。

属性 nncoords

包含( mouseevent )

测试艺术家是否包含鼠标事件。

参数：

鼠标事件matplotlib.backend_bases.MouseEvent

返回：

包含布尔

是否有任何值在半径内。

详细信息字典

事件上下文详细信息的艺术家特定字典，例如选择半径中包含哪些点。有关详细信息，请参阅各个 Artist 子类。

绘制（渲染器）

使用给定的渲染器绘制艺术家（及其子级）。

如果艺术家不可见，这将无效（Artist.get_visible 返回 False）。

参数：

渲染器RendererBase子类。

笔记

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

get_children ( )

Artist返回this的子节点列表Artist。

get_fontsize ( )

返回以磅为单位的字体大小。

get_tightbbox ( renderer = None )

喜欢Artist.get_window_extent，但包括任何剪辑。

参数：

渲染器RendererBase子类

将用于绘制图形的渲染器（即 fig.canvas.get_renderer()）

返回：

Bbox

封闭的边界框（在图中像素坐标中）。

get_window_extent ( renderer = None )

在显示空间中获取艺术家的边界框。

边界框的宽度和高度是非负的。

子类应覆盖以包含在边界框“紧密”计算中。默认是在 0, 0 处返回一个空的边界框。

使用此功能时要小心，如果艺术家的艺术家窗口范围发生变化，结果将不会更新。由于变换堆栈中的任何更改，例如更改轴限制、图形大小或使用的画布（如保存图形时所做的那样），范围可能会发生变化。这可能会导致意外行为，其中交互式图形在屏幕上看起来很好，但会错误地保存。

设置( * , agg_filter=<UNSET> , alpha=<UNSET> , animated=<UNSET> , annotation_clip=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , fontsize=<UNSET > , gid=<UNSET> , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<未设置>,变换=<UNSET> ,url=<UNSET> , visible=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
annotation_clip	布尔或无
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	未知
fontsize	未知
gid	字符串
in_layout	布尔
label	目的
mouseover	布尔
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	Transform
url	字符串
visible	布尔
zorder	漂浮

set_figure ( fig )

设置Figure艺术家所属的实例。

参数：

图Figure

set_fontsize ( s = None )

以磅为单位设置字体大小。

如果未给出srcParams["legend.fontsize"] ，则重置为（默认值：'medium'）。

update_positions (渲染器)

更新注释点、文本和箭头的像素位置。

属性 xyann

zorder = 3

类 matplotlib.offsetbox。AuxTransformBox ( aux_transform )

基地：OffsetBox

带有 aux_transform 的偏移框。它的孩子将首先使用 aux_transform 进行转换，然后将被偏移。aux_transform 的绝对坐标的意义在于它会自动调整，以便在偏移变换之前将子边界框的左下角设置为 (0, 0)。

它类似于绘图区域，只是盒子的范围不是预先确定的，而是根据其子项的窗口范围计算的。此外，孩子的范围将在转换后的坐标中计算。

add_artist ( a )

将一个添加Artist到容器框中。

绘制（渲染器）

如有必要，更新子元素的位置并将它们绘制到给定的渲染器。

get_extent (渲染器)

返回一个盒子的元组。width, height, xdescent, ydescent

get_offset ( )

容器的返回偏移量。

get_transform ( )

将应用返回Transform给孩子

get_window_extent ( renderer = None )

在显示空间中获取艺术家的边界框。

边界框的宽度和高度是非负的。

子类应覆盖以包含在边界框“紧密”计算中。默认是在 0, 0 处返回一个空的边界框。

使用此功能时要小心，如果艺术家的艺术家窗口范围发生变化，结果将不会更新。由于变换堆栈中的任何更改，例如更改轴限制、图形大小或使用的画布（如保存图形时所做的那样），范围可能会发生变化。这可能会导致意外行为，其中交互式图形在屏幕上看起来很好，但会错误地保存。

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET>， gid=<UNSET>， height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<未设置> ,变换=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	（浮动，浮动）
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	未知
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

set_offset ( xy )

设置容器的偏移量。

参数：

xy （浮点数，浮点数）

偏移量的 (x, y) 坐标，以显示单位表示。

set_transform ( t )

set_transform 被忽略。

类 matplotlib.offsetbox。DraggableAnnotation ( annotation , use_blit = False )

基地：DraggableBase

save_offset ( )

update_offset ( dx , dy )

类 matplotlib.offsetbox。DraggableBase ( ref_artist , use_blit = False )

基地：object

可拖动艺术家的助手基类（图例，偏移框）。

派生类必须覆盖以下方法：

def save_offset(self):
    '''
    Called when the object is picked for dragging; should save the
    reference position of the artist.
    '''

def update_offset(self, dx, dy):
    '''
    Called during the dragging; (*dx*, *dy*) is the pixel offset from
    the point where the mouse drag started.
    '''

或者，您可以覆盖以下方法：

def finalize_offset(self):
    '''Called when the mouse is released.'''

DraggableLegend在and 的当前实现中DraggableAnnotation，update_offset将艺术家放置在显示坐标中，并finalize_offset重新计算他​​们在轴坐标中的位置并设置相关属性。

断开连接( )

断开回调。

finalize_offset ( )

on_motion ( evt )

on_pick ( evt )

on_release (事件)

save_offset ( )

update_offset ( dx , dy )

类 matplotlib.offsetbox。DraggableOffsetBox ( ref_artist , offsetbox , use_blit = False )

基地：DraggableBase

get_loc_in_canvas ( )

save_offset ( )

update_offset ( dx , dy )

类 matplotlib.offsetbox。DrawingArea (宽度,高度, xdescent = 0.0 , ydescent = 0.0 , clip = False )

基地：OffsetBox

DrawingArea 可以包含任何 Artist 作为子项。DrawingArea 具有固定的宽度和高度。孩子相对于父母的位置是固定的。可以在父级的边界处裁剪子级。

参数：

宽度，高度浮动

容器盒的宽度和高度。

xdescent, ydescent浮动

盒子在 x 和 y 方向的下降。

剪辑布尔

是否将孩子剪辑到盒子上。

add_artist ( a )

将一个添加Artist到容器框中。

属性 clip_children

如果此 DrawingArea 的子项应被 DrawingArea 边界框剪裁。

绘制（渲染器）

如有必要，更新子元素的位置并将它们绘制到给定的渲染器。

get_extent (渲染器)

返回框的宽度、高度、xdescent、ydescent。

get_offset ( )

容器的返回偏移量。

get_transform ( )

将应用返回Transform给孩子。

get_window_extent ( renderer = None )

在显示空间中获取艺术家的边界框。

边界框的宽度和高度是非负的。

子类应覆盖以包含在边界框“紧密”计算中。默认是在 0, 0 处返回一个空的边界框。

使用此功能时要小心，如果艺术家的艺术家窗口范围发生变化，结果将不会更新。由于变换堆栈中的任何更改，例如更改轴限制、图形大小或使用的画布（如保存图形时所做的那样），范围可能会发生变化。这可能会导致意外行为，其中交互式图形在屏幕上看起来很好，但会错误地保存。

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET>， gid=<UNSET>， height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<未设置> ,变换=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	（浮动，浮动）
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	未知
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

set_offset ( xy )

设置容器的偏移量。

参数：

xy （浮点数，浮点数）

偏移量的 (x, y) 坐标，以显示单位表示。

set_transform ( t )

set_transform 被忽略。

类 matplotlib.offsetbox。HPacker ( pad = None , sep = None , width = None , height = None , align = 'baseline' , mode = 'fixed' , children = None )

基地：PackerBase

HPacker 水平打包它的孩子，在绘制时自动调整它们的相对位置。

参数：

垫浮子，可选

以点为单位的边界填充。

sep浮动，可选

项目之间的间距，以磅为单位。

宽度，高度浮动，可选

容器框的宽度和高度（以像素为单位），如果为 None则计算。

对齐{'top', 'bottom', 'left', 'right', 'center', 'baseline'}，默认值：'baseline'

框对齐。

模式{'fixed', 'expand', 'equal'}，默认值：'fixed'

包装方式。

• 'fixed' 将给定的 s 与sep间距Artist紧密结合。

• 'expand' 使用最大的可用空间以相等的间距分布艺术家。

• 'equal'：每个艺术家占可用空间的相等部分，并且在其中左对齐（或上对齐）。

儿童名单Artist

艺术家打包。

笔记

pad和sep以点为单位，将使用渲染器 dpi 进行缩放，而宽度和高度以像素为单位。

get_extent_offsets (渲染器)

更新孩子的偏移量并返回盒子的范围。

参数：

渲染器RendererBase子类

返回：

宽度

高度

xdescent

ydescent

(xoffset, yoffset) 对的列表

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET>， gid=<UNSET>， height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<未设置> ,变换=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	(float, float) 或可调用
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	Transform
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

类 matplotlib.offsetbox。OffsetBox ( * args , ** kwargs )

基地：Artist

OffsetBox 是一个简单的容器艺术家。

子艺术家应该在与其父级的相对位置上绘制。

作为艺术家本身，所有参数都传递给Artist.

属性 轴

Axes艺术家所在的实例，或None。

包含( mouseevent )

将鼠标事件包含检查委托给孩子。

作为一个容器，OffsetBox不响应鼠标事件。

参数：

鼠标事件matplotlib.backend_bases.MouseEvent

返回：

包含布尔

是否有任何值在半径内。

详细信息字典

事件上下文详细信息的艺术家特定字典，例如选择半径中包含哪些点。有关详细信息，请参阅各个 Artist 子类。

也可以看看

Artist.contains

绘制（渲染器）

如有必要，更新子元素的位置并将它们绘制到给定的渲染器。

get_children ( )

返回 childArtist的列表。

get_extent (渲染器)

返回一个盒子的元组。width, height, xdescent, ydescent

get_extent_offsets (渲染器)

更新孩子的偏移量并返回盒子的范围。

参数：

渲染器RendererBase子类

返回：

宽度

高度

xdescent

ydescent

(xoffset, yoffset) 对的列表

get_offset ( width , height , xdescent , ydescent , renderer )

将偏移量作为元组 (x, y) 返回。

必须提供范围参数来处理偏移量由可调用对象动态确定的情况（请参阅 参考资料 set_offset）。

参数：

宽度、高度、xdescent、ydescent

范围参数。

渲染器RendererBase子类

get_visible_children ( )

返回可见 childArtist的列表。

get_window_extent ( renderer = None )

在显示空间中获取艺术家的边界框。

边界框的宽度和高度是非负的。

子类应覆盖以包含在边界框“紧密”计算中。默认是在 0, 0 处返回一个空的边界框。

使用此功能时要小心，如果艺术家的艺术家窗口范围发生变化，结果将不会更新。由于变换堆栈中的任何更改，例如更改轴限制、图形大小或使用的画布（如保存图形时所做的那样），范围可能会发生变化。这可能会导致意外行为，其中交互式图形在屏幕上看起来很好，但会错误地保存。

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET>， gid=<UNSET>， height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<未设置> ,变换=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	(float, float) 或可调用
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	Transform
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

set_figure ( fig )

Figure为 theOffsetBox及其所有子级设置。

参数：

图Figure

set_height (高度)

设置盒子的高度。

参数：

高度浮动

set_offset ( xy )

设置偏移量。

参数：

xy (float, float) 或可调用

偏移量的 (x, y) 坐标，以显示单位表示。这些既可以作为元组 (x, y) 显式给出，也可以通过提供将范围转换为偏移量的函数来给出。此函数必须具有签名：

def offset(width, height, xdescent, ydescent, renderer) -> (float, float)

set_width (宽度)

设置框的宽度。

参数：

宽度浮动

类 matplotlib.offsetbox。OffsetImage ( arr , * , zoom = 1 , cmap = None , norm = None , interpolation = None , origin = None , filternorm = True , filterrad = 4.0 , resample = False , dpi_cor = True , ** kwargs )

基地：OffsetBox

绘制（渲染器）

如有必要，更新子元素的位置并将它们绘制到给定的渲染器。

get_children ( )

返回 childArtist的列表。

get_data ( )

get_extent (渲染器)

返回一个盒子的元组。width, height, xdescent, ydescent

get_offset ( )

容器的返回偏移量。

get_window_extent ( renderer = None )

在显示空间中获取艺术家的边界框。

边界框的宽度和高度是非负的。

子类应覆盖以包含在边界框“紧密”计算中。默认是在 0, 0 处返回一个空的边界框。

使用此功能时要小心，如果艺术家的艺术家窗口范围发生变化，结果将不会更新。由于变换堆栈中的任何更改，例如更改轴限制、图形大小或使用的画布（如保存图形时所做的那样），范围可能会发生变化。这可能会导致意外行为，其中交互式图形在屏幕上看起来很好，但会错误地保存。

get_zoom ( )

设置( * , agg_filter=<UNSET> , alpha=<UNSET> , animated=<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET> , data=<UNSET> , gid=<UNSET > , height=<UNSET> , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> ,snap=<未设置> ,transform=<UNSET> , url=<UNSET> , visible=<UNSET> , width=<UNSET> , zoom=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
data	未知
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	(float, float) 或可调用
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	Transform
url	字符串
visible	布尔
width	漂浮
zoom	未知
zorder	漂浮

set_data ( arr )

set_zoom (缩放)

类 matplotlib.offsetbox。PackerBase ( pad = None , sep = None , width = None , height = None , align = 'baseline' , mode = 'fixed' , children = None )

基地：OffsetBox

参数：

垫浮子，可选

以点为单位的边界填充。

sep浮动，可选

项目之间的间距，以磅为单位。

宽度，高度浮动，可选

容器框的宽度和高度（以像素为单位），如果为 None则计算。

对齐{'top', 'bottom', 'left', 'right', 'center', 'baseline'}，默认值：'baseline'

框对齐。

模式{'fixed', 'expand', 'equal'}，默认值：'fixed'

包装方式。

• 'fixed' 将给定的 s 与sep间距Artist紧密结合。

• 'expand' 使用最大的可用空间以相等的间距分布艺术家。

• 'equal'：每个艺术家占可用空间的相等部分，并且在其中左对齐（或上对齐）。

儿童名单Artist

艺术家打包。

笔记

pad和sep以点为单位，将使用渲染器 dpi 进行缩放，而宽度和高度以像素为单位。

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET>， gid=<UNSET>， height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<未设置> ,变换=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	(float, float) 或可调用
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	Transform
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

类 matplotlib.offsetbox。PaddedBox ( child , pad = None , * , draw_frame = False , patch_attrs = None )

基地：OffsetBox

用于在 .周围添加填充的容器Artist。

PaddedBox包含FancyBboxPatch用于在渲染时对其进行可视化的a。

参数：

孩子Artist

包含的Artist.

垫浮子

以点为单位的填充。这将使用渲染器 dpi 进行缩放。相比之下，宽度和高度以像素为单位，因此没有缩放。

draw_frame布尔

是否绘制包含的FancyBboxPatch.

patch_attrs字典或无

传递给包含的附加参数FancyBboxPatch。

绘制（渲染器）

如有必要，更新子元素的位置并将它们绘制到给定的渲染器。

draw_frame (渲染器)

get_extent_offsets (渲染器)

更新孩子的偏移量并返回盒子的范围。

参数：

渲染器RendererBase子类

返回：

宽度

高度

xdescent

ydescent

(xoffset, yoffset) 对的列表

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET>， gid=<UNSET>， height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<未设置> ,变换=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	(float, float) 或可调用
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	Transform
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

update_frame ( bbox , fontsize = None )

类 matplotlib.offsetbox。TextArea ( s , * , textprops = None , multilinebaseline = False )

基地：OffsetBox

TextArea 是单个 Text 实例的容器艺术家。

默认情况下，文本以基线+左对齐放置在 (0, 0) 处。TextArea 实例的宽度和高度是其子文本的宽度和高度。

参数：

字符串_

要显示的文本。

textprops字典，默认值：{}

要传递给Text TextArea 中实例的关键字参数字典。

multilinebaseline布尔值，默认值：False

是否调整多行文本的基线，使其与单行文本（大约）居中对齐。

绘制（渲染器）

如有必要，更新子元素的位置并将它们绘制到给定的渲染器。

get_extent (渲染器)

返回一个盒子的元组。width, height, xdescent, ydescent

get_multilinebaseline ( )

获取多线基线。

get_offset ( )

容器的返回偏移量。

get_text ( )

返回此区域文本的字符串表示形式。

get_window_extent ( renderer = None )

在显示空间中获取艺术家的边界框。

边界框的宽度和高度是非负的。

子类应覆盖以包含在边界框“紧密”计算中。默认是在 0, 0 处返回一个空的边界框。

使用此功能时要小心，如果艺术家的艺术家窗口范围发生变化，结果将不会更新。由于变换堆栈中的任何更改，例如更改轴限制、图形大小或使用的画布（如保存图形时所做的那样），范围可能会发生变化。这可能会导致意外行为，其中交互式图形在屏幕上看起来很好，但会错误地保存。

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET>， gid=<UNSET>， height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , multilinebaseline=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<未设置>, snap=<UNSET> ,text=<UNSET> , transform=<UNSET> , url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
multilinebaseline	未知
offset	（浮动，浮动）
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
text	未知
transform	未知
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

set_multilinebaseline ( t )

设置多线基线。

如果为 True，则调整多行文本的基线，使其与单行文本（大约）居中对齐。这例如由图例实现使用，以便单行标签与基线对齐，但多行标签与它们“中心”对齐。

set_offset ( xy )

设置容器的偏移量。

参数：

xy （浮点数，浮点数）

偏移量的 (x, y) 坐标，以显示单位表示。

set_text ( s )

将此区域的文本设置为字符串。

set_transform ( t )

set_transform 被忽略。

类 matplotlib.offsetbox。VPacker ( pad = None , sep = None , width = None , height = None , align = 'baseline' , mode = 'fixed' , children = None )

基地：PackerBase

VPacker 垂直打包它的孩子，在绘制时自动调整它们的相对位置。

参数：

垫浮子，可选

以点为单位的边界填充。

sep浮动，可选

项目之间的间距，以磅为单位。

宽度，高度浮动，可选

容器框的宽度和高度（以像素为单位），如果为 None则计算。

对齐{'top', 'bottom', 'left', 'right', 'center', 'baseline'}，默认值：'baseline'

框对齐。

模式{'fixed', 'expand', 'equal'}，默认值：'fixed'

包装方式。

• 'fixed' 将给定的 s 与sep间距Artist紧密结合。

• 'expand' 使用最大的可用空间以相等的间距分布艺术家。

• 'equal'：每个艺术家占可用空间的相等部分，并且在其中左对齐（或上对齐）。

儿童名单Artist

艺术家打包。

笔记

pad和sep以点为单位，将使用渲染器 dpi 进行缩放，而宽度和高度以像素为单位。

get_extent_offsets (渲染器)

更新孩子的偏移量并返回盒子的范围。

参数：

渲染器RendererBase子类

返回：

宽度

高度

xdescent

ydescent

(xoffset, yoffset) 对的列表

设置（*， agg_filter=<UNSET>， alpha=<UNSET>，动画=<UNSET>， clip_box=<UNSET>， clip_on=<UNSET>， clip_path=<UNSET>， gid=<UNSET>， height=<UNSET > , in_layout=<UNSET> , label=<UNSET> , mouseover=<UNSET> , offset=<UNSET> , path_effects=<UNSET > , picker=< UNSET> , rasterized=<UNSET> , sketch_params=<UNSET> , snap=<未设置> ,变换=<UNSET> ,url=<UNSET> , visible=<UNSET> , width=<UNSET> , zorder=<UNSET> )

一次设置多个属性。

支持的属性是

财产	描述
agg_filter	一个过滤器函数，它接受一个 (m, n, 3) 浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
alpha	标量或无
animated	布尔
clip_box	Bbox
clip_on	布尔
clip_path	补丁或（路径，变换）或无
figure	Figure
gid	字符串
height	漂浮
in_layout	布尔
label	目的
mouseover	布尔
offset	(float, float) 或可调用
path_effects	AbstractPathEffect
picker	None 或 bool 或 float 或可调用
rasterized	布尔
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
transform	Transform
url	字符串
visible	布尔
width	漂浮
zorder	漂浮

matplotlib.offsetbox。bbox_artist ( * args , ** kwargs )