Main Content

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

Quiver のプロパティ

quiver グラフの外観と動作

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

q = quiver(1:10,1:10);
q.Color = 'red';

矢印

すべて展開する

矢印の色。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'

例: 'blue'

例: [0 0 1]

Color プロパティの設定方法を制御します。次のいずれかの値として指定します。

  • 'auto' — 座標軸の ColorOrder プロパティから色を選択することにより、MATLAB が Color プロパティ値を制御します。

  • 'manual' — ユーザーがオブジェクトの Color プロパティの値を直接設定するか、プロット関数を呼び出すときに LineSpec 引数に色を含めることにより、Color プロパティの値を手動で制御します。

Color プロパティの値を手動で変更すると、MATLAB は ColorMode プロパティの値を 'manual' に変更します。

矢印の軸のスタイル。次の表に挙げるライン スタイルのいずれかとして指定します。

ライン スタイル説明結果
'-'実線

'--'破線

':'点線

'-.'一点鎖線

'none'軸なし軸なし

LineStyle プロパティの設定方法を制御します。次のいずれかの値として指定します。

  • 'auto' — MATLAB が座標軸の LineStyleOrder プロパティからライン スタイルを選択することにより、LineStyle プロパティ値を制御します。

  • 'manual' — ユーザーがオブジェクトの LineStyle プロパティの値を直接設定するか、プロット関数を呼び出すときに LineSpec 引数を指定することにより、LineStyle プロパティの値を手動で制御します。

LineStyle プロパティの値を手動で変更すると、MATLAB は LineStyleMode プロパティの値を 'manual' に変更します。

矢印の軸の幅。ポイント単位の 0 より大きいスカラー数値として指定します。1 ポイントは 1/72 インチです。既定値は 0.5 ポイントです。

例: 0.75

シリーズ インデックス。0 または正の整数として指定します。このプロパティは、いくつかの Quiver オブジェクトの色、ライン スタイル、またはマーカーを、互いに一致するよう再割り当てするのに役立ちます。既定では、Quiver オブジェクトの SeriesIndex プロパティは、1 から始まる、作成順に対応する数値です。

MATLAB はこの数値を使用して、プロット関数を呼び出すときに、色、ライン スタイル、またはマーカーを割り当てるインデックスを計算します。インデックスは座標軸の ColorOrder プロパティと LineStyleOrder プロパティに格納されている配列の行を参照します。

MATLAB は、その SeriesIndex を変更するか、座標軸の ColorOrder プロパティまたは LineStyleOrder プロパティを変更する際に、Quiver オブジェクトの色、ライン スタイル、またはマーカーを自動的に更新します。ただし、変更が有効になるには、以下の条件に該当しなければなりません。

  • Quiver オブジェクトの ColorModeLineStyleMode、または MarkerMode プロパティの少なくとも 1 つが 'auto' に設定されている。

  • Quiver オブジェクトの SeriesIndex プロパティが 0 より大きい。

  • axes オブジェクトの NextSeriesIndex プロパティが 0 より大きい。

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

  • 'on' — ベクトルを矢じり付きで表示します。

  • 'off' — ベクトルを矢じりなしで表示します。

矢じりの最大サイズ。矢印の長さを単位基準としたスカラー値として指定します。

例: 0.1

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

矢印の長さの自動スケーリング。'on' または 'off' もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

  • 'on' — グリッドで定義された座標データ内に収まるように矢印の長さをスケーリングし、矢印が重なり合わないようにします。関数 quiver は、その後にその矢印の長さに対して AutoScaleFactor を適用します。

  • 'off' — 矢印の長さをスケーリングしません。

スケール係数。スカラーとして指定します。値が 2 の場合は矢印の長さが 2 倍になり、値が 0.5 の場合は矢印の長さが半分になります。

このプロパティは AutoScale'on' に設定されている場合のみ有効です。

例: 2

垂直および水平のラインのシャープ化。'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 を呼び出します。サポートされている場合、rendererinfoinfo.Details.SupportsAlignVertexCenters1 の値を返します。

マーカー

すべて展開する

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

説明
'o'
'+'プラス記号
'*'アスタリスク
'.'
'x'十字
'square' または 's'正方形
'diamond' または 'd'菱形
'^'上向き三角形
'v'下向き三角形
'>'右向き三角形
'<'左向き三角形
'pentagram' または 'p'星形五角形
'hexagram' または 'h'星形六角形
'none'マーカーなし

Marker プロパティの設定方法を制御します。次のいずれかの値として指定します。

  • 'auto' — MATLAB がオブジェクトの Marker プロパティ値を制御します。

  • 'manual' — ユーザーがオブジェクトの Marker プロパティの値を直接設定するか、プロット関数を呼び出すときに LineSpec 引数にマーカーを含めることにより、Marker プロパティの値を手動で制御します。

Marker プロパティの値を手動で変更すると、MATLAB は MarkerMode プロパティの値を 'manual' に変更します。

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

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

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

マーカーの塗りつぶし色。'auto'、RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。'auto' オプションは親の座標軸の Color プロパティと同じ色を使用します。'auto' を指定し、座標軸のプロット ボックスが非表示の場合、マーカーの塗りつぶし色は figure の色です。

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

