Main Content

Stem のプロパティ

ステム グラフの外観と動作

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

s = stem(1:10);
s.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"

Sample of the color red

"green""g"[0 1 0]"#00FF00"

Sample of the color green

"blue""b"[0 0 1]"#0000FF"

Sample of the color blue

"cyan" "c"[0 1 1]"#00FFFF"

Sample of the color cyan

"magenta""m"[1 0 1]"#FF00FF"

Sample of the color magenta

"yellow""y"[1 1 0]"#FFFF00"

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

"none"該当なし該当なし該当なし色なし

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

RGB 3 成分16 進数カラー コード外観
[0 0.4470 0.7410]"#0072BD"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]"#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]"#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]"#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]"#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]"#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]"#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

例: 'blue'

例: [0 0 1]

例: '#0000FF'

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

  • "auto"Stem オブジェクトの SeiesIndex プロパティと座標軸の ColorOrder プロパティを使用することにより、MATLAB が Color プロパティ値を制御します。

  • "manual"Stem オブジェクトを作成するときに、Color プロパティ値を直接設定するか、関数の引数として間接的に設定します。

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

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

ライン スタイル説明
'-'実線
'--'破線
':'点線
'-.'一点鎖線
'none'ステムなし

例: '--'

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

  • "auto"Stem オブジェクトの SeiesIndex プロパティと座標軸の LineStyleOrder プロパティを使用することにより、MATLAB が LineStyle プロパティ値を制御します。

  • "manual"Stem オブジェクトを作成するときに、LineStyle プロパティ値を直接設定するか、関数の引数として間接的に設定します。

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

ステムとマーカー エッジのライン幅。ポイント単位の 0 より大きいスカラー数値として指定します。既定のライン幅は 0.5 ポイントです。

例: 0.75

シリーズ インデックス。正の整数または "none" として指定します。このプロパティは、Stem オブジェクトの色、ライン スタイル、またはマーカーを他のオブジェクトと一致するよう再割り当てするのに役立ちます。

既定では、SeriesIndex プロパティは Stem オブジェクトが作成された順番に対応する数値で、1 から始まります。MATLAB は、この数値を使用して、プロット関数を呼び出すときに色、ライン スタイル、またはマーカーを自動的に割り当てるためのインデックスを計算します。インデックスは座標軸の ColorOrder プロパティと LineStyleOrder プロパティに格納されている配列の行を参照します。同じ SeriesIndex 数値をもつ座標軸内のオブジェクトは同じ色 (および、該当する場合は同じライン スタイルとマーカー) ももちます。

SeriesIndex の値が "none" の場合は、インデックス方式に参加しない中間色の実線に対応します。

色、ライン スタイル、またはマーカーの手動設定が SeriesIndex の動作をオーバーライドする方法

色、ライン スタイル、マーカーを手動で制御するには、Stem オブジェクトの ColorLineStyleMarker プロパティを設定します。

オブジェクトのこれらのプロパティを手動で設定すると、MATLAB はそのオブジェクトの色、ライン スタイル、マーカーの自動選択を無効にし、SeriesIndex プロパティの値に関係なく選択を保持できるようにします。ColorModeLineStyleModeMarkerMode プロパティは、色、ライン スタイル、マーカーが手動で (ユーザーにより) 設定されているか、自動的に設定されているかを示します。これらの各モード プロパティについて、値 "manual" は手動選択を示し、値 "auto" は自動選択を示します。

自動選択を再度有効にするには、ColorModeLineStyleModeMarkerMode、または 3 つのプロパティすべてを "auto" に設定し、SeriesIndex プロパティを正の整数に設定します。

場合によっては、MATLAB は SeriesIndex プロパティを 0 に設定し、自動選択も無効にします。

マーカー

すべて展開する

マーカー記号。次の表に挙げるマーカーのいずれかとして指定します。

マーカー説明結果のマーカー
"o"

Sample of circle marker

"+"プラス記号

Sample of plus sign marker

"*"アスタリスク

Sample of asterisk marker

"."

Sample of point marker

"x"十字

Sample of cross marker

"_"水平線

Sample of horizontal line marker

"|"垂直線

Sample of vertical line marker

"square"正方形

Sample of square marker

"diamond"菱形

Sample of diamond marker

"^"上向き三角形

Sample of upward-pointing triangle marker

"v"下向き三角形

Sample of downward-pointing triangle marker

">"右向き三角形

Sample of right-pointing triangle marker

"<"左向き三角形

Sample of left-pointing triangle marker

