文本

matplotlib.text¶

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

class matplotlib.text.Annotation(s, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)[源代码]¶

基类：matplotlib.text.Text, matplotlib.text._AnnotationBase

安 Annotation 是一个 Text 指的是一个特定的位置 xy . （可选）从文本指向 xy 可以画出来。

属性:	xy 注释位置。 木栓 的坐标系 xy . arrow_patch A FancyArrowPatch 指向 木文 到 xy .

注释该点 xy 带文字 s .

在最简单的形式中，文本放置在 xy .

或者，文本可以显示在其他位置 木文 . 从文本指向注释点的箭头 xy 然后可以通过定义 箭头 .

参数:

s : STR 批注的文本。 xy : （浮标，浮标） 重点 （x，y） 注释。 木文 : （浮动，浮动）可选 位置 （x，y） 将文本放置在。如果 None 默认为 xy . 木栓 STR， Artist ， Transform ，可调用或元组，可选 : str、artist、transform、callable或tuple，可选 坐标系 xy 给出。支持以下类型的值： 下列字符串之一： 价值 描述 “图形点” 图左下角的点 “图形像素” 图片左下角的像素 '数字分数' 从左下角开始的分数 “轴点” 轴左下角的点 “轴像素” 来自轴左下角的像素 “轴分数” 从左下角开始的轴分数 “数据” 使用要注释的对象的坐标系（默认） “极地” （θ，r） 如果不是本机“数据”坐标 安 Artist ： xy 被解读为艺术家的一部分 Bbox . 例如。 （0, 0） 将是边界框的左下角，并且 （0.5，1） 将是边界框的中心顶部。 A Transform 改造 xy 以筛选坐标。 具有以下签名之一的函数： def transform(renderer) -> Bbox def transform(renderer) -> Transform 在哪里？ 渲染器 是一个 RendererBase 子类。 函数的结果解释为 Artist 和 Transform 以上病例。 元组 （xcoords，ycoords） 为指定单独的坐标系 x 和 y . XCORDS 和 钇铝石榴石 必须为上述类型之一。 见 高级批注 了解更多详细信息。 默认为“数据”。 文本框 STR， Artist ， Transform ，可调用或元组，可选 : str、artist、transform、callable或tuple，可选 坐标系 木文 给出。 所有 木栓 值和以下字符串都有效： 价值 描述 “偏移点” 偏移（以点为单位） xy 价值 偏移像素 偏移（像素） xy 价值 默认值为 木栓 也就是说，对注释点和文本位置使用相同的坐标系。 箭头 : 可选的 用于绘制 FancyArrowPatch 位置之间的箭头 xy 和 木文 . 如果 箭头 不包含键“arrowstyle”。允许的键为： 键 描述 宽度 箭头的宽度（以点为单位） 头宽 箭头底端的宽度（以点为单位） 头长 箭头的长度（以点为单位） 收缩 从两端收缩的总长度的分数 是吗？ 任何密钥到 matplotlib.patches.FancyArrowPatch 如果 箭头 包含键“arrowstyle”。禁止使用上述键。允许的值 'arrowstyle' 是： 名字 阿特斯 '-' 没有 '->' head_length=0.4,head_width=0.2 '-[' widthB=1.0,lengthB=0.2,angleB=None '|-|' widthA=1.0,widthB=1.0 '-|>' head_length=0.4,head_width=0.2 '<-' head_length=0.4,head_width=0.2 '<->' head_length=0.4,head_width=0.2 '<|-' head_length=0.4,head_width=0.2 '<|-|>' head_length=0.4,head_width=0.2 'fancy' head_length=0.4,head_width=0.4,tail_width=0.4 'simple' head_length=0.5,head_width=0.5,tail_width=0.2 'wedge' tail_width=0.3,shrink_factor=0.5 有效键 FancyArrowPatch 是： 键 描述 箭头风格 箭头风格 连接方式 连接方式 雷波斯 默认值为（0.5，0.5） 帕查 默认为文本的边界框 帕奇布 默认为无 克里斯 默认为2分 收缩 默认为2分 mutation_scale 默认为文本大小（以点为单位） mutation_aspect 默认值为1。 是吗？ 任意键 matplotlib.patches.PathPatch 默认为无，即不绘制箭头。 annotation_clip : 布尔或无，可选 是否在批注点时绘制批注 xy 在轴区域之外。 如果 True ，仅当 xy 在轴内。 如果 假 ，注释将始终绘制。 如果 None ，仅当 xy 在轴和 木栓 是“数据”。 默认为 None . **kwargs 额外的禁运转给 Text .

返回:

注释 ： Annotation : 注释

参见

高级批注

anncoords¶

要用于的坐标系 Annotation.xyann .

arrow¶

3.0 版后已移除: Matplotlib 3.0中已弃用arrow，将在3.2中删除。用箭头补片代替。

contains(event)[源代码]¶

测试修补程序中是否发生鼠标事件。

对于文本，在包含文本的轴对齐边界框中的任何位置命中都为真。

返回:	bool : 布尔

draw(renderer)[源代码]¶

画出 Annotation 对给定对象的对象 渲染器 .

get_anncoords()¶

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

也见 木栓 在里面 Annotation .

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

返回 Bbox 以显示单位绑定文本和箭头。

