matplotlib.text

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

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

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

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

属性:

xy

注释位置。

xycoords

的坐标系 xy .

arrow_patch

A FancyArrowPatch 指向 木文 到 xy .

注释该点 xy 带文字 text .

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

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

参数:

textSTR

批注的文本。 s 是此参数的已弃用同义词。

xy（浮标，浮标）

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

木文 ：（float，float），默认值： xy（float，float），默认值：

位置 （x，y） 将文本放置在。坐标系由 文本框 .

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

坐标系 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 或float，或float，默认值 木栓str或

坐标系 木文 给出。

所有 木栓 值和以下字符串都有效：

价值	描述
“偏移点”	偏移（以点为单位） xy 价值
偏移像素	偏移（像素） xy 价值

arrowprops可选的

用于绘制 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_clipbool或None，默认值：None

是否在批注点时绘制批注 xy 在轴区域之外。

• 如果 True ，仅当 xy 在轴内。
• 如果 假 ，注释将始终绘制。
• 如果 None ，仅当 xy 在轴和 木栓 是“数据”。

**kwargs

额外的禁运转给 Text .

返回:

Annotation

参见

高级批注

property anncoords

要用于的坐标系 Annotation.xyann .

contains(event)

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

draw(renderer)

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

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

参数:

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

笔记

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

get_anncoords()

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

也见 木栓 在里面 Annotation .

get_window_extent(renderer=None)

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

参数:

renderer渲染器，可选

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

set_anncoords(coords)

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

也见 木栓 在里面 Annotation .

set_figure(fig)

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

参数:

fig ： Figure图形

update_positions(renderer)

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

property xyann

文本位置。

也见 木文 在里面 Annotation .

property xycoords

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

基类：object

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

参数:

艺术家 ： Artist 或 BboxBase 或 Transform艺术家或BboxBase或Transform

计算偏移量的对象。

ref_coord（浮标，浮标）

如果 艺术家 是一个 Artist 或 BboxBase ，该值是偏移原点的位置，以 艺术家 包围盒。

如果 艺术家 是转换，偏移原点是应用于该值的转换。

unit{'points，'pixels}，默认值：'points'

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

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 .

有效的关键字参数为：

