このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
Stair のプロパティ
階段状グラフの外観と動作
Stair
プロパティは、Stair
オブジェクトの外観と動作を制御します。プロパティの値を変更することによって、階段状グラフの特定の要素を変更できます。プロパティのクエリと設定にはドット表記を使用します。
s = stairs(1:10); s.Color = 'red';
色とスタイル
Color
— ラインの色
[0 0 0]
(既定値) | RGB 3 成分 | 16 進数カラー コード | 'r'
| 'g'
| 'b'
| ...
ラインの色。RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。既定値 [0 0 0]
は、黒に相当します。
カスタム色を使用する場合は、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]
例: '#0000FF'
ColorMode
— Color
の設定方法を制御
"auto"
(既定値) | "manual"
Color
プロパティの設定方法を制御します。次のいずれかの値として指定します。
"auto"
— MATLAB がStair
オブジェクトのSeriesIndex
プロパティと座標軸のColorOrder
プロパティを使用して、Color
プロパティ値を制御します。"manual"
—Stair
オブジェクトを作成するときに、Color
プロパティ値を直接設定するか、関数の引数として間接的に設定します。
Color
プロパティの値を手動で変更すると、MATLAB は ColorMode
プロパティの値を "manual"
に変更します。
LineStyle
— ライン スタイル
"-"
(既定値) | "--"
| ":"
| "-."
| "none"
ライン スタイル。次の表にリストされたオプションのいずれかとして指定します。
ライン スタイル | 説明 | 結果として得られる線 |
---|---|---|
"-" | 実線 |
|
"--" | 破線 |
|
":" | 点線 |
|
"-." | 一点鎖線 |
|
"none" | ラインなし | ラインなし |
LineStyleMode
— LineStyle
の設定方法を制御
"auto"
(既定値) | "manual"
LineStyle
プロパティの設定方法を制御します。次のいずれかの値として指定します。
"auto"
—Stair
オブジェクトのSeriesIndex
プロパティと座標軸のLineStyleOrder
プロパティを使用することにより、MATLAB がLineStyle
プロパティ値を制御します。"manual"
—Stair
オブジェクトを作成するときに、LineStyle
プロパティ値を直接設定するか、関数の引数として間接的に設定します。
LineStyle
プロパティの値を手動で変更すると、MATLAB は LineStyleMode
プロパティの値を "manual"
に変更します。
LineWidth
— ライン幅
0.5
(既定値) | 正の値
ライン幅。ポイント単位の正の値として指定します。1 ポイントは 1/72 インチです。ラインがマーカーをもつ場合、ライン幅はマーカー エッジにも影響します。
ライン幅をピクセルの幅より細くすることはできません。システムでライン幅をピクセルの幅より細い値に設定すると、ラインは 1 ピクセル幅で表示されます。
SeriesIndex
— シリーズ インデックス
正の整数 (既定値) | "none"
シリーズ インデックス。正の整数または "none"
として指定します。このプロパティは、Stair
オブジェクトの色、ライン スタイル、またはマーカーを他のオブジェクトと一致するよう再割り当てするのに役立ちます。
既定では、SeriesIndex
プロパティは Stair
オブジェクトが作成された順番に対応する数値で、1
から始まります。MATLAB は、この数値を使用して、プロット関数を呼び出すときに色、ライン スタイル、またはマーカーを自動的に割り当てるためのインデックスを計算します。インデックスは座標軸の ColorOrder
プロパティと LineStyleOrder
プロパティに格納されている配列の行を参照します。同じ SeriesIndex
数値をもつ座標軸内のオブジェクトは同じ色 (および、該当する場合は同じライン スタイルとマーカー) ももちます。
SeriesIndex
の値が "none"
の場合は、インデックス方式に参加しない中間色の実線に対応します。
色、ライン スタイル、またはマーカーの手動設定が SeriesIndex
の動作をオーバーライドする方法
色、ライン スタイル、マーカーを手動で制御するには、Stair
オブジェクトの Color
、LineStyle
、Marker
プロパティを設定します。
オブジェクトのこれらのプロパティを手動で設定すると、MATLAB はそのオブジェクトの色、ライン スタイル、マーカーの自動選択を無効にし、SeriesIndex
プロパティの値に関係なく選択を保持できるようにします。ColorMode
、LineStyleMode
、MarkerMode
プロパティは、色、ライン スタイル、マーカーが手動で (ユーザーにより) 設定されているか、自動的に設定されているかを示します。これらの各モード プロパティについて、値 "manual"
は手動選択を示し、値 "auto"
は自動選択を示します。
自動選択を再度有効にするには、ColorMode
、LineStyleMode
、MarkerMode
、または 3 つのプロパティすべてを "auto"
に設定し、SeriesIndex
プロパティを正の整数に設定します。
場合によっては、MATLAB は SeriesIndex
プロパティを 0
に設定し、自動選択も無効にします。
マーカー
Marker
— マーカー記号
"none"
(既定値) | "o"
| "+"
| "*"
| "."
| ...
マーカー記号。次の表に挙げる値のいずれかとして指定します。既定では、オブジェクトはマーカーを表示しません。マーカー記号を指定すると、各データ点または各頂点にマーカーが追加されます。
マーカー | 説明 | 結果のマーカー |
---|---|---|
"o" | 円 |
|
"+" | プラス記号 |
|
"*" | アスタリスク |
|
"." | 点 |
|
"x" | 十字 |
|
"_" | 水平線 |
|
"|" | 垂直線 |
|
"square" | 正方形 |
|
"diamond" | 菱形 |
|
"^" | 上向き三角形 |
|
"v" | 下向き三角形 |
|
">" | 右向き三角形 |
|
"<" | 左向き三角形 |
|
"pentagram" | 星形五角形 |
|
"hexagram" | 星形六角形 |
|
"none" | マーカーなし | 該当なし |
MarkerMode
— Marker
の設定方法を制御
"auto"
(既定値) | "manual"
Marker
プロパティの設定方法を制御します。次のいずれかの値として指定します。
"auto"
—Stair
オブジェクトのSeriesIndex
プロパティと座標軸のLineStyleOrder
プロパティを使用することにより、MATLAB がオブジェクトのMarker
プロパティ値を制御します。"manual"
—Stair
オブジェクトを作成するときに、Marker
プロパティ値を直接設定するか、関数の引数として間接的に設定します。
Marker
プロパティの値を手動で変更すると、MATLAB は MarkerMode
プロパティの値を "manual"
に変更します。
MarkerSize
— マーカー サイズ
6
(既定値) | 正の値
マーカー サイズ。ポイント単位の正の値として指定します。1 ポイントは 1/72 インチです。
MarkerEdgeColor
— マーカーの輪郭の色
"auto"
(既定値) | RGB 3 成分 | 16 進数カラー コード | "r"
| "g"
| "b"
| ...
マーカーの輪郭の色。"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" |
MarkerFaceColor
— マーカーの塗りつぶし色
"none"
(既定値) | "auto"
| RGB 3 成分 | 16 進数カラー コード | "r"
| "g"
| "b"
| ...
マーカーの塗りつぶし色。"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" |
座標のデータ
XData
— x 値
[]
(既定値) | ベクトル
x 値。ベクトルとして指定します。関数 stairs
への入力引数 X
は x 値を設定します。x 値を指定しない場合、stairs
は YData
のインデックスを使用します。XData
と YData
は同じ長さでなければなりません。
例: 1:10
データ型: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| categorical
| datetime
| duration
XDataMode
— XData
の設定方法を制御
'auto'
| 'manual'
XData
プロパティの設定方法を制御します。次のいずれかの値として指定します。
'auto'
— MATLAB によってXData
プロパティの値が制御されます。XData
の値は次のいずれかになります。YData
の値のインデックス。table 変数の値。
SourceTable
プロパティが table を指定し、XVariable
プロパティが変数を指定します。SourceTable
プロパティまたはXVariable
プロパティが空の場合は、YData
インデックスが使用されます。
'manual'
—XData
プロパティは直接設定され、自動的には更新されません。これは、座標のベクトルまたは行列をプロットする場合に当てはまります。
XDataSource
— XData
にリンクされている変数
''
(既定値) | 文字ベクトル | string
XData
にリンクされている変数。MATLAB ワークスペースの変数名を含む文字ベクトルまたは string として指定します。MATLAB はベース ワークスペース内の変数を評価して XData
を生成します。
既定ではリンクされている変数はないため、この値は空の文字ベクトル ''
です。変数をリンクしても MATLAB は XData
の値をすぐに更新しません。データ値の更新を強制するには、関数 refreshdata
を使用します。
メモ
1 つのデータ ソース プロパティを異なる次元のデータを含む変数に変更すると、すべてのデータ ソース プロパティを適切な値に変更するまでは、関数が警告を生成し、グラフが描画されない可能性があります。
例: 'x'
YData
— y 値
[]
(既定値) | ベクトル
y 値。ベクトルとして指定します。関数 stairs
への入力引数 Y
は y 値を設定します。XData
と YData
は同じ長さでなければなりません。
例: 1:10
データ型: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| categorical
| datetime
| duration
YDataMode
— YData
の設定方法を制御
'auto'
| 'manual'
YData
プロパティの設定方法を制御します。次のいずれかの値として指定します。
'auto'
—YData
プロパティは、SourceTable
プロパティとYVariable
プロパティに基づいて自動的に更新されます。これは、プロット関数に table を渡す場合に当てはまります。'manual'
—YData
プロパティは直接設定され、自動的には更新されません。これは、座標のベクトルまたは行列をプロットする場合に当てはまります。
YDataSource
— YData
にリンクされている変数
''
(既定値) | 文字ベクトル | string
YData
にリンクされている変数。MATLAB ワークスペースの変数名を含む文字ベクトルまたは string として指定します。MATLAB はベース ワークスペース内の変数を評価して YData
を生成します。
既定ではリンクされている変数はないため、この値は空の文字ベクトル ''
です。変数をリンクしても MATLAB は YData
の値をすぐに更新しません。データ値の更新を強制するには、関数 refreshdata
を使用します。
メモ
1 つのデータ ソース プロパティを異なる次元のデータを含む変数に変更すると、すべてのデータ ソース プロパティを適切な値に変更するまでは、関数が警告を生成し、グラフが描画されない可能性があります。
例: 'y'
table データ (R2022b 以降)
SourceTable
— ソース table
table | timetable
プロットするデータを含むソース table。このプロパティは table または timetable として指定します。
XVariable
— x 座標を含む table 変数
string スカラー | 文字ベクトル | パターン | 数値スカラー | logical ベクトル | vartype()
x 座標を含む table 変数。次の表のインデックス方式のいずれかを使用して指定します。指定する変数には、数値、categorical 値、datetime 値、または duration 値を含めることができます。このプロパティを設定すると、MATLAB は XData
プロパティを更新します。
次の表に、table 変数の指定に使用できるさまざまなインデックス方式を示します。
インデックス方式 | 例 |
---|---|
変数名:
|
|
変数インデックス:
|
|
変数の型:
|
|
YVariable
— y 座標を含む table 変数
string スカラー | 文字ベクトル | パターン | 数値スカラー | logical ベクトル | vartype()
y 座標を含む table 変数。次の表のインデックス方式のいずれかを使用して指定します。指定する変数には、数値、categorical 値、datetime 値、または duration 値を含めることができます。このプロパティを設定すると、MATLAB は YData
プロパティを更新します。
次の表に、table 変数の指定に使用できるさまざまなインデックス方式を示します。
インデックス方式 | 例 |
---|---|
変数名:
|
|
変数インデックス:
|
|
変数の型:
|
|
凡例
DisplayName
— 凡例ラベル
''
(既定値) | 文字ベクトル | string スカラー
凡例ラベル。文字ベクトルまたは string スカラーとして指定します。legend
コマンドを呼び出すまで、凡例は表示されません。テキストを指定しない場合、legend
は 'dataN'
形式を使用してラベルを設定します。
Annotation
— 凡例にオブジェクトを含める
Annotation
オブジェクト
凡例にオブジェクトを含めるかどうか。Annotation
オブジェクトとして指定します。Annotation
オブジェクトの基となる IconDisplayStyle
プロパティを次のいずれかの値に設定します。
"on"
— 凡例にオブジェクトを含めます (既定)。"off"
— 凡例にオブジェクトを含めません。
たとえば、obj
という Stair
オブジェクトを凡例から除外するには、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
プロパティの値にかかわらずスケジュールに従ってコールバックが実行されます。
BusyAction
— コールバック キューイング
'queue'
(既定値) | 'cancel'
コールバック キューイング。'queue'
または 'cancel'
として指定します。BusyAction
プロパティは MATLAB による割り込みコールバックの実行の処理方法を決定します。次の 2 つのコールバックの状態について考慮する必要があります。
"実行中" コールバックは、現在実行しているコールバックです。
"割り込み" コールバックは、実行中のコールバックに割り込もうとするコールバックです。
BusyAction
プロパティによってコールバック キューイングの動作が決まるのは、次の両方の条件を満たす場合のみです。
これらの条件に当てはまる場合、割り込みコールバックを所有するオブジェクトの BusyAction
プロパティに応じて MATLAB による割り込みコールバックの処理方法が決まります。BusyAction
プロパティは次の値を取ることができます。
'queue'
— 割り込みコールバックをキューに入れ、実行中のコールバックが終了した後に処理されるようにします。'cancel'
— 割り込みコールバックを実行しません。
PickableParts
— マウス クリック キャプチャ機能
'visible'
(既定値) | 'none'
マウス クリック キャプチャ機能。次の値の 1 つとして指定します。
'visible'
— 表示されている場合にマウス クリックをキャプチャします。Visible
プロパティが'on'
に設定されていなければならず、Stair
オブジェクトの色が定義されている部分をクリックしなければなりません。関連付けられている色のプロパティが'none'
に設定されている部分をクリックすることはできません。プロットにマーカーが含まれている場合は、エッジまたは塗りつぶしのいずれかに色が定義されている場合にマーカー全体がクリック可能になります。Stair
オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest
プロパティが決定します。'none'
— マウス クリックをキャプチャしません。Stair
オブジェクトをクリックすると、Figure ウィンドウの現在のビュー内でその下にあるオブジェクトにクリックが渡されます。Stair
オブジェクトの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'
—Stair
オブジェクトのButtonDownFcn
コールバックをトリガーします。ContextMenu
プロパティが定義されている場合は、コンテキスト メニューを呼び出します。'off'
—Stair
オブジェクトの先祖のうち、次のいずれかの条件を満たす最も近い先祖のコールバックをトリガーします。HitTest
プロパティが'on'
に設定されているPickableParts
プロパティが、先祖によるマウス クリックのキャプチャを有効にする値に設定されている
メモ
PickableParts
プロパティは、Stair
オブジェクトがマウス クリックをキャプチャできるかどうかを決定します。キャプチャできない場合、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
— グラフィックス オブジェクトのタイプ
'stair'
この プロパティ は読み取り専用です。
グラフィックス オブジェクトのタイプ。'stair'
として返されます。プロット階層内にある特定のタイプのすべてのオブジェクトを検出するためにこのプロパティを使用できます。たとえば findobj
を使用してタイプを検索します。
Tag
— オブジェクト識別子
''
(既定値) | 文字ベクトル | string スカラー
オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。オブジェクトの識別子として機能する一意の Tag
値を指定できます。コードの他の部分からオブジェクトにアクセスする必要がある場合、関数 findobj
を使用して Tag
値に基づいてオブジェクトを検索できます。
UserData
— ユーザー データ
[]
(既定値) | 配列
ユーザー データ。任意の MATLAB 配列として指定します。たとえば、スカラー、ベクトル、行列、cell 配列、文字配列、table、または構造体を指定できます。このプロパティを使用して、任意のデータをオブジェクトに保存します。
App Designer を使用している場合は、UserData
プロパティを使用する代わりに、アプリでパブリック プロパティまたはプライベート プロパティを作成してデータを共有します。詳細については、App Designer アプリ内でのデータの共有を参照してください。
バージョン履歴
R2006a より前に導入R2023b: SeriesIndex="none"
を使用した色とライン スタイルの自動選択のオプトアウト
SeriesIndex
プロパティを "none"
に設定して、Stair
オブジェクトの色とライン スタイルの自動選択をオプトアウトします。"none"
を指定すると、Stair
オブジェクトはマーカーなしの実線のライン スタイルと中間色をもちます。
自動選択を再度有効にするには、SeriesIndex
プロパティを正の整数に設定します。
R2022b: table からのプロットをサポートするプロパティ
SourceTable
、XVariable
、YVariable
、および ZVariable
プロパティを使用して、table データを使って作成されたプロットを変更します。
YDataMode
および ZDataMode
プロパティは、MATLAB でのデータの管理方法を制御します。
R2020a: SeriesIndex
プロパティによる色とライン スタイルの自動選択の制御
Stair
オブジェクトの SeriesIndex
プロパティを設定し、オブジェクトの色、ライン スタイル、マーカー記号がどのように変化するかを制御します。このプロパティの値を変更することは、座標軸内の異なるオブジェクトの色、ライン スタイル、マーカーを一致させる場合に便利です。
R2020a: UIContextMenu
プロパティは非推奨
UIContextMenu
プロパティの設定や取得は推奨されていません。代わりに、ContextMenu
プロパティを使用してください。これは、UIContextMenu
プロパティと同じタイプの入力を受け入れ、同じように動作します。
UIContextMenu
プロパティを削除する予定はありませんが、関数 set
、get
、または properties
を Stair
オブジェクトで呼び出す際にリストされなくなりました。
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)