matplotlib.text

用于在图中包含文本的类。

class matplotlib.text.Text(x=0, y=0, text='', *, color=None, verticalalignment='baseline', horizontalalignment='left', multialignment=None, fontproperties=None, rotation=None, linespacing=None, rotation_mode=None, usetex=None, wrap=False, transform_rotates_text=False, parse_math=None, antialiased=None, **kwargs)

基类：Artist

处理在窗口或数据坐标中存储和绘制文本。

在 x, y 位置创建一个带有字符串 text 的 Text 实例。

文本相对于锚点 (x, y) 根据 ``horizontalalignment``（默认：'left'）和 ``verticalalignment``（默认：'baseline'）进行对齐。另请参阅 文本对齐。

虽然 Text 接受 'label' 关键字参数，但默认情况下它不会添加到图例的句柄中。

有效的关键字参数是：

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	标量或无
animated	布尔
抗锯齿	布尔
背景颜色	color
bbox	带有 patches.FancyBboxPatch 属性的字典
clip_box	未知
clip_on	未知
clip_path	未知
颜色 或 c	color
figure	Figure 或 SubFigure
fontfamily 或 family 或 fontname	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties 或 font 或 font_properties	font_manager.FontProperties 或 str 或 pathlib.Path
fontsize 或 size	浮点数或 {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch 或 stretch	{一个数值范围在0-1000之间, '超压缩', '特压缩', '压缩', '半压缩', '正常', '半扩展', '扩展', '特扩展', '超扩展'}
fontstyle 或样式	{'normal', 'italic', 'oblique'}
fontvariant 或 variant	{'normal', 'small-caps'}
fontweight 或 weight	{一个数值范围在0-1000之间, '超轻', '轻', '正常', '常规', '书', '中等', '罗马', '半粗', '半粗', '半', '粗', '重', '特粗', '黑'}
gid	str
horizontalalignment 或 ha	{'left', 'center', 'right'}
in_layout	布尔
标签	对象
行间距	浮动（字体大小的倍数）
math_fontfamily	str
鼠标悬停	布尔
多重对齐 或 ma	{'left', 'right', 'center'}
解析数学	布尔
path_effects	AbstractPathEffect 列表
picker	None 或 bool 或 float 或 callable
位置	(浮点数, 浮点数)
光栅化	布尔
旋转	float 或 {'vertical', 'horizontal'}
rotation_mode	{None, 'default', 'anchor'}
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
文本	对象
transform	Transform
transform_rotates_text	布尔
url	str
usetex	bool, 默认值: rcParams["text.usetex"] (default: False)
垂直对齐 或 va	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
可见	布尔
wrap	布尔
x	float
y	float
zorder	float

contains(mouseevent)

返回鼠标事件是否发生在文本的轴对齐边界框内。

draw(renderer)

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

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

参数:

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

注释

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

get_antialiased()

返回是否使用抗锯齿渲染。

get_bbox_patch()

返回 bbox 补丁，如果 patches.FancyBboxPatch 未创建，则返回 None。

get_c()

get_color 的别名。

get_color()

返回文本的颜色。

get_family()

get_fontfamily 的别名。

get_font()

get_fontproperties 的别名。

get_font_properties()

get_fontproperties 的别名。

get_fontfamily()

返回用于字体查找的字体族列表。

参见

font_manager.FontProperties.get_family

get_fontname()

返回字体名称作为字符串。

参见

font_manager.FontProperties.get_name

get_fontproperties()

返回 font_manager.FontProperties。

get_fontsize()

返回字体大小为整数。

参见

font_manager.FontProperties.get_size_in_points

get_fontstyle()

返回字体样式为字符串。

参见

font_manager.FontProperties.get_style

get_fontvariant()

返回字体变体作为字符串。

参见

font_manager.FontProperties.get_variant

get_fontweight()

返回字体粗细作为字符串或数字。

参见

font_manager.FontProperties.get_weight

get_ha()

get_horizontalalignment 的别名。

get_horizontalalignment()

返回水平对齐方式为字符串。 将是 'left'、'center' 或 'right' 之一。

get_math_fontfamily()

返回 Matplotlib 渲染的数学文本的字体族名称。

默认值是 rcParams["mathtext.fontset"] (default: 'dejavusans')。

参见

set_math_fontfamily

get_name()

get_fontname 的别名。

get_parse_math()

返回是否考虑对此 Text 进行 mathtext 解析。

get_position()

返回文本的 (x, y) 位置。

get_rotation()

返回文本角度，以度为单位，范围在0到360之间。

get_rotation_mode()

返回文本旋转模式。

get_size()

get_fontsize 的别名。

get_stretch()

返回字体拉伸作为一个字符串或数字。

参见

font_manager.FontProperties.get_stretch

get_style()

get_fontstyle 的别名。

get_text()

返回文本字符串。

get_transform_rotates_text()

返回变换的旋转是否影响文本方向。

get_unitless_position()

返回文本的无单位 (x, y) 位置。

get_usetex()

返回此 Text 对象是否使用 TeX 进行渲染。

get_va()

get_verticalalignment 的别名。

get_variant()

get_fontvariant 的别名。

get_verticalalignment()

返回垂直对齐方式为字符串。可以是 'top', 'center', 'bottom', 'baseline' 或 'center_baseline' 之一。

get_weight()

get_fontweight 的别名。

get_window_extent(renderer=None, dpi=None)

返回包围文本的 Bbox 边界框，以显示单位表示。

除了内部使用外，这在网页上的png文件中指定可点击区域时也很有用。

参数:

渲染器渲染器，可选

需要一个渲染器来计算边界框。如果艺术家已经被绘制，渲染器会被缓存；因此，只有在第一次绘制之前调用 get_window_extent 时才需要传递此参数。实际上，通常更容易先触发一次绘制，例如通过调用 draw_without_rendering 或 plt.show()。

dpi浮点数，可选

用于计算 bbox 的 dpi 值，默认为 ``self.get_figure(root=True).dpi``（不是渲染器的 dpi）；如果需要匹配保存为自定义 dpi 值的图像区域，则应设置此值。

get_wrap()

返回文本是否可以被换行。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, mouseover=<UNSET>, multialignment=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	标量或无
animated	布尔
抗锯齿	布尔
背景颜色	color
bbox	带有 patches.FancyBboxPatch 属性的字典
clip_box	未知
clip_on	未知
clip_path	未知
颜色	color
figure	Figure 或 SubFigure
fontfamily 或 fontname	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties	font_manager.FontProperties 或 str 或 pathlib.Path
fontsize	浮点数或 {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch	{一个数值范围在0-1000之间, '超压缩', '特压缩', '压缩', '半压缩', '正常', '半扩展', '扩展', '特扩展', '超扩展'}
fontstyle	{'normal', 'italic', 'oblique'}
fontvariant	{'normal', 'small-caps'}
fontweight	{一个数值范围在0-1000之间, '超轻', '轻', '正常', '常规', '书', '中等', '罗马', '半粗', '半粗', '半', '粗', '重', '特粗', '黑'}
gid	str
horizontalalignment	{'left', 'center', 'right'}
in_layout	布尔
标签	对象
行间距	浮动（字体大小的倍数）
math_fontfamily	str
鼠标悬停	布尔
多重对齐	{'left', 'right', 'center'}
解析数学	布尔
path_effects	AbstractPathEffect 列表
picker	None 或 bool 或 float 或 callable
位置	(浮点数, 浮点数)
光栅化	布尔
旋转	float 或 {'vertical', 'horizontal'}
rotation_mode	{None, 'default', 'anchor'}
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
文本	对象
transform	Transform
transform_rotates_text	布尔
url	str
usetex	bool, 默认值: rcParams["text.usetex"] (default: False)
垂直对齐	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
可见	布尔
wrap	布尔
x	float
y	float
zorder	float

set_antialiased(antialiased)

设置是否使用抗锯齿渲染。

参数:

抗锯齿布尔

注释

抗锯齿将由 rcParams["text.antialiased"] (default: True) 决定，如果文本包含数学表达式，参数 antialiased 将不起作用。

set_backgroundcolor(color)

通过更新 bbox 来设置文本的背景颜色。

参数:

颜色 : color颜色

参见

set_bbox

要更改边界框的位置

set_bbox(rectprops)

在 self 周围绘制一个边界框。

参数:

rectprops : 包含 patches.FancyBboxPatch 属性的字典带有属性的字典

默认的 boxstyle 是 'square'。patches.FancyBboxPatch 的突变比例设置为字体大小。

示例

t.set_bbox(dict(facecolor='red', alpha=0.5))

set_c(color)

set_color 的别名。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常从 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的裁剪。

set_clip_on(b)

设置艺术家是否使用剪裁。

当设置为 False 时，艺术家将可见于 Axes 之外，这可能导致意外的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_color(color)

设置文本的前景色

参数:

颜色 : color颜色

set_family(fontname)

set_fontfamily 的别名。

set_font(fp)

set_fontproperties 的别名。

set_font_properties(fp)

set_fontproperties 的别名。

set_fontfamily(fontname)

设置字体族。可以是单个字符串，或按优先级递减的列表。每个字符串可以是实际字体名称或通用字体类名称。如果是后者，将在相应的rcParams中查找具体的字体名称。

如果 Text 实例是用 fontfamily=None 构造的，那么字体将被设置为 rcParams["font.family"] (default: ['sans-serif'])，当在现有的 Text 实例上调用 set_fontfamily() 时，也会进行同样的操作。

参数:

字体名称{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

参见

font_manager.FontProperties.set_family

set_fontname(fontname)

set_fontfamily 的别名。

单向别名：获取器不同。

参数:

字体名称{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

参见

font_manager.FontProperties.set_family

set_fontproperties(fp)

设置控制文本的字体属性。

参数:

fp : font_manager.FontProperties 或 str 或 pathlib.Pathfont_manager.FontProperties 或 str 或 pathlib.Path

如果是 str ，它被解释为 FontProperties 解析的字体配置模式。如果是 pathlib.Path ，它被解释为字体文件的绝对路径。

set_fontsize(fontsize)

设置字体大小。

参数:

字体大小浮点数或 {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

如果是一个浮点数，表示字体大小为点数。字符串值表示相对于默认字体大小的尺寸。

参见

font_manager.FontProperties.set_size

set_fontstretch(stretch)

设置字体拉伸（水平压缩或扩展）。

参数:

伸展{一个数值范围在0-1000之间, '超压缩', '特压缩', '压缩', '半压缩', '正常', '半扩展', '扩展', '特扩展', '超扩展'}

参见

font_manager.FontProperties.set_stretch

set_fontstyle(fontstyle)

设置字体样式。

参数:

字体样式{'normal', 'italic', 'oblique'}

参见

font_manager.FontProperties.set_style

set_fontvariant(variant)

设置字体变体。

参数:

变体{'normal', 'small-caps'}

参见

font_manager.FontProperties.set_variant

set_fontweight(weight)

设置字体粗细。

参数:

重量{一个数值范围在0-1000之间, '超轻', '轻', '正常', '常规', '书', '中等', '罗马', '半粗', '半粗', '半', '粗', '重', '特粗', '黑'}

参见

font_manager.FontProperties.set_weight

set_ha(align)

set_horizontalalignment 的别名。

set_horizontalalignment(align)

设置相对于锚点的水平对齐方式。

另请参阅 文本对齐。

参数:

对齐{'left', 'center', 'right'}

set_linespacing(spacing)

将行距设置为字体大小的倍数。

默认行距为1.2。

参数:

间距浮动（字体大小的倍数）

set_ma(align)

set_multialignment 的别名。

set_math_fontfamily(fontfamily)

设置 Matplotlib 渲染的数学文本的字体族。

这仅影响 Matplotlib 自己的数学渲染器。在使用 TeX 渲染时（usetex=True），它没有效果。

参数:

字体家族str

字体家族的名称。

可用的字体族在 默认的 matplotlibrc 文件 中定义。

参见

get_math_fontfamily

set_multialignment(align)

设置多行文本的对齐方式。

所有线条的边界框的布局由 horizontalalignment 和 verticalalignment 属性决定。此属性控制文本行在该框内的对齐方式。

参数:

对齐{'left', 'right', 'center'}

set_name(fontname)

set_fontname 的别名。

set_parse_math(parse_math)

覆盖开关以禁用此 Text 的任何 mathtext 解析。

参数:

parse_math布尔

如果为 False，这个 Text 将永远不会使用 mathtext。如果为 True，如果有偶数个未转义的美元符号，将使用 mathtext。

set_position(xy)

设置文本的 (x, y) 位置。

参数:

xy(浮点数, 浮点数)

set_rotation(s)

设置文本的旋转。

参数:

sfloat 或 {'vertical', 'horizontal'}

以数学正方向（逆时针）表示的旋转角度，单位为度。'horizontal' 等于 0，'vertical' 等于 90。

set_rotation_mode(m)

设置文本旋转模式。

参数:

m{None, 'default', 'anchor'}

如果 "default"，文本将首先旋转，然后根据其水平和垂直对齐方式进行对齐。如果 "anchor"，则在对齐之前进行旋转。传递 None 会将旋转模式设置为 "default"。

set_size(fontsize)

set_fontsize 的别名。

set_stretch(stretch)

set_fontstretch 的别名。

set_style(fontstyle)

set_fontstyle 的别名。

set_text(s)

设置文本字符串 s。

它可能包含换行符 (\n) 或 LaTeX 语法中的数学公式。

参数:

s对象

任何对象都会被转换为其 str 表示形式，除了 None 会被转换为空字符串。

set_transform_rotates_text(t)

变换的旋转是否影响文本方向。

参数:

t布尔

set_usetex(usetex)

参数:

usetex布尔值或无

是否使用 TeX 渲染，None 表示使用 rcParams["text.usetex"] (default: False)。

set_va(align)

set_verticalalignment 的别名。

set_variant(variant)

set_fontvariant 的别名。

set_verticalalignment(align)

设置相对于锚点的垂直对齐方式。

另请参阅 文本对齐。

参数:

对齐{'baseline', 'bottom', 'center', 'center_baseline', 'top'}

set_weight(weight)

set_fontweight 的别名。

set_wrap(wrap)

设置文本是否可以换行。

包装确保文本被限制在（子）图形框内。它不考虑任何其他艺术家。

参数:

包裹布尔

注释

包装与 savefig(..., bbox_inches='tight') （这在 IPython/Jupyter 中的 %matplotlib inline 内部也使用）不兼容。'tight' 设置会重新调整画布以适应所有内容，并在包装之前发生。

set_x(x)

设置文本的 x 位置。

参数:

xfloat

set_y(y)

设置文本的 y 位置。

参数:

yfloat

update(kwargs)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_bbox_position_size(renderer)

更新 bbox 的位置和大小。

当需要在实际绘制边界框之前更新其位置和大小时，应使用此方法。

update_from(other)

将属性从 other 复制到 self。

zorder = 3

class matplotlib.text.Annotation(text, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)

基类：Text, _AnnotationBase

Annotation 是一个 Text，可以指向特定的位置 xy。可以选择绘制一个从文本指向 xy 的箭头。

属性:

xy

带注释的位置。

xycoords

用于 xy 的坐标系。

arrow_patch

一个 FancyArrowPatch 用于从 xytext 指向 xy。

用文本 text 标注点 xy。

在最简单的形式中，文本被放置在 xy 处。

可选地，文本可以显示在另一个位置 xytext。通过定义 arrowprops，可以添加一个从文本指向注释点 xy 的箭头。

参数:

文本str

注释的文本。

xy(浮点数, 浮点数)

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

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

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

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

给出 xy 的坐标系。支持以下类型的值：

• 以下字符串之一：

  值	描述
  '图示点'	从图的左下方开始
  'figure pixels'	来自图形左下角的像素
  'figure fraction'	从左下角开始的图形部分
  '子图点'	子图的左下方点
  '子图像素'	子图左下角的像素
  '子图比例'	左下子图的比例
  '轴点'	从Axes的左下角开始的点
  'axes pixels'	从Axes的左下角开始的像素
  'axes fraction'	从左下角开始的轴的比例
  '数据'	使用被注释对象的坐标系（默认）
  '极地'	(theta, r) 如果不是原生的 '数据' 坐标

  请注意，对于父图来说，'subfigure pixels' 和 'figure pixels' 是相同的，因此希望在子图中使用代码的用户可以使用 'subfigure pixels'。

• 一个 Artist 的 xy 被解释为艺术家 Bbox 的分数。例如，(0, 0) 将是边界框的左下角，而 (0.5, 1) 将是边界框的中心顶部。

• 一个将 xy 转换为屏幕坐标的 Transform。

• 具有以下签名之一的函数:

  def transform(renderer) -> Bbox
  def transform(renderer) -> Transform
  

  其中 renderer 是 RendererBase 的子类。

  函数的结果解释方式与上述 Artist 和 Transform 的情况类似。

• 一个元组 (xcoords, ycoords) ，用于为 x 和 y 指定单独的坐标系。xcoords 和 ycoords 必须分别是上述描述的类型之一。

更多详情请参见 绘图指南-注释。

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

给定 xytext 的坐标系。

所有 xycoords 值都是有效的，以及以下字符串：

值	描述
'偏移点'	从 xy 值偏移，以点为单位
'偏移像素'	偏移量，以像素为单位，从 xy 值
'偏移字体大小'	偏移量，相对于字体大小，从 xy 值

arrowprops字典, 可选

用于在位置 xy 和 xytext 之间绘制 FancyArrowPatch 箭头的属性。默认为 None，即不绘制箭头。

由于历史原因，指定箭头有两种不同的方式，“简单”和“花哨”：

简单箭头：

如果 arrowprops 不包含键 'arrowstyle'，则允许的键是：

键	描述
宽度	箭头的宽度，单位为点
headwidth	箭头头部的基部宽度，单位为点
headlength	箭头头部的长度（以点为单位）
缩小	总长度两端缩小的比例
toctree 是一个 reStructuredText 指令 ，这是一个非常多功能的标记。指令可以有参数、选项和内容。	任何 FancyArrowPatch 属性

箭头附着在文本框的边缘，确切的位置（角或中心）取决于它指向的方向。

花哨的箭头：

如果 arrowprops 中提供了 'arrowstyle'，则使用此选项。

有效键是以下 FancyArrowPatch 参数：

键	描述
箭头样式	箭头样式
连接样式	连接样式
relpos	见下文；默认值为 (0.5, 0.5)
patchA	默认是文本的边界框
patchB	默认是 None
缩小A	以点为单位。默认是2点。
shrinkB	以点为单位。默认是2点。
mutation_scale	默认是文本大小（以点为单位）
mutation_aspect	默认是 1
toctree 是一个 reStructuredText 指令 ，这是一个非常多功能的标记。指令可以有参数、选项和内容。	任何 FancyArrowPatch 属性

箭头的精确起始位置由 relpos 定义。它是一个文本框的相对坐标元组，其中 (0, 0) 是左下角，(1, 1) 是右上角。支持 <0 和 >1 的值，并指定文本框外的点。默认值为 (0.5, 0.5)，因此起始点位于文本框的中心。

annotation_clip布尔值或无, 默认: 无

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

• 如果 True，当 xy 在 Axes 之外时，注释将被裁剪。

• 如果 False，注释将始终被绘制。

• 如果为 None，当 xy 在 Axes 之外且 xycoords 为 'data' 时，注释将被裁剪。

**kwargs

附加的 kwargs 传递给 Text。

返回:

Annotation

参见

注释

property anncoords

用于 Annotation.xyann 的坐标系。

contains(mouseevent)

返回鼠标事件是否发生在文本的轴对齐边界框内。

draw(renderer)

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

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

参数:

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

注释

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

get_anncoords()

返回用于 Annotation.xyann 的坐标系。

另请参见 Annotation 中的 xycoords。

get_tightbbox(renderer=None)

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

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

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

返回:

Bbox 或 None

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

get_window_extent(renderer=None)

返回包围文本的 Bbox 边界框，以显示单位表示。

除了内部使用外，这在网页上的png文件中指定可点击区域时也很有用。

参数:

渲染器渲染器，可选

需要一个渲染器来计算边界框。如果艺术家已经被绘制，渲染器会被缓存；因此，只有在第一次绘制之前调用 get_window_extent 时才需要传递此参数。实际上，通常更容易先触发一次绘制，例如通过调用 draw_without_rendering 或 plt.show()。

dpi浮点数，可选

用于计算 bbox 的 dpi 值，默认为 ``self.get_figure(root=True).dpi``（不是渲染器的 dpi）；如果需要匹配保存为自定义 dpi 值的图像区域，则应设置此值。

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, anncoords=<UNSET>, annotation_clip=<UNSET>, antialiased=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, mouseover=<UNSET>, multialignment=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	标量或无
animated	布尔
anncoords	未知
annotation_clip	布尔值或无
抗锯齿	布尔
背景颜色	color
bbox	带有 patches.FancyBboxPatch 属性的字典
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
颜色 或 c	color
figure	未知
fontfamily 或 family 或 fontname	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties 或 font 或 font_properties	font_manager.FontProperties 或 str 或 pathlib.Path
fontsize 或 size	浮点数或 {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch 或 stretch	{一个数值范围在0-1000之间, '超压缩', '特压缩', '压缩', '半压缩', '正常', '半扩展', '扩展', '特扩展', '超扩展'}
fontstyle 或样式	{'normal', 'italic', 'oblique'}
fontvariant 或 variant	{'normal', 'small-caps'}
fontweight 或 weight	{一个数值范围在0-1000之间, '超轻', '轻', '正常', '常规', '书', '中等', '罗马', '半粗', '半粗', '半', '粗', '重', '特粗', '黑'}
gid	str
horizontalalignment 或 ha	{'left', 'center', 'right'}
in_layout	布尔
标签	对象
行间距	浮动（字体大小的倍数）
math_fontfamily	str
鼠标悬停	布尔
多重对齐 或 ma	{'left', 'right', 'center'}
解析数学	布尔
path_effects	AbstractPathEffect 列表
picker	None 或 bool 或 float 或 callable
位置	(浮点数, 浮点数)
光栅化	布尔
旋转	float 或 {'vertical', 'horizontal'}
rotation_mode	{None, 'default', 'anchor'}
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
文本	对象
transform	Transform
transform_rotates_text	布尔
url	str
usetex	bool, 默认值: rcParams["text.usetex"] (default: False)
垂直对齐 或 va	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
可见	布尔
wrap	布尔
x	float
y	float
zorder	float

set_anncoords(coords)

设置用于 Annotation.xyann 的坐标系。

另请参见 Annotation 中的 xycoords。

set_figure(fig)

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

参数:

fig : Figure 或 SubFigure图或子图

update_positions(renderer)

更新注释文本和箭头补丁的像素位置。

property xyann

文本位置。

另请参见 Annotation 中的 xytext。

property xycoords

!! 由 numpydoc 处理 !!

class matplotlib.text.OffsetFrom(artist, ref_coord, unit='points')

基类：object

用于处理 Annotation 的可调用辅助类。

参数:

艺术家 : Artist 或 BboxBase 或 TransformArtist 或 BboxBase 或 Transform

要计算偏移量的对象。

ref_coord(浮点数, 浮点数)

如果 artist 是一个 Artist 或 BboxBase ，这个值是偏移原点在 artist 边界框分数中的位置。

如果 artist 是一个变换，偏移原点是应用于此值的变换。

单元{'points', 'pixels'}, 默认: 'points'

用于偏移输入的屏幕单位（像素或点）。

get_unit()

返回用于 __call__ 所用变换的输入单位。

set_unit(unit)

设置输入到 __call__ 所使用的变换的单位。

参数:

单元{'点', '像素'}

class matplotlib.text.TextPath(xy, s, size=None, prop=None, _interpolation_steps=1, usetex=False)

基类：Path

从文本创建路径。

从文本创建路径。请注意，它只是一个路径，而不是一个艺术家。你需要使用 `.PathPatch`（或其他艺术家）将此路径绘制到画布上。

参数:

xy两个浮点值的元组或数组

文本的位置。没有偏移时，使用 xy=(0, 0)。

sstr

要转换为路径的文本。

大小浮点数，可选

字体大小，以点为单位。默认值为通过字体属性 prop 指定的尺寸。

prop : FontProperties, 可选FontProperties，可选

字体属性。如果未提供，将使用默认的 FontProperties 并从 rcParams 获取参数。

_interpolation_stepsint, 可选

（当前忽略）

usetexbool, 默认: False

是否使用 tex 渲染。

示例

以下代码从字符串“ABC”创建了一个使用Helvetica字体的路径；并从LaTeX分数1/2创建了另一个路径:

from matplotlib.text import TextPath
from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Helvetica", style="italic")
path1 = TextPath((12, 12), "ABC", size=12, prop=fp)
path2 = TextPath((0, 0), r"$\frac{1}{2}$", size=12, usetex=True)

另请参阅 将文本用作路径。

property codes

返回代码

get_size()

获取文本大小。

set_size(size)

设置文本大小。

property vertices

如果需要，更新后返回缓存路径。

class matplotlib.text.TextToPath

基类：object

一个将字符串转换为路径的类。

DPI = 72

FONT_SCALE = 100.0

get_glyphs_mathtext(prop, s, glyph_map=None, return_new_glyphs_only=False)

解析 mathtext 字符串 s 并将其转换为 (顶点, 代码) 对。

get_glyphs_tex(prop, s, glyph_map=None, return_new_glyphs_only=False)

使用 usetex 模式将字符串 s 转换为顶点和代码。

get_glyphs_with_font(font, s, glyph_map=None, return_new_glyphs_only=False)

使用提供的 ttf 字体将字符串 s 转换为顶点和代码。

get_text_path(prop, s, ismath=False)

将文本 s 转换为路径（matplotlib.path.Path 的顶点和代码的元组）。

参数:

prop字体属性

文本的字体属性。

sstr

要转换的文本。

ismath{False, True, "TeX"}

如果为 True，使用 mathtext 解析器。如果为 "TeX"，使用 TeX 进行渲染。

返回:

verts列表

包含顶点 (x, y) 坐标的数组列表。

代码列表

路径代码列表。

示例

从文本创建顶点和代码的列表，并从这些创建一个 Path:

from matplotlib.path import Path
from matplotlib.text import TextToPath
from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Comic Neue", style="italic")
verts, codes = TextToPath().get_text_path(fp, "ABC")
path = Path(verts, codes, closed=False)

另请参阅 TextPath 以更直接的方式从文本创建路径。

get_text_width_height_descent(s, prop, ismath)