Surface のプロパティ

基本的な表面の外観と動作

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

s = surface;
c = s.CData;
s.CDataMapping = 'direct';

面

FaceColor — 面の色

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

面の色。次の表のいずれかの値として指定します。

値	説明
'flat'	CData プロパティの値に基づいて面ごとに異なる色を使用します。まず、CData プロパティを ZData と同じサイズの行列として指定しなければなりません。各面の最初の頂点 (正の x 方向と y 方向) のカラー値が、面全体の色を決定します。この値は FaceAlpha プロパティが 'interp' に設定されている場合は使用できません。
'interp'	CData プロパティの値に基づいて、面ごとに内挿によるカラーリングを使用します。まず、CData プロパティを ZData と同じサイズの行列として指定しなければなりません。頂点のカラー値を内挿することにより、各面の端から端へと色が変化します。この値は FaceAlpha プロパティが 'flat' に設定されている場合は使用できません。
RGB 3 成分、16 進数カラー コード、色名	指定した色をすべての面で使用します。このオプションは CData プロパティのカラー値を使用しません。
'texturemap'	CData のカラー データを表面に適合するように変換します。
'none'	面を描画しません。

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"

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] のスカラー | 'flat' | 'interp' | 'texturemap'

面の透明度。次の値のいずれかとして指定します。

• 範囲 [0,1] のスカラー — すべての面に一様な透明度を使用します。値 1 は完全に不透明で、値 0 は完全に透明です。0 と 1 の間の値は半透明です。このオプションは AlphaData プロパティの透明度値を使用しません。

• 'flat' — AlphaData プロパティの値に基づいて面ごとに異なる透明度を使用します。面全体の透明度は、最初の頂点の透明度値によって決まります。まず AlphaData プロパティを ZData プロパティと同じサイズの行列として指定しなければなりません。FaceColor プロパティも、'flat' に設定しなければなりません。

• 'interp' — AlphaData プロパティの値に基づいて面ごとに内挿された透明度を使用します。頂点の値を内挿することにより、各面に異なる透明度が使用されます。まず AlphaData プロパティを ZData プロパティと同じサイズの行列として指定しなければなりません。FaceColor プロパティも、'interp' に設定しなければなりません。

• 'texturemap' — AlphaData のデータを表面に適合するように変換します。

FaceLighting — 面に対する light オブジェクトの効果

'flat' (既定値) | 'gouraud' | 'none'

面に対する light オブジェクトの効果。次の値のいずれかとして指定します。

• 'flat' — 各面にライトを一様に適用します。この値は小平面で構成されたオブジェクトを表示する場合に使用します。

• 'gouraud' — 面のライトを変化させます。各頂点のライトを計算し、面上でライトを線形内挿します。この値は曲面を表示する場合に使用します。

• 'none' — light オブジェクトのライトを面に適用しません。

light オブジェクトを座標軸に追加するには、関数 light を使用します。

メモ

値 'phong' は削除されました。代わりに 'gouraud' を使用してください。

BackFaceLighting — 法線がカメラと反対方向の場合の面のライティング方法

'reverselit' (既定値) | 'unlit' | 'lit'

頂点の法線がカメラと反対方向の場合の面のライティング方法。次の値の 1 つとして指定します。

• 'reverselit' — 頂点法線がカメラに向かっているかのように面をライティングします。

• 'unlit' — 面をライティングしません。

• 'lit' — 頂点法線に従って面をライティングします。

このプロパティを使用すると、オブジェクトの内部と外部を見分けられます。例については、背面ライティングを参照してください。

エッジ

MeshStyle — 表示するエッジ

'both' (既定値) | 'row' | 'column'

表示するエッジ。'both'、'row'、'column' のいずれかとして指定します。

EdgeColor — エッジのラインの色

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

エッジのラインの色。次のいずれかの値として指定します。既定の色は [0 0 0] で、これは黒色のエッジに対応します。

