`matplotlib.offsetbox`#

用于 Artist 的容器类。

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)[源代码][源代码]#

基类：OffsetBox

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

AnchoredOffsetbox 只有一个子元素。当需要多个子元素时，使用额外的 OffsetBox 来包含它们。默认情况下，偏移框锚定在其父 Axes 上。您可以显式指定 bbox_to_anchor。

参数:

locstr: 盒子的位置。有效位置为 '左上'、'中上'、'右上'、'左中'、'中心'、'右中'、'左下'、'中下'、'右下'。为了向后兼容，也接受数值。详情请参见 Legend 的参数 loc。
填充float, 默认值: 0.4: 子元素周围的填充，作为字体大小的分数。
borderpad浮点数, 默认值: 0.5: 偏移框框架与 bbox_to_anchor 之间的填充。
子 : OffsetBox偏移框: 将被固定的盒子。
propFontProperties: 这仅用作填充的参考。如果没有给出，则使用 rcParams["legend.fontsize"] (default: 'medium')。
frameon布尔: 是否在盒子周围画一个边框。
bbox_to_anchor : BboxBase, 2-tuple, 或 4-tuple 的浮点数BboxBase, 2-tuple, 或 4-tuple 的浮点数: 用于与 loc 一起定位图例的框。
bbox_transform : None 或 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)[源代码][源代码]#: 如有必要，更新子节点的位置并将它们绘制到给定的 renderer 上。

get_bbox(renderer)[源代码][源代码]#: 返回偏移框的边界框，忽略父级偏移。

get_bbox_to_anchor()[源代码][源代码]#: 返回该框所锚定的边界框。

get_child()[源代码][源代码]#: 返回子节点。

get_children()[源代码][源代码]#: 返回子项列表。

get_offset(bbox, renderer)[源代码][源代码]#

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

需要提供范围参数来处理偏移量由可调用对象动态确定的情况（参见 set_offset）。

参数:

bboxBbox
渲染器 : RendererBase 子类RendererBase 子类

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

set_bbox_to_anchor(bbox, transform=None)[源代码][源代码]#

设置盒子所锚定的边界框。

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)[源代码][源代码]#

基类：AnchoredOffsetbox

带有文本的 AnchoredOffsetbox。

参数:

sstr: 文本。
locstr: 位置代码。参见 AnchoredOffsetbox。
填充float, 默认值: 0.4: 文本周围的填充作为字体大小的分数。
borderpad浮点数, 默认值: 0.5: 偏移框框架与 bbox_to_anchor 之间的间距。
属性字典, 可选: 要传递给 Text 实例的关键字参数字典，该实例包含在 AnchoredText 中。
**kwargs: 所有其他参数都传递给 AnchoredOffsetbox。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

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)[源代码][源代码]#

基类：Artist, _AnnotationBase

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

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

这类似于 Annotation，但使用 OffsetBox 而不是 Text。

参数:

offsetbox偏移框

xy(浮点数, 浮点数)

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

xybox : (float, float), 默认: xy(浮点数, 浮点数), 默认值:

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

xycoords : 单个或两个元组的 str 或 Artist 或 Transform 或可调用对象，默认值: 'data'单个或两个字符串的元组或

给定 xy 的坐标系。有关详细描述，请参见 Annotation 中的参数 xycoords。

boxcoords : 单个或两个字符串或 Artist 或 Transform 或可调用对象，默认值：xycoords 的值单个或两个字符串的元组或

xybox 所处的坐标系。详细描述请参见 Annotation 中的参数 textcoords。

frameonbool, 默认值: True

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

annotation_clip: bool 或 None, 默认: None

当注释点 xy 位于 Axes 区域之外时，是否裁剪（即不绘制）注释。

如果 True，当 xy 在 Axes 外部时，注释将被裁剪。
如果 False，注释将始终被绘制。
如果为 None ，当 xy 在 Axes 之外且 xycoords 为 'data' 时，注释将被裁剪。

填充float, 默认值: 0.4

偏移框周围的填充。

box_alignment(浮点数, 浮点数)

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

bboxprops字典, 可选

用于设置注释边界框属性的字典，例如 boxstyle 和 alpha。详情请参见 FancyBboxPatch。

arrowprops: dict, 可选

箭头属性，描述见 Annotation。

字体大小: float 或 str, 可选

转换为点并通过 mutation_scale 传递给 FancyBboxPatch 以缩放框样式的属性（例如 pad 或 rounding_size）。名称的选择类似于 Text，其中 fontsize 同样定义了变异比例。如果未给出，则使用 rcParams["legend.fontsize"] (default: 'medium')。有关有效值，请参见 Text.set_fontsize。

