legend
座標軸への凡例の追加
構文
説明
legend は、プロットされたデータ系列ごとに説明ラベルがある凡例を作成します。ラベルについては、凡例ではデータ系列の DisplayName プロパティのテキストが使用されます。DisplayName プロパティが空の場合、凡例では 'dataN' 形式のラベルが使用されます。この凡例は、座標軸でデータ系列を追加または削除すると自動的に更新されます。このコマンドは gca コマンドにより返される現在の座標軸の凡例を作成します。現在の座標軸が空の場合、凡例も空になります。座標軸が存在しない場合、legend は直交座標軸を作成します。
legend( は凡例のラベルを設定します。ラベルを label1,...,labelN)legend('Jan','Feb','Mar') などの文字ベクトルまたは string のリストとして指定します。
legend( は文字ベクトルの cell 配列、string 配列または文字行列を使用してラベルを設定します (たとえば labels)legend({'Jan','Feb','Mar'}))。
legend( には subset,___)subset にリストされたデータ系列に対する凡例の項目のみが含まれます。subset をグラフィックス オブジェクトのベクトルとして指定します。subset は、ラベルを指定する前に指定することも、他の入力引数がない状態で指定することもできます。
legend(___,'Location', は凡例の位置を設定します。たとえば、lcn)'Location','northeast' は座標軸の右上隅に凡例を配置します。位置は、他の入力引数の後に指定します。
legend(___,'Orientation', (ornt)ornt が 'horizontal' の場合) は凡例項目を横に並べて表示します。ornt の既定は 'vertical' で、項目を縦に並べます。
legend(___, は、名前と値のペア引数を 1 つ以上使用して、凡例プロパティを設定します。Name,Value)
lgd = legend(___)Legend オブジェクトを返します。lgd を使用して、凡例の作成後にそのプロパティのクエリと設定を行います。プロパティの一覧については、Legend のプロパティ を参照してください。
legend( は凡例の可視性を制御します。vsbl)vsbl は 'hide'、'show' または 'toggle' です。
legend('off') は凡例を削除します。
例
2 本のラインをプロットし、凡例を現在の座標軸に追加します。凡例ラベルを関数 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 を呼び出して、axes オブジェクト 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'})
2 本のラインをプロットします。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
凡例からラインを除外するには、そのラベルを空の文字ベクトルまたは string として指定します。たとえば、2 つの正弦波をプロットし、関数 yline を呼び出して 0 の破線を追加します。次に、凡例を作成し、0 のラインのラベルとして '' を指定してそのラインを除外します。
x = 0:0.2:10; plot(x,sin(x),x,sin(x+1)); hold on yline(0,'--') legend('sin(x)','sin(x+1)','')
4 本のラインをプロットします。座標軸の北西領域に凡例を作成します。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 プロパティを設定して、凡例項目の順序を反転できます。たとえば、4 本のラインをプロットし、凡例を追加します。
plot([4 5 6 7; 0 1 2 3]) lgd = legend("First","Second","Third","Fourth");
凡例項目の順序を反転します。
lgd.Direction = "reverse";
2 つ以上のプロット間で凡例を共有する場合は、レイアウトの個々のタイルに凡例を表示できます。凡例はタイルのグリッド内または外側のタイルに配置できます。
タイル表示チャート レイアウトで 3 つのプロットを作成します。
t = tiledlayout('flow','TileSpacing','compact'); nexttile plot(rand(5)) nexttile plot(rand(5)) nexttile plot(rand(5))
共有の凡例を追加し、それを 4 番目のタイルに移動します。
lgd = legend; lgd.Layout.Tile = 4;
次に、4 番目のプロットを追加して凡例を east タイルに移動します。
nexttile
plot(rand(5))
lgd.Layout.Tile = 'east';
プロットされたグラフィックス オブジェクトの一部を凡例に含めない場合は、含めるグラフィックス オブジェクトを指定できます。
3 本のラインをプロットし、作成された Line オブジェクトを返します。2 本のラインのみを含む凡例を作成します。最初の入力引数を、含める 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');
2 本のラインをプロットし、凡例を作成します。その後、凡例にタイトルを追加します。
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')
2 本のラインをプロットし、座標軸の左下隅に凡例を作成します。次に、凡例の背景と外枠を削除します。
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 オブジェクトのプロパティを設定できます。
ランダム データの 4 本のラインをプロットします。凡例を作成し、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 プロパティを設定することで、凡例アイコンの幅を指定できます。たとえば、1 つのラインと 2 つの散布データのセットをプロットします。
% 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
プロットの上部に水平の凡例を追加します。ライン アイコンは 2 つのマーカー アイコンよりも幅が広いため、凡例ではマーカー アイコンの周囲に余分な空白が含まれています。
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 3 成分、16 進数カラー コード、色名、または省略名として指定します。既定色は黒で、[0 0 0] の値で指定されます。
カスタム色を使用する場合は、RGB 3 成分または 16 進数カラー コードを指定します。
RGB 3 成分は、色の赤、緑、青成分の強度を指定する 3 成分の行ベクトルです。強度値は
[0,1]の範囲でなければなりません。たとえば[0.4 0.6 0.7]のようになります。16 進数カラー コードは、ハッシュ記号 (
#) で始まり、3 桁または 6 桁の0からFまでの範囲の 16 進数が続く string スカラーまたは文字ベクトルです。この値は大文字と小文字を区別しません。したがって、カラー コード"#FF8800"、"#ff8800"、"#F80"、および"#f80"は等価です。
あるいは、名前を使用して一部の一般的な色を指定できます。次の表に、名前の付いた色オプション、等価の RGB 3 成分、および 16 進数カラー コードを示します。
| 色名 | 省略名 | RGB 3 成分 | 16 進数カラー コード | 外観 |
|---|---|---|---|---|
"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 3 成分および 16 進数カラー コードを取得できます。たとえば、"gem" パレットの RGB 3 成分を取得し、16 進数カラー コードに変換します。
RGB = orderedcolors("gem");
H = rgb2hex(RGB);R2023b より前: RGB = get(groot,"FactoryAxesColorOrder") を使用して、RGB 3 成分を取得します。
R2024a より前: H = compose("#%02X%02X%02X",round(RGB*255)) を使用して、16 進数カラー コードを取得します。
例: [0 0 1]
例: 'blue'
例: '#0000FF'
出力引数
ヒント
凡例内の 50 を超えるオブジェクトにラベルを付けるには、各オブジェクトにラベルを指定します。そうしないと、
legendは最初の 50 個のオブジェクトのみをグラフに示します。
アルゴリズム
関数
legendを再呼び出ししても凡例のプロパティ (位置や向きなど) はリセットされません。凡例が存在する場合、関数legendは既存の凡例を更新します。Axesオブジェクトに設定できる凡例は 1 つだけです。凡例には、座標軸内のグラフィックス オブジェクトの可視性が反映されます。
Visibleプロパティが'off'に設定されているグラフィックス オブジェクトは、凡例においてグレー表示の項目として表示されます。
バージョン履歴
R2006a より前に導入積み上げ型 (垂直) の棒グラフと面グラフの凡例項目の既定の順序が、グラフの重なり順序と一致するように反転されました。以前は、積み上げ型の棒グラフと面グラフの順序とは逆の順序で凡例項目が表示されていました。
以前のリリースの順序を維持するには、凡例の Direction プロパティを "normal" に設定します。
関数 legend を呼び出して、ラベルを空の文字ベクトル、空の string、または cell 配列か string 配列の空の要素として指定すると、対応するエントリが凡例から除外されます。R2020b 以前のリリースでは、エントリは凡例にラベルなしで表示されます。
たとえば、次のコードは 2 つの正弦波をプロットし、y=0 の位置に基準線をプロットします。次に、3 つのラベルがある凡例を作成します。ここで、最後のラベルは空です。R2020b では、3 番目のラインは凡例にラベルなしで表示されます。R2021a では、3 番目のラインは凡例から除外されます。
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)',' ')
あるいは、空白文字を表示しないようにするには、ラベルの配列を指定して個々の line オブジェクトを関数 legend に渡します。個々の line オブジェクトを取得するには、出力引数を指定して各プロット関数を呼び出します。
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)',''});
