FunctionSurface のプロパティ

表面グラフの外観と動作

FunctionSurface プロパティは FunctionSurface オブジェクトの外観と動作を制御します。プロパティの値を変更することによって、表面グラフの特定の要素を変更できます。ドット表記を使用して、特定のオブジェクトとプロパティを参照できます。

fs = fsurf(@(x,y) sin(x)+cos(y))
alp = fs.FaceAlpha
fs.FaceAlpha = 0.6

面

すべて展開する

`FaceColor` — 面の色
`'interp'` (既定値) | RGB 3 成分 | 16 進数カラーコード | `'r'` | `'g'` | `'b'` | ...

面の色。'interp'、RGB 3 成分、16 進数カラーコード、色名、または省略名として指定します。既定値の 'interp' を使用すると、ZData の値に基づいて色が内挿されます。

カスタム色を使用する場合は、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]` のスカラー

面の透明度。[0,1] の範囲のスカラーとして指定します。すべての面に一様な透明度を使用します。値 1 は完全に不透明で、値 0 は完全に透明です。0 と 1 の間の値は半透明です。

エッジ

すべて展開する

`LineStyle` — ラインスタイル
`"-"` (既定値) | `"--"` | `":"` | `"-."` | `"none"`

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

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

`LineWidth` — ライン幅
`0.5` (既定値) | 正の値

ライン幅。ポイント単位の正の値として指定します。1 ポイントは 1/72 インチです。ラインがマーカーをもつ場合、ライン幅はマーカーエッジにも影響します。

ライン幅をピクセルの幅より細くすることはできません。システムでライン幅をピクセルの幅より細い値に設定すると、ラインは 1 ピクセル幅で表示されます。

`EdgeColor` — ラインの色
`[0 0 0]` (既定値) | `'interp'` | RGB 3 成分 | 16 進数カラーコード | `'r'` | `'g'` | `'b'` | ...

ラインの色。'interp'、RGB 3 成分、16 進数カラーコード、色名、または省略名として指定します。既定の RGB 3 成分の値 [0 0 0] は、黒に相当します。'interp' 値では、ZData の値に基づいてエッジに着色します。

カスタム色を使用する場合は、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 進数カラーコード	外観
`"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"`

マーカー

すべて展開する

`Marker` — マーカー記号
`"none"` (既定値) | `"o"` | `"+"` | `"*"` | `"."` | ...

マーカー記号。次の表に挙げる値のいずれかとして指定します。既定では、オブジェクトはマーカーを表示しません。マーカー記号を指定すると、各データ点または各頂点にマーカーが追加されます。

マーカー	説明	結果のマーカー
`"o"`	円
`"+"`	プラス記号
`"*"`	アスタリスク
`"."`	点
`"x"`	十字
`"_"`	水平線
`"\|"`	垂直線
`"square"`	正方形
`"diamond"`	菱形
`"^"`	上向き三角形
`"v"`	下向き三角形
`">"`	右向き三角形
`"<"`	左向き三角形
`"pentagram"`	星形五角形
`"hexagram"`	星形六角形
`"none"`	マーカーなし	該当なし

`MarkerSize` — マーカーサイズ
`6` (既定値) | 正の値

マーカーサイズ。ポイント単位の正の値として指定します。1 ポイントは 1/72 インチです。

`MarkerEdgeColor` — マーカーの輪郭の色
`'auto'` (既定値) | RGB 3 成分 | 16 進数カラーコード | `'r'` | `'g'` | `'b'` | ...

マーカーの輪郭の色。'auto'、RGB 3 成分、16 進数カラーコード、色名、または省略名として指定します。既定値の 'auto' は、EdgeColor プロパティと同じ色を使用します。

カスタム色を使用する場合は、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 進数カラーコード	外観
`"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"`

例: [0.5 0.5 0.5]

例: 'blue'

例: '#D2F9A7'

`MarkerFaceColor` — マーカーの塗りつぶし色
`"none"` (既定値) | `"auto"` | RGB 3 成分 | 16 進数カラーコード | `"r"` | `"g"` | `"b"` | ...

マーカーの塗りつぶし色。"auto"、RGB 3 成分、16 進数カラーコード、色名、または省略名として指定します。"auto" 値を指定すると、MarkerEdgeColor プロパティと同じ色が使用されます。

カスタム色を使用する場合は、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 進数カラーコード	外観
`"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"`

例: [0.3 0.2 0.1]

例: "green"

例: "#D2F9A7"

関数

すべて展開する

`Function` — プロット対象の関数
関数ハンドル | 無名関数 | シンボリック式 | シンボリック関数

プロット対象の関数。関数ハンドル、無名関数、シンボリック式またはシンボリック関数として指定します。

`XRange` — x 値のプロット区間
`[–5 5]` (既定値) | `[xmin xmax]` の形式の 2 要素ベクトル

x 値のプロット区間。[xmin xmax] の形式の 2 要素ベクトルとして指定します。

`XRangeMode` — `XRange` の選択モード
`'auto'` (既定値) | `'manual'`

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

'auto' — 既定値 [-5 5] を使用します。座標軸の範囲が指定されている場合は、代わりに指定の範囲に従います。
'manual' — 手動で指定した値を使用します。値を指定するには、XRange プロパティを設定します。

`YRange` — y 値のプロット区間
`[–5 5]` (既定値) | `[ymin ymax]` の形式の 2 要素ベクトル

y 値のプロット区間。[ymin ymax] の形式の 2 要素ベクトルとして指定します。

`YRangeMode` — `YRange` の選択モード
`'auto'` (既定値) | `'manual'`

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

'auto' — 既定値 [-5 5] を使用します。座標軸の範囲が指定されている場合は、代わりに指定の範囲に従います。
'manual' — 手動で指定した値を使用します。値を指定するには、YRange プロパティを設定します。

`MeshDensity` — 方向ごとの評価点の数
35 (既定値) | 数値

方向ごとの評価点の数。数値として指定します。既定値は 35 です。FunctionSurface オブジェクトでは適応評価を使用するため、評価点の実際の数はそれより多くなります。

例: 100

`ShowContours` — プロットの下に等高線図を表示
`'off'` (既定値) | on/off logical 値

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

データ

すべて展開する

`XData` — x 値
行列

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

x 値。行列として指定します。XData は、少なくとも 2 行 2 列の行列です。size(XData)、size(YData) および size(ZData) は等価です。

`YData` — y 値
行列

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

y 値。行列として指定します。YData は、少なくとも 2 行 2 列の行列です。size(XData)、size(YData) および size(ZData) は等価です。

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

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

等高線の表面を定義するデータ。行列として指定します。ZData は少なくとも 2 行 2 列の行列です。size(XData)、size(YData) および size(ZData) は等価です。

周囲光

すべて展開する

`AmbientStrength` — 周囲光の強度
`0.3` (既定値) | 範囲 `[0,1]` のスカラー

周囲光の強度。[0,1] の範囲のスカラー値として指定します。周囲光は場面全体を照らす方向性のない光です。周囲光が視覚可能であるためには、座標軸に対して少なくとも 1 つの視覚可能な light オブジェクトがなければなりません。

周囲光の色は座標軸の AmbientLightColor プロパティで設定します。座標軸のすべてのオブジェクトに同じ色が使用されます。

例: 0.5

データ型: double

`DiffuseStrength` — 拡散光の強度
`0.6` (既定値) | 範囲 `[0,1]` のスカラー

拡散光の強度。[0,1] の範囲のスカラー値として指定します。拡散光は座標軸の light オブジェクトからの非鏡面反射です。

例: 0.3

データ型: double

`SpecularColorReflectance` — 鏡面反射の色
1 (既定値) | 範囲 `[0,1]` のスカラー

鏡面反射の色。[0,1] の範囲のスカラー値として指定します。値が 1 の場合、光源の色だけを使用して色が設定されます。値が 0 の場合、反射するオブジェクトの色と光源の色の両方を使用して色が設定されます。光源の色はライトの Color プロパティに格納されています。中間の値では、その割合は線形に変化します。

例: 0.5

データ型: double

`SpecularExponent` — 鏡面スポットのサイズ
10 (既定値) | 1 以上のスカラー

鏡面スポットのサイズ。1 以上のスカラー値として指定します。ほとんどが、[5 20] の範囲の指数です。

例: 7

データ型: double

`SpecularStrength` — 鏡面反射の強度
`0.9` (既定値) | 範囲 `[0,1]` のスカラー

鏡面反射の強度。[0,1] の範囲のスカラー値として指定します。鏡面反射は座標軸の light オブジェクトが照らす表面上の部分です。

例: 0.3

データ型: double

凡例

すべて展開する

`DisplayName` — 凡例ラベルのテキスト
自動生成されたラベル (既定値) | 文字ベクトル | string

凡例ラベルのテキスト。カスタム文字ベクトルまたは string として指定します。既定のラベルは Function プロパティと関数 texlabel から自動生成されます。関数 legend を呼び出すまで凡例は表示されません。

データ型: char | string

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

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

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

たとえば、obj という FunctionSurface オブジェクトを凡例から除外するには、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' に設定されている場合でも選択ハンドルを表示しません。

コールバック

すべて展開する

`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 は、この式をベースワークスペースで評価します。

