Legend のプロパティ
凡例の外観と動作
Legend プロパティは、Legend オブジェクトの外観と動作を制御します。プロパティの値を変更することによって、凡例の特定の要素を変更できます。ドット表記を使用して、特定のオブジェクトとプロパティを参照します。
plot(rand(3))
lgd = legend('a','b','c');
c = lgd.TextColor;
lgd.TextColor = 'red';位置とレイアウト
列数。正の整数として指定します。指定された列数より凡例項目が少ない場合、表示される列数が少なくなることがあります。
各列または各行のいずれに沿って凡例項目を順番に表示するかを制御するには、Orientation プロパティを使用します。
例: lgd.NumColumns = 3
NumColumns 値の選択モード。次の値のいずれかとして指定します。
'auto'— 値を自動で選択します。'manual'— 手動で指定した値を使用します。値を指定するには、NumColumnsプロパティを設定します。
R2023b 以降
凡例項目の順序。次の表のいずれかの値として指定します。
ほとんどのチャートで、既定の方向は "normal" です。ただし、積み上げ型の棒グラフと面グラフの場合、チャートの重なり順序に一致するように、既定の方向は "reverse" となります。
| 値 | 説明 | 例 |
|---|---|---|
| 最初の項目を一番上に、最後の項目を一番下にリストします。 |
|
| 最初の項目を一番下に、最後の項目を一番上にリストします。 |
|
R2023b 以降
Direction 値の選択モード。次の値のいずれかとして指定します。
"auto"— 値を自動で選択します。"manual"— 手動で指定した値を使用します。値を指定するには、Directionプロパティを設定します。
R2024b 以降
凡例アイコンの水平方向のスペース。ポイント単位の正の数値として指定します。1 ポイントは 1/72 インチです。このプロパティは、凡例アイコンの周囲のスペースの量をカスタマイズする場合に使用します。値を小さくすると、特定のアイコンの幅が短くなります。結果として、空白が減り、凡例ボックスが狭くなります。
たとえば、次の 3 つの凡例は、IconColumnWidth 値 (それぞれ、30、40、および 10) を除いて同じです。
ヒント
アイコンを含む領域を正方形にするには、IconColumnWidth プロパティを FontSize プロパティと同じ値に設定します。
lgd.IconColumnWidth = lgd.FontSize;
R2024b 以降
IconColumnWidth プロパティの設定方法を制御します。次のいずれかの値として指定します。
"auto"— 凡例内のアイコンに応じて、MATLAB® によってIconColumnWidthプロパティの値が制御されます。凡例にマーカー アイコンのみが含まれている場合は、列が縮小してアイコンの周囲のスペースが最小化されます。それ以外の場合、幅は30です。"manual"—IconColumnWidthプロパティの値を直接設定します。この幅は変更されません。
IconColumnWidth プロパティの値を手動で設定すると、MATLAB は IconColumnWidthMode プロパティの値を "manual" に変更します。
カスタムの位置とサイズ。[left bottom width height] の形式の 4 要素ベクトルとして指定します。最初の 2 つの値 left と bottom は、Figure の左下隅から凡例の左下隅までの距離を指定します。最後の 2 つの値 width と height は、凡例のサイズを指定します。位置の単位は Units プロパティで定義されます。
Position プロパティを設定すると、MATLAB は Location プロパティを自動的に 'none' に変更します。
例: legend({'A','B'},'Position',[0.2 0.6 0.1 0.2])
メモ
親コンテナーが TiledChartLayout オブジェクトの場合、このプロパティを設定しても効果はありません。
位置の単位。次の表のいずれかの値を指定します。
Units | 説明 |
|---|---|
'normalized' (既定) | コンテナー (通常は Figure) を基準に正規化されます。Figure の左下隅が (0,0) で、右上隅が (1,1) になります。Figure のサイズを変更すると、Position ベクトルの値が更新されます。 |
'inches' | インチ。 |
'centimeters' | センチメートル。 |
'characters' | 既定のシステム フォントの文字サイズを基準にします。
|
'points' | ポイント。1 ポイントは 1/72 インチです。 |
'pixels' | ピクセル。 Windows® システムおよび Macintosh システムでは、ピクセルのサイズは 1/96 インチです。このサイズはシステムの解像度に依存しません。 Linux® システムでは、ピクセルのサイズは使用しているシステムの解像度によって決まります。 |
すべての単位は、コンテナー ウィンドウの左下隅から測定されます。
このプロパティは Position プロパティに影響します。単位を変更した場合、Units が既定値であることを前提としている他の関数に影響を及ぼさないように、計算終了後に元の既定値に戻すことを推奨します。
オブジェクトの作成時に Position プロパティと Units プロパティを Name,Value のペアとして指定する場合は、指定する順序が重要です。特定の単位で位置を定義するには、Units プロパティを設定してから Position プロパティを設定しなければなりません。
レイアウト オプション。TiledChartLayoutOptions オブジェクトとして指定します。このプロパティは、凡例がタイル表示チャート レイアウトにある場合に役立ちます。
タイル表示チャート レイアウトのグリッド内に凡例を配置するには、Tile プロパティを TiledChartLayoutOptions オブジェクトに設定します。たとえば、3 行 3 列のタイル表示チャート レイアウトについて考えます。レイアウトの中央にタイルのグリッドがあり、外側のエッジに沿って 4 つのタイルがあります。実際には、グリッドは非表示であり、座標軸またはその他のオブジェクトが入力されるまで、外側のタイルは領域を占有しません。
次のコードは、凡例 lgd をグリッドの 3 番目のタイルに配置します。
lgd.Layout.Tile = 3;
凡例を周囲のいずれかのタイルに配置するには、Tile プロパティを 'north'、'south'、'east'、または 'west' として指定します。たとえば、値を 'east' に設定すると、タイル内の凡例はグリッドの右側のタイルに配置されます。
lgd.Layout.Tile = 'east';凡例がタイル表示チャート レイアウトの子ではない場合 (たとえば、Figure の子である場合)、このプロパティは空で、効果はありません。
ラベル
座標軸の現在の状態を反映する凡例項目の自動更新。"on" または "off"、もしくは数値あるいは logical 1 (true) または 0 (false) として指定します。"on" の値は true と等価であり、"off" の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。
"on"— 座標軸に追加された新しいグラフィックス オブジェクトに対して自動的に凡例項目を追加します。"off"— 凡例項目を自動的に追加しません。
座標軸からオブジェクトを削除すると、このプロパティが "on" または "off" に設定されているかどうかに関係なく、変更内容を反映して凡例が更新されます。 (R2022b 以降)
例: legend(["A","B"],"AutoUpdate","off")
凡例ラベルのテキスト。文字ベクトルの cell 配列、string 配列または categorical 配列として指定します。ラベルに特殊文字やギリシャ文字を含めるには、TeX マークアップを使用します。オプションの表については、Interpreter プロパティを参照してください。
凡例のタイトル。legend text オブジェクトとして返されます。凡例のタイトルを追加するには、legend text オブジェクトの 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 マークアップを使用して、上付き文字や下付き文字の追加、フォントのタイプや色の変更、テキストへの特殊文字の挿入を行うことができます。
修飾子の効果はテキストの末尾まで適用されます。上付き文字と下付き文字は例外であり、次の 1 文字または中かっこで囲まれた文字にのみ適用されます。インタープリターを "tex" に設定した場合にサポートされる修飾子は次のとおりです。
| 修飾子 | 説明 | 例 |
|---|---|---|
^{ } | 上付き文字 | "text^{superscript}" |
_{ } | 下付き文字 | "text_{subscript}" |
\bf | 太字フォント | "\bf text" |
\it | イタリック フォント | "\it text" |
\sl | 斜体フォント (通常はイタリック フォントと同じ) | "\sl text" |
\rm | 標準フォント | "\rm text" |
\fontname{ | フォント名 — | "\fontname{Courier} text" |
\fontsize{ | フォント サイズ — | "\fontsize{15} text" |
\color{ | フォントの色 — red、green、yellow、magenta、blue、black、white、gray、darkGreen、orange、lightBlue の色のいずれかに置き換えます。 | "\color{magenta} text" |
\color[rgb]{specifier} | フォントのカスタムの色 — | "\color[rgb]{0,0.5,0.5} text" |
次の表に、"tex" インタープリターでサポートされる特殊文字を示します。
| 文字列 | 記号 | 文字列 | 記号 | 文字列 | 記号 |
|---|---|---|---|---|---|
| α |
| υ |
| ~ |
| ∠ |
| ϕ |
| ≤ |
|
|
| χ |
| ∞ |
| β |
| ψ |
| ♣ |
| γ |
| ω |
| ♦ |
| δ |
| Γ |
| ♥ |
| ϵ |
| Δ |
| ♠ |
| ζ |
| Θ |
| ↔ |
| η |
| Λ |
| ← |
| θ |
| Ξ |
| ⇐ |
| ϑ |
| Π |
| ↑ |
| ι |
| Σ |
| → |
| κ |
| ϒ |
| ⇒ |
| λ |
| Φ |
| ↓ |
| µ |
| Ψ |
| º |
| ν |
| Ω |
| ± |
| ξ |
| ∀ |
| ≥ |
| π |
| ∃ |
| ∝ |
| ρ |
| ∍ |
| ∂ |
| σ |
| ≅ |
| • |
| ς |
| ≈ |
| ÷ |
| τ |
| ℜ |
| ≠ |
| ≡ |
| ⊕ |
| ℵ |
| ℑ |
| ∪ |
| ℘ |
| ⊗ |
| ⊆ |
| ∅ |
| ∩ |
| ∈ |
| ⊇ |
| ⊃ |
| ⌈ |
| ⊂ |
| ∫ |
| · |
| ο |
| ⌋ |
| ¬ |
| ∇ |
| ⌊ |
| x |
| ... |
| ⊥ |
| √ |
| ´ |
| ∧ |
| ϖ |
| ∅ |
| ⌉ |
| 〉 |
| | |
| ∨ |
| 〈 |
| © |
LaTeX マークアップ
LaTeX マークアップを使用するには、インタープリターを "latex" に設定します。インライン モードでは、マークアップを 1 つのドル記号 ($) で囲みます。表示モードでは、マークアップを 2 つのドル記号 ($$) で囲みます。
| LaTeX モード | 例 | 結果 |
|---|---|---|
| インライン |
"$\int_1^{20} x^2 dx$" |
|
| 表示 |
"$$\int_1^{20} x^2 dx$$" |
|
テキストは LaTeX の既定のフォント スタイルで表示され、FontName、FontWeight、FontAngle のプロパティは無視されます。フォント スタイルを変更するには、LaTeX マークアップを使用します。
LaTeX インタープリターで使用できるテキストの最大サイズは 1200 文字です。複数行のテキストの場合は、さらに 1 行につき 10 文字ほど文字数が少なくなります。
MATLAB では、大半の標準の LaTeX 数式モード コマンドがサポートされています。詳細については、サポートされる LaTeX コマンドを参照してください。TeX および LaTeX の使用例については、チャートのテキスト内のギリシャ文字と特殊文字を参照してください。
フォント
色とスタイル
テキストの色。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'
背景色。RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。既定値の [1 1 1] は、白に相当します。
カスタム色を使用する場合は、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 進数カラー コードを取得します。
例: legend({'A','B'},'Color','y')
例: legend({'A','B'},'Color',[0.8 0.8 1])
例: legend({'A','B'},'Color','#D9A2E9')
ボックス外枠の色。RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。既定値の [0.15 0.15 0.15] は、濃いグレーに相当します。
カスタム色を使用する場合は、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 進数カラー コードを取得します。
例: legend({'A','B'},'EdgeColor',[0 1 0])
R2024a 以降
背景の透明度。範囲 [0, 1] のスカラーとして指定します。値 1 は完全に不透明で、値 0 は完全に透明です。0 と 1 の間の値は一部透明です。BackgroundAlpha の値が異なるいくつかの凡例の例を次に示します。
| 値 | 外観 |
|---|---|
|
|
|
|
|
|
ボックスの外枠の表示。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。
'on'— 凡例の周囲にボックスを表示します。'off'— 凡例の周囲にボックスを表示しません。
例: legend({'A','B'},'Box','off')
対話機能
コールバック
凡例の項目をクリックすると実行されるコールバック。次の値のいずれかとして指定します。
関数ハンドル。たとえば、
@myCallbackのようになります。関数ハンドルと追加の引数を含む cell 配列。たとえば、
{@myCallback,arg3}のようになります。ベース ワークスペース内で評価される、有効な MATLAB コマンドまたは MATLAB 関数である文字ベクトル (非推奨)。
関数ハンドルを使用してこのプロパティを指定すると、MATLAB は、Legend オブジェクトとイベント データ構造体を 1 番目と 2 番目の入力引数として関数に渡します。次の表は、イベント データ構造体のフィールドについて説明しています。
イベント データ構造体のフィールド
| フィールド | 説明 |
|---|---|
Peer | クリックされた凡例項目に関連付けられているチャート オブジェクト。 |
Region | 凡例項目のクリックされる領域。'icon' または 'label' のいずれかとして返されます。 |
SelectionType | クリックのタイプ。次の値のいずれかとして返されます。
|
Source | Legend オブジェクト。 |
EventName | イベント名 'ItemHit'。 |
メモ
ButtonDownFcn プロパティを設定した場合、ItemHitFcn プロパティは無効になります。
例
凡例内の項目をクリックしたときに、関連付けられたチャートが何らかの方法で更新されるように、対話型の凡例を作成できます。たとえば、チャートの表示/非表示を切り替えたり、ラインの幅を変更したりすることができます。凡例の ItemHitFcn プロパティを、チャートをどのように変更するかを制御するコールバック関数に設定します。この例では、凡例内のチャートのアイコンまたはラベルをクリックしたときにチャートの表示/非表示を切り替える方法を説明します。チャートの Visible プロパティを 'on' または 'off' のいずれかに変更するコールバック関数を作成します。
次のコードを新しい関数ファイルにコピーし、hitcallback_ex1.m として、現在のフォルダーまたは MATLAB 検索パス上のフォルダーのいずれかに保存します。2 つの入力引数 src と evnt は、legend オブジェクトとイベント データ構造体です。凡例内の項目がクリックされると、MATLAB によって、これらの入力がコールバック関数に自動的に渡されます。イベント データ構造体の Peer フィールドを使用して、クリックされた凡例項目に関連付けられたチャート オブジェクトのプロパティにアクセスします。
function hitcallback_ex1(src,evnt) if strcmp(evnt.Peer.Visible,'on') evnt.Peer.Visible = 'off'; else evnt.Peer.Visible = 'on'; end end
次に、4 本のラインをプロットし、凡例を作成して、legend オブジェクトを変数に代入します。legend オブジェクトの ItemHitFcn プロパティをコールバック関数に設定します。凡例内の項目をクリックすると、関連付けられたチャートの表示/非表示が切り替わります。チャートを非表示にすると、凡例ラベルがグレーに変わります。
plot(rand(4)); l = legend('Line 1','Line 2','Line 3','Line 4'); l.ItemHitFcn = @hitcallback_ex1;
マウスクリック コールバック。次の値のいずれかとして指定します。
関数ハンドル
関数ハンドルと追加の引数を含む cell 配列
ベース ワークスペース内で評価される有効な MATLAB コマンドまたは MATLAB 関数の文字ベクトル (非推奨)
このプロパティは、オブジェクトをクリックしたときにコードを実行するために使用します。関数ハンドルを使用してこのプロパティを指定した場合、MATLAB はコールバックを実行するときに次の 2 つの引数をコールバック関数に渡します。
クリックしたオブジェクト — コールバック関数内から、クリックしたオブジェクトのプロパティにアクセスします。
イベント データ — 空の引数です。この引数が使用されないことを示すために、関数定義の中でこの引数をチルダ文字 (
~) に置換します。
関数ハンドルを使用してコールバック関数を定義する方法についての詳細は、グラフィックス オブジェクトのコールバックの作成を参照してください。
メモ
PickableParts プロパティが 'none' に設定されている場合または HitTest プロパティが 'off' に設定されている場合には、このコールバックは実行されません。
コールバック実行制御
親/子
識別子
バージョン履歴
R2014b で導入積み上げ型 (垂直) の棒グラフと面グラフの凡例項目の既定の順序が、グラフの重なり順序と一致するように反転されました。以前は、積み上げ型の棒グラフと面グラフの順序とは逆の順序で凡例項目が表示されていました。
以前のリリースの順序を維持するには、凡例の Direction プロパティを "normal" に設定します。