**kwargs

其他 AnnotationBbox 属性。参见 AnnotationBbox.set 获取列表。

property anncoords#: !! 由 numpydoc 处理 !!

contains(mouseevent)[源代码][源代码]#

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

参数:

mouseevent鼠标事件

返回:

包含布尔: 是否有任何值在半径范围内。
详情dict: 一个特定于艺术家的活动上下文细节字典，例如拾取半径内包含哪些点。详情请参阅各个 Artist 子类。

draw(renderer)[源代码][源代码]#

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

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

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

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

get_children()[源代码][源代码]#: 返回此 Artist 的子 Artist 列表。

get_fontsize()[源代码][源代码]#: 返回以点为单位的字体大小。

get_tightbbox(renderer=None)[源代码][源代码]#

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选: 用于绘制图形（即 fig.canvas.get_renderer()）的渲染器

返回:

Bbox 或 None: 包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_window_extent(renderer=None)[源代码][源代码]#

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

边界框的宽度和高度为非负值。

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

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

set(*, 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>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

set_figure(fig)[源代码][源代码]#

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

参数:

fig : Figure 或 SubFigure图或子图

set_fontsize(s=None)[源代码][源代码]#

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

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

update_positions(renderer)[源代码][源代码]#: 更新标注点的像素位置、文本和箭头。

property xyann#: !! 由 numpydoc 处理 !!

zorder = 3#

class matplotlib.offsetbox.AuxTransformBox(aux_transform)[源代码][源代码]#

基类：OffsetBox

带有 aux_transform 的偏移框。其子对象将首先通过 aux_transform 进行变换，然后进行偏移。aux_transform 的绝对坐标是有意义的，因为它会自动调整，使得子对象的边界框的左下角在偏移变换之前被设置为 (0, 0)。

它类似于绘图区域，不同之处在于框的范围不是预先确定的，而是根据其子窗口的范围计算得出的。此外，子窗口的范围将在变换坐标中计算。

add_artist(a)[源代码][源代码]#: 将 Artist 添加到容器框中。

draw(renderer)[源代码][源代码]#: 如有必要，更新子节点的位置并将它们绘制到给定的 renderer 上。

get_bbox(renderer)[源代码][源代码]#: 返回偏移框的边界框，忽略父级偏移。

get_offset()[源代码][源代码]#: 返回容器的偏移量。

get_transform()[源代码][源代码]#: 返回应用于子元素的 Transform

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

set_offset(xy)[源代码][源代码]#

设置容器的偏移量。

参数:

xy(浮点数, 浮点数): 偏移量的 (x, y) 坐标，以显示单位表示。

set_transform(t)[源代码][源代码]#: set_transform 被忽略。

class matplotlib.offsetbox.DraggableAnnotation(annotation, use_blit=False)[源代码][源代码]#

基类：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 则重新计算它们在轴坐标中的位置并设置相关属性。

property canvas#: !! 由 numpydoc 处理 !!

property cids#: !! 由 numpydoc 处理 !!

disconnect()[源代码][源代码]#: 断开回调。

finalize_offset()[源代码][源代码]#

on_motion(evt)[源代码][源代码]#

on_pick(evt)[源代码][源代码]#

on_release(event)[源代码][源代码]#

save_offset()[源代码][源代码]#

update_offset(dx, dy)[源代码][源代码]#

class matplotlib.offsetbox.DraggableOffsetBox(ref_artist, offsetbox, use_blit=False)[源代码][源代码]#

基类：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)[源代码][源代码]#

基类：OffsetBox

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

参数:

宽度, 高度浮动: 容器框的宽度和高度。
xdescent, ydescent浮动: 盒子在x和y方向上的下降。
剪辑布尔: 是否将子元素裁剪到盒子内。

add_artist(a)[源代码][源代码]#: 将 Artist 添加到容器框中。

property clip_children#: 如果此 DrawingArea 的子元素应被 DrawingArea 的边界框裁剪。

draw(renderer)[源代码][源代码]#: 如有必要，更新子节点的位置并将它们绘制到给定的 renderer 上。

get_bbox(renderer)[源代码][源代码]#: 返回偏移框的边界框，忽略父级偏移。

get_offset()[源代码][源代码]#: 返回容器的偏移量。

get_transform()[源代码][源代码]#: 返回应用于子项的 Transform。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

set_offset(xy)[源代码][源代码]#

设置容器的偏移量。

参数:

