matplotlib.offsetbox

的容器类 Artist S

OffsetBox

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

AnchoredOffsetbox, AnchoredText

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

DrawingArea

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

HPacker, VPacker

用于垂直或水平放置其子对象的容器。

PaddedBox

在 Artist .

TextArea

包含单个 Text 实例。

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

基类：matplotlib.offsetbox.OffsetBox

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

AnchoredOffsetbox只有一个孩子。当需要多个孩子时，使用一个额外的偏移框将他们围起来。默认情况下，偏移框相对于其父轴定位。可以显式指定 bbox_to_anchor .

参数:

locSTR

盒子的位置。支持的值：

• 右上角
• “左上角”
• “左下角”
• 右下角
• “左中锋”
• “中间偏右”
• “下中心”
• “上中心”
• “中心”

为了向后兼容，也可以接受数值。请参见参数 loc 属于 Legend 有关详细信息。

pad浮动，默认值：0.4

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

borderpad浮动，默认值：0.5

偏移框框架和 bbox_to_anchor .

小孩 ： OffsetBoxOffsetBox

将被锚定的盒子。

prop ： FontPropertiesFontProperties

仅供参考。如果不给， rcParams["legend.fontsize"] (default: 'medium') 使用。

frameon布尔

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

bbox_to_anchor ： BboxBase ，2元组，或4元组浮点数bboxbase、2元组或4元组浮点数

用于将图例与 loc .

bbox_transform : None or matplotlib.transforms.Transform无或

边界框的变换( bbox_to_anchor ）

**kwargs

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

笔记

见 Legend 有关锚定机制的详细说明。

codes = {'center': 10, 'center left': 6, 'center right': 7, 'lower center': 8, 'lower left': 3, 'lower right': 4, 'right': 5, 'upper center': 9, 'upper left': 2, 'upper right': 1}

draw(renderer)

如有必要，更新子项的位置并将其绘制到给定的 渲染器 .

get_bbox_to_anchor()

返回框锚定到的bbox。

get_child()

孩子回来了。

get_children()

返回子项列表。

get_extent(renderer)

将框的范围返回为（宽度、高度、x、y）。

这是孩子的程度加上填充物。

get_window_extent(renderer)

返回显示空间中的边界框。

set_bbox_to_anchor(bbox, transform=None)

设置框锚定到的bbox。

bbox 可以是bbox实例，列表 [左、下、宽、高] 或列表 [左、下] 其中宽度和高度假定为零。bbox将通过给定的转换转换为显示坐标。

set_child(child)

设置要锚定的子对象。

update_frame(bbox, fontsize=None)

zorder = 5

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

基类：matplotlib.offsetbox.AnchoredOffsetbox

带文本的anchoredoffsetbox。

参数:

sSTR

文本。

locSTR

位置代码。看到了吗 AnchoredOffsetbox .

pad浮动，默认值：0.4

以字体大小的分数填充文本。

borderpad浮动，默认值：0.5

偏移框框架和 bbox_to_anchor .

prop可选的

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

**kwargs

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

class 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, fontsize=None, **kwargs)

基类：matplotlib.artist.Artist, matplotlib.text._AnnotationBase

集装箱 OffsetBox 指特定的职位 xy .

（可选）从偏移框指向 xy 可以画出来。

这就像 Annotation 但是 OffsetBox 而不是 Text .

参数:

偏心箱 ： OffsetBoxOffsetBox

xy（浮标，浮标）

重点 （x，y） 注释。坐标系由 木栓 .

xybox公司 ：（float，float），默认值： xy（float，float），默认值：

位置 （x，y） 将文本放置在。坐标系由 博克斯公司 .

木栓 STR或 Artist 或 Transform 或callable或（float，float），默认值：“data”str或

坐标系 xy 是的。请参见参数 木栓 在里面 Annotation 详细描述。

博克斯公司 STR或 Artist 或 Transform 或float，或float，默认值 木栓str或

