Legend 属性

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

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

方向，指定为下列值之一：

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

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

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

示例: lgd.NumColumns = 3

NumColumns 值的选择模式，指定为下列值之一：

图例项的顺序，指定为下表中的值之一。

对于大多数图，默认方向是 "normal"。但是，对于堆叠条形图和区域图，默认方向是 "reverse" 以匹配图的堆叠顺序。

Direction 值的选择模式，指定为下列值之一：

图例图标的水平空间，指定为正数（以磅为单位），其中 1 磅为 1/72 英寸。当您要自定义图例图标周围的空间量时，请使用此属性。值越小，特定图标的宽度会越窄，从而导致空白越少、图例框越窄。

例如，以下三个图例除了其 IconColumnWidth 值（分别为 30、40 和 10）之外完全相同。

lgd.IconColumnWidth = lgd.FontSize;

控制如何设置 IconColumnWidth 属性，指定为下列值之一：

如果您手动设置 IconColumnWidth 属性的值，MATLAB 会将 IconColumnWidthMode 属性的值更改为 "manual"。

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

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

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

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

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

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

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

布局选项，指定为 TiledChartLayoutOptions 对象。当图例位于分块图布局中时，此属性非常有用。

要在分块图布局的网格中定位图例，请设置 TiledChartLayoutOptions 对象的 Tile 属性。例如，假设有一个 3×3 分块图布局。布局的中心有一个包含若干图块的网格，外边缘四周各有一个图块。实际上，该网格不可见，外侧图块也不占用空间，除非您用坐标区或其他对象填充它们。

以下代码将图例 lgd 放置在网格的第三个图块中。

lgd.Layout.Tile = 3;

要将图例放置在周围的一个图块中，请将 Tile 属性指定为 'north'、'south'、'east' 或 'west'。例如，将值设置为 'east' 会将图例放置在网格右侧的图块中。

lgd.Layout.Tile = 'east';

如果图例不是分块图布局的子级（例如，如果它是图窗的子级），则此属性为空且不起作用。

自动更新图例项以反映坐标区的当前状态，指定为 "on" 或 "off"，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 "on" 等效于 true，"off" 等效于 false。因此，您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

如果从坐标区删除对象，则无论此属性是设置为 "on" 还是 "off"，图例都会更新以反映更改。 (自 R2022b 起)

示例: legend(["A","B"],"AutoUpdate","off")

图例标签文本，指定为字符向量元胞数组、字符串数组或分类数组。要在标签中包括特殊字符或希腊字母，请使用 TeX 标记。要查看选项表，请参阅 Interpreter 属性。

图例标题，以图例文本对象形式返回。要添加图例标题，请设置图例文本对象的 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 标记

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

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

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

LaTeX 标记

要使用 LaTeX 标记，请将解释器设置为 "latex"。对于行内模式，用单美元符号 ($) 将标记括起来。对于显示模式，用双美元符号 ($$) 将标记括起来。

"$\int_1^{20} x^2 dx$"

"$$\int_1^{20} x^2 dx$$"

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

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

MATLAB 支持大多数标准 LaTeX 数学模式命令。有关详细信息，请参阅支持的 LaTeX 命令。有关使用 TeX 和 LaTeX 的示例，请参阅图文本中的希腊字母和特殊字符。

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

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

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

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

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

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

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

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

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

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

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

下表列出了浅色和深色主题中绘图的默认调色板。

您可以使用 orderedcolors 和 rgb2hex 函数获取这些调色板的 RGB 三元组和十六进制颜色代码。例如，获取 "gem" 调色板的 RGB 三元组并将其转换为十六进制颜色代码。

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

在 R2023b 之前的版本中: 使用 RGB = get(groot,"FactoryAxesColorOrder") 获取 RGB 三元组。

在 R2024a 之前的版本中: 使用 H = compose("#%02X%02X%02X",round(RGB*255)) 获取十六进制颜色代码。

示例: [0 0 1]

示例: 'blue'

示例: '#0000FF'

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

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

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

下表列出了浅色和深色主题中绘图的默认调色板。

您可以使用 orderedcolors 和 rgb2hex 函数获取这些调色板的 RGB 三元组和十六进制颜色代码。例如，获取 "gem" 调色板的 RGB 三元组并将其转换为十六进制颜色代码。

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

在 R2023b 之前的版本中: 使用 RGB = get(groot,"FactoryAxesColorOrder") 获取 RGB 三元组。

在 R2024a 之前的版本中: 使用 H = compose("#%02X%02X%02X",round(RGB*255)) 获取十六进制颜色代码。

示例: 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 三元组及十六进制颜色代码。

下表列出了浅色和深色主题中绘图的默认调色板。

您可以使用 orderedcolors 和 rgb2hex 函数获取这些调色板的 RGB 三元组和十六进制颜色代码。例如，获取 "gem" 调色板的 RGB 三元组并将其转换为十六进制颜色代码。

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

在 R2023b 之前的版本中: 使用 RGB = get(groot,"FactoryAxesColorOrder") 获取 RGB 三元组。

在 R2024a 之前的版本中: 使用 H = compose("#%02X%02X%02X",round(RGB*255)) 获取十六进制颜色代码。

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

背景透明度，指定为范围 [0, 1] 中的标量。值为 1 时完全不透明，值为 0 时完全透明。0 和 1 之间的值表示部分透明。以下是一些具有不同 BackgroundAlpha 值的图例示例。

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

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

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

示例: 1.5

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

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

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

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

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

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

示例

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

将以下代码复制到一个新的函数文件，然后将其以 hitcallback_ex1.m 的名称保存在当前文件夹或 MATLAB 搜索路径上的某个文件夹中。两个输入参量 src 和 evnt 为图例对象和事件数据结构体。当您点击图例中的项目时，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 在执行回调时将向回调函数传递两个参量：

有关如何使用函数句柄定义回调函数的详细信息，请参阅Create Callbacks for Graphics Objects。

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

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息，请参阅Create Callbacks for Graphics Objects。

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

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

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

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

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息，请参阅Create Callbacks for Graphics Objects。

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

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

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

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

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

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

BusyAction 属性仅在同时满足以下两个条件时才确定回调排队行为：

在这些情况下，由中断回调所属对象的 BusyAction 属性确定 MATLAB 如何处理中断回调。以下是 BusyAction 属性的可能值：

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

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

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

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

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

父容器，指定为 Figure 对象、Panel 对象、Tab 对象或 TiledChartLayout 对象。

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

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

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

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

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

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

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

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

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