xy(浮点数, 浮点数): 偏移量的 (x, y) 坐标，以显示单位表示。

set_transform(t)[源代码][源代码]#: set_transform 被忽略。

class matplotlib.offsetbox.HPacker(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[源代码][源代码]#

基类：PackerBase

HPacker 水平排列其子元素，并在绘制时自动调整它们的相对位置。

参数:

填充浮点数，默认值：0.0

边界的填充，单位为点。

sep浮点数，默认值：0.0

项目之间的间距。

宽度, 高度float, 可选

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

对齐{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, 默认: 'baseline'

盒子的对齐。

模式{'fixed', 'expand', 'equal'}, 默认: 'fixed'

打包模式。

'fixed' 将给定的 Artist 紧密打包，间距为 sep。
'expand' 使用最大可用空间来在艺术家之间均匀分布。
'equal': 每个艺术家占用相等的部分可用空间，并在此空间内左对齐（或顶部对齐）。

children : Artist 的列表列表

要打包的艺术家。

注释

pad 和 sep 以点为单位，并将随渲染器的 dpi 缩放，而 width 和 height 以像素为单位。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

class matplotlib.offsetbox.OffsetBox(*args, **kwargs)[源代码][源代码]#

基类：Artist

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

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

作为一个艺术家本身，所有参数都会传递给 Artist。

property axes#: 艺术家所在的 Axes 实例，或为 None。

contains(mouseevent)[源代码][源代码]#

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

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

参数:

mouseevent鼠标事件

返回:

包含布尔: 是否有任何值在半径范围内。
详情dict: 一个特定于艺术家的活动上下文细节字典，例如拾取半径内包含哪些点。详情请参阅各个 Artist 子类。

参见

Artist.contains

draw(renderer)[源代码][源代码]#: 如有必要，更新子节点的位置并将它们绘制到给定的 renderer 上。

get_bbox(renderer)[源代码][源代码]#: 返回偏移框的边界框，忽略父级偏移。

get_children()[源代码][源代码]#: 返回子`.Artist`的列表。

get_offset(bbox, renderer)[源代码][源代码]#

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

需要提供范围参数来处理偏移量由可调用对象动态确定的情况（参见 set_offset）。

参数:

bboxBbox
渲染器 : RendererBase 子类RendererBase 子类

get_visible_children()[源代码][源代码]#: 返回可见子 Artist 的列表。

get_window_extent(renderer=None)[源代码][源代码]#

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

边界框的宽度和高度为非负值。

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

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

set_figure(fig)[源代码][源代码]#

设置 OffsetBox 及其所有子元素的 Figure。

参数:

fig图

set_height(height)[源代码][源代码]#

设置盒子的高度。

参数:

高度浮动

set_offset(xy)[源代码][源代码]#

设置偏移量。

参数:

xy（浮点数，浮点数）或可调用对象

偏移量的 (x, y) 坐标，以显示单位表示。这些可以显式地作为一个元组 (x, y) 给出，或者通过提供一个将范围转换为偏移量的函数。该函数必须具有以下签名:

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

set_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)[源代码][源代码]#

基类：OffsetBox

draw(renderer)[源代码][源代码]#: 如有必要，更新子节点的位置并将它们绘制到给定的 renderer 上。

get_bbox(renderer)[源代码][源代码]#: 返回偏移框的边界框，忽略父级偏移。

get_children()[源代码][源代码]#: 返回子`.Artist`的列表。

get_data()[源代码][源代码]#

get_offset()[源代码][源代码]#: 返回容器的偏移量。

get_zoom()[源代码][源代码]#

set(*, 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=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zoom=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

set_data(arr)[源代码][源代码]#

set_zoom(zoom)[源代码][源代码]#

class matplotlib.offsetbox.PackerBase(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[源代码][源代码]#

基类：OffsetBox

参数:

填充浮点数，默认值：0.0

边界的填充，单位为点。

sep浮点数，默认值：0.0

项目之间的间距。

宽度, 高度float, 可选

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

对齐{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, 默认: 'baseline'

盒子的对齐。

模式{'fixed', 'expand', 'equal'}, 默认: 'fixed'

打包模式。

'fixed' 将给定的 Artist 紧密打包，间距为 sep。
'expand' 使用最大可用空间来在艺术家之间均匀分布。
'equal': 每个艺术家占用相等的部分可用空间，并在此空间内左对齐（或顶部对齐）。

children : Artist 的列表列表

要打包的艺术家。

注释

pad 和 sep 以点为单位，并将随渲染器的 dpi 缩放，而 width 和 height 以像素为单位。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

class matplotlib.offsetbox.PaddedBox(child, pad=0.0, *, draw_frame=False, patch_attrs=None)[源代码][源代码]#

基类：OffsetBox

一个容器，用于在 Artist 周围添加填充。

.PaddedBox 包含一个用于在渲染时可视化的 .FancyBboxPatch。

参数:

子 : Artist艺术家: 包含的 Artist。
填充浮点数，默认值：0.0: 以点为单位的填充。这将根据渲染器的 dpi 进行缩放。相比之下，width 和 height 是以像素为单位，因此不会缩放。
draw_frame布尔: 是否绘制包含的 FancyBboxPatch。
patch_attrs字典或无: 传递给包含的 FancyBboxPatch 的额外参数。

draw(renderer)[源代码][源代码]#: 如有必要，更新子节点的位置并将它们绘制到给定的 renderer 上。

draw_frame(renderer)[源代码][源代码]#

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

update_frame(bbox, fontsize=None)[源代码][源代码]#

class matplotlib.offsetbox.TextArea(s, *, textprops=None, multilinebaseline=False)[源代码][源代码]#

基类：OffsetBox

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

文本默认放置在 (0, 0) 位置，采用基线左对齐。TextArea 实例的宽度和高度是其子文本的宽度和高度。

参数:

sstr: 要显示的文本。
textpropsdict, 默认值: {}: 传递给 TextArea 中 Text 实例的关键字参数字典。
多行基线bool, 默认值: False: 多行文本的基线是否调整，以便与单行文本（大约）居中对齐。

draw(renderer)[源代码][源代码]#: 如有必要，更新子节点的位置并将它们绘制到给定的 renderer 上。

get_bbox(renderer)[源代码][源代码]#: 返回偏移框的边界框，忽略父级偏移。

get_multilinebaseline()[源代码][源代码]#: 获取多行基线。

get_offset()[源代码][源代码]#: 返回容器的偏移量。

get_text()[源代码][源代码]#: 返回此区域文本的字符串表示。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

set_multilinebaseline(t)[源代码][源代码]#

设置多行基线。

如果为 True，多行文本的基线会调整，使其与单行文本（大约）居中对齐。例如，图例实现使用此功能，使得单行标签基线对齐，而多行标签与它们“居中”对齐。

set_offset(xy)[源代码][源代码]#

设置容器的偏移量。

参数:

xy(浮点数, 浮点数): 偏移量的 (x, y) 坐标，以显示单位表示。

set_text(s)[源代码][源代码]#: 将此区域的文本设置为字符串。

set_transform(t)[源代码][源代码]#: set_transform 被忽略。

class matplotlib.offsetbox.VPacker(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[源代码][源代码]#

基类：PackerBase

VPacker 垂直排列其子元素，在绘制时自动调整它们的相对位置。

参数:

填充浮点数，默认值：0.0

边界的填充，单位为点。

sep浮点数，默认值：0.0

项目之间的间距。

宽度, 高度float, 可选

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

对齐{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, 默认: 'baseline'

盒子的对齐。

模式{'fixed', 'expand', 'equal'}, 默认: 'fixed'

打包模式。

'fixed' 将给定的 Artist 紧密打包，间距为 sep。
'expand' 使用最大可用空间来在艺术家之间均匀分布。
'equal': 每个艺术家占用相等的部分可用空间，并在此空间内左对齐（或顶部对齐）。

children : Artist 的列表列表

要打包的艺术家。

注释

pad 和 sep 以点为单位，并将随渲染器的 dpi 缩放，而 width 和 height 以像素为单位。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<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>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性有

属性	描述
`agg_filter`	一个过滤函数，它接收一个 (m, n, 3) 的浮点数数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
`alpha`	标量或无
`animated`	布尔
`bbox_to_anchor`	未知
`子元素`	未知
`clip_box`	`BboxBase` 或 None
`clip_on`	布尔
`clip_path`	补丁或（路径，变换）或无
`figure`	`Figure`
`gid`	str
`高度`	浮动
`in_layout`	布尔
`标签`	对象
`鼠标悬停`	布尔
`偏移`	（浮点数，浮点数）或可调用对象
`path_effects`	`AbstractPathEffect` 列表
`picker`	None 或 bool 或 float 或 callable
`光栅化`	布尔
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	布尔值或无
`transform`	`Transform`
`url`	str
`可见`	布尔
`宽度`	浮动
`zorder`	浮动

matplotlib.offsetbox#

`matplotlib.offsetbox`#