値	説明
'none'	エッジを描画しません。
'flat'	CData プロパティの値に基づいてエッジごとに異なる色を使用します。まず、CData プロパティを ZData と同じサイズの行列として指定しなければなりません。各面の最初の頂点 (正の x 方向と y 方向) のカラー値が、隣接するエッジの色を決定します。この値は EdgeAlpha プロパティが 'interp' に設定されている場合は使用できません。
'interp'	CData プロパティの値に基づいて、エッジごとに内挿によるカラーリングを使用します。まず、CData プロパティを ZData と同じサイズの行列として指定しなければなりません。頂点でのカラー値を線形内挿することにより、各エッジの端から端に向かって色が変化します。この値は EdgeAlpha プロパティが 'flat' に設定されている場合は使用できません。
RGB 3 成分、16 進数カラー コード、色名	指定した色をすべてのエッジに使用します。このオプションは CData プロパティのカラー値を使用しません。

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"

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] の範囲のスカラー値 | 'flat' | 'interp'

エッジの透明度。次の値のいずれかとして指定します。

• 範囲 [0,1] のスカラー — すべてのエッジに一様な透明度を使用します。値 1 は完全に不透明で、値 0 は完全に透明です。0 と 1 の間の値は半透明です。このオプションは AlphaData プロパティの透明度値を使用しません。

• 'flat' — AlphaData プロパティの値に基づいてエッジごとに異なる透明度を使用します。まず AlphaData プロパティを ZData プロパティと同じサイズの行列として指定しなければなりません。エッジ全体の透明度は、最初の頂点の透明度値によって決まります。EdgeColor プロパティも、'flat' に設定しなければなりません。

• 'interp' — AlphaData プロパティの値に基づいて、エッジごとに内挿した透明度を使用します。まず AlphaData プロパティを ZData プロパティと同じサイズの行列として指定しなければなりません。頂点の値を内挿することにより、各エッジに一様でない透明度が使用されます。EdgeColor プロパティも、'interp' に設定しなければなりません。

LineStyle — ライン スタイル

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

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

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

LineWidth — ライン幅

0.5 (既定値) | 正の値

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

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

AlignVertexCenters — 垂直および水平のラインのシャープ化

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

垂直および水平のラインのシャープ化。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

値	説明	外観
'on'	垂直および水平のラインをシャープ化して不均一な外観を取り除きます。
'off'	垂直および水平のラインをシャープ化しません。均一でない太さや色でラインが表示される場合があります。

関連付けられている Figure の GraphicsSmoothing プロパティが 'on' に設定されていて Renderer プロパティが 'opengl' に設定されている場合、Figure のプロットには平滑化技法が適用されます。場合によってはこの平滑化技法が原因で、垂直および水平のラインが均一でない太さや色で表示されることがあります。この不均一な外観を取り除くために AlignVertexCenters プロパティを使用します。

メモ

この機能をサポートするグラフィックス カードがなければなりません。この機能がサポートされているかどうかを確認するには、関数 rendererinfo を呼び出します。サポートされている場合、rendererinfo は info.Details.SupportsAlignVertexCenters に 1 の値を返します。

EdgeLighting — エッジに対する light オブジェクトの効果

'none' (既定値) | 'flat' | 'gouraud'

エッジに対する light オブジェクトの効果。次の値のいずれかとして指定します。

• 'flat' — 各エッジにライトを一様に適用します。

• 'none' — light オブジェクトのライトをエッジに適用しません。

• 'gouraud' — 各頂点のライトを計算し、エッジ上でライトを線形内挿します。

メモ

値 'phong' は削除されました。代わりに 'gouraud' を使用してください。

マーカー

Marker — マーカー記号

"none" (既定値) | "o" | "+" | "*" | "." | ...

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

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

MarkerSize — マーカー サイズ

6 (既定値) | 正の値

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

MarkerEdgeColor — マーカーの輪郭の色

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

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

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

MarkerFaceColor — マーカーの塗りつぶし色

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

マーカーの塗りつぶし色。'auto'、'flat'、RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。'auto' オプションは座標軸の Color プロパティと同じ色を使用します。'flat' オプションは頂点の CData の値を使用して色を設定します。

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

このプロパティは円、正方形、菱形、星形五角形、星形六角形、4 種類の三角形のマーカー タイプにのみ影響します。

例: [0.3 0.2 0.1]

例: 'green'

例: '#D2F9A7'

座標のデータ

XData — x 座標のデータ

ベクトルまたは行列