坐标系 xybox公司 是的。请参见参数 文本框 在里面 Annotation 详细描述。

frameonbool，默认值：True

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

pad浮动，默认值：0.4

在偏移箱周围填充。

box_alignment（浮标，浮标）

两个浮点数的元组，用于偏移框w.r.t.的垂直和水平对齐 博克斯公司 . 左下角是（0，0），右上角是（1，1）。

**kwargs

其他参数与相同 Annotation .

property anncoords

contains(mouseevent)

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

参数:

鼠标移动 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

返回:

contains布尔

是否有任何值在半径范围内。

details双关语

事件上下文详细信息的艺术家专用词典，例如拾取半径中包含哪些点。有关详细信息，请参见各个艺术家子类。

draw(renderer)

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

如果艺术家不可见，则此操作无效 (Artist.get_visible 返回False）。

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

此方法在Artist子类中被重写。

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_fontsize(s=<deprecated parameter>)

以点为单位返回字体大小。

get_tightbbox(renderer)

在显示空间中获得紧密的边界框。

get_window_extent(renderer)

获取显示空间中的边界框。

set_figure(fig)

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

参数:

fig ： Figure图形

set_fontsize(s=None)

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

如果 s 未给定，重置为 rcParams["legend.fontsize"] (default: 'medium') .

update_positions(renderer)

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

property xyann

zorder = 3

class matplotlib.offsetbox.AuxTransformBox(aux_transform)

基类：matplotlib.offsetbox.OffsetBox

带辅助变换的偏移框。它的子级将首先用辅助转换进行转换，然后再进行偏移。辅助变换的绝对坐标是有意义的，因为它将自动调整，以便在偏移变换之前将子对象边界框的左下角设置为（0，0）。

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

add_artist(a)

添加一个 Artist 到集装箱箱。

draw(renderer)

如有必要，更新子项的位置并将其绘制到给定的 渲染器 .

get_extent(renderer)

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

get_offset()

容器的返回偏移量。

get_transform()

返回 Transform 适用于儿童

get_window_extent(renderer)

返回显示空间中的边界框。

set_offset(xy)

设置容器的偏移量。

参数:

xy（浮标，浮标）

偏移的（x，y）坐标（以显示单位表示）。

set_transform(t)

设置转换被忽略。

class matplotlib.offsetbox.DraggableAnnotation(annotation, use_blit=False)

基类：matplotlib.offsetbox.DraggableBase

save_offset()

update_offset(dx, dy)

class 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 和 DraggableAnnotation ， update_offset 将艺术家放置在显示坐标系中，然后 finalize_offset 重新计算它们在坐标轴中的位置并设置相关属性。

artist_picker(artist, evt)

[Deprecated]

笔记

3.3 版后已移除:

disconnect()

断开回调。

finalize_offset()

on_motion(evt)

on_motion_blit(evt)

[Deprecated]

笔记

3.3 版后已移除:

on_pick(evt)

on_release(event)

save_offset()

update_offset(dx, dy)

class matplotlib.offsetbox.DraggableOffsetBox(ref_artist, offsetbox, use_blit=False)

基类：matplotlib.offsetbox.DraggableBase

get_loc_in_canvas()

save_offset()

update_offset(dx, dy)

class matplotlib.offsetbox.DrawingArea(width, height, xdescent=0.0, ydescent=0.0, clip=False)

基类：matplotlib.offsetbox.OffsetBox

绘图区域可以包含任何儿童艺术家。绘图区域具有固定的宽度和高度。子级相对于父级的位置是固定的。可以在父对象的边界处剪裁子对象。

参数:

宽度、高度浮动

集装箱箱的宽度和高度。

枯萎，腐烂浮动

盒子在x和y方向下降。

clip布尔

是否把孩子们夹在盒子里。

add_artist(a)

添加一个 Artist 到集装箱箱。

property clip_children

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

draw(renderer)

如有必要，更新子项的位置并将其绘制到给定的 渲染器 .

get_extent(renderer)

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

get_offset()

容器的返回偏移量。

get_transform()

返回 Transform 适用于儿童。

get_window_extent(renderer)

返回显示空间中的边界框。

set_offset(xy)

设置容器的偏移量。

参数:

xy（浮标，浮标）

偏移的（x，y）坐标（以显示单位表示）。

set_transform(t)

设置转换被忽略。

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

基类：matplotlib.offsetbox.PackerBase

hpacker的子级水平打包。它在绘制时自动调整子对象的相对位置。

参数:

pad可选浮动

以点为单位的边界填充。

sep可选浮动

点之间的间距。

宽度、高度可选浮动

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

align{'top'、'bottom'、'left'、'right'、'center'、'baseline'}

盒子对齐。

mode{'fixed'、'expand'、'equal'}

包装方式。

• “修复”打包给定的 Artists 紧紧地 sep 间距。
• “展开”使用最大的可用空间以相等的间距分布艺术家。
• “相等”：每个艺术家都是可用空间的相等部分，并在其中左对齐（或顶部对齐）。

儿童 名单 Artist名单

要打包的艺术家。

笔记

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

get_extent_offsets(renderer)

更新子对象的偏移量并返回框的范围。

参数:

渲染器 ： RendererBase 子类RenderBase子类

返回:

宽度

高度

X下降

亚历山大

（xoffset，yoffset）对列表

class matplotlib.offsetbox.OffsetBox(*args, **kwargs)

基类：matplotlib.artist.Artist

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

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

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

property axes

这个 Axes 艺术家居住的实例，或 None .

contains(mouseevent)

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

作为一个容器 OffsetBox 对mouseevents本身没有响应。

参数:

鼠标移动 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

返回:

contains布尔

是否有任何值在半径范围内。

details双关语

事件上下文详细信息的艺术家专用词典，例如拾取半径中包含哪些点。有关详细信息，请参见各个艺术家子类。

参见

Artist.contains

draw(renderer)

如有必要，更新子项的位置并将其绘制到给定的 渲染器 .

get_children()

返回孩子的列表 Artist S

get_extent(renderer)

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

get_extent_offsets(renderer)

更新子对象的偏移量并返回框的范围。

参数:

渲染器 ： RendererBase 子类RenderBase子类

返回:

宽度

高度

X下降

亚历山大

（xoffset，yoffset）对列表

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

以元组（x，y）的形式返回偏移量。

必须提供extent参数来处理偏移量由callable动态确定的情况（请参见 set_offset ）

参数:

宽，高，宽，宽，宽

范围参数。

渲染器 ： RendererBase 子类RenderBase子类

get_visible_children()

返回可见子项的列表 Artist S

get_window_extent(renderer)

返回边界框 (Bbox )在展示空间。

set_figure(fig)

设置 Figure 对于 OffsetBox 以及它所有的孩子。

参数:

fig ： Figure图形

set_height(height)

设置框的高度。

参数:

height浮动

set_offset(xy)

设置偏移量。

参数:

xy（浮动、浮动）或可调用

偏移的（x，y）坐标（以显示单位表示）。它们可以显式地作为一个元组（x，y）给出，也可以通过提供一个函数将范围转换为偏移量。此函数必须具有签名：

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

set_width(width)

设置框的宽度。

参数:

width浮动

class 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)