财产	描述
agg_filter	一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。
alpha	浮动或无
animated	布尔
backgroundcolor	颜色
bbox	带有属性的dict patches.FancyBboxPatch
clip_box	Bbox
clip_on	布尔
clip_path	面片或（路径、变换）或无
color 或c	颜色
contains	未知的
figure	Figure
fontfamily 或是家人	fontname，'serif'、'sans-serif'、'cursive'、'fantasy'、'monospace'
fontproperties 或字体或字体属性	font_manager.FontProperties or str or pathlib.Path
fontsize 或大小	浮点或{'xx-small'、'x-small'、'small'、'medium'、'large'、'x-large'、'xx-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	无、布尔或可呼叫
position	（浮标，浮标）
rasterized	布尔或无
rotation	浮动或{'vertical'，'horizontal'}
rotation_mode	无，'默认值'，'定位点'
sketch_params	（比例：浮动，长度：浮动，随机性：浮动）
snap	布尔或无
text	对象
transform	Transform
url	STR
usetex	布尔或无
verticalalignment 或者弗吉尼亚	‘中心’、‘顶部’、‘底部’、‘基线’、‘中心基线’；
visible	布尔
wrap	布尔
x	浮动
y	浮动
zorder	浮动

contains(mouseevent)

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

draw(renderer)

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

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

参数:

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

笔记

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

get_bbox_patch()

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

get_c()

Alias get_color .

get_color()

返回文本的颜色。

get_family()

Alias get_fontfamily .

get_font()

Alias get_fontproperties .

get_font_properties()

Alias 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()

Alias get_horizontalalignment .

get_horizontalalignment()

以字符串形式返回水平对齐。将是“left”、“center”或“right”之一。

get_name()

Alias get_fontname .

get_position()

返回文本的（x，y）位置。

get_prop_tup(renderer=None)

返回属性的可哈希元组。

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

get_rotation()

返回0到360之间的文本角度（度）。

get_rotation_mode()

返回文本旋转模式。

get_size()

Alias get_fontsize .

get_stretch()

以字符串或数字形式返回字体长度。

参见

font_manager.FontProperties.get_stretch

get_style()

Alias get_fontstyle .

get_text()

返回文本字符串。

get_unitless_position()

返回文本的（x，y）无单位位置。

get_usetex()

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

get_va()

Alias get_verticalalignment .

get_variant()

Alias get_fontvariant .

get_verticalalignment()

以字符串形式返回垂直对齐。将是“top”、“center”、“bottom”或“baseline”之一。

get_weight()

Alias get_fontweight .

get_window_extent(renderer=None, dpi=None)

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

除了在内部使用之外，这对于在网页上的PNG文件中指定可单击区域也很有用。

参数:

renderer渲染器，可选

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

dpi可选浮动

用于计算bbox的dpi值，默认为 self.figure.dpi （ not 渲染器dpi）；应进行设置，例如，如果要匹配使用自定义dpi值保存的图形的区域。

get_wrap()

返回文本是否可以包装。

set_backgroundcolor(color)

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

参数:

color颜色

参见

set_bbox

更改边界框的位置

set_bbox(rectprops)

围绕自身绘制边界框。

参数:

矩形支柱 ：带有属性的dict patches.FancyBboxPatch带有属性的dict

默认的BoxStyle为“Square”。基因突变量表 patches.FancyBboxPatch 设置为字体大小。

实例

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

set_c(color)

Alias set_color .

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_color(color)

设置文本的前景色

参数:

color颜色

set_family(fontname)

Alias set_fontfamily .

set_font(fp)

Alias set_fontproperties .

set_font_properties(fp)

Alias set_fontproperties .

set_fontfamily(fontname)

设置字体系列。可以是单个字符串，也可以是优先级降低的字符串列表。每个字符串可以是真正的字体名，也可以是通用的字体类名。如果是后者，则将在相应的rcparams中查找特定的字体名称。

如果A Text 实例是用 fontfamily=None ，则字体设置为 rcParams["font.family"] (default: ['sans-serif']) ，当 set_fontfamily() 在现有的 Text 实例。

参数:

fontnamefontname，'serif'、'sans-serif'、'cursive'、'fantasy'、'monospace'

参见

font_manager.FontProperties.set_family

set_fontname(fontname)

Alias set_family .

单向别名：getter不同。

参数:

fontnamefontname，'serif'、'sans-serif'、'cursive'、'fantasy'、'monospace'

参见

font_manager.FontProperties.set_family

set_fontproperties(fp)

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

参数:

fp ： font_manager.FontProperties 或 str 或 pathlib.Path字体_管理器.FontProperties或str或路径库路径

如果A str ，它被解释为 FontProperties . 如果A pathlib.Path ，它被解释为字体文件的绝对路径。

set_fontsize(fontsize)

设置字体大小。

参数:

fontsize浮点或{'xx-small'、'x-small'、'small'、'medium'、'large'、'x-large'、'xx-large'}

如果为float，则字体大小以点为单位。字符串值表示相对于默认字体大小的大小。

参见

font_manager.FontProperties.set_size

set_fontstretch(stretch)

设置字体拉伸（水平缩排或展开）。

参数:

stretch范围0-1000内的数值，'ultra condensed'、'extra condensed'、'condensed'、'semi condensed'、'normal'、'semi expanded'、'expanded'、'extra expanded'、'extra expanded'、'extra expanded'、'extra exp

参见

font_manager.FontProperties.set_stretch

set_fontstyle(fontstyle)

设置字体样式。

参数:

fontstyle'正常'、'斜体'、'斜体'

参见

font_manager.FontProperties.set_style

set_fontvariant(variant)

设置字体变量。

参数:

variant“普通”、“小大写”

参见

font_manager.FontProperties.set_variant

set_fontweight(weight)

设置字体粗细。

参数:

weight范围为0-1000、'ultralight'、'light'、'normal'、'regular'、'book'、'medium'、'roman'、'semibold'、'demi bold'、'demi'、'bold'、'heavy'、'extra bold'、'black'的数值。

参见

font_manager.FontProperties.set_weight

set_ha(align)

Alias set_horizontalalignment .

set_horizontalalignment(align)

将水平对齐设置为

参数:

align“居中”、“右”、“左”

set_linespacing(spacing)

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

默认行距为1.2。

参数:

spacing浮动（字体大小的倍数）

set_ma(align)

Alias set_multialignment .

set_multialignment(align)

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

所有线的边界框的布局由“水平对齐”和“垂直对齐”属性决定。此属性控制该框中文本行的对齐方式。

参数:

align'左'、'右'、'中'

set_name(fontname)

Alias set_fontname .

set_position(xy)

设置（ x ， y ）文本的位置。

参数:

xy（浮标，浮标）

set_rotation(s)

设置文本的旋转。

参数:

s浮动或{'vertical'，'horizontal'}

在数学上正方向（逆时针方向）的旋转角度，单位为度“水平”等于0，“垂直”等于90。

set_rotation_mode(m)

设置文本旋转模式。

参数:

m无，'默认值'，'定位点'

如果 None 或 "default" ，文本将首先旋转，然后根据其水平和垂直对齐方式进行对齐。如果 "anchor" ，然后在旋转之前进行对齐。

set_size(fontsize)

Alias set_fontsize .

set_stretch(stretch)

Alias set_fontstretch .

set_style(fontstyle)

Alias set_fontstyle .

set_text(s)

设置文本字符串 s .

它可能包含换行符 (\n ）或者用 Latex 语法的数学。

参数:

s对象

任何对象都将转换为 str 陈述，除了 None 转换为空字符串。

set_usetex(usetex)

参数:

usetex布尔或无

是否使用tex渲染， None 使用方法 rcParams["text.usetex"] (default: False) .

set_va(align)

Alias set_verticalalignment .

set_variant(variant)

Alias set_fontvariant .

set_verticalalignment(align)

设置垂直对齐。

参数:

align‘中心’、‘顶部’、‘底部’、‘基线’、‘中心基线’；

set_weight(weight)

Alias set_fontweight .

set_wrap(wrap)

设置是否可以包装文本。

参数:

wrap布尔

set_x(x)

设置 x 文本的位置。

参数:

x浮动

set_y(y)

设置 y 文本的位置。

参数:

y浮动

update(kwargs)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

update_bbox_position_size(renderer)

更新bbox的位置和大小。

当实际绘制bbox之前需要更新bbox的位置和大小时，应使用此方法。

update_from(other)

从复制属性 其他 到 self .

zorder = 3

matplotlib.text.get_rotation(rotation)

返回 旋转 标准化为0到360度之间的角度。

参数:

rotationfloat或{None，'水平'，'垂直'}

旋转角度（度）。 None “水平”等于0，“垂直”等于90。

返回:

浮动