本页对应的英文页面已更新,但尚未翻译。 若要查看最新内容,请点击此处访问英文页面。

Legend 属性

图例的外观和行为

Legend 属性控制 Legend 对象的外观和行为。通过更改属性值,您可以修改该图例的特定方面。使用圆点表示法引用特定的对象和属性:

plot(rand(3))
lgd = legend('a','b','c');
c = lgd.TextColor;
lgd.TextColor = 'red';

位置和布局

全部展开

相对于坐标区的位置,指定为下表中所列的位置值之一。

说明
'north'坐标区中的顶部
'south'坐标区中的底部
'east'坐标区中的右侧区域
'west'坐标区中的左侧区域
'northeast'坐标区中的右上角(二维坐标区的默认值)
'northwest'坐标区中的左上角
'southeast'坐标区中的右下角
'southwest'坐标区中的左下角
'northoutside'坐标区的上方
'southoutside'坐标区的下方
'eastoutside'到坐标区的右侧
'westoutside'到坐标区的左侧
'northeastoutside'坐标区外的右上角(三维坐标区的默认值)
'northwestoutside'坐标区外的左上角
'southeastoutside'坐标区外的右下角
'southwestoutside'坐标区外的左下角
'best'在与绘图中的数据发生最少冲突的坐标区内
'bestoutside'坐标区的右上角之外(当图例为垂直方向时)或坐标区下方(当图例为水平方向时)
'none'Position 属性决定。可使用 Position 属性指定自定义位置。

示例: legend('Location','northeastoutside')

方向,指定为下列值之一:

  • 'vertical' - 垂直堆叠图例项。如果图例有多列,则逐列从上到下排列图例项。

  • 'horizontal' - 并排列出图例项。如果图例有多列,则逐行从左到右排列图例项。

示例: legend('Orientation','horizontal')

列数,指定为正整数。如果没有足够的图例项填充指定数量的列,则显示的列数可能会少一些。

使用 Orientation 属性控制图例项是逐列还是逐行依序显示。

示例: lgd.NumColumns = 3

NumColumns 值的选择模式,指定为下列值之一:

  • 'auto' - 自动选择值。

  • 'manual' - 使用手动指定的值。要指定值,请设置 NumColumns 属性。

自定义位置和大小,指定为 [left bottom width height] 形式的四元素向量。前两个值 leftbottom 指定从图窗左下角到图例左下角的距离。后两个值 widthheight 指定图例的维度。Units 属性确定位置单位。

如果您指定 Position 属性,MATLAB® 会自动将 Location 属性更改为 'none'

示例: legend({'A','B'},'Position',[0.2 0.6 0.1 0.2])

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

Units说明
'normalized'(默认值)相对于容器(通常为图窗)进行归一化。图窗的左下角映射到 (0,0),右上角映射到 (1,1)。调整图窗大小会更新 Position 向量的值。
'inches'英寸。
'centimeters'厘米。
'characters'

基于默认系统字体的字符大小。

  • 字符宽度 = 字母 x 的宽度。

  • 字符高度 = 两个文本行的基线之间的距离。

'points'磅。一磅等于 1/72 英寸。
'pixels'

像素。

从 R2015b 开始,以像素为单位的距离不再依赖 Windows®Macintosh 系统上的系统分辨率。

  • 在 Windows 系统上,一个像素是 1/96 英寸。

  • Macintosh 系统上,一个像素是 1/72 英寸。

  • 在 Linux® 系统上,一个像素的大小由系统分辨率确定。

所有单位都是从容器窗口左下角进行测量的。

此属性会影响 Position 属性。如果您更改单位,则比较好的做法是在完成计算后将其恢复为默认值,以便不影响其他假定 Units 为默认值的函数。

如果您在创建对象时以 Name,Value 对组的形式指定 PositionUnits 属性,则指定顺序很重要。如果想用特定单位定义位置,则必须在设置 Position 属性之前先设置 Units 属性。

标签

全部展开

是否自动更新图例项以反映坐标区的当前状态,指定为下列值之一:

  • 'on' - 自动为添加到坐标区的新图形对象添加图例项。删除已从坐标区删除的图形对象的图例项。

  • 'off' - 不自动添加或删除图例项。

示例: legend({'A','B'},'AutoUpdate','off')

图例标签的文本,指定为字符向量元胞数组或字符串数组。

