matplotlib.text
#
用于在图中包含文本的类。
- 类 matplotlib.text。文本( x = 0 , y = 0 , text = '' , * , color = None , verticalalignment = 'baseline' , Horizo ntalalignment = 'left' , multialignment = None , fontproperties = None , rotation = None , linespacing = None , rotation_mode =无, usetex = None , wrap = False , transform_rotates_text = False , parse_math = None , ** kwargs ) [来源] #
基地:
Artist
处理窗口或数据坐标中文本的存储和绘制。
在x , y处创建一个带有字符串text
Text
的实例。文本根据(默认:'left')和 (默认:'bottom')相对于锚点(x,y )对齐。另请参见 文本对齐。
horizontalalignment
verticalalignment
虽然 Text 接受 'label' 关键字参数,但默认情况下它不会添加到图例的句柄中。
有效的关键字参数是:
财产
描述
一个过滤器函数,它接受一个 (m, n, 3) 浮点数组和一个 dpi 值,并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
标量或无
布尔
颜色
具有属性的字典
patches.FancyBboxPatch
未知
未知
未知
color
或 c颜色
fontfamily
或家人{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties
或字体或字体属性fontsize
或尺寸浮动或{'xx-small'、'x-small'、'small'、'medium'、'large'、'x-large'、'xx-large'}
fontstretch
或拉伸{0-1000 范围内的数值,'超压缩','超压缩','压缩','半压缩','普通','半扩展','扩展','超扩展', '超膨胀'}
fontstyle
或风格{'正常','斜体','斜体'}
fontvariant
或变体{'正常', '小型大写字母'}
fontweight
或重量{0-1000 范围内的数值, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', '粗体','重','超粗体','黑色'}
字符串
{'左','中心','右'}
布尔
目的
浮动(字体大小的倍数)
字符串
布尔
{'左','右','中心'}
布尔
None 或 bool 或 float 或可调用
(浮动,浮动)
布尔
浮动或{'垂直','水平'}
{无,'默认','锚点'}
(比例:浮动,长度:浮动,随机性:浮动)
布尔或无
目的
布尔
字符串
布尔或无
{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
布尔
布尔
漂浮
漂浮
漂浮
- 绘制(渲染器)[来源] #
使用给定的渲染器绘制艺术家(及其子级)。
如果艺术家不可见,这将无效(
Artist.get_visible
返回 False)。- 参数:
- 渲染器
RendererBase
子类。
- 渲染器
笔记
此方法在 Artist 子类中被覆盖。
- get_bbox_patch ( ) [来源] #
返回 bbox 补丁,如果
patches.FancyBboxPatch
未制作,则返回 None。
- get_family ( ) [来源] #
的别名
get_fontfamily
。
- get_math_fontfamily ( ) [来源] #
返回由 Matplotlib 呈现的数学文本的字体系列名称。
默认值为
rcParams["mathtext.fontset"]
(默认值:'dejavusans'
)。也可以看看
- get_name ( ) [来源] #
的别名
get_fontname
。
- get_prop_tup ( renderer = None ) [来源] #
[弃用]返回属性的可散列元组。
不打算供人类阅读,但对于想要缓存有关文本(例如布局)的派生信息并需要知道文本是否已更改的后端很有用。
笔记
自 3.5 版起已弃用。
- get_size ( ) [来源] #
的别名
get_fontsize
。
- get_style ( ) [来源] #
的别名
get_fontstyle
。
- get_variant ( ) [来源] #
的别名
get_fontvariant
。
- get_weight ( ) [来源] #
的别名
get_fontweight
。
- get_window_extent ( renderer = None , dpi = None ) [source] #
Bbox
以显示单位返回文本的边界。除了在内部使用之外,这对于在网页上的 png 文件中指定可点击区域很有用。
- 参数:
- 渲染器渲染器,可选
需要渲染器来计算边界框。如果艺术家已经被绘制,渲染器被缓存;
get_window_extent
因此,只有在第一次抽奖之前调用时才需要传递此参数。在实践中,首先触发平局通常更容易,例如通过调用draw_without_rendering
orplt.show()
。- dpi浮点数,可选
计算bbox的dpi值,默认为
self.figure.dpi
(不是渲染器dpi);应该设置,例如是否将区域与使用自定义 dpi 值保存的图形匹配。
- 设置( * , agg_filter=<UNSET> , alpha=<UNSET> , animated=<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=<未设置>,水平对齐=<未设置>, in_layout=<UNSET> , label=<UNSET> , linespacing=<UNSET> , math_fontfamily=<UNSET> , mouseover=<UNSET > , multialignment=<UNSET> , parse_math =<UNSET> , path_effects=<UNSET> ,选择器=<UNSET> , position=<UNSET> , rasterized=<UNSET> , rotation=<UNSET> , rotation_mode=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> , text=<UNSET> , transform=<未设置> ,transform_rotates_text=<UNSET> ,url=<UNSET> , usetex=<UNSET> , verticalalignment=<UNSET> , visible=<UNSET> , wrap=<UNSET> , x=<UNSET> , y=<UNSET> , zorder=<UNSET> ) [来源] #
一次设置多个属性。
支持的属性是
财产
描述
一个过滤器函数,它接受一个 (m, n, 3) 浮点数组和一个 dpi 值,并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
标量或无
布尔
颜色
具有属性的字典
patches.FancyBboxPatch
未知
未知
未知
颜色
{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
浮动或{'xx-small'、'x-small'、'small'、'medium'、'large'、'x-large'、'xx-large'}
{0-1000 范围内的数值,'超压缩','超压缩','压缩','半压缩','普通','半扩展','扩展','超扩展', '超膨胀'}
{'正常','斜体','斜体'}
{'正常', '小型大写字母'}
{0-1000 范围内的数值, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', '粗体','重','超粗体','黑色'}
字符串
{'左','中心','右'}
布尔
目的
浮动(字体大小的倍数)
字符串
布尔
{'左','右','中心'}
布尔
None 或 bool 或 float 或可调用
(浮动,浮动)
布尔
浮动或{'垂直','水平'}
{无,'默认','锚点'}
(比例:浮动,长度:浮动,随机性:浮动)
布尔或无
目的
布尔
字符串
布尔或无
{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
布尔
布尔
漂浮
漂浮
漂浮
- set_bbox ( rectprops ) [来源] #
在自己周围画一个边界框。
- 参数:
- rectprops dict 属性为
patches.FancyBboxPatch
默认的 boxstyle 是“方形”。的突变比例
patches.FancyBboxPatch
设置为字体大小。
- rectprops dict 属性为
例子
t.set_bbox(dict(facecolor='red', alpha=0.5))
- set_clip_path ( path , transform = None ) [source] #
设置艺术家的剪辑路径。
- 参数:
- 路径
Patch
或Path
或TransformedPath
或 无 剪辑路径。如果给定 a
Path
,则还必须提供转换。如果为None,则删除先前设置的剪辑路径。- 变换
Transform
,可选 仅在path是 a时使用
Path
,在这种情况下,给定Path
的将转换为TransformedPath
using transform。
- 路径
笔记
为了效率,如果path是 a
Rectangle
此方法会将剪切框设置为相应的矩形,并将剪切路径设置为None
。由于技术原因(支持
set
),元组(路径,变换)也被接受为单个位置参数。
- set_family ( fontname ) [来源] #
的别名
set_fontfamily
。
- set_fontfamily ( fontname ) [来源] #
设置字体系列。可以是单个字符串,也可以是优先级递减的字符串列表。每个字符串可以是真正的字体名称或通用字体类名称。如果是后者,具体的字体名称会在对应的rcParams中查找。
如果
Text
实例是用 构造的fontfamily=None
,则字体设置为rcParams["font.family"]
(默认值:['sans-serif']
),并且在set_fontfamily()
现有Text
实例上调用时也是如此。- 参数:
- fontname {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
- set_fontname ( fontname ) [源代码] #
的别名
set_family
。仅单向别名:getter 不同。
- 参数:
- fontname {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
- set_fontproperties ( fp ) [来源] #
设置控制文本的字体属性。
- 参数:
- fp
font_manager.FontProperties
或str
或pathlib.Path
如果是
str
,则将其解释为由 . 解析的 fontconfig 模式FontProperties
。如果 apathlib.Path
,则将其解释为字体文件的绝对路径。
- fp
- set_fontsize ( fontsize ) [源代码] #
设置字体大小。
- 参数:
- fontsize float 或 {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
如果是浮点数,则以磅为单位的字体大小。字符串值表示相对于默认字体大小的大小。
- set_fontstretch ( stretch ) [来源] #
设置字体拉伸(水平压缩或扩展)。
- 参数:
- 拉伸{0-1000范围内的数值,'超压缩','超压缩','压缩','半压缩','正常','半扩展','扩展','额外-扩展','超扩展'}
- set_fontweight (重量) [来源] #
设置字体粗细。
- 参数:
- weight {0-1000 范围内的数值, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi' , '粗体', '重', '超粗体', '黑色'}
- set_horizontalalignment ( align ) [来源] #
设置相对于锚点的水平对齐方式。
另请参见文本对齐。
- 参数:
- 对齐{'left', 'center', 'right'}
- set_math_fontfamily ( fontfamily ) [来源] #
为 Matplotlib 渲染的数学文本设置字体系列。
这只会影响 Matplotlib 自己的数学渲染器。
usetex=True
使用 TeX ( )渲染时没有效果。- 参数:
- 字体家族str
字体系列的名称。
可用字体系列在 matplotlibrc.template 文件中定义。
也可以看看
- set_multialignment ( align ) [来源] #
设置多行文本的文本对齐方式。
所有行的边界框的布局由水平对齐和垂直对齐属性决定。此属性控制该框中文本行的对齐方式。
- 参数:
- 对齐{'left', 'right', 'center'}
- set_name ( fontname ) [来源] #
的别名
set_fontname
。
- set_parse_math ( parse_math ) [来源] #
覆盖开关以禁用对此的任何数学文本解析
Text
。- 参数:
- parse_math布尔值
如果为 False,
Text
则永远不会使用 mathtext。如果为 True,如果有偶数个未转义的美元符号,将使用 mathtext。
- set_rotation ( s ) [来源] #
设置文本的旋转。
- 参数:
- s float 或 {'vertical', 'horizontal'}
数学上正方向(逆时针)的旋转角度,以度为单位。“水平”等于 0,“垂直”等于 90。
- set_rotation_mode ( m ) [来源] #
设置文本旋转模式。
- 参数:
- m {无,'默认','锚'}
如果
None
或"default"
,文本将首先旋转,然后根据它们的水平和垂直对齐方式对齐。如果"anchor"
,则对齐发生在旋转之前。
- set_size ( fontsize ) [来源] #
的别名
set_fontsize
。
- set_stretch (拉伸) [来源] #
的别名
set_fontstretch
。
- set_style ( fontstyle ) [来源] #
的别名
set_fontstyle
。
- set_text ( s ) [来源] #
设置文本字符串s。
它可能包含换行符 (
\n
) 或 LaTeX 语法中的数学。- 参数:
- 对象_
任何对象都会转换为其
str
表示形式,但None
转换为空字符串的对象除外。
- set_usetex ( usetex ) [来源] #
- 参数:
- usetex布尔或无
是否使用 TeX 渲染,
None
表示使用rcParams["text.usetex"]
(默认:False
)。
- set_variant (变体) [来源] #
的别名
set_fontvariant
。
- set_verticalalignment ( align ) [来源] #
设置相对于锚点的垂直对齐方式。
另请参见文本对齐。
- 参数:
- 对齐{'bottom'、'baseline'、'center'、'center_baseline'、'top'}
- set_weight (重量) [来源] #
的别名
set_fontweight
。
- set_wrap ( wrap ) [来源] #
设置文本是否可以换行。
- 参数:
- 换行布尔
笔记
包装不能与 (在 IPython/Jupyter内部也使用)一起使用。'tight' 设置重新调整画布以适应所有内容并在换行之前发生。
savefig(..., bbox_inches='tight')
%matplotlib inline
- zorder = 3 #
- 类 matplotlib.text。注释( text , xy , xytext = None , xycoords = 'data' , textcoords = None , arrowprops = None , annotation_clip = None , ** kwargs ) [来源] #
基地:
Text
,_AnnotationBase
An
Annotation
是Text
可以引用特定位置xy的 a 。可选地,可以绘制从文本指向xy的箭头。- 属性:
- xy
注释的位置。
- 坐标
xy的坐标系。
- 箭头补丁
A
FancyArrowPatch
从xytext指向xy。
用文本text注释点xy。
在最简单的形式中,文本放置在xy处。
可选地,文本可以显示在另一个位置xytext。然后可以通过定义arrowprops添加从文本指向注释点xy的箭头。
- 参数:
- 文字串
注释的文本。
- xy (浮点数,浮点数)
要注释的点(x, y) 。坐标系由xycoords确定。
- xytext (浮点数,浮点数),默认值:xy
放置文本的位置(x, y) 。坐标系由textcoords确定。
- xycoords str or
Artist
or orTransform
or callable or (float, float),默认值:'data' 给定xy的坐标系。支持以下类型的值:
以下字符串之一:
价值
描述
'数字点'
图左下角的点
'数字像素'
图左下角的像素
'数字分数'
图左下角的分数
'子图点'
子图左下角的点
'子图像素'
子图左下角的像素
'子图分数'
左下角子图的分数
'轴点'
坐标轴左下角的点
'轴像素'
坐标轴左下角的像素
'轴分数'
左下角轴的分数
'数据'
使用被注释对象的坐标系(默认)
'极性'
(theta, r)如果不是本机“数据”坐标
请注意,父图的“子图像素”和“图像素”是相同的,因此想要在子图中可用的代码的用户可以使用“子图像素”。
An
Artist
: xy被解释为艺术家的Bbox
. 例如,(0, 0)将是边界框的左下角,(0.5, 1)将是边界框的中心顶部。A
Transform
将xy转换为屏幕坐标。具有以下签名之一的函数:
def transform(renderer) -> Bbox def transform(renderer) -> Transform
其中渲染器是一个
RendererBase
子类。为x和y指定单独坐标系的元组(xcoords, ycoords)。xcoords和ycoords都必须是上述类型之一。
有关详细信息,请参阅高级注释。
- textcoords str or
Artist
orTransform
or callable or (float, float),默认值:xycoords的值 给定xytext的坐标系。
所有xycoords值以及以下字符串都是有效的:
价值
描述
'偏移点'
与xy值的偏移量(以磅为单位)
'偏移像素'
从xy值偏移(以像素为单位)
- arrowprops dict,可选
用于在xy和xytext位置之间绘制
FancyArrowPatch
箭头的属性。默认为无,即不绘制箭头。由于历史原因,有两种不同的方式来指定箭头,“简单”和“花哨”:
简单箭头:
如果arrowprops不包含键 'arrowstyle',则允许的键是:
钥匙
描述
宽度
箭头的宽度(以磅为单位)
头宽
箭头底部的宽度(以磅为单位)
头长
箭头的长度(以磅为单位)
收缩
从两端收缩的总长度的分数
?
箭头附加到文本框的边缘,确切的位置(角或中心)取决于它指向的位置。
花式箭头:
如果在 arrowprops 中提供了“arrowstyle”,则使用此选项。
有效键是以下
FancyArrowPatch
参数:钥匙
描述
箭头样式
箭头样式
连接方式
连接方式
回复
见下文; 默认为 (0.5, 0.5)
补丁A
默认是文本的边界框
补丁B
默认为无
收缩A
默认为 2 点
收缩B
默认为 2 点
突变规模
默认为文本大小(以磅为单位)
突变方面
默认值为 1。
?
箭头的确切起点位置由 relpos定义。它是文本框相对坐标的元组,其中 (0, 0) 是左下角, (1, 1) 是右上角。支持值 <0 和 >1,并指定文本框外的点。默认情况下 (0.5, 0.5) 起始点在文本框中居中。
- annotation_clip布尔或无,默认值:无
当注释点xy在坐标区之外时,是否剪裁(即不绘制)注释。
如果为True ,则当xy位于轴之外时,注释将被剪裁。
如果为False,则将始终绘制注释。
如果为None ,则当xy在轴外且xycoords为“数据”时,注释将被剪裁。
- **kwargs
额外的 kwargs 被传递给
Text
.
- 返回:
也可以看看
- 属性 nncoords #
用于 的坐标系
Annotation.xyann
。
- 绘制(渲染器)[来源] #
使用给定的渲染器绘制艺术家(及其子级)。
如果艺术家不可见,这将无效(
Artist.get_visible
返回 False)。- 参数:
- 渲染器
RendererBase
子类。
- 渲染器
笔记
此方法在 Artist 子类中被覆盖。
- get_anncoords ( ) [来源] #
返回用于 的坐标系
Annotation.xyann
。另请参见中的xycoords
Annotation
。
- get_tightbbox ( renderer = None ) [source] #
喜欢
Artist.get_window_extent
,但包括任何剪辑。- 参数:
- 渲染器
RendererBase
子类 将用于绘制图形的渲染器(即
fig.canvas.get_renderer()
)
- 渲染器
- 返回:
Bbox
封闭的边界框(在图中像素坐标中)。
- get_window_extent ( renderer = None ) [source] #
Bbox
以显示单位返回文本的边界。除了在内部使用之外,这对于在网页上的 png 文件中指定可点击区域很有用。
- 参数:
- 渲染器渲染器,可选
需要渲染器来计算边界框。如果艺术家已经被绘制,渲染器被缓存;
get_window_extent
因此,只有在第一次抽奖之前调用时才需要传递此参数。在实践中,首先触发平局通常更容易,例如通过调用draw_without_rendering
orplt.show()
。- dpi浮点数,可选
计算bbox的dpi值,默认为
self.figure.dpi
(不是渲染器dpi);应该设置,例如是否将区域与使用自定义 dpi 值保存的图形匹配。
- set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animated=<UNSET> , anncoords=<UNSET> , annotation_clip=<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> ,字体变体=<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=<未设置> ,文本=<未设置> ,transform=<UNSET> , transform_rotates_text=<UNSET> , url=<UNSET> , usetex=<UNSET> , verticalalignment=<UNSET> , visible=<UNSET> , wrap=<UNSET> , x=<UNSET> , y= <UNSET> , zorder=<UNSET> ) [来源] #
一次设置多个属性。
支持的属性是
财产
描述
一个过滤器函数,它接受一个 (m, n, 3) 浮点数组和一个 dpi 值,并返回一个 (m, n, 3) 数组和距图像左下角的两个偏移量
标量或无
布尔
未知
annotation_clip
布尔或无
颜色
具有属性的字典
patches.FancyBboxPatch
布尔
补丁或(路径,变换)或无
color
或 c颜色
未知
fontfamily
或家人{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties
或字体或字体属性fontsize
或尺寸浮动或{'xx-small'、'x-small'、'small'、'medium'、'large'、'x-large'、'xx-large'}
fontstretch
或拉伸{0-1000 范围内的数值,'超压缩','超压缩','压缩','半压缩','普通','半扩展','扩展','超扩展', '超膨胀'}
fontstyle
或风格{'正常','斜体','斜体'}
fontvariant
或变体{'正常', '小型大写字母'}
fontweight
或重量{0-1000 范围内的数值, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', '粗体','重','超粗体','黑色'}
字符串
{'左','中心','右'}
布尔
目的
浮动(字体大小的倍数)
字符串
布尔
{'左','右','中心'}
布尔
None 或 bool 或 float 或可调用
(浮动,浮动)
布尔
浮动或{'垂直','水平'}
{无,'默认','锚点'}
(比例:浮动,长度:浮动,随机性:浮动)
布尔或无
目的
布尔
字符串
布尔或无
{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
布尔
布尔
漂浮
漂浮
漂浮
- set_anncoords ( coords ) [来源] #
设置用于 的坐标系
Annotation.xyann
。另请参见中的xycoords
Annotation
。
- 属性 xyann #
文本位置。
另请参见中的xytext
Annotation
。
- 属性 xycoords #
- 类 matplotlib.text。OffsetFrom (艺术家, ref_coord , unit = 'points' ) [来源] #
基地:
object
用于使用的可调用助手类
Annotation
。- 参数: