Contour のプロパティ

等高線図の外観と動作

Contour プロパティは Contour オブジェクトの外観と動作を制御します。プロパティの値を変更することによって、等高線図の特定の要素を変更できます。プロパティのクエリと設定にはドット表記を使用します。

[C,h] = contour(...);
w = h.LineWidth;
h.LineWidth = 2;

レベル

LevelList — 等高線のレベル

空行列 (既定値) | z 値のベクトル

等高線のレベル。z 値のベクトルとして指定します。既定では、関数 contour は ZData プロパティの値の範囲に対応する値を選択します。

このプロパティを設定すると、対応するモード プロパティが manual に設定されます。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

LevelListMode — LevelList の選択モード

'auto' (既定値) | 'manual'

LevelList の選択モード。次の値のいずれかとして指定します。

• 'auto' — ZData の値に基づいて値を決定します。

• 'manual' — 手動で指定した値を使用します。値を指定するには、LevelList プロパティを設定します。モードが manual の場合、関数 contour で ZData の変更に合わせた値の変更は行われません。

LevelStep — 等高線の間隔

0 (既定値) | スカラー数値

等高線の間隔。スカラー数値として指定します。たとえば、2 ずつ増分する等高線を描画するには、この値を 2 に指定します。関数 contour は、ZData の値に基づいて等高線の間隔を決定します。

このプロパティを設定すると、対応するモード プロパティが manual に設定されます。

例: 3.4

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

LevelStepMode — LevelStep の選択モード

'auto' (既定値) | 'manual'

LevelStep の選択モード。次の値のいずれかとして指定します。

• 'auto' — ZData の値に基づいて値を決定します。

• 'manual' — 手動で指定した値を使用します。値を指定するには、LevelStep プロパティを設定します。モードが manual の場合、関数 contour で ZData の変更に合わせた値の変更は行われません。

ZLocation — z 軸に沿った等高線の位置

'zmin' | 'zmax' | スカラー数値

z 軸に沿った等高線の位置。次の値のいずれかとして指定します。

• 'zmin' — プロット ボックス内に最小の z レベルで等高線を配置します。これは surfc プロットと meshc プロットの既定の位置です。

• 'zmax' — プロット ボックス内に最大の z レベルで等高線を配置します。

• スカラー数値 — 指定した z レベルで等高線を配置します。contour と contourf で作成されたプロットは、既定で 0 の値を使用します。

メモ

このプロパティを関数 contour3 で作成した 3 次元等高線図で設定しても効果はありません。

色とスタイル

FaceColor — 等高線間の塗りつぶし色

"flat" | RGB 3 成分 | 16 進数カラー コード | "r" | "g" | "b" | ...

R2022b 以降

等高線間の塗りつぶし色。"flat"、RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。値を "flat" に設定すると、現在のカラーマップの色が使用されます。カラーマップの色のマッピングは、等高線値、カラーマップ、およびカラーマップへのデータ値のスケーリングによって決定されます。カラーマップへのデータのスケーリングの詳細については、カラーマップの範囲の制御を参照してください。

すべての線間で同じ色を使用するには、RGB 3 成分、16 進数カラー コード、色名、または省略名を指定します。

カスタム色を使用する場合は、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"	該当なし	該当なし	該当なし	色なし

MATLAB^® の多くのタイプのプロットで使用されている既定の色の RGB 3 成分および 16 進数カラー コードを次に示します。