このプロパティは、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'` (既定値) | `'all'` | `'none'`

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

'visible' — 表示されている場合にマウスクリックをキャプチャします。Visible プロパティが 'on' に設定されていなければならず、FunctionSurface オブジェクトの色が定義されている部分をクリックしなければなりません。関連付けられている色のプロパティが 'none' に設定されている部分をクリックすることはできません。プロットにマーカーが含まれている場合は、エッジまたは塗りつぶしのいずれかに色が定義されている場合にマーカー全体がクリック可能になります。FunctionSurface オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest プロパティが決定します。
'all' — 表示状態に関係なくマウスクリックをキャプチャします。Visible プロパティを 'on' または 'off' に設定でき、FunctionSurface オブジェクトの色が設定されていない部分をクリックできます。FunctionSurface オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest プロパティが決定します。
'none' — マウスクリックをキャプチャしません。FunctionSurface オブジェクトをクリックすると、Figure ウィンドウの現在のビュー内でその下にあるオブジェクトまでクリックが渡されます。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' — FunctionSurface オブジェクトの ButtonDownFcn コールバックをトリガーします。ContextMenu プロパティが定義されている場合は、コンテキストメニューを呼び出します。
'off' — FunctionSurface オブジェクトの先祖のうち、次のいずれかの条件を満たす最も近い先祖のコールバックをトリガーします。
- HitTest プロパティが 'on' に設定されている
- PickableParts プロパティが、先祖によるマウスクリックのキャプチャを有効にする値に設定されている