x 座標のデータ。ZData と同じサイズの行列または length(n) のベクトルとして指定します。ここで [m,n] = size(ZData) です。

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

XDataMode — XData の選択モード

'auto' | 'manual'

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

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

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

YData — y 座標のデータ

ベクトルまたは行列

y 座標のデータ。ZData と同じサイズの行列または length(m) のベクトルとして指定します。ここで [m,n] = size(ZData) です。

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

YDataMode — YData の選択モード

'auto' | 'manual'

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

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

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

ZData — z 座標のデータ

行列

z 座標のデータ。行列として指定します。

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

カラー データと透明度データ

CData — 頂点の色

2 次元配列または 3 次元配列

頂点の色。次のいずれかの形式で指定します。

• 2 次元配列 — カラーマップの色を使用します。CData を ZData と同じサイズの配列に設定して各頂点の色を指定します。これらの値と現在のカラーマップとの対応は CDataMapping プロパティで決まります。FaceColor プロパティが 'texturemap' に設定されている場合は、CData を ZData と同じサイズにする必要はありません。ただし、型は double または uint8 でなければなりません。CData の値は ZData で定義された表面に適合するようにマッピングされます。

• 3 次元配列 — トゥルーカラーを使用します。CData を m×n×3 の配列に設定して各頂点の色を RGB 3 成分で指定します。ここで [m,n] = size(ZData) です。RGB 3 成分は、色の赤、緑、青成分の強度を指定する 3 成分のベクトルです。配列の最初のページは赤、2 番目のページは緑、3 番目のページは青の成分になります。表面にはカラーマップの色ではなくトゥルーカラーが使用されるので、CDataMapping プロパティは無効になります。

  • CData が double 型または single 型の場合、RGB 3 成分の値 [0 0 0] は黒に対応し、[1 1 1] は白に対応します。

  • CData が整数型の場合、すべてのデータの範囲を使用して表面の色が決定されます。たとえば CData が uint8 型の場合、[0 0 0] は黒に対応し、[255 255 255] は白に対応します。CData が int8 型の場合、[-128 -128 -128] は黒に対応し、[127 127 127] は白に対応します。

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

CDataMode — CData の選択モード

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

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

• 'auto' — ZData の値を使用して色を設定します。

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

CDataMapping — 直接カラー マッピングまたはスケーリングしたカラー マッピング

'scaled' (既定値) | 'direct'

直接カラー マッピングまたはスケーリングしたカラー マッピング。次の値のいずれかとして指定します。

• scaled — 軸の CLim プロパティで指定したカラーマップの部分全体にカラー データを変換し、データ値を色に線形にマッピングします。

• direct — カラー データを直接カラーマップのインデックスとして使用します。カラー データは、1 ～ length(colormap) の範囲の整数値でなければなりません。MATLAB は、1 より小さい値をカラーマップ内の最初の色に、length(colormap) より大きな値をカラーマップの最後の色にマップします。小数部分の値は、最近傍値の小さい方の整数に丸められます。

AlphaData — 透明度のデータ

1 (既定値) | ZData と同じサイズの配列

各頂点の透明度データ。ZData プロパティと同じサイズの配列として指定します。値を指定した後、FaceAlpha プロパティと EdgeAlpha プロパティを設定して透明度のタイプを制御します。FaceAlpha プロパティと EdgeAlpha プロパティの両方がスカラー値に設定されている場合、surface は AlphaData の値を使用しません。

AlphaDataMapping プロパティによって、surface が AlphaData プロパティの値をどのように解釈するかが決まります。

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

AlphaDataMapping — AlphaData 値の解釈

'scaled' (既定値) | 'direct' | 'none'

AlphaData の値の解釈。次の値のいずれかとして指定します。

• 'none' — 値を透明度値として解釈します。1 以上の値は完全に不透明に、0 以下の値は完全に透明に、0 と 1 の間の値は半透明になります。

• 'scaled' — 値を Figure の alphamap にマッピングします。座標軸のアルファ値の範囲の最小値と最大値によって、alphamap の最初と最後の要素にマッピングされる AlphaData の値が決まります。たとえば、アルファ値の範囲が [3 5] の場合、3 以下の値は alphamap の最初の要素にマッピングされます。5 以上の値は alphamap の最後の要素にマッピングされます。座標軸の ALim プロパティにはアルファ値の範囲が含まれています。Figure の Alphamap プロパティには alphamap が含まれています。