"pentagram"星形五角形

Sample of pentagram marker

"hexagram"星形六角形

Sample of hexagram marker

"none"マーカーなし該当なし

例: '+'

例: 'diamond'

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

  • "auto"Stem オブジェクトの SeiesIndex プロパティと座標軸の LineStyleOrder プロパティを使用することにより、MATLAB がオブジェクトの Marker プロパティ値を制御します。

  • "manual"Stem オブジェクトを作成するときに、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"

Sample of the color red

"green""g"[0 1 0]"#00FF00"

Sample of the color green

"blue""b"[0 0 1]"#0000FF"

Sample of the color blue

"cyan" "c"[0 1 1]"#00FFFF"

Sample of the color cyan

"magenta""m"[1 0 1]"#FF00FF"

Sample of the color magenta

"yellow""y"[1 1 0]"#FFFF00"

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

"none"該当なし該当なし該当なし色なし

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

RGB 3 成分16 進数カラー コード外観
[0 0.4470 0.7410]"#0072BD"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]"#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]"#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]"#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]"#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]"#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]"#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

マーカーの塗りつぶし色。"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"

Sample of the color red

"green""g"[0 1 0]"#00FF00"

Sample of the color green

"blue""b"[0 0 1]"#0000FF"

Sample of the color blue

"cyan" "c"[0 1 1]"#00FFFF"

Sample of the color cyan

"magenta""m"[1 0 1]"#FF00FF"

Sample of the color magenta

"yellow""y"[1 1 0]"#FFFF00"

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

"none"該当なし該当なし該当なし色なし

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

RGB 3 成分16 進数カラー コード外観
[0 0.4470 0.7410]"#0072BD"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]"#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]"#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]"#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]"#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]"#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]"#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

ベースライン

すべて展開する

ベースライン値。スカラー数値として指定します。

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

  • 'on' — ベースラインを表示します。

  • 'off' — ベースラインを非表示にします。

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

baseline オブジェクト。ベースライン プロパティの一覧については、Baseline のプロパティ を参照してください。

座標のデータ

すべて展開する

x 軸上の値。ベクトルとして指定します。

  • 2 次元ステム グラフの場合、x 値は、関数 stem の入力引数 X に基づきます。X を指定しない場合、stemYData のインデックスを x 値として使用します。XDataYData は同じ長さでなければなりません。

  • 3 次元ステム グラフの場合、x 値は、関数 stem3 の入力引数 X に基づきます。X を指定しない場合、stem3ZData のインデックスを x 値として使用します。XDataYDataZData は同じ長さでなければなりません。

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

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

  • 'auto' — MATLAB によって XData プロパティの値が制御されます。XData の値は次のいずれかになります。

    • YData の値のインデックス。

    • table 変数の値。SourceTable プロパティが table を指定し、XVariable プロパティが変数を指定します。SourceTable プロパティまたは XVariable プロパティが空の場合は、YData インデックスが使用されます。

  • 'manual'XData プロパティは直接設定され、自動的には更新されません。これは、座標のベクトルまたは行列をプロットする場合に当てはまります。

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

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

メモ

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

例: 'x'

y 軸上の値。ベクトルとして指定します。

  • 2 次元ステム グラフの場合、y 値は関数 stem の入力引数 Y に基づきます。YData はステムの高さを定義します。XDataYData は同じ長さでなければなりません。

  • 3 次元ステム グラフの場合、y 値は関数 stem3 の入力引数 Y に基づきます。YDatay 軸に沿ったステムの位置を定義します。XDataYDataZData は同じ長さでなければなりません。

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

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

  • 'auto'YData プロパティは、SourceTable プロパティと YVariable プロパティに基づいて自動的に更新されます。これは、プロット関数に table を渡す場合に当てはまります。

  • 'manual'YData プロパティは直接設定され、自動的には更新されません。これは、座標のベクトルまたは行列をプロットする場合に当てはまります。

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

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

メモ

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

例: 'y'

z 軸上の値。ベクトルとして指定します。

  • 2 次元ステム グラフの場合、ZData は既定では空です。

  • 3 次元ステム グラフの場合、z 値は関数 stem3 の入力引数 Z に基づきます。XDataYDataZData は同じ長さでなければなりません。

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

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

  • 'auto'ZData プロパティは、SourceTable プロパティと ZVariable プロパティに基づいて自動的に更新されます。これは、プロット関数に table を渡す場合に当てはまります。

  • 'manual'ZData プロパティは直接設定され、自動的には更新されません。これは、座標のベクトルまたは行列をプロットする場合に当てはまります。

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

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

