Matlab中Text 属性的使用

目录

文本

String - 要显示的文本

Color - 文本颜色

Interpreter - 文本解释器

字体

FontName - 字体名称

FontSize - 字体大小

FontWeight - 字符粗细

FontAngle - 字符倾斜

FontUnits - 字体大小单位

FontSmoothing - 对字体字符外观进行平滑处理

文本框

Rotation - 文本方向

EdgeColor - 框轮廓的颜色

BackgroundColor - 文本框背景的颜色

LineStyle - 框轮廓的线型

LineWidth - 框轮廓的宽度

Margin - 文本框中文本周围的空间

Clipping - 以坐标区图框为界进行裁剪

位置

Position - 文本位置

Extent - 包围文本的矩形的大小和位置

Units - 位置和范围单位

HorizontalAlignment - 相对于位置点水平对齐文本

VerticalAlignment - 相对于位置点垂直对齐文本

交互性

Editing - 交互式编辑模式

Visible - 可见性状态

ContextMenu - 上下文菜单

Selected - 选择状态

SelectionHighlight - 是否显示选择句柄

回调

ButtonDownFcn - 鼠标点击回调

CreateFcn - 创建函数

DeleteFcn - 删除函数

回调执行控件

Interruptible - 回调中断

BusyAction - 回调排队

PickableParts - 捕获鼠标点击的能力

HitTest - 响应捕获的鼠标点击

BeingDeleted - 删除状态

父级/子级

Parent - 父级

Children - 子级

HandleVisibility - 对象句柄的可见性

标识符

Type - 图形对象的类型

Tag - 对象标识符

UserData - 用户数据

兼容性考虑

不推荐使用 UIContextMenu 属性

---

Text 属性是坐标区文本的外观和行为。

        Text 属性可控制 Text 对象的外观和行为。通过更改属性值，可以修改该文本的特定方面。使用圆点表示法查询和设置属性。

t = text(0.5,0.5,'text here');
s = t.FontSize;
t.FontSize = 12;

文本

String - 要显示的文本

        要显示的文本，指定为字符向量、字符向量元胞数组、字符串数组、分类数组或数值。根据希望文本具有的外观指定一个值。下表列出了最常见的情况。

文本外观	值的说明	示例
一行文本	字符向量或 1×1 字符串数组。	str = 'My Text' 或 str = "My Text"
多行文本	字符向量元胞数组或字符串数组。	str = {'First line','Second line'}; 或 str = ["First line", "Second line"];
包含数值变量的文本	包含已转换为char数组的数值的数组。使用num2str转换值。	x = 42; str = ['The value is ',num2str(x)];
包含特殊字符（例如希腊字母或数学符号）的文本	包含TeX标记的数组。有关支持的标记的列表，可以参考Interpreter属性。	str = 'x ranges from 0 to 2\pi'

注意

• 词语 default、factory 和 remove 是保留字，作为标准字符引用时，文本中将不会出现。要在文本中单独显示这些单词中的任意单词，需在该单词之前放置反斜杠，例如 '\default' 或 '\remove'。

• 如果将此属性指定为分类数组，MATLAB® 将使用数组中的值，而不是类别。

• 如果指定仅包含数值的文本，此数值将会使用 sprintf('%g',value) 转换。例如，12345678 显示为 1.23457e+07。

Color - 文本颜色

        文本颜色，指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。默认值 [0 0 0] 对应于黑色。

对于自定义颜色，请指定 RGB 三元组或十六进制颜色代码。

• RGB 三元组是包含三个元素的行向量，其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内，例如 [0.4 0.6 0.7]。

