legend
在坐标区上添加图例
语法
说明
legend 为每个绘制的数据序列创建一个带有描述性标签的图例。对于标签，图例使用数据序列的 DisplayName 属性中的文本。如果 DisplayName 属性为空，则图例使用 'dataN' 形式的标签。当您在坐标区上添加或删除数据序列时，图例会自动更新。此命令在由 gca 命令返回的当前坐标区中创建一个图例。如果当前坐标区为空，则图例为空。如果不存在坐标区，则 legend 创建一个笛卡尔坐标区。
legend( 设置图例标签。以字符向量或字符串列表形式指定标签，例如 label1,...,labelN)legend('Jan','Feb','Mar')。
legend( 使用字符向量元胞数组、字符串数组或字符矩阵设置标签，例如 labels)legend({'Jan','Feb','Mar'})。
legend( 仅在图例中包括 subset,___)subset 中列出的数据序列的项。subset 以图形对象向量的形式指定。您可以在指定标签之前或不指定其他输入参量的情况下指定 subset。
legend(___, 使用一个或多个名称-值对组参量来设置图例属性。Name,Value)
legend( 控制图例的可见性，其中 vsbl)vsbl 为 'hide'、'show' 或 'toggle'。
legend('off') 删除图例。
示例
绘制两个线条并在当前坐标区上添加一个图例。将图例标签指定为 legend 函数的输入参量。
x = linspace(0,pi); y1 = cos(x); plot(x,y1) hold on y2 = cos(2*x); plot(x,y2) legend('cos(x)','cos(2x)')
如果您在坐标区添加或删除数据序列，图例会相应地更新。创建数据序列时，可通过将 DisplayName 属性设置为名称-值对组来控制新数据序列的标签。如果您不指定标签，则图例使用 'dataN' 形式的标签。
注意：如果您不希望在坐标区中添加或删除数据序列时自动更新图例，可将图例的 AutoUpdate 属性设置为 'off'。
y3 = cos(3*x); plot(x,y3,'DisplayName','cos(3x)') hold off
删除图例。
legend('off')
您可以使用 tiledlayout 和 nexttile 函数显示分块图。调用 tiledlayout 函数以创建一个 2×1 分块图布局。调用 nexttile 函数以创建坐标区对象 ax1 和 ax2。在每个坐标区中对随机数据绘图。通过指定 ax1 作为 legend 的第一个输入参量，在上部绘图中添加一个图例。
tiledlayout(2,1)
y1 = rand(3);
ax1 = nexttile;
plot(y1)
y2 = rand(5);
ax2 = nexttile;
plot(y2)
legend(ax1,{'Line 1','Line 2','Line 3'})
绘制两个线条。通过将 DisplayName 属性设置为所需的文本，在执行绘图命令的过程中指定图例标签。然后，添加一个图例。
x = linspace(0,pi); y1 = cos(x); plot(x,y1,'DisplayName','cos(x)') hold on y2 = cos(2*x); plot(x,y2,'DisplayName','cos(2x)') hold off legend
要从图例中排除一个线条，请将其标签指定为空字符向量或字符串。例如，绘制两个正弦波，并通过调用 yline 函数在零位置添加一条水平虚线。然后创建一个图例，并通过将其标签指定为 '' 来排除该零位置的虚线。
x = 0:0.2:10; plot(x,sin(x),x,sin(x+1)); hold on yline(0,'--') legend('sin(x)','sin(x+1)','')
绘制四个线条。在坐标区的西北角创建一个图例。使用 NumColumns 属性指定图例的列数。
x = linspace(0,pi); y1 = cos(x); plot(x,y1) hold on y2 = cos(2*x); plot(x,y2) y3 = cos(3*x); plot(x,y3) y4 = cos(4*x); plot(x,y4) hold off legend({'cos(x)','cos(2x)','cos(3x)','cos(4x)'},... 'Location','northwest','NumColumns',2)
默认情况下，图例项逐列从上到下排列。要逐行从左到右排列图例项，请将 Orientation 属性设置为 'horizontal'。
自 R2023b 起
通过设置图例的 Direction 属性，可以反转图例项的顺序。例如，绘制四个线条并添加一个图例。
plot([4 5 6 7; 0 1 2 3]) lgd = legend("First","Second","Third","Fourth");
反转图例项的顺序。
lgd.Direction = "reverse";
当您要在两个或多个图之间共享一个图例时，您可以在布局的一个单独图块中显示该图例。您可以将图例放置在图块网格中，或放置在外侧图块中。
在一个分块图布局中创建三个绘图。
t = tiledlayout('flow','TileSpacing','compact'); nexttile plot(rand(5)) nexttile plot(rand(5)) nexttile plot(rand(5))
添加一个共享图例，并将其移至第四个图块。
lgd = legend; lgd.Layout.Tile = 4;
接下来，添加第四个绘图，并将图例移到 east 图块。
nexttile
plot(rand(5))
lgd.Layout.Tile = 'east';
如果您不想将绘制的所有图形对象都包含在图例中，可以指定要包含的图形对象。
绘制三个线条并返回创建的 Line 对象。创建只包含其中两条线的图例。将第一个输入参量指定为要包含的 Line 对象的向量。
x = linspace(0,pi); y1 = cos(x); p1 = plot(x,y1); hold on y2 = cos(2*x); p2 = plot(x,y2); y3 = cos(3*x); p3 = plot(x,y3); hold off legend([p1 p3],{'First','Third'})
创建一个图，通过调用 legend 函数并将 Interpreter 属性设置为 'latex' 来添加包含 LaTeX 标记的图例。用美元符号 ($) 将标记括起来。
x = 0:0.1:10; y = sin(x); dy = cos(x); plot(x,y,x,dy); legend('$sin(x)$','$\frac{d}{dx}sin(x)$','Interpreter','latex');
绘制两个线条并创建一个图例。然后为图例添加标题。
x = linspace(0,pi); y1 = cos(x); plot(x,y1) hold on y2 = cos(2*x); plot(x,y2) hold off lgd = legend('cos(x)','cos(2x)'); title(lgd,'My Legend Title')
绘制两个线条并在坐标区左下角创建一个图例。然后，删除图例的背景和轮廓。
x = linspace(0,pi); y1 = cos(x); plot(x,y1) hold on y2 = cos(2*x); plot(x,y2) hold off legend({'cos(x)','cos(2x)'},'Location','southwest') legend('boxoff')
您可以通过设置属性来更改图例的不同方面。您可以在调用 legend 时通过指定名称-值参量来设置属性，也可以在调用 legend 后设置 Legend 对象的属性。
绘制四行随机数据。创建一个图例并将 Legend 对象赋给变量 lgd。使用名称-值参量设置 FontSize 和 TextColor 属性。
rdm = rand(4);
plot(rdm)
lgd = legend({'Line 1','Line 2','Line 3','Line 4'},...
'FontSize',12,'TextColor','blue');
创建图例后，通过引用 lgd 来修改图例。使用对象圆点属性名称表示法设置 NumColumns 属性。
lgd.NumColumns = 2;
自 R2024b 起
您可以通过设置 IconColumnWidth 属性来指定图例图标的宽度。例如，绘制一个线条和两组散点数据。
% Create the data x = 1:50; sample1 = x + randn(1,50); sample2 = (x-5) + randn(1,50); y = x - 10; % Plot the data plot(x,y) hold on scatter(x,sample1,"filled") scatter(x,sample2,"filled") hold off
在图的顶部添加一个水平图例。线条图标比两个标记图标宽，因此图例会在标记图标周围包含额外的空白。
lgd = legend("Expected","Sample 1","Sample 2"); lgd.Location = "north"; lgd.Orientation = "horizontal";
通过将 IconColumnWidth 属性设置为 10，减小图标列的宽度。结果，线条图标会缩短，标记周围的空白也会缩小。
lgd.IconColumnWidth = 10;
输入参数
名称-值参数
以 Name1=Value1,...,NameN=ValueN 的形式指定可选参量对组，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但对各个参量对组的顺序没有要求。
在 R2021a 之前，使用逗号分隔每个名称和值，并用引号将 Name 引起来。
示例: legend({'A','B'},'TextColor','blue','FontSize',12) 创建一个蓝色、12 磅字体的图例。
注意
此处所列的属性只是一部分。有关完整列表，请参阅 Legend 属性。
文本颜色，指定为 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" | 不适用 | 不适用 | 不适用 | 无颜色 |
下表列出了浅色和深色主题中绘图的默认调色板。
| 调色板 | 调色板颜色 |
|---|---|
在 R2025a 之前的版本中: 大多数绘图默认使用这些颜色。 |
|
|
|
您可以使用 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'
输出参量
提示
要为图例中 50 个以上的对象添加标签，必须为每个对象指定一个标签。否则，
legend仅描绘图中的前 50 个对象。
算法
重新调用
legend函数不会重置图例属性，如位置或方向。如果存在图例，legend函数将更新现有图例。一个Axes对象仅可以拥有一个图例。图例反映图形对象在坐标区上的可见性。
Visible属性设置为'off'的图形对象在图例中灰显。
版本历史记录
在 R2006a 之前推出堆叠（垂直）条形图和区域图的图例项的默认顺序现在已反转以匹配图的堆叠顺序。以前，图例项以堆叠条形图和区域图的相反顺序列出。
要保留以前的版本的顺序，请将图例的 Direction 属性设置为 "normal"。
当您调用 legend 函数并将标签指定为空字符向量、空字符串或者元胞数组或字符串数组中的空元素时，将在图例中省略对应的条目。在 R2020b 及更早版本中，该条目会出现在图例中，但不带标签。
例如，以下代码在 y=0 处绘制两个正弦波和一条参考线。然后它创建一个具有三个标签的图例，其中最后一个标签为空。在 R2020b 中，第三条线会出现在图例中，但不带标签。在 R2021a 中，图例中会省略第三条线。
x = 0:0.2:10; plot(x,sin(x),x,sin(x+1)); hold on yline(0,'--') legend('sin(x)','sin(x+1)','')
要在图例中保留不带标签的条目，请在标签中包含一个空格字符。例如，要更新上述代码，请将最后一个标签指定为包含一个空格的字符向量 (' ')。
legend('sin(x)','sin(x+1)',' ')
或者，如果不想显示空格字符，可以使用标签数组将各线条对象传递给 legend 函数。要获取各线条对象，请带输出参量调用每个绘图函数。
x = 0:0.2:10; p = plot(x,sin(x),x,sin(x+1)); hold on line0 = yline(0,'--'); legend([p(1) p(2) line0], {'sin(x)','sin(x+1)',''});
