Binscatter のプロパティ

binscatter の外観と動作

Binscatter プロパティは、ビン化された散布図の外観と動作を制御します。プロパティ値を変更することによって、表示の要素を変更できます。ドット表記を使用して、特定のオブジェクトとプロパティを参照します。

h = binscatter(randn(1,100),randn(1,100));
N = h.NumBins
h.NumBins = [3 3]

ビン

NumBins — ビンの数

スカラー | 2 要素ベクトル

ビンの数。スカラーまたは 2 要素ベクトル [Nx Ny] として指定します。

• NumBins を 2 要素ベクトル [Nx Ny] として指定した場合、binscatter は x 次元で Nx 個のビンと y 次元で Ny 個のビンを使用します。

• NumBins をスカラーとして指定した場合、Nx と Ny の両方がスカラー値に設定されます。

binscatter は、座標軸にズームインしていない初期プロット内で、x 次元および y 次元に Nx 個と Ny 個のビンを使用します (XLimMode プロパティと YLimMode プロパティの両方が 'auto' の場合、座標軸はズームインされません)。ズームすると、binscatter はビンのサイズを維持するためにビンの数を調整し、プロットの表示部分をほぼ Nx 個 x Ny 個のビンに分割します。

各次元のビンの最大数は 250 個です。既定のビンの数は、データ サイズと標準偏差に基づいて計算され、100 個を超えません。

例: [10 20]

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

NumBinsMode — ビンの数の選択モード

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

ビンの数の選択モード。'auto' または 'manual' のいずれかとして指定します。既定値 'auto' の場合、ビンの数は次のスコットの法則に従ってデータから計算されます。[3.5*std(X(:))*numel(X)^(-1/4), 3.5*std(Y(:))*numel(Y)^(-1/4)]

ビンの数を指定した場合、'NumBinsMode' の値は 'manual' に設定されます。

ShowEmptyBins — 空のビンの表示切り替え

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

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

ビンの範囲内にあるがデータ点のないプロット内のタイルに着色するには、'on' または true を指定します。

XBinEdges — x 次元のビンのエッジ

ベクトル

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

x 次元のビンのエッジ。ベクトルとして返されます。

データ型: single | double | datetime | duration

YBinEdges — y 次元のビンのエッジ

ベクトル

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

y 次元のビンのエッジ。ベクトルとして返されます。

データ型: single | double | datetime | duration

XLimits — x 次元のデータの範囲

ベクトル

x 次元のデータの範囲。2 要素ベクトル [Xmin Xmax] として指定します。

binscatter は、次の指定されたデータの範囲内にあるデータ点のみを表示します。$$X_{\min }\le X\le X_{\max }$$

例: [0 10]

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

XLimitsMode — x 次元のデータの範囲の選択モード

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

x 次元のデータの範囲の選択モード。'auto' または 'manual' として指定します。既定値は 'auto' であり、ビンの範囲は x 軸方向のデータに合わせて自動的に調整されます。

XLimits を明示的に指定すると、XLimitsMode は自動的に 'manual' に設定されます。この場合に XLimitsMode を 'auto' に指定すると、ビンの範囲はデータに合わせて再びスケーリングされます。

YLimits — y 次元のデータの範囲

ベクトル

y 次元のデータの範囲。2 要素ベクトル [Ymin Ymax] として指定します。

binscatter は、次の指定されたデータの範囲内にあるデータ点のみを表示します。$$Y_{\min }\le Y\le Y_{\max }$$

例: [0 10]

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

YLimitsMode — y 次元のデータの範囲の選択モード

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

y 次元のデータの範囲の選択モード。'auto' または 'manual' として指定します。既定値は 'auto' であり、ビンの範囲は y 軸方向のデータに合わせて自動的に調整されます。

YLimits を明示的に指定すると、YLimitsMode は自動的に 'manual' に設定されます。この場合に YLimitsMode を 'auto' に指定すると、ビンの範囲はデータに合わせて再びスケーリングされます。

データ

XData — データの x 座標

ベクトル