图例标题,以图例文本对象形式返回。要添加图例标题,请设置图例文本对象的 String 属性。要更改标题外观,例如字体样式或字体颜色,请设置图例文本属性。有关列表,请参阅 Text 属性

plot(rand(3));
lgd = legend('line 1','line 2','line 3');
lgd.Title.String = 'My Legend Title';
lgd.Title.FontSize = 12;

也可以使用 title 函数添加标题并控制外观。

plot(rand(3));
lgd = legend('line 1','line 2','line 3');
title(lgd,'My Legend Title','FontSize',12)

文本字符的解释,指定为下列值之一:

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

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

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

TeX 标记

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

修饰符会一直作用到文本结尾,但上标和下标除外,因为它们仅修饰下一个字符或花括号中的字符。当您将 Interpreter 属性设置为 '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 替换为以下颜色之一:redgreenyellowmagentablueblackwhitegraydarkGreenorangelightBlue'\color{magenta} text'
\color[rgb]{specifier}自定义字体颜色 - 将 specifier 替换为三元素 RGB 三元组。'\color[rgb]{0,0.5,0.5} text'

下表列出了当 Interpreter 属性设置为 '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 标记,请将 Interpreter 属性设置为 'latex'。使用美元符号将文本括起来,例如,对于内联模式,使用 '$\int_1^{20} x^2 dx$';对于显示模式,使用 '$$\int_1^{20} x^2 dx$$'

显示的文本将使用默认的 LaTeX 字体样式。FontNameFontWeightFontAngle 属性不起任何作用。要更改字体样式,请使用 LaTeX 标记。

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

有关 LaTeX 系统的详细信息,请访问 LaTeX Project 网站:https://www.latex-project.org/

字体

全部展开

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

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

字体大小,指定为大于 0 的标量值(以磅为单位)。默认字体大小取决于具体操作系统和区域设置。

如果您更改坐标区字体大小,MATLAB 会自动将颜色栏的字体大小设置为坐标区字体大小的 90%。如果手动设置了颜色栏的字体大小,则更改坐标区字体大小不会影响颜色栏的字体。

字符粗细,指定为 'normal''bold'

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

字符倾斜,指定为 'normal''italic'

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

颜色和样式

全部展开

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

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

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

  • 十六进制颜色代码是字符向量或字符串标量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 '#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'

示例: [0 0 1]

示例: 'blue'

示例: '#0000FF'

背景颜色,指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。默认值 [1 1 1] 对应的颜色为白色。

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

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

  • 十六进制颜色代码是字符向量或字符串标量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 '#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'

示例: legend({'A','B'},'Color','y')

示例: legend({'A','B'},'Color',[0.8 0.8 1])

示例: legend({'A','B'},'Color','#D9A2E9')

框轮廓颜色,指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。默认值 [0.15 0.15 0.15] 对应的颜色为深灰色。

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

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

  • 十六进制颜色代码是字符向量或字符串标量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 '#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'

示例: legend({'A','B'},'EdgeColor',[0 1 0])

框轮廓的显示方式,指定为下列值之一:

  • 'on' - 显示图例周围的框。

  • 'off' - 不显示图例周围的框。

示例: legend({'A','B'},'Box','off')

框轮廓的宽度,指定为以磅为单位的正值。一磅等于 1/72 英寸。

示例: 1.5

交互性

全部展开

可见性状态,指定为下列值之一:

  • 'on' - 显示对象。

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

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

注意

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

选择状态,指定为下列值之一:

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

  • 'off' - 未选择。

选定时选择句柄的显示方式,指定为以下值之一:

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

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

回调

全部展开

点击图例项时执行的回调,指定为下列值之一:

  • 函数句柄。例如,@myCallback

  • 元胞数组,包含一个函数句柄和其他参数。例如,{@myCallback,arg3}

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

如果您使用函数句柄指定此属性,MATLAB 将传递 Legend 对象和事件数据结构体作为该函数的第一个和第二个输入参数。此表介绍了事件数据结构体中的字段。

事件数据结构体字段

字段说明
Peer与点击的图例项关联的图对象。
Region点击的图例项区域,以 'icon''label' 形式返回。
SelectionType

点击的类型,返回为下列值之一:

  • 'normal' - 单击鼠标左键

  • 'extend' - 按住 Shift 键并单击鼠标左键

  • 'open' - 双击任何鼠标按键

  • 'alt' - 单击鼠标右键、同时单击鼠标左右键(Windows 和 Mac)或者单击鼠标中键(Mac 和 Linux)。如果 UIContextMenu 属性包含有效的上下文菜单(这是默认值),则此类点击将打开上下文菜单,而不是触发 ItemHitFcn 回调。

