matplotlib.spines#

class matplotlib.spines.Spine(axes, spine_type, path, **kwargs)[源代码][源代码]#

基类:Patch

轴脊 -- 标记数据区域边界的线。

脊线是连接轴刻度线并标记数据区域边界的线。它们可以放置在任意位置。更多信息请参见 set_position

默认位置是 ('outward', 0)

脊柱是 Patch 的子类,并继承了它们的大部分行为。

Spines 根据是否调用了 set_patch_lineset_patch_circleset_patch_arc 来绘制线条、圆形或弧形。默认情况下是线条状的。

示例请参见 书脊

参数:
axesAxes

包含脊柱的 Axes 实例。

spine_typestr

书脊类型。

路径 : Path路径

用于绘制书脊的 Path 实例。

其他参数:
**kwargs

有效的关键字参数是:

属性

描述

agg_filter

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

alpha

未知

animated

布尔

抗锯齿 或 aa

布尔值或无

capstyle

CapStyle 或 {'butt', 'projecting', 'round'}

clip_box

BboxBase 或 None

clip_on

布尔

clip_path

补丁或(路径,变换)或无

颜色

color

edgecolor 或 ec

color or None

facecolor 或 fc

color or None

figure

FigureSubFigure

fill

布尔

gid

str

hatch

{'/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

布尔

joinstyle

JoinStyle 或 {'miter', 'round', 'bevel'}

标签

对象

linestyle 或 ls

{'-', '--', '-.', ':', '', (偏移, 开-关序列), ...}

linewidth 或 lw

浮点数或无

鼠标悬停

布尔

path_effects

AbstractPathEffect 列表

picker

None 或 bool 或 float 或 callable

光栅化

布尔

sketch_params

(scale: float, length: float, randomness: float)

snap

布尔值或无

transform

Transform

url

str

可见

布尔

zorder

浮动

classmethod arc_spine(axes, spine_type, center, radius, theta1, theta2, **kwargs)[源代码][源代码]#

创建并返回一个弧线 Spine

classmethod circular_spine(axes, center, radius, **kwargs)[源代码][源代码]#

创建并返回一个圆形的 Spine

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

清除当前的书脊。

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

使用给定的渲染器绘制艺术家(及其子项)。

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

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

注释

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

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

获取书脊的范围。

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

返回将补丁坐标映射到数据坐标的 Transform 实例。

例如,可以通过提供单位圆的坐标和一个将坐标(补丁坐标)缩放5倍的变换,来定义一个表示半径为5的圆的补丁。

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

返回此补丁的路径。

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

返回书脊位置。

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

返回脊柱变换。

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

返回显示空间中脊线的窗口范围,包括刻度的填充(但不包括它们的标签)

classmethod linear_spine(axes, spine_type, **kwargs)[源代码][源代码]#

创建并返回一个线性 Spine

register_axis(axis)[源代码][源代码]#

注册一个轴。

轴应该与其对应的 Axes 实例中的脊柱注册。这允许脊柱在需要时清除任何轴属性。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, bounds=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, patch_arc=<UNSET>, patch_circle=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[源代码]#

一次性设置多个属性。

支持的属性是

属性

描述

agg_filter

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

alpha

标量或无

animated

布尔

抗锯齿 或 aa

布尔值或无

边界

(低: 浮点数, 高: 浮点数)

capstyle

CapStyle 或 {'butt', 'projecting', 'round'}

clip_box

BboxBase 或 None

clip_on

布尔

clip_path

补丁或(路径,变换)或无

颜色

color

edgecolor 或 ec

color or None

facecolor 或 fc

color or None

figure

FigureSubFigure

fill

布尔

gid

str

hatch

{'/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

布尔

joinstyle

JoinStyle 或 {'miter', 'round', 'bevel'}

标签

对象

linestyle 或 ls

{'-', '--', '-.', ':', '', (偏移, 开-关序列), ...}

linewidth 或 lw

浮点数或无

鼠标悬停

布尔

patch_arc

未知

patch_circle

未知

path_effects

AbstractPathEffect 列表

picker

None 或 bool 或 float 或 callable

位置

未知

光栅化

布尔

sketch_params

(scale: float, length: float, randomness: float)

snap

布尔值或无

transform

Transform

url

str

可见

布尔

zorder

浮动

set_bounds(low=None, high=None)[源代码][源代码]#

设置书脊边界。

参数:
浮点数或无,可选

下脊边界。传递 None 保持限制不变。

边界也可以作为元组 (low, high) 作为第一个位置参数传递。

浮点数或无,可选

更高的书脊边界。传递 None 保持限制不变。

set_color(c)[源代码][源代码]#

设置边缘颜色。

参数:
c颜色

注释

此方法不会修改 facecolor(默认值为“none”),这与父类中定义的 Patch.set_color 方法不同。使用 Patch.set_facecolor 来设置 facecolor。

set_patch_arc(center, radius, theta1, theta2)[源代码][源代码]#

将脊柱设置为弧形。

set_patch_circle(center, radius)[源代码][源代码]#

将脊柱设置为圆形。

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

将脊柱设置为线性。

set_position(position)[源代码][源代码]#

设置书脊的位置。

脊椎位置由一个包含 (位置类型, 数量) 的 2 元组指定。位置类型包括:

  • 'outward': 将脊柱从数据区域向外放置指定数量的点。(负值将脊柱向内放置。)

  • 'axes': 将脊柱放置在指定的 Axes 坐标(0 到 1)。

  • 'data': 将脊柱放置在指定的数据坐标处。

此外,简写符号定义了特殊位置:

  • 'center' -> ('axes', 0.5)

  • 'zero' -> ('data', 0.0)

示例

脊柱放置

class matplotlib.spines.Spines(**kwargs)[源代码][源代码]#

基类:MutableMapping

Axes 中所有 Spine 的容器。

该接口类似于字典,将名称(例如 'left')映射到 Spine 对象。此外,它还实现了一些类似 pandas.Series 的功能,例如通过属性访问元素:

spines['top'].set_visible(False)
spines.top.set_visible(False)

可以通过传递列表来同时处理多个书脊:

spines[['top', 'right']].set_visible(False)

使用开放切片来处理所有脊椎:

spines[:].set_visible(False)

后两种索引方法将返回一个 SpinesProxy,它会将其所有 set_*()set() 调用广播到其成员,但不能用于任何其他操作。

classmethod from_dict(d)[源代码][源代码]#
class matplotlib.spines.SpinesProxy(spine_dict)[源代码][源代码]#

基类:object

一个代理,用于将 set_*()set() 方法调用广播到包含的 Spines

代理不能用于对其成员进行任何其他操作。

支持的方法是根据包含的书脊动态确定的。如果并非所有书脊都支持某个给定的方法,则该方法仅在支持它的书脊子集上执行。