データの x 座標。ベクトルとして指定します。

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

YData — データの y 座標

ベクトル

データの y 座標。ベクトルとして指定します。

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

Values — ビンの値

double 行列ベクトル

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

ビンの値。double 行列として返されます。Values の (i,j) 番目の要素は、x のエッジが [XBinEdges(i), XBinEdges(i+1)] で y のエッジが [YBinEdges(j), YBinEdges(j+1)] のビンのカウント数を指定します。

Values の異なる番号をもつビンに対するビン包含スキームと、ビンの x 軸および y 軸に対する相対方向は次のとおりです。

たとえば、(1,1) のビンは、各次元の最初のエッジ上にある値を含みます。右下の最後のビンは、その任意のエッジ上にある値をすべて含みます。

透明度

FaceAlpha — タイルの透明度

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

タイルの透明度。0 以上 1 以下のスカラー値として指定します。binscatter はすべてのタイルに同じ透明度を使用します。1 の値は完全な不透明を、0 の値は完全な透明 (非表示) を意味します。

例: binscatter(X,Y,'FaceAlpha',0.5) は、半透明のビンを使用して、ビン化された散布図を作成します。

凡例

DisplayName — 凡例によって使用されるテキスト

Data の変数名または '' (既定値) | 文字ベクトル

凡例によって使用されるテキスト。文字ベクトルとして指定します。このテキストは binscatter のアイコンの隣に表示されます。

例: 'Text Description'

テキストを複数行にする場合、sprintf を使用して改行文字 \n を含む文字ベクトルを作成します。

例: sprintf('line one\nline two')

あるいは、関数 legend を使用して凡例テキストを指定することもできます。

• 関数 legend の入力引数としてテキストを指定した場合、凡例には指定されたテキストが使用され、DisplayName プロパティが同じ値に設定されます。

• 関数 legend の入力引数としてテキストを指定しない場合、凡例には DisplayName プロパティのテキストが使用されます。DisplayName の既定値は次のいずれかの値です。

  • 数値入力の場合、DisplayName は文字ベクトルであり、ヒストグラムの作成に使用される入力データの変数名を表します。入力データに変数名が含まれていない場合、DisplayName は空 ('') です。

  • categorical 配列の入力の場合、DisplayName は空 ('') です。

DisplayName プロパティにテキストが含まれていない場合は、凡例で文字ベクトルが生成されます。この文字ベクトルは 'dataN' の形式になります。ここで、N は、凡例エントリのリスト内の位置を基に binscatter オブジェクトに割り当てられる数字です。

既存の凡例内でこの文字ベクトルを対話的に編集した場合、MATLAB^® は DisplayName プロパティを編集後の文字ベクトルに更新します。

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

Annotation オブジェクト

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

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

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

たとえば、obj という Binscatter オブジェクトを凡例から除外するには、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' に設定されている場合でも選択ハンドルを表示しません。

コールバック

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' (既定値) | 'none'

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

• 'visible' — 表示されている場合にのみマウス クリックをキャプチャします。Visible プロパティは、'on' に設定しなければなりません。Binscatter オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest プロパティが決定します。

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

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

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

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

メモ

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

BeingDeleted — 削除状態

on/off logical 値

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

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

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

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

親/子

Parent — 親

Axes オブジェクト

親。Axes オブジェクトとして指定します。

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

'binscatter'

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

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

Tag — オブジェクト識別子

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

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

UserData — ユーザー データ

[] (既定値) | 配列

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

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

バージョン履歴

R2017b で導入

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

R2020a 以降、コンテキスト メニューをグラフィックス オブジェクトまたは UI コンポーネントに割り当てる UIContextMenu プロパティの使用は推奨されなくなりました。代わりに、ContextMenu プロパティを使用してください。プロパティ値は同じです。

現在のところ、UIContextMenu プロパティのサポートを削除する予定はありません。ただし、UIContextMenu プロパティは、グラフィカル オブジェクトまたは UI コンポーネントで関数 get を呼び出して返されるリストに表示されなくなります。

参考

binscatter