メモ

PickableParts プロパティは、FunctionSurface オブジェクトがマウスクリックをキャプチャできるかどうかを決定します。キャプチャできない場合、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` — グラフィックスオブジェクトのタイプ
`'functionsurface'`

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

グラフィックスオブジェクトのタイプ。'functionsurface' として返されます。プロット階層内にある特定のタイプのすべてのオブジェクトを検出するためにこのプロパティを使用できます。たとえば findobj を使用してタイプを検索します。

`Tag` — オブジェクト識別子
`''` (既定値) | 文字ベクトル | string スカラー

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

`UserData` — ユーザーデータ
`[]` (既定値) | 配列

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

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

バージョン履歴

R2016a で導入

すべて展開する

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

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

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

参考

fsurf | fmesh

FunctionSurface のプロパティ

面

FaceColor — 面の色 'interp' (既定値) | RGB 3 成分 | 16 進数カラー コード | 'r' | 'g' | 'b' | ...

FaceAlpha — 面の透明度 1 (既定値) | 範囲 [0 1] のスカラー

エッジ

LineStyle — ライン スタイル "-" (既定値) | "--" | ":" | "-." | "none"

LineWidth — ライン幅 0.5 (既定値) | 正の値

EdgeColor — ラインの色 [0 0 0] (既定値) | 'interp' | RGB 3 成分 | 16 進数カラー コード | 'r' | 'g' | 'b' | ...

マーカー

Marker — マーカー記号 "none" (既定値) | "o" | "+" | "*" | "." | ...

MarkerSize — マーカー サイズ 6 (既定値) | 正の値

MarkerEdgeColor — マーカーの輪郭の色 'auto' (既定値) | RGB 3 成分 | 16 進数カラー コード | 'r' | 'g' | 'b' | ...

MarkerFaceColor — マーカーの塗りつぶし色 "none" (既定値) | "auto" | RGB 3 成分 | 16 進数カラー コード | "r" | "g" | "b" | ...

関数

Function — プロット対象の関数 関数ハンドル | 無名関数 | シンボリック式 | シンボリック関数

XRange — x 値のプロット区間 [–5 5] (既定値) | [xmin xmax] の形式の 2 要素ベクトル

XRangeMode — XRange の選択モード 'auto' (既定値) | 'manual'

YRange — y 値のプロット区間 [–5 5] (既定値) | [ymin ymax] の形式の 2 要素ベクトル

YRangeMode — YRange の選択モード 'auto' (既定値) | 'manual'

MeshDensity — 方向ごとの評価点の数 35 (既定値) | 数値

ShowContours — プロットの下に等高線図を表示 'off' (既定値) | on/off logical 値

データ

XData — x 値 行列

YData — y 値 行列

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

周囲光

AmbientStrength — 周囲光の強度 0.3 (既定値) | 範囲 [0,1] のスカラー

DiffuseStrength — 拡散光の強度 0.6 (既定値) | 範囲 [0,1] のスカラー

SpecularColorReflectance — 鏡面反射の色 1 (既定値) | 範囲 [0,1] のスカラー

SpecularExponent — 鏡面スポットのサイズ 10 (既定値) | 1 以上のスカラー

SpecularStrength — 鏡面反射の強度 0.9 (既定値) | 範囲 [0,1] のスカラー

凡例

DisplayName — 凡例ラベルのテキスト 自動生成されたラベル (既定値) | 文字ベクトル | string

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

対話機能

Visible — 可視性の状態 "on" (既定値) | on/off logical 値

DataTipTemplate — データ ヒントの内容 DataTipTemplate オブジェクト

ContextMenu — コンテキスト メニュー 空の GraphicsPlaceholder 配列 (既定値) | ContextMenu オブジェクト

Selected — 選択状態 'off' (既定値) | on/off logical 値

SelectionHighlight — 選択ハンドルの表示 'on' (既定値) | on/off logical 値

コールバック

ButtonDownFcn — マウスクリック コールバック '' (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

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

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

コールバック実行制御

Interruptible — コールバックの割り込み 'on' (既定値) | on/off logical 値

BusyAction — コールバック キューイング 'queue' (既定値) | 'cancel'

PickableParts — マウス クリック キャプチャ機能 'visible' (既定値) | 'all' | 'none'

HitTest — キャプチャしたマウス クリックへの応答 'on' (既定値) | on/off logical 値

BeingDeleted — 削除状態 on/off logical 値

親/子

Parent — 親 Axes オブジェクト | Group オブジェクト | Transform オブジェクト

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

HandleVisibility — オブジェクト ハンドルの可視性 "on" (既定値) | "off" | "callback"

識別子

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

Tag — オブジェクト識別子 '' (既定値) | 文字ベクトル | string スカラー

UserData — ユーザー データ [] (既定値) | 配列

バージョン履歴

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

参考

トピック

`FaceColor` — 面の色
`'interp'` (既定値) | RGB 3 成分 | 16 進数カラーコード | `'r'` | `'g'` | `'b'` | ...

`FaceAlpha` — 面の透明度
1 (既定値) | 範囲 `[0 1]` のスカラー

`LineStyle` — ラインスタイル
`"-"` (既定値) | `"--"` | `":"` | `"-."` | `"none"`

`LineWidth` — ライン幅
`0.5` (既定値) | 正の値

`EdgeColor` — ラインの色
`[0 0 0]` (既定値) | `'interp'` | RGB 3 成分 | 16 進数カラーコード | `'r'` | `'g'` | `'b'` | ...

`Marker` — マーカー記号
`"none"` (既定値) | `"o"` | `"+"` | `"*"` | `"."` | ...

`MarkerSize` — マーカーサイズ
`6` (既定値) | 正の値

`MarkerEdgeColor` — マーカーの輪郭の色
`'auto'` (既定値) | RGB 3 成分 | 16 進数カラーコード | `'r'` | `'g'` | `'b'` | ...

`MarkerFaceColor` — マーカーの塗りつぶし色
`"none"` (既定値) | `"auto"` | RGB 3 成分 | 16 進数カラーコード | `"r"` | `"g"` | `"b"` | ...

`Function` — プロット対象の関数
関数ハンドル | 無名関数 | シンボリック式 | シンボリック関数

`XRange` — x 値のプロット区間
`[–5 5]` (既定値) | `[xmin xmax]` の形式の 2 要素ベクトル

`XRangeMode` — `XRange` の選択モード
`'auto'` (既定値) | `'manual'`

`YRange` — y 値のプロット区間
`[–5 5]` (既定値) | `[ymin ymax]` の形式の 2 要素ベクトル

`YRangeMode` — `YRange` の選択モード
`'auto'` (既定値) | `'manual'`

`MeshDensity` — 方向ごとの評価点の数
35 (既定値) | 数値

`ShowContours` — プロットの下に等高線図を表示
`'off'` (既定値) | on/off logical 値

`XData` — x 値
行列

`YData` — y 値
行列

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

`AmbientStrength` — 周囲光の強度
`0.3` (既定値) | 範囲 `[0,1]` のスカラー

`DiffuseStrength` — 拡散光の強度
`0.6` (既定値) | 範囲 `[0,1]` のスカラー

`SpecularColorReflectance` — 鏡面反射の色
1 (既定値) | 範囲 `[0,1]` のスカラー

`SpecularExponent` — 鏡面スポットのサイズ
10 (既定値) | 1 以上のスカラー

`SpecularStrength` — 鏡面反射の強度
`0.9` (既定値) | 範囲 `[0,1]` のスカラー

`DisplayName` — 凡例ラベルのテキスト
自動生成されたラベル (既定値) | 文字ベクトル | string

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

`Visible` — 可視性の状態
`"on"` (既定値) | on/off logical 値

`DataTipTemplate` — データヒントの内容
`DataTipTemplate` オブジェクト

`ContextMenu` — コンテキストメニュー
空の `GraphicsPlaceholder` 配列 (既定値) | `ContextMenu` オブジェクト

`Selected` — 選択状態
`'off'` (既定値) | on/off logical 値

`SelectionHighlight` — 選択ハンドルの表示
`'on'` (既定値) | on/off logical 値

`ButtonDownFcn` — マウスクリックコールバック
`''` (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

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

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

`Interruptible` — コールバックの割り込み
`'on'` (既定値) | on/off logical 値

`BusyAction` — コールバックキューイング
`'queue'` (既定値) | `'cancel'`

`PickableParts` — マウスクリックキャプチャ機能
`'visible'` (既定値) | `'all'` | `'none'`

`HitTest` — キャプチャしたマウスクリックへの応答
`'on'` (既定値) | on/off logical 値

`BeingDeleted` — 削除状態
on/off logical 値

`Parent` — 親
`Axes` オブジェクト | `Group` オブジェクト | `Transform` オブジェクト

`Children` — 子
空の `GraphicsPlaceholder` 配列 | `DataTip` オブジェクト配列

`HandleVisibility` — オブジェクトハンドルの可視性
`"on"` (既定値) | `"off"` | `"callback"`

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

`Tag` — オブジェクト識別子
`''` (既定値) | 文字ベクトル | string スカラー

`UserData` — ユーザーデータ
`[]` (既定値) | 配列

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