Line のプロパティ

プリミティブ ラインの外観と動作

Line プロパティは、Line オブジェクトの外観と動作を制御します。プロパティの値を変更することによって、線グラフの特定の要素を変更できます。

h = line;
h.LineStyle = ":";

ライン

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"

ColorMode — Color の設定方法を制御

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

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

• "auto" — MATLAB が Line オブジェクトの SeriesIndex プロパティと座標軸の ColorOrder プロパティを使用して、Color プロパティ値を制御します。

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

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

LineStyle — ライン スタイル

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

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

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

LineStyleMode — LineStyle の設定方法を制御

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

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

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

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

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

LineWidth — ライン幅

0.5 (既定値) | 正の値

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

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

SeriesIndex — シリーズ インデックス

正の整数 (既定値) | "none"

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

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

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

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

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

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

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

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

LineJoin — ラインの角のスタイル

"round" (既定値) | "miter" | "chamfer"

ラインの角のスタイル。"round"、"miter"、"chamfer" のいずれかに指定します。次の表に、各値によって指定される外観を示します。

"round"	"miter"	"chamfer"

Figure の Renderer プロパティが "painters" ではなく "opengl" に設定されている場合、"round" オプションの外観は異なる場合があります。

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 の値を返します。

マーカー

Marker — マーカー記号

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

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

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

MarkerMode — Marker の設定方法を制御

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

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

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

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

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

MarkerIndices — マーカーを表示するデータ点のインデックス

1:length(YData) (既定値) | 正の整数のベクトル | 正のスカラー整数

マーカーを表示するデータ点のインデックス。正の整数のベクトルとして指定します。インデックスを指定しない場合、MATLAB はすべてのデータ点でマーカーを表示します。

メモ

マーカーを表示するには、マーカー記号も指定しなければなりません。

例: plot(x,y,"-o","MarkerIndices",[1 5 10]) は 1 番目、5 番目、10 番目のデータ点に円形マーカーを表示します。

例: plot(x,y,"-x","MarkerIndices",1:3:length(y)) は 3 つのデータ点ごとに X 印のマーカーを表示します。

例: plot(x,y,"Marker","square","MarkerIndices",5) は 5 番目のデータ点に正方形マーカーを 1 つ表示します。

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 値

[0 1] (既定値) | ベクトル

x 値。ベクトルとして指定します。XData と YData は同じ長さでなければなりません。

例: 1:10

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

YData — y 値

[0 1] (既定値) | ベクトル

y 値。ベクトルとして指定します。XData と YData は同じ長さでなければなりません。

例: 1:10

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

ZData — z 値

空行列 (既定値) | ベクトル

z 値。ベクトルとして指定します。ZData は XData と YData と同じ長さでなければなりません。

例: 1:10

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

RData — 半径の値

ベクトル

半径の値。ベクトルとして指定します。ThetaData と RData は同じ長さのベクトルでなければなりません。

このプロパティは、極座標軸のラインにのみ適用されます。

ThetaData — 角度の値

ベクトル

角度の値。ベクトルとして指定します。ThetaData と RData は同じ長さのベクトルでなければなりません。

このプロパティは、極座標軸のラインにのみ適用されます。

AffectAutoLimits — 座標軸の範囲にデータ範囲を含める

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

R2023a 以降

座標軸の範囲の自動選択に Line オブジェクトのデータ範囲を含めるかどうか。"on"、"off"、logical 1 (true)、または 0 (false) として指定します。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

既定では、座標軸の範囲は、座標軸で作成した後続の各ラインのデータ範囲を含むように自動的に変更されます。このプロパティを設定することで、ラインのサブセットの範囲に焦点を合わせることができます。自動選択でラインのデータ範囲を除外するには、その AffectAutoLimits プロパティを "off" に設定します。

両方のラインで AffectAutoLimits="on" を設定	細い赤のラインで AffectAutoLimits="off" を設定

凡例

DisplayName — 凡例ラベル

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

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

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

Annotation オブジェクト

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

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

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

たとえば、obj という Line オブジェクトを凡例から除外するには、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' に設定されていなければならず、Line オブジェクトの色が定義されている部分をクリックしなければなりません。関連付けられている色のプロパティが 'none' に設定されている部分をクリックすることはできません。プロットにマーカーが含まれている場合は、エッジまたは塗りつぶしのいずれかに色が定義されている場合にマーカー全体がクリック可能になります。Line オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest プロパティが決定します。

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

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

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

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

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

メモ

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

BeingDeleted — 削除状態

on/off logical 値

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

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

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

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

親/子

Parent — 親

Axes オブジェクト | PolarAxes オブジェクト | Group オブジェクト | Transform オブジェクト

親。Axes、PolarAxes、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 — グラフィックス オブジェクトのタイプ

'line'

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

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

Tag — オブジェクト識別子

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

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

UserData — ユーザー データ

[] (既定値) | 配列

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

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

バージョン履歴

R2006a より前に導入

R2023b: SeriesIndex プロパティによる色とライン スタイルの自動選択の制御

SeriesIndex プロパティを設定することにより、Line オブジェクトの色、ライン スタイル、マーカーがどのように変化するかを制御します。このプロパティは、座標軸内の異なるオブジェクトの色、ライン スタイル、マーカーを一致させる場合に便利です。

R2023a: AffectsAutoLimits プロパティによる、ラインが座標軸の範囲の自動計算に影響するかどうかの制御

AffectsAutoLimits プロパティを設定して、特定のラインが、自動的に選択される座標軸の範囲に影響するかどうかを指定します。既定では、座標軸の範囲は、作成した後続の各ラインのデータ範囲を含むように変更されます。このプロパティを設定することで、座標軸のラインのサブセットの範囲に焦点を合わせることができます。

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

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

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

参考

line

トピック

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