メモ

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

例: 'z'

table データ (R2022b 以降)

すべて展開する

プロットするデータを含むソース table。このプロパティは table または timetable として指定します。

x 座標を含む table 変数。次の表のインデックス方式のいずれかを使用して指定します。指定する変数には、数値、categorical 値、datetime 値、または duration 値を含めることができます。このプロパティを設定すると、MATLAB は XData プロパティを更新します。

次の表に、table 変数の指定に使用できるさまざまなインデックス方式を示します。

インデックス方式

変数名:

  • string スカラーまたは文字ベクトル。

  • pattern オブジェクト。pattern オブジェクトは 1 つの変数のみを参照しなければなりません。

  • "A" または 'A'A という名前の変数

  • "Var"+digitsPattern(1)"Var" の後に数字 1 桁が続く名前の変数

変数インデックス:

  • table 内の変数の位置を参照するインデックス番号。

  • logical ベクトル。通常、このベクトルの長さは変数の数と同じですが、末尾の 0 値や false 値は省略できます。

  • 3 — table の 3 番目の変数

  • [false false true] — 3 番目の変数

変数の型:

  • 指定したタイプの table 変数を選択する vartype 添字。添字は 1 つの変数のみを参照しなければなりません。

  • vartype("double") — double 値を含んでいる変数

y 座標を含む table 変数。次の表のインデックス方式のいずれかを使用して指定します。指定する変数には、数値、categorical 値、datetime 値、または duration 値を含めることができます。このプロパティを設定すると、MATLAB は YData プロパティを更新します。

次の表に、table 変数の指定に使用できるさまざまなインデックス方式を示します。

インデックス方式

変数名:

  • string スカラーまたは文字ベクトル。

  • pattern オブジェクト。pattern オブジェクトは 1 つの変数のみを参照しなければなりません。

  • "A" または 'A'A という名前の変数

  • "Var"+digitsPattern(1)"Var" の後に数字 1 桁が続く名前の変数

変数インデックス:

  • table 内の変数の位置を参照するインデックス番号。

  • logical ベクトル。通常、このベクトルの長さは変数の数と同じですが、末尾の 0 値や false 値は省略できます。

  • 3 — table の 3 番目の変数

  • [false false true] — 3 番目の変数

変数の型:

  • 指定したタイプの table 変数を選択する vartype 添字。添字は 1 つの変数のみを参照しなければなりません。

  • vartype("double") — double 値を含んでいる変数

z 座標を含む table 変数。次の表のインデックス方式のいずれかを使用して指定します。指定する変数には、数値、categorical 値、datetime 値、または duration 値を含めることができます。このプロパティを設定すると、MATLAB は ZData プロパティを更新します。

次の表に、table 変数の指定に使用できるさまざまなインデックス方式を示します。

インデックス方式

変数名:

  • string スカラーまたは文字ベクトル。

  • pattern オブジェクト。pattern オブジェクトは 1 つの変数のみを参照しなければなりません。

  • "A" または 'A'A という名前の変数

  • "Var"+digitsPattern(1)"Var" の後に数字 1 桁が続く名前の変数

変数インデックス:

  • table 内の変数の位置を参照するインデックス番号。

  • logical ベクトル。通常、このベクトルの長さは変数の数と同じですが、末尾の 0 値や false 値は省略できます。

  • 3 — table の 3 番目の変数

  • [false false true] — 3 番目の変数

変数の型:

  • 指定したタイプの table 変数を選択する vartype 添字。添字は 1 つの変数のみを参照しなければなりません。

  • vartype("double") — double 値を含んでいる変数

凡例

すべて展開する

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

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

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

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

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

obj.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 は、コールバック キューを処理するコマンドを実行するたびにコールバックの割り込み動作を判別します。これらのコマンドには、drawnowfigureuifiguregetframewaitforpause があります。

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

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

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

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

メモ

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

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

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

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

メモ

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

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

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

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

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

  • 実行中コールバックに drawnowfigureuifiguregetframewaitforpause などのコールバック キューを処理するコマンドが含まれている。

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

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

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

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

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

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

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

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

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

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

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

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

メモ

PickableParts プロパティは、Stem オブジェクトがマウス クリックをキャプチャできるかどうかを決定します。キャプチャできない場合、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 プロパティの設定にかかわらず、すべてのオブジェクト ハンドルがリストされます。

識別子

すべて展開する

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

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

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

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

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

バージョン履歴

R2006a より前に導入

すべて展開する