RGB 3 成分	16 進数カラー コード	外観
[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"

FaceAlpha — 塗りつぶし色の透明度

1 (既定値) | 範囲 [0,1] のスカラー

R2022b 以降

塗りつぶし色の透明度。[0,1] の範囲のスカラーとして指定します。値 1 は不透明で、値 0 は完全に透明です。0 と 1 の間の値は半透明です。

EdgeColor — 等高線の色

"flat" (既定値) | RGB 3 成分 | 16 進数カラー コード | "r" | "g" | "b" | ...

R2022b 以降

等高線の色。"flat"、RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。等高線ごとに異なる色を使用するには、"flat" を指定します。カラーマップの色のマッピングは、等高線値、カラーマップ、およびカラーマップへのデータ値のスケーリングによって決定されます。カラーマップへのデータのスケーリングの詳細については、カラーマップの範囲の制御を参照してください。

すべての等高線に同じ色を使用するには、RGB 3 成分、16 進数カラー コード、色名、または省略名を指定します。

カスタム色を使用する場合は、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"	該当なし	該当なし	該当なし	色なし

MATLAB の多くのタイプのプロットで使用されている既定の色の RGB 3 成分および 16 進数カラー コードを次に示します。

RGB 3 成分	16 進数カラー コード	外観
[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"

EdgeAlpha — 等高線の透明度

1 (既定値) | 範囲 [0,1] のスカラー

R2022b 以降

等高線の透明度。[0,1] の範囲のスカラーとして指定します。値 1 は不透明で、値 0 は完全に透明です。0 と 1 の間の値は半透明です。

LineStyle — ライン スタイル

"-" (既定値) | "--" | ":" | "-." | "none"

ライン スタイル。次の表にリストされたオプションのいずれかとして指定します。

ライン スタイル	説明	結果として得られる線
"-"	実線
"--"	破線
":"	点線
"-."	一点鎖線
"none"	ラインなし	ラインなし

LineWidth — ライン幅

0.5 (既定値) | 正の値

等高線の幅。ポイント単位の正の値として指定します。1 ポイントは 1/72 インチです。

ラベル

ShowText — 等高線のラベル

'off' (既定値) | on/off logical 値

等高線のラベル。'on' または 'off' もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

• 'on' — 等高線に沿って高さの値を表示します。

• 'off' — 等高線にラベルを付けません。

LabelColor — 等高線のラベルの色

[0.13 0.13 0.13] (既定値) | "flat" | "none" | RGB 3 成分 | 16 進数カラー コード | "r" | "g" | "b" | ...

R2023b 以降

等高線のラベルの色。"flat"、"none"、RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。レベルごとにラベルに異なる色を使用するには、"flat" を指定します。カラーマップの色のマッピングは、等高線値、カラーマップ、およびカラーマップへのデータ値のスケーリングによって決定されます。カラーマップへのデータのスケーリングの詳細については、カラーマップの範囲の制御を参照してください。

ラベルを非表示にするには、LabelColor プロパティを "none" に設定します。この値を設定すると、ShowText プロパティも "off" に設定されます。ただし、ShowText プロパティを設定しても、LabelColor プロパティには影響しません。LabelColor プロパティを "none" に設定した後に ShowText プロパティを "on" に設定すると、等高線に隙間ができることに注意してください。最適な結果を得るには、LabelColor が "none" のときに、ShowText を "off" に設定します。

すべての等高線に同じ色を使用するには、RGB 3 成分、16 進数カラー コード、色名、または省略名を指定します。

カスタム色を使用する場合は、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"	該当なし	該当なし	該当なし	色なし

MATLAB の多くのタイプのプロットで使用されている既定の色の RGB 3 成分および 16 進数カラー コードを次に示します。

RGB 3 成分	16 進数カラー コード	外観
[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"

LabelSpacing — ラベルの間隔

144 (既定値) | スカラー

等高線に沿ったラベルの間隔。ポイント単位のスカラー値として指定します。1 ポイントは 1/72 インチです。このプロパティを使用して、等高線に沿った等高線のラベル数を制御します。値が小さいほどラベル数が多くなります。

LabelSpacing プロパティを有効にするには、ShowText プロパティを 'on' に設定しなければなりません。

関数 clabel を使用してラベルを表示する場合、LabelSpacing プロパティは無効になり、プロットはラインごとに 1 つのラベルを表示します。

LabelFormat — ラベルの形式

@string (既定値) | 書式演算子 | 関数ハンドル

R2022b 以降

ラベルの形式。関数 compose が受け入れる書式演算子、または関数ハンドルとして指定します。オプションで、書式演算子とテキストを組み合わせることができます。関数ハンドルを指定する場合、関数は、等高線レベルのベクトルを含む引数を 1 つ受け入れ、入力ベクトルと同じサイズの、string ベクトルか文字ベクトルの cell 配列を含む引数を 1 つ返さなければなりません。

例: 書式演算子の指定

小数点以下 1 桁の後に文字 m が続くラベルを表示する、等高線図を作成します。

contour(peaks,[-4 0 2],"ShowText",true,"LabelFormat","%0.1f m")

例: 関数ハンドルの指定

myfun.m というプログラム ファイルを作成し、次の関数を定義します。この関数は入力をメートルからフィートに変換し、メートル単位の各値と、かっこで囲んだフィート単位での等価値を含む string ベクトルを返します。

function labels = myfun(vals)
feetPerMeter = 3.28084;
feet = round(vals.*feetPerMeter);
labels = vals + " m (" + feet + " ft)";
labels(vals == 0) = "0 m";
end

次に、等高線図を作成し、LabelFormat プロパティを myfun のハンドルとして指定します。

contour(peaks,[-4 0 2],"ShowText",true,"LabelFormat",@myfun)

TextStep — ラベルを付ける等高線の間隔

0 (既定値) | スカラー数値

ラベルを付ける等高線の間隔。スカラー数値として指定します。ShowText プロパティが 'on' に設定されている場合、既定では等高線図のすべての等高線にラベルが表示されます。

このプロパティを設定すると、対応するモード プロパティが manual に設定されます。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

TextStepMode — TextStep の選択モード

'auto' (既定値) | 'manual'

TextStep の選択モード。次の値のいずれかとして指定します。

• 'auto' — ZData の値に基づいて値を決定します。ShowText プロパティが 'on' に設定されている場合、関数 contour はすべての等高線にラベルを付けます。

• 'manual' — 手動で指定した値を使用します。値を指定するには、TextStep プロパティを設定します。

TextList — ラベルを付ける等高線

空行列 (既定値) | 実数値のベクトル

ラベルを付ける等高線。実数値のベクトルとして指定します。

このプロパティを設定すると、対応するモード プロパティが manual に設定されます。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

TextListMode — TextList の選択モード

'auto' (既定値) | 'manual'

TextList の選択モード。次の値のいずれかとして指定します。

• 'auto' — LevelList プロパティの値と等しい値を使用します。等高線図のそれぞれの等高線にテキスト ラベルが含まれます。

• 'manual' — 手動で指定した値を使用します。値を指定するには TextList プロパティを設定します。

データ

ContourMatrix — 等高線行列

行列

等高線行列。次の形式の 2 行の行列として返されます。

Z1, x1,1, x1,2, ..., x1,N1, Z2, x2,1, x2,2, ..., x2,N2, Z3, ...
N1, y1,1, y1,2, ..., y1,N1, N2, y2,1, y2,2, ..., y2,N2, N3, ...

この行列の各列は等高線を定義します。各等高線は Z 値と N 値を含む列で始まります。

• Zi — i 番目の等高線の高さ

• Ni — i 番目の等高線の頂点の数

• (x_ij, y_ij) — i 番目の等高線の頂点の座標 (j は 1 ～ Ni の範囲)

XData — x 値

[] (既定値) | ベクトルまたは行列

x 値。ベクトルまたは行列として指定します。

• XData がベクトルの場合、length(XData) が size(ZData,2) と等しく、YData もベクトルでなければなりません。XData の値は厳密に増加するか厳密に減少するかのどちらかでなければならず、重複値を含めることはできません。

• XData が行列の場合、size(XData) と size(YData) は size(ZData) と等しくなければなりません。通常は、列が厳密に増加するか厳密に減少して行が均一 (または行が厳密に増加するか厳密に減少して列が均一) になるように XData の値を設定します。

このプロパティを設定すると、対応するモード プロパティが manual に設定されます。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

XDataMode — XData の選択モード

'auto' (既定値) | 'manual'

XData の選択モード。次の値のいずれかとして指定します。

• 'auto' — ZData の列インデックスを使用して XData を設定します。

• 'manual' — 手動で指定した値を使用します。値を指定するには、XData プロパティを直接設定するか、関数 contour、contourf、contour3 の入力引数 X を指定します。

XDataSource — XData にリンクされている変数

'' (既定値) | 文字ベクトル | string

XData にリンクされている変数。MATLAB ワークスペースの変数名を含む文字ベクトルまたは string として指定します。MATLAB はベース ワークスペース内の変数を評価して XData を生成します。

既定ではリンクされている変数はないため、この値は空の文字ベクトル '' です。変数をリンクしても MATLAB は XData の値をすぐに更新しません。データ値の更新を強制するには、関数 refreshdata を使用します。

メモ

1 つのデータ ソース プロパティを異なる次元のデータを含む変数に変更すると、すべてのデータ ソース プロパティを適切な値に変更するまでは、関数が警告を生成し、グラフが描画されない可能性があります。

例: 'x'

YData — y 値

[] (既定値) | ベクトルまたは行列

y 値。ベクトルまたは行列として指定します。

• YData がベクトルの場合、length(YData) が size(ZData,1) と等しく、XData もベクトルでなければなりません。XData の値は厳密に増加するか厳密に減少するかのどちらかでなければならず、重複値を含めることはできません。

• YData が行列の場合、size(XData) と size(YData) は size(ZData) と等しくなければなりません。通常は、列が厳密に増加するか厳密に減少して行が均一 (または行が厳密に増加するか厳密に減少して列が均一) になるように YData の値を設定します。

このプロパティを設定すると、対応するモード プロパティが manual に設定されます。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

YDataMode — YData の選択モード

'auto' (既定値) | 'manual'

YData の選択モード。次の値のいずれかとして指定します。

• 'auto' — ZData の行インデックスを使用して YData を設定します。

• 'manual' — 手動で指定した値を使用します。値を指定するには、YData プロパティを直接設定するか、関数 contour、contourf、contour3 の入力引数 Y を指定します。

YDataSource — YData にリンクされている変数

'' (既定値) | 文字ベクトル | string

YData にリンクされている変数。MATLAB ワークスペースの変数名を含む文字ベクトルまたは string として指定します。MATLAB はベース ワークスペース内の変数を評価して YData を生成します。

既定ではリンクされている変数はないため、この値は空の文字ベクトル '' です。変数をリンクしても MATLAB は YData の値をすぐに更新しません。データ値の更新を強制するには、関数 refreshdata を使用します。

メモ

1 つのデータ ソース プロパティを異なる次元のデータを含む変数に変更すると、すべてのデータ ソース プロパティを適切な値に変更するまでは、関数が警告を生成し、グラフが描画されない可能性があります。

例: 'y'

ZData — 等高線の表面を定義するデータ

[] (既定値) | 行列

等高線の表面を定義するデータ。行列として指定します。ZData は少なくとも 2 行 2 列の行列でなければなりません。

このプロパティを設定すると、対応するモード プロパティが manual に設定されます。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

ZDataSource — ZData にリンクされている変数

'' (既定値) | 文字ベクトル | string

ZData にリンクされている変数。MATLAB ワークスペースの変数名を含む文字ベクトルまたは string として指定します。MATLAB はベース ワークスペース内の変数を評価して ZData を生成します。

既定ではリンクされている変数はないため、この値は空の文字ベクトル '' です。変数をリンクしても MATLAB は ZData の値をすぐに更新しません。データ値の更新を強制するには、関数 refreshdata を使用します。

メモ

1 つのデータ ソース プロパティを異なる次元のデータを含む変数に変更すると、すべてのデータ ソース プロパティを適切な値に変更するまでは、関数が警告を生成し、グラフが描画されない可能性があります。

例: 'z'

凡例

DisplayName — 凡例ラベル

'' (既定値) | 文字ベクトル | string スカラー

凡例ラベル。文字ベクトルまたは string スカラーとして指定します。legend コマンドを呼び出すまで、凡例は表示されません。テキストを指定しない場合、legend は 'dataN' 形式を使用してラベルを設定します。

Annotation — 凡例にオブジェクトを含める

Annotation オブジェクト

凡例にオブジェクトを含めるかどうか。Annotation オブジェクトとして指定します。Annotation オブジェクトの基となる IconDisplayStyle プロパティを次のいずれかの値に設定します。

• "on" — 凡例にオブジェクトを含めます (既定)。

• "off" — 凡例にオブジェクトを含めません。

たとえば、obj という Contour オブジェクトを凡例から除外するには、IconDisplayStyle プロパティを "off" に設定します。

obj.Annotation.LegendInformation.IconDisplayStyle = "off";

あるいは、関数 legend を使用して、凡例内の項目を制御することもできます。最初の入力引数を、含めるグラフィックス オブジェクトのベクトルとして指定します。最初の入力引数に既存のグラフィックス オブジェクトを指定しない場合、それは凡例に表示されません。ただし、凡例が作成された後に座標軸に追加されたグラフィックス オブジェクトは凡例には表示されません。追加の項目を避けるには、すべてのプロットを作成した後に凡例を作成することを考慮してください。

対話機能

Visible — 可視性の状態

"on" (既定値) | on/off logical 値

可視性の状態。"on" または "off"、もしくは数値または logical 1 (true) または 0 (false) として指定します。"on" の値は true と等価であり、"off" は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

• "on" — オブジェクトを表示します。

• "off" — オブジェクトを削除せずに非表示にします。非表示のオブジェクトのプロパティには引き続きアクセスできます。

DataTipTemplate — データ ヒントの内容

DataTipTemplate オブジェクト

データ ヒントの内容。DataTipTemplate オブジェクトとして指定します。基となる DataTipTemplate オブジェクトのプロパティを変更することにより、データ ヒントに表示される内容を制御できます。プロパティの一覧については、DataTipTemplate のプロパティ を参照してください。

データ ヒントの変更の例については、カスタム データ ヒントの作成を参照してください。

メモ

DataTipTemplate オブジェクトは findobj または findall によって返されず、copyobj によってコピーされません。

ContextMenu — コンテキスト メニュー

空の GraphicsPlaceholder 配列 (既定値) | ContextMenu オブジェクト

コンテキスト メニュー。ContextMenu オブジェクトとして指定します。このプロパティは、オブジェクトを右クリックしたときにコンテキスト メニューを表示するために使用します。関数 uicontextmenu を使用して、コンテキスト メニューを作成します。

メモ

PickableParts プロパティが 'none' に設定されている場合または HitTest プロパティが 'off' に設定されている場合には、このコンテキスト メニューは表示されません。

Selected — 選択状態

'off' (既定値) | on/off logical 値

選択状態。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

• 'on' — 選択されています。プロット編集モードでオブジェクトをクリックした場合、MATLAB は Selected プロパティを 'on' に設定します。SelectionHighlight プロパティも 'on' に設定されている場合、MATLAB はオブジェクトの周囲に選択ハンドルを表示します。

• 'off' — 選択されていません。

SelectionHighlight — 選択ハンドルの表示

'on' (既定値) | on/off logical 値

選択時の選択ハンドルの表示。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

• 'on' — Selected プロパティが 'on' に設定されているときに選択ハンドルを表示します。

• 'off' — Selected プロパティが 'on' に設定されている場合でも選択ハンドルを表示しません。

Clipping — 座標軸の範囲でのオブジェクトのクリップ

'on' (既定値) | on/off logical 値

座標軸の範囲でのオブジェクトのクリップ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

• 'on' の値は座標軸の範囲外になるオブジェクトの部分をクリップします。

• 'off' の値は座標軸の範囲外に表示される部分があってもオブジェクト全体を表示します。プロットの作成、hold on の設定、座標軸のスケーリングの固定を行ってから、元のプロットよりも大きくなるようにオブジェクトを作成した場合、オブジェクトの一部が座標軸の範囲の外に表示されることがあります。

オブジェクトを含む座標軸の Clipping プロパティは 'on' に設定しなければなりません。そうしない場合、このプロパティの効果はありません。クリップ動作の詳細については、座標軸の Clipping プロパティを参照してください。

コールバック

ButtonDownFcn — マウスクリック コールバック

'' (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

マウスクリック コールバック。次の値のいずれかとして指定します。

• 関数ハンドル

• 関数ハンドルと追加の引数を含む cell 配列

• ベース ワークスペース内で評価される有効な MATLAB コマンドまたは MATLAB 関数の文字ベクトル (非推奨)

このプロパティは、オブジェクトをクリックしたときにコードを実行するために使用します。関数ハンドルを使用してこのプロパティを指定した場合、MATLAB はコールバックを実行するときに次の 2 つの引数をコールバック関数に渡します。

• クリックしたオブジェクト — コールバック関数内から、クリックしたオブジェクトのプロパティにアクセスします。

• イベント データ — 空の引数です。この引数が使用されないことを示すために、関数定義の中でこの引数をチルダ文字 (~) に置換します。

関数ハンドルを使用してコールバック関数を定義する方法についての詳細は、グラフィックス オブジェクトのコールバックの作成を参照してください。

メモ

PickableParts プロパティが 'none' に設定されている場合または HitTest プロパティが 'off' に設定されている場合には、このコールバックは実行されません。

CreateFcn — 作成関数

'' (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

オブジェクト作成関数。次の値のいずれかとして指定します。

• 関数ハンドル。

• 最初の要素が関数ハンドルである cell 配列。cell 配列内のその後の要素はコールバック関数に渡される引数です。

• 有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベース ワークスペースで評価します。

コールバックを関数ハンドル、cell 配列、または文字ベクトルとして指定する方法の詳細については、グラフィックス オブジェクトのコールバックの作成を参照してください。

このプロパティは、MATLAB がオブジェクトを作成するときに実行されるコールバック関数を指定します。MATLAB は CreateFcn コールバックを実行する前に、すべてのプロパティ値を初期化します。CreateFcn プロパティを指定しない場合、MATLAB は既定の作成関数を実行します。

既存のコンポーネントに CreateFcn プロパティを設定しても効果はありません。

このプロパティを関数ハンドルまたは cell 配列として指定した場合、コールバック関数の最初の引数を使用して、作成中のオブジェクトにアクセスできます。それ以外の場合は、関数 gcbo を使用してオブジェクトにアクセスします。

DeleteFcn — 削除関数

'' (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

オブジェクト削除関数。次の値のいずれかとして指定します。

• 関数ハンドル。

• 最初の要素が関数ハンドルである cell 配列。cell 配列内のその後の要素はコールバック関数に渡される引数です。

• 有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベース ワークスペースで評価します。

コールバックを関数ハンドル、cell 配列、または文字ベクトルとして指定する方法の詳細については、グラフィックス オブジェクトのコールバックの作成を参照してください。

このプロパティは、MATLAB がオブジェクトを削除するときに実行されるコールバック関数を指定します。MATLAB は、オブジェクトのプロパティを破棄する前に DeleteFcn コールバックを実行します。DeleteFcn プロパティを指定しない場合、MATLAB は既定の削除関数を実行します。

このプロパティを関数ハンドルまたは cell 配列として指定した場合、コールバック関数の最初の引数を使用して、削除されるオブジェクトにアクセスできます。それ以外の場合は、関数 gcbo を使用してオブジェクトにアクセスします。

コールバック実行制御

Interruptible — コールバックの割り込み

'on' (既定値) | on/off logical 値

コールバックの割り込み。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティは実行中のコールバックが割り込み可能かどうかを決定します。次の 2 つのコールバックの状態について考慮する必要があります。

• "実行中" コールバックは、現在実行しているコールバックです。

• "割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。

MATLAB は、コールバック キューを処理するコマンドを実行するたびにコールバックの割り込み動作を判別します。これらのコマンドには、drawnow、figure、uifigure、getframe、waitfor、pause があります。

実行中コールバックにこれらのコマンドが含まれていない場合、割り込みは発生しません。MATLAB は、実行中コールバックの実行を先に終了させ、その後に割り込みコールバックを実行します。

実行中コールバックにこれらのいずれかのコマンドが含まれている場合、実行中コールバックを所有するオブジェクトの Interruptible プロパティに応じて割り込みが発生するかどうかが決まります。

• Interruptible の値が 'off' の場合、割り込みは発生しません。代わりに、割り込みコールバックを所有するオブジェクトの BusyAction プロパティに応じて、割り込みコールバックが破棄されるかコールバック キューに追加されるかが決まります。

• Interruptible の値が 'on' の場合、割り込みが発生します。MATLAB は、コールバック キューの次回処理時に、実行中コールバックの実行を停止し、割り込みコールバックを実行します。割り込みコールバックが完了した後、MATLAB は実行中だったコールバックの実行を再開します。

メモ

コールバックの割り込みと実行は、以下の状況では動作が異なります。

• 割り込みコールバックが DeleteFcn、CloseRequestFcn または SizeChangedFcn コールバックの場合、Interruptible プロパティの値にかかわらず割り込みが発生します。

• 実行中のコールバックが関数 waitfor を現在実行している場合、Interruptible プロパティの値にかかわらず割り込みが発生します。

• 割り込みコールバックが Timer オブジェクトで所有されている場合、Interruptible プロパティの値にかかわらずスケジュールに従ってコールバックが実行されます。

メモ

MATLAB は、割り込みが発生したときにプロパティの状態や表示を保存しません。たとえば、gca コマンドや gcf コマンドから返されたオブジェクトは、別のコールバックを実行するときに変更されている可能性があります。

BusyAction — コールバック キューイング

'queue' (既定値) | 'cancel'

コールバック キューイング。'queue' または 'cancel' として指定します。BusyAction プロパティは MATLAB による割り込みコールバックの実行の処理方法を決定します。次の 2 つのコールバックの状態について考慮する必要があります。

• "実行中" コールバックは、現在実行しているコールバックです。

• "割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。

BusyAction プロパティによってコールバック キューイングの動作が決まるのは、次の両方の条件を満たす場合のみです。

• 実行中コールバックに drawnow、figure、uifigure、getframe、waitfor、pause などのコールバック キューを処理するコマンドが含まれている。

• 実行中コールバックを所有するオブジェクトの Interruptible プロパティの値が 'off' である。

これらの条件に当てはまる場合、割り込みコールバックを所有するオブジェクトの BusyAction プロパティに応じて MATLAB による割り込みコールバックの処理方法が決まります。BusyAction プロパティは次の値を取ることができます。

• 'queue' — 割り込みコールバックをキューに入れ、実行中のコールバックが終了した後に処理されるようにします。

• 'cancel' — 割り込みコールバックを実行しません。

PickableParts — マウス クリック キャプチャ機能

'visible' (既定値) | 'none'

マウス クリック キャプチャ機能。次の値の 1 つとして指定します。

• 'visible' — 表示されている場合にのみマウス クリックをキャプチャします。Visible プロパティは、'on' に設定しなければなりません。Contour オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest プロパティが決定します。

• 'none' — マウス クリックをキャプチャしません。Contour オブジェクトをクリックすると、Figure ウィンドウの現在のビュー内でその後ろにあるオブジェクトにクリックが渡されます。Contour オブジェクトの HitTest プロパティの効果はありません。

HitTest — キャプチャしたマウス クリックへの応答

'on' (既定値) | on/off logical 値

キャプチャしたマウス クリックへの応答。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

• 'on' — Contour オブジェクトの ButtonDownFcn コールバックをトリガーします。ContextMenu プロパティが定義されている場合は、コンテキスト メニューを呼び出します。

• 'off' — Contour オブジェクトの先祖のうち、次のいずれかの条件を満たす最も近い先祖のコールバックをトリガーします。

  • HitTest プロパティが 'on' に設定されている

  • PickableParts プロパティが、先祖によるマウス クリックのキャプチャを有効にする値に設定されている

メモ

PickableParts プロパティは、Contour オブジェクトがマウス クリックをキャプチャできるかどうかを決定します。キャプチャできない場合、HitTest プロパティは無効です。

BeingDeleted — 削除状態

on/off logical 値

この プロパティ は読み取り専用です。

削除状態。matlab.lang.OnOffSwitchState 型の on/off logical 値として返されます。

MATLAB は、DeleteFcn コールバックが実行を開始すると、BeingDeleted プロパティを 'on' に設定します。コンポーネント オブジェクトが存在しなくなるまで BeingDeleted プロパティは 'on' に設定されたままです。

クエリや変更の前にオブジェクトが削除されようとしていないか確認するために BeingDeleted プロパティの値をチェックします。

親/子

Parent — 親

Axes オブジェクト | Group オブジェクト | Transform オブジェクト

親。Axes、Group または Transform オブジェクトとして指定します。

Children — 子

空の GraphicsPlaceholder 配列 | DataTip オブジェクト配列

子。空の GraphicsPlaceholder 配列、または DataTip オブジェクト配列として返されます。このプロパティを使用して、チャートにプロットされるデータ ヒントのリストを表示します。

Children プロパティを使用して子の追加や削除を行うことはできません。このリストに子を追加するには、DataTip オブジェクトの Parent プロパティをチャート オブジェクトに設定します。

HandleVisibility — オブジェクト ハンドルの可視性

"on" (既定値) | "off" | "callback"

親の Children プロパティ内でのオブジェクト ハンドルの可視性。次の値のいずれかとして指定します。

• "on" — オブジェクト ハンドルは常に表示されます。

• "off" — オブジェクト ハンドルは常に非表示です。このオプションは、他の関数による意図しない変更を防止するために役立ちます。HandleVisibility を "off" に設定すると、その関数の実行中にハンドルが一時的に非表示になります。

• "callback" — オブジェクト ハンドルはコールバック内から、あるいはコールバックにより呼び出される関数から参照できます。しかし、コマンド ラインから呼び出される関数からは参照できません。このオプションを使用すると、コマンド ラインからのオブジェクトへのアクセスがブロックされますが、コールバック関数からのアクセスは許可されます。

オブジェクトが親の Children プロパティ内にリストされない場合、オブジェクト階層の検索またはハンドル プロパティのクエリによってオブジェクト ハンドルを取得する関数は、そのオブジェクト ハンドルを返しません。こうした関数の例としては、関数 get、findobj、gca、gcf、gco、newplot、cla、clf、および close などが挙げられます。

非表示のオブジェクト ハンドルは有効なままです。ルートの ShowHiddenHandles プロパティを "on" に設定すると、HandleVisibility プロパティの設定にかかわらず、すべてのオブジェクト ハンドルがリストされます。

識別子

Type — グラフィックス オブジェクトのタイプ

'contour'

この プロパティ は読み取り専用です。

グラフィックス オブジェクトのタイプ。'contour' として返されます。

Tag — オブジェクト識別子

'' (既定値) | 文字ベクトル | string スカラー

オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。オブジェクトの識別子として機能する一意の Tag 値を指定できます。コードの他の部分からオブジェクトにアクセスする必要がある場合、関数 findobj を使用して Tag 値に基づいてオブジェクトを検索できます。

UserData — ユーザー データ

[] (既定値) | 配列

ユーザー データ。任意の MATLAB 配列として指定します。たとえば、スカラー、ベクトル、行列、cell 配列、文字配列、table、または構造体を指定できます。このプロパティを使用して、任意のデータをオブジェクトに保存します。

App Designer を使用している場合は、UserData プロパティを使用する代わりに、アプリでパブリック プロパティまたはプライベート プロパティを作成してデータを共有します。詳細については、App Designer アプリ内でのデータの共有を参照してください。

バージョン履歴

R2006a より前に導入

R2023b: LabelColor プロパティを使用したラベルの色の制御

LabelColor プロパティを設定して、等高線のラベルの色を制御します。等高線のレベルに応じて色を変えたり、一様な色を指定したり、色なしを指定してラベルを非表示にしたりできます。

R2022b: LabelFormat プロパティを使用した等高線ラベルの書式設定

等高線ラベルの書式設定を、関数 compose が受け入れる書式文字列として指定します。また、ラベルの書式設定時に計算を実行する関数のハンドルを指定することもできます。

R2022b: FaceColor および EdgeColor プロパティを使用した塗りつぶし色とラインの色の制御

FaceColor プロパティを使用して等高線間の塗りつぶし色を指定し、EdgeColor プロパティを使用して等高線の色を指定します。以前のリリースの Fill プロパティと LineColor プロパティは、これらの新しいプロパティに置き換えられます。

R2022b: FaceAlpha および EdgeAlpha プロパティを使用した透明度の制御

FaceAlpha プロパティを使用して等高線間の色の透明度を指定し、EdgeAlpha プロパティを使用して等高線の透明度を指定します。

R2022b: Fill および LineColor プロパティは非推奨

Fill プロパティまたは LineColor プロパティの値を設定または取得することは推奨されません。代わりに、FaceColor プロパティと EdgeColor プロパティを使用してください。FaceColor プロパティは Fill プロパティより多くの色指定オプションを提供しますが、EdgeColor プロパティは LineColor プロパティと同じオプションを提供します。

以前のリリースでのコード	R2022b での等価のコード
contour(peaks,"Fill",true)	contour(peaks,"FaceColor","flat")
contour(peaks,"LineColor",[0 0 0])	contour(peaks,"EdgeColor",[0 0 0])

Fill または LineColor の各プロパティを削除する予定はありませんが、関数 set、get、または properties を Contour オブジェクトで呼び出す際にこれらはリストされなくなりました。

R2020a: UIContextMenu プロパティは非推奨

UIContextMenu プロパティの設定や取得は推奨されていません。代わりに、ContextMenu プロパティを使用してください。これは、UIContextMenu プロパティと同じタイプの入力を受け入れ、同じように動作します。

UIContextMenu プロパティを削除する予定はありませんが、関数 set、get、または properties を Contour オブジェクトで呼び出す際にリストされなくなりました。

参考

contour | contourf | contour3 | surfc | meshc

トピック

• プロパティ値へのアクセス
• グラフィックス オブジェクトのプロパティ