• 十六进制颜色代码是字符向量或字符串标量，以井号 (#) 开头，后跟三个或六个十六进制数字，范围可以是 0 到 F。这些值不区分大小写。因此，颜色代码 '#FF8800' 与 '#ff8800'、'#F80' 与 '#f80' 是等效的。

        此外，还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称	短名称	RGB 三元组	十六进制颜色代码	外观
'red'	'r'	[1 0 0]	'#FF0000'
'green'	'g'	[0 1 0]	'#00FF00'
'blue'	'b'	[0 0 1]	'#0000FF'
'cyan'	'c'	[0 1 1]	'#00FFFF'
'magenta'	'm'	[1 0 1]	'#FF00FF'
'yellow'	'y'	[1 1 0]	'#FFFF00'
'black'	'k'	[0 0 0]	'#000000'
'white'	'w'	[1 1 1]	'#FFFFFF'
'none'	不适用	不适用	不适用	无颜色

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组	十六进制颜色代码	外观
[0 0.4470 0.7410]	'#0072BD'
[0.8500 0.3250 0.0980]	'#D95319'
[0.9290 0.6940 0.1250]	'#EDB120'
[0.4940 0.1840 0.5560]	'#7E2F8E'
[0.4660 0.6740 0.1880]	'#77AC30'
[0.3010 0.7450 0.9330]	'#4DBEEE'
[0.6350 0.0780 0.1840]	'#A2142F'

        例如： 'blue'  [0 0 1]  '#0000FF'

Interpreter - 文本解释器

文本解释器，指定为下列值之一：

• 'tex' - 使用 TeX 标记子集解释字符。

• 'latex' - 使用 LaTeX 标记解释字符。

• 'none' - 显示字面字符。

TeX 标记

        默认情况下，MATLAB 支持一部分 TeX 标记。使用 TeX 标记可添加下标和上标，修改字体类型和颜色，并在文本中包括特殊字符。

        修饰符会一直作用到文本结尾，但上标和下标除外，因为它们仅修饰下一个字符或花括号中的字符。将解释器设置为 'tex' 时，支持的修饰符如下所示。

修饰符	说明	示例
^{ }	上标	'text^{superscript}'
_{ }	下标	'text_{subscript}'
\bf	粗体	'\bf text'
\it	斜体	'\it text'
\sl	伪斜体（通常与斜体相同）	'\sl text'
\rm	常规字体	'\rm text'
\fontname{specifier}	字体名称 - 将 specifier 替换为字体系列的名称。您可以将此说明符与其他修饰符结合使用。	'\fontname{Courier}text'
\fontsize{specifier}	字体大小 - 将 specifier 替换为以磅为单位的数值标量值。	'\fontsize{15} text'
\color{specifier}	字体颜色 - 将 specifier 替换为以下颜色之一：red、green、yellow、magenta、blue、black、white、gray、darkGreen、orange 或 lightBlue。	'\color{magenta} text'
\color[rgb]{specifier}	自定义字体颜色 - 将 specifier 替换为三元素 RGB 三元组。	'\color[rgb]{0,0.5,0.5} text'

下表列出了 'tex' 解释器所支持的特殊字符。

字符序列	符号	字符序列	符号	字符序列	符号
\alpha	α	\upsilon	υ	\sim	~
\angle	∠	\phi		\leq	≤
\ast	*	\chi	χ	\infty	∞
\beta	β	\psi	ψ	\clubsuit	♣
\gamma	γ	\omega	ω	\diamondsuit	♦
\delta	δ	\Gamma	Γ	\heartsuit	♥
\epsilon	ϵ	\Delta	Δ	\spadesuit	♠
\zeta	ζ	\Theta	Θ	\leftrightarrow	↔
\eta	η	\Lambda	Λ	\leftarrow	←
\theta	θ	\Xi	Ξ	\Leftarrow	⇐
\vartheta	ϑ	\Pi	Π	\uparrow	↑
\iota	ι	\Sigma	Σ	\rightarrow	→
\kappa	κ	\Upsilon	ϒ	\Rightarrow	⇒
\lambda	λ	\Phi	Φ	\downarrow	↓
\mu	µ	\Psi	Ψ	\circ	º
\nu	ν	\Omega	Ω	\pm	±
\xi	ξ	\forall	∀	\geq	≥
\pi	π	\exists	∃	\propto	∝
\rho	ρ	\ni	∍	\partial	∂
\sigma	σ	\cong	≅	\bullet	•
\varsigma	ς	\approx	≈	\div	÷
\tau	τ	\Re	ℜ	\neq	≠
\equiv	≡	\oplus	⊕	\aleph	ℵ
\Im	ℑ	\cup	∪	\wp	℘
\otimes	⊗	\subseteq	⊆	\oslash	∅
\cap	∩	\in	∈	\supseteq	⊇
\supset	⊃	\lceil	⌈	\subset	⊂
\int	∫	\cdot	·	\o	ο
\rfloor	⌋	\neg	¬	\nabla	∇
\lfloor	⌊	\times	x	\ldots	...
\perp	⊥	\surd	√	\prime	´
\wedge	∧	\varpi	ϖ	\0	∅
\rceil	⌉	\rangle	〉	\mid	|
\vee	∨	\langle	〈	\copyright	©

LaTeX 标记

        要使用 LaTeX 标记，请将解释器设置为 'latex'。使用美元符号将文本括起来，例如，对于内联模式，使用 '$\int_1^{20} x^2 dx$'；对于显示模式，使用 '$$\int_1^{20} x^2 dx$$'。

        显示的文本将使用默认的 LaTeX 字体样式。FontName、FontWeight 和 FontAngle 属性不起任何作用。要更改字体样式，请使用 LaTeX 标记。

        用于 LaTeX 解释器的文本最多可以包含 1200 个字符。对于多行文本，请在此数量的基础上每行减少约 10 个字符。

字体

FontName - 字体名称

        字体名称，指定为支持的字体名称或 'FixedWidth'。要正确显示和打印文本，必须选择系统支持的字体。默认字体取决于操作系统和区域设置。

        要使用在任何区域设置中都有较好显示效果的等宽字体，使用 'FixedWidth'。等宽字体依赖于根 FixedWidthFontName属性。设置根FixedWidthFontName属性会导致立即更新显示方式以使用新字体。

FontSize - 字体大小

        字体大小，指定为大于 0 的标量值（以磅为单位）。默认字体大小取决于具体操作系统和区域设置。一磅等于 1/72 英寸。要更改字体单位，使用FontUnits属性。

例如：12

数据类型：single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

FontWeight - 字符粗细

        字符粗细，指定为 'normal' 或 'bold'。

        MATLAB使用FontWeight属性从系统提供的字体中选择一种字体。并非所有字体都有加粗字体。因此，指定加粗字体仍可能得到普通字体。

FontAngle - 字符倾斜

        字符倾斜，指定为 'normal' 或 'italic'。

        并非所有字体都有两种字体样式。因此，斜体可能看上去和常规字体一样。

FontUnits - 字体大小单位

        字体大小单位，指定为此表中的一个值。

Units	说明
'points'	磅。一磅等于 1/72 英寸。
'inches'	英寸。
'centimeters'	厘米。
'normalized'	按坐标区绘图框高度的一定比例来解释字体大小。如果调整坐标区的大小，则字体大小也会相应地修改。例如，如果FontSize为0.1（归一化单位），则文本为绘图框高度的 1/10。
'pixels'	像素。 从 R2015b 开始，以像素为单位的距离不再依赖 Windows® 和 Macintosh 系统上的系统分辨率： 在 Windows 系统上，一个像素是 1/96 英寸。 在 Macintosh 系统上，一个像素是 1/72 英寸。 在 Linux® 系统上，一个像素的大小由系统分辨率确定。

        如果在一次函数调用中同时设置字体大小和字体单位，必须先设置FontUnits属性以使坐标区能正确解释指定的字体大小。

FontSmoothing - 对字体字符外观进行平滑处理

        对字体字符外观进行平滑处理，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，可以使用此属性的值作为逻辑值。该值存储为matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

• 'on' - 应用字体平滑处理。减少文本字符中出现参差不齐，使文本更易于读取。

• 'off' - 不应用字体平滑处理。

文本框

Rotation - 文本方向

        文本方向，指定为以度为单位的标量值。默认的 0 度旋转可使文本处于水平。对于垂直文本，请将此属性设置为 90 或 -90。设置为正值可逆时针旋转文本。设置为负值可顺时针旋转文本。

例如： 90  -90

数据类型：single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

EdgeColor - 框轮廓的颜色

框轮廓的颜色，指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。

对于自定义颜色，请指定 RGB 三元组或十六进制颜色代码。

• RGB 三元组是包含三个元素的行向量，其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内，例如 [0.4 0.6 0.7]。

• 十六进制颜色代码是字符向量或字符串标量，以井号 (#) 开头，后跟三个或六个十六进制数字，范围可以是 0 到 F。这些值不区分大小写。因此，颜色代码 '#FF8800' 与 '#ff8800'、'#F80' 与 '#f80' 是等效的。

        此外，还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称	短名称	RGB 三元组	十六进制颜色代码	外观
'red'	'r'	[1 0 0]	'#FF0000'
'green'	'g'	[0 1 0]	'#00FF00'
'blue'	'b'	[0 0 1]	'#0000FF'
'cyan'	'c'	[0 1 1]	'#00FFFF'
'magenta'	'm'	[1 0 1]	'#FF00FF'
'yellow'	'y'	[1 1 0]	'#FFFF00'
'black'	'k'	[0 0 0]	'#000000'
'white'	'w'	[1 1 1]	'#FFFFFF'
'none'	不适用	不适用	不适用	无颜色

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组	十六进制颜色代码	外观
[0 0.4470 0.7410]	'#0072BD'
[0.8500 0.3250 0.0980]	'#D95319'
[0.9290 0.6940 0.1250]	'#EDB120'
[0.4940 0.1840 0.5560]	'#7E2F8E'
[0.4660 0.6740 0.1880]	'#77AC30'
[0.3010 0.7450 0.9330]	'#4DBEEE'
[0.6350 0.0780 0.1840]	'#A2142F'

例如： 'blue'  [0 0 1]   '#0000FF'

BackgroundColor - 文本框背景的颜色

文本框背景色，指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。

对于自定义颜色，请指定 RGB 三元组或十六进制颜色代码。

• RGB 三元组是包含三个元素的行向量，其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内，例如 [0.4 0.6 0.7]。

• 十六进制颜色代码是字符向量或字符串标量，以井号 (#) 开头，后跟三个或六个十六进制数字，范围可以是 0 到 F。这些值不区分大小写。因此，颜色代码 '#FF8800' 与 '#ff8800'、'#F80' 与 '#f80' 是等效的。

此外，还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称	短名称	RGB 三元组	十六进制颜色代码	外观
'red'	'r'	[1 0 0]	'#FF0000'
'green'	'g'	[0 1 0]	'#00FF00'
'blue'	'b'	[0 0 1]	'#0000FF'
'cyan'	'c'	[0 1 1]	'#00FFFF'
'magenta'	'm'	[1 0 1]	'#FF00FF'
'yellow'	'y'	[1 1 0]	'#FFFF00'
'black'	'k'	[0 0 0]	'#000000'
'white'	'w'	[1 1 1]	'#FFFFFF'
'none'	不适用	不适用	不适用	无颜色

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组	十六进制颜色代码	外观
[0 0.4470 0.7410]	'#0072BD'
[0.8500 0.3250 0.0980]	'#D95319'
[0.9290 0.6940 0.1250]	'#EDB120'
[0.4940 0.1840 0.5560]	'#7E2F8E'
[0.4660 0.6740 0.1880]	'#77AC30'
[0.3010 0.7450 0.9330]	'#4DBEEE'
[0.6350 0.0780 0.1840]	'#A2142F'

例如： 'blue'  [0 0 1]  '#0000FF'

LineStyle - 框轮廓的线型

框轮廓的线型，指定为下表中的选项之一。

线型	说明	表示的线条
'-'	实线
'--'	虚线
':'	点线
'-.'	点划线
'none'	线条不可见

LineWidth - 框轮廓的宽度

框轮廓的宽度，指定为数值标量（以磅为单位）。一磅等于 1/72 英寸。

例如：1.5

数据类型： single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Margin - 文本框中文本周围的空间

文本框中文本周围的空间，指定为数值标量（以磅为单位）。

MATLAB 使用 Extent 属性值以及 Margin 属性值来确定文本框的大小。

例如： 8

数据类型： single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Clipping - 以坐标区图框为界进行裁剪

以坐标区图框为界裁剪文本，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，可以使用此属性的值作为逻辑值。该值存储为matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

• 'on' - 以坐标区图框为界裁剪文本。

  • 如果坐标区的 ClippingStyle 属性设置为 '3dbox'（默认设置），则 MATLAB 或许显示全部文本或许不显示任何文本，具体情况取决于文本的位置。如果文本 Position 属性定义的点位于坐标区内部，则 MATLAB 显示全部文本。如果该点位于坐标区的外部，则 MATLAB 不显示任何文本。

  • 如果坐标区的 ClippingStyle 属性设置为'rectangle'，则 MATLAB 显示位于坐标区图框内部的文本部分，而不显示位于坐标区图框外部的文本部分。

• 'off' - 不裁剪文本。其中有部分可能会显示在坐标区图框之外。

注意

如果关联的坐标区的 Clipping 属性设置为 'on'（默认设置），则每个对象控制各自的裁剪行为。如果坐标区的 Clipping 属性设置为 'off'，则 MATLAB 不裁剪坐标区中的任何对象，而与单个对象的 Clipping 属性无关。

位置

Position - 文本位置

文本位置，指定为 [x y] 格式的二元素向量或 [x y z] 格式的三元素向量。如果省略第三个元素 z，则 MATLAB 将其设置为 0。

使用数值指定位置。要将日期时间或持续时间值转换为特定坐标方向上的相应数值，参考ruler2num函数。

默认情况下，位置值是以数据单位定义的。要更改单位，请使用 Units 属性。

例如： [0.5 0.5 0]

数据类型： double | single | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Extent - 包围文本的矩形的大小和位置

此属性为只读

包围文本的矩形的大小和位置（不包括边距），以 [left bottom width height] 格式的四元素向量形式返回。前两个元素 left 和 bottom 定义矩形左下角的位置。后两个元素 width 和 height 定义矩形的维度。

默认情况下，范围值是以数据单位定义的。要更改单位，请使用 Units 属性。

例如： [0.5 0.5 0.4 0.2]

Units - 位置和范围单位

位置单位，指定为此表中的一个值。

单位	说明
'data'（默认值）	数据坐标。
'normalized'	针对坐标区进行归一化。坐标区的左下角映射到 (0,0)，右上角映射到 (1,1)。
'inches'	英寸。
'centimeters'	厘米。
'characters'	基于默认系统字体的字符大小。 字符宽度 = 字母 x 的宽度。 字符高度 = 两个文本行的基线之间的距离。
'points'	磅。一磅等于 1/72 英寸。
'pixels'	像素。 从 R2015b 开始，以像素为单位的距离不再依赖 Windows 和 Macintosh 系统上的系统分辨率： 在 Windows 系统上，一个像素是 1/96 英寸。 在 Macintosh 系统上，一个像素是 1/72 英寸。 在 Linux 系统上，一个像素的大小由系统分辨率确定。

所有单位（'data' 除外）都是从坐标区的左下角进行测量的。此属性会影响 Position 和 Extent 属性。

如果在创建 Text 对象时以 Name,Value 对组的形式指定 Position 和 Units 属性，则指定顺序很重要。若要使用特定单位定义位置，请在设置 Position 属性之前先设置 Units 属性。

HorizontalAlignment - 相对于位置点水平对齐文本

相对于 Position 属性中的 x 值水平对齐文本，指定为此表中的一个值。垂直线指示 x 值相对于文本的位置。

值	结果
'left'（默认值）
'center'
'right'

VerticalAlignment - 相对于位置点垂直对齐文本

相对于 Position 属性中的y值垂直对齐文本，指定为此表中的一个值。垂直线指示y值相对于文本的位置。

值	结果
'middle'
'top'
'cap'
'bottom'
'baseline'

交互性

Editing - 交互式编辑模式

交互式编辑模式，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，可以使用此属性的值作为逻辑值。该值存储为matlab.lang.OnOffSwitchState类型的 on/off 逻辑值。

• 'on' - 允许以交互方式编辑文本。MATLAB 可在文本中放置插入游标，并通过键入来更改相应的文本。要应用新的文本，请执行以下任意操作：

  • 按 Esc 键。

  • 在远离文本的任意位置点击。

  • 将 Editing 属性重置为 'off'。

  MATLAB 会更新 String 属性以包含新文本，并将 Editing 属性重置为 'off'。

• 'off' - 不允许以交互方式编辑文本。要更改文本，必须设置 String 属性。这是默认值。

Visible - 可见性状态

可见性状态，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，可以使用此属性的值作为逻辑值。该值存储为matlab.lang.OnOffSwitchState类型的 on/off 逻辑值。

• 'on' - 显示对象。

• 'off' - 隐藏对象而不删除它。仍然可以访问不可见对象的属性。

ContextMenu - 上下文菜单

上下文菜单，指定为 ContextMenu 对象。使用此属性在右键点击对象时显示上下文菜单。使用uicontextmenu函数创建上下文菜单。

注意

如果 PickableParts 属性设置为 'none' 或者 HitTest 属性设置为 'off'，该上下文菜单将不显示。

Selected - 选择状态

选择状态，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，可以使用此属性的值作为逻辑值。该值存储为matlab.lang.OnOffSwitchState类型的 on/off 逻辑值。

• 'on' - 已选择。如果在绘图编辑模式下点击对象，则 MATLAB 会将其 Selected 属性设置为 'on'。如果 SelectionHighlight 属性也设置为 'on'，则 MATLAB 将在对象周围显示选择句柄。

• 'off' - 未选择。

SelectionHighlight - 是否显示选择句柄

选择时显示选择句柄，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于false。因此，可以使用此属性的值作为逻辑值。该值存储为matlab.lang.OnOffSwitchState类型的 on/off 逻辑值。

• 'on' - 在 Selected 属性设置为 'on' 时显示选择句柄。

• 'off' - 永远不显示选择句柄，即使 Selected 属性设置为 'on' 也是如此。

回调

ButtonDownFcn - 鼠标点击回调

鼠标点击回调，指定为下列值之一：

• 函数句柄

• 元胞数组，包含一个函数句柄和其他参数

• 作为有效 MATLAB 命令或函数（在基础工作区中计算）的字符向量（不推荐）

使用此属性在点击对象时执行代码。如果使用函数句柄指定此属性，则 MATLAB 在执行回调时将向回调函数传递两个参数：

• 点击的对象 - 从回调函数中访问点击的对象的属性。

• 事件数据 - 空参数。在函数定义中将其替换为波浪号字符 (~) 以指示不使用此参数。

有关如何使用函数句柄定义回调函数的详细信息，参考回调定义。

注意

如果 PickableParts 属性设置为 'none' 或者 HitTest 属性设置为 'off'，则不执行此回调。

CreateFcn - 创建函数

对象创建函数，指定为下列值之一：

• 函数句柄。

• 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参数。

• 包含有效 MATLAB 表达式的字符向量（不推荐）。MATLAB 在基础工作区计算此表达式。

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息，参考回调定义。

此属性指定要在 MATLAB 创建对象时执行的回调函数。MATLAB 将在执行 CreateFcn 回调之前初始化所有属性值。如果不指定 CreateFcn 属性，则 MATLAB 执行默认的创建函数。

对现有组件设置 CreateFcn 属性没有任何作用。

如果将此属性指定为函数句柄或元胞数组，则可以使用回调函数的第一个参数访问正在创建的对象。否则，使用gcbo函数访问该对象。

DeleteFcn - 删除函数

对象删除函数，指定为下列值之一：

• 函数句柄。

• 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参数。

• 包含有效 MATLAB 表达式的字符向量（不推荐）。MATLAB 在基础工作区计算此表达式。

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息，参考回调定义。

此属性指定在 MATLAB 删除对象时要执行的回调函数。MATLAB 在销毁对象的属性之前执行 DeleteFcn 回调。如果不指定 DeleteFcn 属性，则 MATLAB 执行默认的删除函数。

如果将此属性指定为函数句柄或元胞数组，则可以使用回调函数的第一个参数访问要删除的对象。否则，使用gcbo函数访问该对象。

回调执行控件

Interruptible - 回调中断

回调中断，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，可以使用此属性的值作为逻辑值。该值存储为matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

此属性确定是否可以中断运行中回调。有以下两种回调状态要考虑：

• 运行中回调是当前正在执行的回调。

• 中断回调是试图中断运行中回调的回调。

每当 MATLAB 调用回调时，回调都会试图中断正在运行的回调（如果存在）。运行中回调所属对象的 Interruptible 属性决定着是否允许中断。

• 值 'on' 允许其他回调中断对象的回调。中断发生在 MATLAB 处理队列的下一个位置，例如当存在drawnow、figure、uifigure、getframe、waitfor 或 pause命令时。

  • 如果运行中回调包含以上命令之一，则 MATLAB 将在该时刻停止执行回调并执行中断回调。当中断回调完成时，MATLAB 将恢复执行运行中回调。

  • 如果运行中回调不包含以上命令之一，则 MATLAB 执行完当前回调，不会出现任何中断。

• 值 'off' 阻止所有中断尝试。由中断回调所属的对象的 BusyAction 属性决定是放弃该中断回调还是将其放入队列中。

注意

回调的中断和执行在以下情况下会有不同的表现：

• 如果中断回调是 DeleteFcn、CloseRequestFcn 或 SizeChangedFcn 回调，则无论是否存在 Interruptible 属性值都会发生中断。

• 如果运行中回调当前正在执行 waitfor 函数，则无论是否存在 Interruptible 属性值都会发生中断。

• Timer 对象根据排定时间执行，而不管 Interruptible 属性值如何。

发生中断时，MATLAB 不保存属性状态或显示内容。例如，gca或 gcf命令返回的对象可能会在另一个回调执行时发生改变。

BusyAction - 回调排队

回调排队，指定为 'queue' 或 'cancel'。BusyAction 属性决定 MATLAB 如何处理中断回调的执行。有以下两种回调状态要考虑：

• 运行中回调是当前正在执行的回调。

• 中断回调是试图中断运行中回调的回调。

无论何时 MATLAB 调用回调，该回调都会试图中断运行中回调。运行中回调所属对象的 Interruptible 属性决定着是否允许中断。如果不允许中断，则中断回调所属对象的属性 BusyAction 将决定是放弃该回调还是将回调放入队列中。以下是 BusyAction 属性的可能值：

• 'queue' - 将中断回调放入队列中，以便在运行中回调执行完毕后进行处理。

• 'cancel' - 不执行中断回调。

PickableParts - 捕获鼠标点击的能力

捕获鼠标点击的能力，指定为以下值之一：

• 'visible' - 仅当对象可见时才捕获鼠标点击。Visible 属性必须设置为 'on'。HitTest 属性决定是 Text 对象响应点击还是父级响应点击。

• 'all' - 无论是否可见都捕获鼠标点击。Visible 属性可以设置为 'on' 或 'off'。HitTest 属性决定是 Text 对象响应点击还是父级响应点击。

• 'none' - 无法捕获鼠标点击。点击 Text 对象会将点击操作传递给图窗窗口的当前视图中该对象下面的对象，通常是坐标区或图窗。HitTest 属性没有任何作用。

如果希望某个对象在其位于其他不需要点击的对象下方时可点击，请将其他对象的 PickableParts 属性设置为 'none' 以使点击穿过它们。

HitTest - 响应捕获的鼠标点击

对捕获的鼠标点击的响应，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

• 'on' - 触发 Text 对象的 ButtonDownFcn 回调。如果已定义 ContextMenu 属性，则调用上下文菜单。

• 'off' - 触发满足以下条件之一的 Text 对象的最近父级的回调：

  • HitTest 属性设置为 'on'

  • PickableParts 属性所设置的值允许父级捕获鼠标点击

注意

PickableParts 属性决定 Text 对象是否可以捕获鼠标点击。如果无法捕获，则 HitTest 属性没有任何作用。

BeingDeleted - 删除状态

此属性为只读

删除状态，以matlab.lang.OnOffSwitchState类型的 on/off 逻辑值形式返回。

当 DeleteFcn 回调开始执行时，MATLAB 会将 BeingDeleted 属性设置为 'on'。BeingDeleted 属性将一直保持 'on' 设置状态，直到组件对象不再存在为止。

在查询或修改对象之前，请先检查其 BeingDeleted 属性的值，以确认它不是待删除项。

父级/子级

Parent - 父级

父级，指定为 Axes、PolarAxes、Group 或 Transform 对象。

Children - 子级

对象没有任何子级。您不能设置该属性。

HandleVisibility - 对象句柄的可见性

父级的 Children 属性中对象句柄的可见性，指定为下列值之一：

• 'on' - 对象句柄始终可见。

• 'off' - 对象句柄始终不可见。该选项用于防止另一函数无意中对其进行更改。将 HandleVisibility 设置为 'off' 可在执行该函数时暂时隐藏句柄。

• 'callback' - 对象句柄在回调或回调所调用的函数中可见，但在从命令行调用的函数中不可见。此选项阻止通过命令行访问对象，但允许回调函数访问对象。

如果父级的 Children 属性中未列出该对象，则通过搜索对象层次结构或查询句柄属性获取对象句柄的函数无法返回该对象。此类函数的示例包括 get、findobj、gca、gcf、gco、newplot、cla、clf 和 close 函数。

隐藏的对象句柄仍有效。将根 ShowHiddenHandles 属性设置为 'on' 以列出所有对象句柄，而不管其 HandleVisibility 属性设置如何。

标识符

Type - 图形对象的类型

此属性为只读

图形对象的类型，以 'text' 形式返回。使用该属性在绘制层次结构中查找指定类型的所有对象，例如，使用findobj搜索该类型。

Tag - 对象标识符

对象标识符，指定为字符向量或字符串标量。可以指定唯一的 Tag 值作为对象的标识符。如果需要访问代码中其他位置的对象，可以使用findobj函数基于 Tag 值搜索对象。

UserData - 用户数据

用户数据，指定为任何 MATLAB 数组。例如，可以指定标量、向量、矩阵、元胞数组、字符数组、表或结构体。使用此属性存储对象上的任意数据。

如果在 App 设计工具中工作，请在该 App 中创建公共或私有属性以共享数据，而不是使用 UserData 属性。有关详细信息，可以参考在用 App 设计工具创建的 App 内共享数据。

兼容性考虑

不推荐使用 UIContextMenu 属性

从 R2020a 起不建议使用