基类：matplotlib.offsetbox.OffsetBox

draw(renderer)

如有必要，更新子项的位置并将其绘制到给定的 渲染器 .

get_children()

返回孩子的列表 Artist S

get_data()

get_extent(renderer)

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

get_offset()

容器的返回偏移量。

get_window_extent(renderer)

返回显示空间中的边界框。

get_zoom()

set_data(arr)

set_zoom(zoom)

class matplotlib.offsetbox.PackerBase(pad=None, sep=None, width=None, height=None, align=None, mode=None, children=None)

基类：matplotlib.offsetbox.OffsetBox

参数:

pad可选浮动

以点为单位的边界填充。

sep可选浮动

点之间的间距。

宽度、高度可选浮动

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

align{'top'、'bottom'、'left'、'right'、'center'、'baseline'}

盒子对齐。

mode{'fixed'、'expand'、'equal'}

包装方式。

• “修复”打包给定的 Artists 紧紧地 sep 间距。
• “展开”使用最大的可用空间以相等的间距分布艺术家。
• “相等”：每个艺术家都是可用空间的相等部分，并在其中左对齐（或顶部对齐）。

儿童 名单 Artist名单

要打包的艺术家。

笔记

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

class matplotlib.offsetbox.PaddedBox(child, pad=None, draw_frame=False, patch_attrs=None)