参数:	渲染器 : 渲染器，可选 需要渲染器来计算边界框。如果已经绘制了艺术家，则会缓存渲染器；因此，只有在调用 get_window_extent 在第一个之前 draw . 在实践中，通常更容易先触发一个绘制（例如通过保存图形）。

set_anncoords(coords)¶

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

也见 木栓 在里面 Annotation .

set_figure(fig)[源代码]¶

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

参数:	fig ： Figure : 图形

update_positions(renderer)[源代码]¶

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

xyann¶

文本位置。

也见 木文 在里面 Annotation .

class matplotlib.text.OffsetFrom(artist, ref_coord, unit='points')[源代码]¶

基类：object

用于处理的可调用帮助程序类 Annotation

参数:	艺术家 ： Artist ， BboxBase 或 Transform : 艺术家、bboxbase或变换 计算偏移量的对象。 ref_coord : 长度2序列 如果 artist 是一个 Artist 或 BboxBase ，该值是偏移原点的位置，以 artist 包围盒。 如果 artist 是转换，偏移原点是应用于该值的转换。 unit : '点，'像素' 用于偏移输入的屏幕单位（像素或点）。

get_unit()[源代码]¶

用于输入转换的单位 __call__

set_unit(unit)[源代码]¶

用于输入转换的单位 __call__

参数:	unit : '点'，'像素'

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, **kwargs)[源代码]¶

基类：matplotlib.artist.Artist

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

创建一个 Text 实例在 x ， y 带弦 text .

有效Kwargs是

财产	描述
agg_filter	一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。
alpha	浮动
animated	布尔
backgroundcolor	颜色
bbox	带有属性的dict patches.FancyBboxPatch
clip_box	matplotlib.transforms.Bbox
clip_on	布尔
clip_path	{ (path.Path, transforms.Transform), patches.Patch, None }
color	颜色
contains	可赎回的
figure	Figure
fontfamily	fontname，'serif'、'sans-serif'、'cursive'、'fantasy'、'monospace'
fontname	fontname，'serif'、'sans-serif'、'cursive'、'fantasy'、'monospace'
fontproperties	font_manager.FontProperties
fontsize	以点为单位的大小，'x x small'、'x-small'、'small'、'medium'、'large'、'x-large'、'x x large'
fontstretch	范围0-1000内的数值，'ultra condensed'、'extra condensed'、'condensed'、'semi condensed'、'normal'、'semi expanded'、'expanded'、'extra expanded'、'extra expanded'、'extra expanded'、'extra exp
fontstyle	'正常'、'斜体'、'斜体'
fontvariant	“普通”、“小大写”
fontweight	范围为0-1000、'ultralight'、'light'、'normal'、'regular'、'book'、'medium'、'roman'、'semibold'、'demi bold'、'demi'、'bold'、'heavy'、'extra bold'、'black'的数值。
gid	STR
horizontalalignment	“居中”、“右”、“左”
in_layout	布尔
label	对象
linespacing	浮动（字体大小的倍数）
multialignment	'左'、'右'、'中'
path_effects	AbstractPathEffect
picker	无或bool或float或callable
position	（浮标，浮标）
rasterized	布尔或无
rotation	角度（度）、“垂直”、“水平”
rotation_mode	无，'默认值'，'定位点'
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
text	可转换为字符串的字符串或对象（但 None 变成 '' ）
transform	Transform
url	STR
usetex	布尔或无
verticalalignment	‘中心’、‘顶部’、‘底部’、‘基线’、‘中心基线’；
visible	布尔
wrap	布尔
x	浮动
y	浮动
zorder	浮动

contains(mouseevent)[源代码]¶

测试修补程序中是否发生鼠标事件。

对于文本，在包含文本的轴对齐边界框中的任何位置命中都为真。

返回:	bool : 布尔

draw(renderer)[源代码]¶

绘制 Text 对给定对象的对象 渲染器 .

get_bbox_patch()[源代码]¶

返回bbox补丁，如果 patches.FancyBboxPatch 不是制造出来的。

get_color()[源代码]¶

返回文本的颜色

get_family(*args, **kwargs)¶

别名 get_fontfamily

get_font_properties(*args, **kwargs)¶

别名 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(*args, **kwargs)¶

别名 get_horizontalalignment

get_horizontalalignment()[源代码]¶

以字符串形式返回水平对齐。将是“左”、“中”或“右”之一。

get_name(*args, **kwargs)¶

别名 get_fontname

get_position()[源代码]¶

返回文本作为元组的位置（ x ， y ）

get_prop_tup(renderer=None)[源代码]¶

返回属性的可哈希元组。

不适合人类阅读，但对于希望缓存有关文本（如布局）的派生信息并需要知道文本是否已更改的后端非常有用。

get_rotation()[源代码]¶

返回以度为单位的浮动文本角度。

get_rotation_mode()[源代码]¶

获取文本旋转模式。

get_size(*args, **kwargs)¶

别名 get_fontsize

get_stretch()[源代码]¶

获取作为字符串或数字的字体拉伸

参见

font_manager.FontProperties.get_stretch

get_style(*args, **kwargs)¶

别名 get_fontstyle

get_text()[源代码]¶

将文本作为字符串获取

get_unitless_position()[源代码]¶

返回文本作为元组的无单位位置（ x ， y ）

get_usetex()[源代码]¶

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

如果用户没有手动设置此值，则默认为 rcParams["text.usetex"] .