SourceLegend 对象。
EventName事件名称,'ItemHit'

注意

如果设置 ButtonDownFcn 属性,则 ItemHitFcn 属性将被禁用。

示例

您可以创建交互式图例,以便在点击图例中的项目时,关联的图表会以某种方式进行更新。例如,您可以切换图表的可见性或更改其线宽。将图例的 ItemHitFcn 属性设置为可控制图表更改方式的回调函数。以下示例演示如何在点击图例中的图表图标或标签时切换图表的可见性。它会创建一个回调函数,该函数将图表的 Visible 属性设置为 'on''off'

将以下代码复制到一个新的函数文件,然后将其以 hitcallback_ex1.m 的名称保存在当前文件夹或 MATLAB 搜索路径上的某个文件夹中。两个输入参数 srcevnt 为图例对象和事件数据结构体。当您点击图例中的项目时,MATLAB 会将这些输入自动传递给回调函数。使用事件数据结构体的 Peer 字段访问与所点击的图例项目关联的图形对象属性。

function hitcallback_ex1(src,evnt)

if strcmp(evnt.Peer.Visible,'on')
    evnt.Peer.Visible = 'off';
else 
    evnt.Peer.Visible = 'on';
end

end

然后,绘制四条线条、创建一个图例并将图例对象赋给变量。将图例对象的 ItemHitFcn 属性设置为回调函数。点击图例中的项目以显示或隐藏所关联的图形。当您隐藏图形时,图例标签会更改为灰色。

plot(rand(4));
l = legend('Line 1','Line 2','Line 3','Line 4');
l.ItemHitFcn = @hitcallback_ex1;

鼠标点击回调,指定为下列值之一:

  • 函数句柄

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

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

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

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

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

有关如何使用函数句柄定义回调函数的详细信息,请参阅回调定义

注意

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

对象创建函数,指定为下列值之一:

  • 函数句柄。

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

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

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

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

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

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

对象删除函数,指定为下列值之一:

  • 函数句柄。

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

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

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

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

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

回调执行控件

全部展开

回调中断,指定为 'off''on'Interruptible 属性确定是否可以中断运行中回调。

考虑以下回调状态:

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

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

无论何时 MATLAB 调用回调,该回调都会试图中断运行中回调。运行中回调所属对象的 Interruptible 属性决定着是否允许中断。Interruptible 属性具有下列两个可能的值:

  • 'off' - 不能中断运行中回调。MATLAB 在不发生任何中断的情况一直将运行中回调执行完成。由中断回调所属对象的 BusyAction 属性决定是放弃该回调还是将其放入队列中。

  • 'on' - 可以中断运行中回调。在 MATLAB 处理队列时的下一个时间点发生中断。例如,当您执行 drawnowfiguregetframewaitforpause 等命令时。

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

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

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

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

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

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

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

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

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

  • 'visible' - 当对象可见时,捕获鼠标点击。Visible 属性必须设置为 'on',而且您必须点击 Legend 对象中具有定义颜色的部分。不能点击包含设置为 'none' 的相关颜色属性的部分。HitTest 属性决定是 Legend 对象响应点击还是父级响应点击。

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

响应捕获的鼠标点击,指定为以下值之一:

  • 'on' - 触发 Legend 对象的 ButtonDownFcn 回调。如果您已定义 UIContextMenu 属性,则调用上下文菜单。

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

    • HitTest 属性设置为 'on'

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

注意

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

此属性为只读

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

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

父级/子级

全部展开

父级,指定为 Figure 对象、Panel 对象或 Tab 对象。

Legend 对象必须与关联的坐标区具有相同的父级。如果更改关联坐标区的父级,Legend 对象将自动更新以使用相同的父级。

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

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

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

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

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

如果父级的 Children 属性中未列出该对象,则通过搜索对象层次结构或查询句柄属性获取对象句柄的函数无法返回该对象。此类函数的示例包括 getfindobjgcagcfgconewplotclaclfclose 函数。

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

标识符

全部展开

此属性为只读

图形对象的类型,以 'legend' 形式返回。使用该属性在绘制层次结构中查找指定类型的所有对象。

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

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

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

在 R2014b 中推出