基类：matplotlib.offsetbox.OffsetBox

在 Artist .

这个 PaddedBox 包含一个 FancyBboxPatch 用于在渲染时将其可视化。

参数:

小孩 ： Artist艺术家

包含的 Artist .

pad浮动

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

draw_frame布尔

是否绘制包含的 FancyBboxPatch .

patch_attrs不记名

传递给包含的 FancyBboxPatch .

draw(renderer)

如有必要，更新子项的位置并将其绘制到给定的 渲染器 .

draw_frame(renderer)

get_extent_offsets(renderer)

更新子对象的偏移量并返回框的范围。

参数:

渲染器 ： RendererBase 子类RenderBase子类

返回:

宽度

高度

X下降

亚历山大

（xoffset，yoffset）对列表

update_frame(bbox, fontsize=None)

class matplotlib.offsetbox.TextArea(s, textprops=None, multilinebaseline=None, minimumdescent=True)

基类：matplotlib.offsetbox.OffsetBox

TextArea包含一个文本实例。文字放置在（0，0）处，基线+左对齐。TextArea实例的宽度和高度是其子文本的宽度和高度。

参数:

sSTR

要显示的文本。

textprops可选的

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

multilinebaseline可选的布尔

如果 True ，将调整多行文字的基线，使其（大约）与单行文字居中对齐。

minimumdescent可选的布尔

如果 True ，框的最小下降值为“P”。

draw(renderer)

如有必要，更新子项的位置并将其绘制到给定的 渲染器 .

get_extent(renderer)

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

get_minimumdescent()

获得最小下降。

get_multilinebaseline()

获取多重基线。

get_offset()

容器的返回偏移量。

get_text()

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

get_window_extent(renderer)

返回显示空间中的边界框。

set_minimumdescent(t)

设置最小下降。

如果为真，则调整单行文本的范围，使其最小下降值为“P”。

set_multilinebaseline(t)

设置多重基线。

如果为True，则调整多行文字的基线，使其（大约）与单行文字居中对齐。

set_offset(xy)

设置容器的偏移量。

参数:

xy（浮标，浮标）

偏移的（x，y）坐标（以显示单位表示）。

set_text(s)

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

set_transform(t)

设置转换被忽略。

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

基类：matplotlib.offsetbox.PackerBase

VPacker的子项是垂直打包的。它在绘图时自动调整孩子的相对位置。

参数:

pad可选浮动

以点为单位的边界填充。

sep可选浮动

点之间的间距。

宽度、高度可选浮动

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

align{'top'、'bottom'、'left'、'right'、'center'、'baseline'}

盒子对齐。

mode{'fixed'、'expand'、'equal'}

包装方式。

• “修复”打包给定的 Artists 紧紧地 sep 间距。
• “展开”使用最大的可用空间以相等的间距分布艺术家。
• “相等”：每个艺术家都是可用空间的相等部分，并在其中左对齐（或顶部对齐）。

儿童 名单 Artist名单

要打包的艺术家。

笔记

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

get_extent_offsets(renderer)

更新子对象的偏移量并返回框的范围。

参数:

渲染器 ： RendererBase 子类RenderBase子类

返回:

宽度

高度

X下降

亚历山大

（xoffset，yoffset）对列表

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