データ

すべて展開する

ベクトルの x 方向の長さ。ベクトルまたは行列として指定します。プロパティ UDataVDataWData の組み合わせで、quiver グラフに矢印として表示されるベクトルの成分を指定します。

例: 1:10

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

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

メモ

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

ベクトルの y 方向の長さ。ベクトルまたは行列として指定します。プロパティ UDataVDataWData の組み合わせで、quiver グラフに矢印として表示されるベクトルの成分を指定します。

例: 1:10

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

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

メモ

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

ベクトルの z 方向の長さ。ベクトルまたは行列として指定します。プロパティ UDataVDataWData の組み合わせで、quiver グラフに矢印として表示されるベクトルの成分を指定します。2 次元の quiver グラフの場合、WData は空の配列になります。

例: 1:10

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

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

メモ

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

x 座標。ベクトルまたは行列として指定します。x 座標は、関数 quiver の入力引数 X に基づきます。X を指定しない場合、quiverUData のインデックスを x 座標として使用します。XData のサイズは YData と等しくなければなりません。

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

例: 1:10

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

  • 'auto' — 値を自動で選択します。

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

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

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

メモ

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

例: 'x'

y 座標。ベクトルまたは行列として指定します。y 座標は、関数 quiver の入力引数 Y に基づきます。Y を指定しない場合、quiverVData のインデックスを y 座標として使用します。YData のサイズは XData と等しくなければなりません。

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

例: 1:10

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

  • 'auto' — 値を自動で選択します。

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

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

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

メモ

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

例: 'y'

z 座標。ベクトルまたは行列として指定します。z 座標は、関数 quiver3 の入力引数 Z に基づきます。2 次元の quiver グラフの場合、ZData は空の配列になります。3 次元の quiver グラフの場合、ZData のサイズは XData および YData と等しくなければなりません。

例: 1:10

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

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

メモ

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

例: 'z'

凡例

すべて展開する

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

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

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

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

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

たとえば、グラフィックス オブジェクト go を凡例から除外するには、IconDisplayStyle プロパティを 'off' に設定します。

go.Annotation.LegendInformation.IconDisplayStyle = 'off';

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

対話機能

すべて展開する

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

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

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

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

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

メモ

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

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

メモ

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

選択状態。'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' — 選択されていません。

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

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

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

座標軸の範囲でのオブジェクトのクリップ。'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 プロパティを参照してください。

コールバック

すべて展開する

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

  • 関数ハンドル

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

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

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

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

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

関数ハンドルを使用してコールバック関数を定義する方法についての詳細は、コールバック定義を参照してください。

メモ

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

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

  • 関数ハンドル。

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

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

コールバックを関数ハンドル、cell 配列、または文字ベクトルとして指定する方法の詳細については、コールバック定義を参照してください。

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

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

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

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

  • 関数ハンドル。

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

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

コールバックを関数ハンドル、cell 配列、または文字ベクトルとして指定する方法の詳細については、コールバック定義を参照してください。

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

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

コールバック実行制御

すべて展開する

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

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

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

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

MATLAB がコールバックを呼び出すたびに、そのコールバックは実行中のコールバック (がある場合) に割り込もうとします。実行中のコールバックを所有するオブジェクトの Interruptible プロパティが、割り込み可能かどうかを決定します。

  • 値が 'on' の場合、他のコールバックがオブジェクトのコールバックに割り込むことができます。割り込みは、drawnowfigureuifiguregetframewaitforpause コマンドなどの、MATLAB が次にキューを処理するポイントで発生します。

    • 実行中のコールバックにこれらのいずれかのコマンドが含まれている場合、MATLAB はそのポイントでコールバックの実行を停止し、割り込みコールバックを実行します。割り込みコールバックが完了すると、MATLAB は実行中だったコールバックの実行を再開します。

    • 実行中のコールバックにこれらのコマンドが含まれていない場合、MATLAB はそのコールバックの実行を割り込みなしで完了します。

  • 値が 'off' の場合、割り込みの試行はすべてブロックされます。割り込みコールバックを所有するオブジェクトの BusyAction プロパティが、その割り込みコールバックを破棄するかキューに入れるかを決定します。

メモ

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

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

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

  • Timer オブジェクトは、Interruptible プロパティ値にかかわらず、スケジュールに従って実行されます。

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

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

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

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

MATLAB がコールバックを呼び出すたびに、そのコールバックは実行中のコールバックに割り込もうとします。実行中のコールバックを所有するオブジェクトの Interruptible プロパティが、割り込みを許可するかどうかを決定します。割り込みが許可されない場合は、割り込みコールバックを所有するオブジェクトの BusyAction プロパティが、そのコールバックを破棄するかキューに入れるかを決定します。BusyAction プロパティは次の値を取ることができます。

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

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

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

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

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

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

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

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

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

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

メモ

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

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

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

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

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

親/子

すべて展開する

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

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

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

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

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

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

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

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

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

識別子

すべて展開する

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

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

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

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

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

互換性についての考慮事項

すべて展開する

R2020a 以降は非推奨

R2006a より前に導入