• 'direct' — Figure の alphamap のインデックスとして値を解釈します。小数部分の値は、最近傍値の小さい方の整数に丸められます。

  • 値が double 型または single 型の場合、1 以下の値は alphamap の最初の要素にマッピングされます。alphamap の長さ以上の値は、alphamap の最後の要素にマッピングされます。

  • 値が整数型の場合、0 以下の値は alphamap の最初の要素にマッピングされます。alphamap の長さ以上の値は、alphamap の最後の要素 (または整数型の最大値まで) にマッピングされます。整数型は uint8、uint16、uint32、uint64、int8、int16、int32、int64 です。

  • 値が logical 型の場合、0 の値は alphamap の最初の要素に、1 の値は alphamap の 2 番目の要素にマッピングされます。

法線

VertexNormals — 表面の各頂点の法線ベクトル

[] (既定値) | m×n×3 の配列

表面の各頂点の法線ベクトル。m×n×3 の配列として指定します。ここで [m,n] = size(ZData) です。法線ベクトルは頂点ごとに 1 つずつ指定します。

このプロパティの値を設定すると、対応するモード プロパティが manual に設定されます。法線ベクトルを指定しない場合、ライティングの計算用にこの値が自動的に生成されます。

データ型: single | double

VertexNormalsMode — VertexNormals の選択モード

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

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

• 'auto' — 座標データに基づいて法線ベクトルを計算します。

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

FaceNormals — 表面の各面の法線ベクトル

[] (既定値) | (m-1)×(n-1)×3 の配列

表面の各面の法線ベクトル。(m-1)×(n-1)×3 の配列として指定します。ここで [m,n] = size(ZData) です。法線ベクトルは面ごとに 1 つずつ指定します。

このプロパティの値を設定すると、対応するモード プロパティが manual に設定されます。法線ベクトルを指定しない場合、ライティングの計算用にこの値が自動的に生成されます。

データ型: single | double

FaceNormalsMode — FaceNormals の選択モード

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

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

• 'auto' — 座標データに基づいて法線ベクトルを計算します。

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

ライティング

AmbientStrength — 周囲光の強度

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

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

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

例: 0.5

データ型: double

DiffuseStrength — 拡散光の強度

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

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

例: 0.3

データ型: double

SpecularStrength — 鏡面反射の強度

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

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

例: 0.3

データ型: double

SpecularExponent — 鏡面スポットのサイズ

10 (既定値) | 1 以上のスカラー

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

例: 7

データ型: double

SpecularColorReflectance — 鏡面反射の色

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

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

例: 0.5

データ型: double

凡例

DisplayName — 凡例ラベル

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

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

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

Annotation オブジェクト

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

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

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

たとえば、obj という Surface オブジェクトを凡例から除外するには、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' (既定値) | 'all' | 'none'

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

• 'visible' — 表示されている場合にマウス クリックをキャプチャします。Visible プロパティが 'on' に設定されていなければならず、Surface オブジェクトの色が定義されている部分をクリックしなければなりません。関連付けられている色のプロパティが 'none' に設定されている部分をクリックすることはできません。プロットにマーカーが含まれている場合は、エッジまたは塗りつぶしのいずれかに色が定義されている場合にマーカー全体がクリック可能になります。Surface オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest プロパティが決定します。

• 'all' — 表示状態に関係なくマウス クリックをキャプチャします。Visible プロパティを 'on' または 'off' に設定でき、Surface オブジェクトの色が設定されていない部分をクリックできます。Surface オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest プロパティが決定します。

• 'none' — マウス クリックをキャプチャしません。Surface オブジェクトをクリックすると、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' — Surface オブジェクトの ButtonDownFcn コールバックをトリガーします。ContextMenu プロパティが定義されている場合は、コンテキスト メニューを呼び出します。

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

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

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

メモ

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

'surface'

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

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

Tag — オブジェクト識別子

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

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

UserData — ユーザー データ

[] (既定値) | 配列

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

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

バージョン履歴

R2006a より前に導入

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

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

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

参考

surface | pcolor

トピック

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