Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

Histogram のプロパティ

ヒストグラムの外観と動作

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

h = histogram(randn(10,1));
c = h.BinWidth;
h.BinWidth = 2;

ビン

すべて展開する

ビンの数。正の整数として指定します。NumBins を指定しない場合、histogramData の値に基づいて使用するビンの数を自動的に計算します。

このオプションは、カテゴリカル データのヒストグラムには適用されません。

ビンの幅。スカラーとして指定します。BinWidth を指定する場合、histogram は最大 65,536 (216) 個のビンを使用できます。指定したビンの幅によってさらに多くのビンが必要となる場合、histogram は最大のビン数に対応するより大きなビンの幅を使用します。

datetime データおよび duration データの場合、'BinWidth' の値をスカラー期間またはカレンダー期間にすることができます。

このオプションは、カテゴリカル データのヒストグラムには適用されません。

例: histogram(X,'BinWidth',5) は幅が 5 のビンを使用します。

ビンのエッジ。数値ベクトルとして指定します。ベクトルの最初の要素は最初のビンの左の端を指定します。最後の要素は最後のビンの右の端を指定します。ビンのエッジを指定しない場合、histogram は自動的にビンのエッジの位置を決定します。

このオプションは、カテゴリカル データのヒストグラムには適用されません。

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

ビンの範囲。2 要素ベクトル [bmin,bmax] として指定します。このオプションは、入力配列 Xbmin 以上 bmax 以下の値を使用してヒストグラムをプロットします。つまり、X(X>=bmin & X<=bmax) です。

このオプションは、カテゴリカル データのヒストグラムには適用されません。

例: histogram(X,'BinLimits',[1,10])1 以上 10 以下の X の値のみを使用してヒストグラムをプロットします。

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

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

このオプションは、カテゴリカル データのヒストグラムには適用されません。

ビン化アルゴリズム。次の表のいずれかの値を指定します。

説明

'auto'

既定値の 'auto' アルゴリズムは、データの範囲をカバーするビンの幅を選択することで、基となる分布の形状を明らかにします。

'scott'

スコットの法則はデータが正規分布に近い場合に最適です。この規則は他の多くの分布にも適しています。ビンの幅として 3.5*std(X(:))*numel(X)^(-1/3) を使用します。

'fd'

Freedman-Diaconis の法則は、データの外れ値の影響を受けにくく、裾が大きい分布をもつデータにより適しています。ビンの幅として 2*IQR(X(:))*numel(X)^(-1/3) を使用します。ここで IQRX の四分位数間範囲です。

'integers'

整数ルールは整数ごとにビンを作成するため整数データで役立ちます。幅が 1 のビンを使用し、ビンのエッジを整数の中間に設定します。誤って多すぎるビンを作成しないように、このルールを使用して作成するビンを 65536 個以下に制限できます (216)。データの範囲が 65,536 よりも大きい場合、整数ルールは代わりに幅の広いビンを使用します。

メモ

'integers' は datetime データまたは duration データをサポートしません。

'sturges'

Sturges の法則は簡単なためよく用いられています。ビンの数として ceil(1 + log2(numel(X))) を選択します。

'sqrt'

平方根ルールは他のソフトウェア パッケージで広く使用されています。ビンの数として ceil(sqrt(numel(X))) を選択します。

histogram は、これらの式を厳密に使用してビンの数を選択するとは限りません。場合によっては、ビンのエッジが "きりのよい" 数字になるように、ビンの数がわずかに調整されることがあります。

datetime データの場合、ビン メソッドを次の時間単位のいずれかにすることができます。

'second''month'
'minute''quarter'
'hour''year'
'day''decade'
'week''century'

duration データの場合、ビン メソッドを次の時間単位のいずれかにすることができます。

'second''day'
'minute''year'
'hour' 

datetime データまたは duration データを使用して BinMethod を指定する場合、histogram は最大 65,536 (216) 個のビンを使用できます。指定したビンの期間にさらに多くのビンが必要となる場合、histogram は最大のビン数に対応する、より大きいビンの幅を使用します。

このオプションは、カテゴリカル データのヒストグラムには適用されません。

メモ

BinLimitsNumBinsBinEdges または BinWidth プロパティを設定した場合、BinMethod プロパティは 'manual' に設定されます。

例: histogram(X,'BinMethod','integers') は整数を中心とするビンをもつヒストグラムを作成します。

カテゴリ

すべて展開する

メモ

このオプションはカテゴリカル ヒストグラムにのみ適用されます。

ヒストグラムに含めるカテゴリ。文字ベクトルの cell 配列、categorical 配列または string 配列として指定します。

  • 入力 categorical 配列 C を指定すると、histogram は既定で C の各カテゴリのバーをプロットします。その場合にカテゴリの一意のサブセットを指定するには、Categories を使用します。

  • ビンのカウント数を指定する場合、Categories にはヒストグラムの関連するカテゴリ名を指定します。

例: h = histogram(C,{'Large','Small'}) は、カテゴリ 'Large' および 'Small' のカテゴリカル データのみをプロットします。

例: histogram('Categories',{'Yes','No','Maybe'},'BinCounts',[22 18 3]) は 3 つのカテゴリと関連するビンのカウント数をもつヒストグラムをプロットします。

例: h.Categories は、histogram オブジェクト h 内にあるカテゴリをクエリします。

データ型: cell | categorical | string

カテゴリの表示順序。'ascend''descend'、または 'data' として指定します。'ascend' または 'descend' を使用すると、ヒストグラムには増加または減少するバーの高さが表示されます。既定の 'data' 値では、入力データ C のカテゴリの順序を使用します。

このオプションは、カテゴリカル データでのみ機能します。

表示するカテゴリ数。スカラーとして指定します。'DisplayOrder' オプションを使用して、ヒストグラムに表示されるカテゴリの順序を変更できます。

このオプションは、カテゴリカル データでのみ機能します。

非表示カテゴリに属するデータの概要表示の切り替え。'on' または 'off' として、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off'false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このオプションを 'on' に設定すると、ヒストグラムに 'Others' という名前の追加のバーが表示されます。この追加のバーには、ヒストグラムに表示されるカテゴリに属さないすべての要素がカウントされます。

ヒストグラムに表示されるカテゴリ数とその順序は、'NumDisplayBins' および 'DisplayOrder' オプションを使用して変更できます。

このオプションは、カテゴリカル データでのみ機能します。

データ

すべて展開する

ビンに分散させるデータ。ベクトル、行列、多次元配列または categorical 配列として指定します。Data がベクトルでない場合、histogram はそれを 1 つの列ベクトル Data(:) として扱い、1 つのヒストグラムをプロットします。

histogram は、NaNNaT および未定義のカテゴリカル値をすべて無視します。同様にビンのエッジとして明示的に Inf または -Inf を指定しない限り、histogramInf 値および -Inf 値を無視します。通常、NaN 値、NaT 値、Inf 値、-Inf 値、<undefined> 値はプロットされませんが、'probability' などのデータ要素の総数を含む正規化計算に引き続き含まれます。

histogram オブジェクトの Data プロパティで値を変更しても、ビンのエッジは自動更新されません。ビンを再計算するには、BinMethodNumBins など、ビンに関連するプロパティを調整します。当初、カテゴリカルを使用して histogram オブジェクトが作成された場合、Data にはカテゴリカル値のみを指定できます。

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

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

ビンの値。数値ベクトルとして返されます。Normalization'count' (既定値) の場合、Valuesk 番目の要素は Data の要素が k 番目のビンの区間に何個入るか (ビンのカウント数) を指定します。最後のビンはビンの "両端" の値を含みますが、そのほかのすべてのビンは左端の値のみを含みます。

Normalization の値によっては、Values プロパティは代わりにビンのカウント数の正規化されたバリアントを含むことができます。

正規化のタイプ。次の表のいずれかの値を指定します。各ビン i に対して次のようになります。

  • vi はビンの値です。

  • ci はビン内の要素数です。

  • wi はビンの幅です。

  • N は入力データ内の要素数です。データに NaNNaT、または <undefined> 値が含まれる場合、あるいは一部のデータがビンの範囲外にある場合、この値はビン化されたデータより大きくなることがあります。

ビンの値メモ
'count' (既定)

vi=ci

  • 観測のカウント数または頻度。

  • ビンの値の合計は numel(X) 以下です。一部の入力データがビンに含まれていない場合にのみ、合計は numel(X) 未満になります。

  • カテゴリカル データの場合、ビンの値の合計は numel(X) 以下または sum(ismember(X(:),Categories)) 以下のいずれかです。

'countdensity'

vi=ciwi

  • ビンの幅でスケーリングされたカウント数または頻度。

  • それぞれのバーの面積 (高さ * 幅) はビン内の観測数になります。バーの面積の合計は numel(X) 以下です。

  • カテゴリカル ヒストグラムの場合、これは 'count' と同じです。

メモ

'countdensity' は datetime データまたは duration データをサポートしません。

'cumcount'

vi=j=1icj

  • 累積カウント数。各ビンの値は、そのビンとその前にあるすべてのビンの累積観測数です。

  • 最後のバーの高さは numel(X) 以下です。

  • カテゴリカル ヒストグラムの場合、最後のバーの高さは numel(X) 以下または sum(ismember(X(:),Categories)) 以下です。

'probability'

vi=ciN

  • 相対的確率。

  • バーの高さの合計は 1 以下です。

'pdf'

vi=ciNwi

  • 確率密度関数の推定値です。

  • それぞれのバーの面積は相対的な観測数になります。バーの面積の合計は 1 以下です。

  • カテゴリカル ヒストグラムの場合、これは 'probability' と同じです。

メモ

'pdf' は datetime データまたは duration データをサポートしません。

'cdf'

vi=j=1icjN

  • 累積密度関数の推定値です。

  • それぞれのバーの高さは、そのビンとそれ以前のすべてのビンの相対的な観測数の累積と等しくなります。最後のバーの高さは 1 以下です。

  • カテゴリカル データの場合、それぞれのバーの高さは、そのカテゴリとそれ以前のすべてのカテゴリの相対的な観測数の累積と等しくなります。

例: histogram(X,'Normalization','pdf')X の確率密度関数の推定値をプロットします。

ビンのカウント数。ベクトルとして指定します。ビンのカウント数の計算が個別に実行され、histogram でデータのビン化を行わない場合、この入力を使用してビンのカウント数を histogram に渡します。

counts の長さはビン数と等しくなければなりません。

  • 数値ヒストグラムの場合、ビン数は length(edges)-1 です。

  • カテゴリカル ヒストグラムの場合、ビン数はカテゴリの数と同じです。

Values プロパティとは異なり、BinCounts は正規化されません。Normalization'count' の場合、ValuesBinCounts は等価になります。

例: histogram('BinEdges',-2:2,'BinCounts',[5 8 15 9])

例: histogram('Categories',{'Yes','No','Maybe'},'BinCounts',[22 18 3])

ビンのカウント数の選択モード。'auto' または 'manual' として指定します。既定値は 'auto' で、ビンのカウント数が Data および BinEdges から自動的に計算されます。

BinCounts を指定すると、BinCountsMode は自動的に 'manual' に設定されます。同様に、Data を指定すると、BinCountsMode は自動的に 'auto' に設定されます。

色とスタイル

すべて展開する

ヒストグラムの表示スタイル。'bar' または 'stairs' で指定します。'stairs' を指定すると、内部を塗りつぶさずにヒストグラムの外枠を表示する階段状プロットを表示します。

既定値の 'bar' はヒストグラムの棒グラフを表示します。

例: histogram(X,'DisplayStyle','stairs') はヒストグラムの外枠をプロットします。

バーの向き。'vertical' または 'horizontal' で指定します。

例: histogram(X,'Orientation','horizontal') は水平なバーをもつヒストグラム プロットを作成します。

メモ

このオプションは、カテゴリカル データのヒストグラムにのみ適用されます。

カテゴリカル バーの相対的な幅。範囲 [0,1] のスカラー値として指定します。このプロパティは、ヒストグラム内にあるカテゴリカル バーの間隔を制御するために使用します。既定値の 0.9 は、バーの幅が前のバーから次のバーまでの間隔の 90 % で、その間隔の 5 % ずつがバーの両側にあることを示します。

このプロパティを 1 に設定すると、バー同士が隙間なく表示されます。

例: 0.5

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

ヒストグラムのバーの色。次の値の 1 つとして指定します。

  • 'none' — バーは塗りつぶされません。

  • 'auto' — ヒストグラムのバーの色が自動的に選択されます (既定値)。

  • 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'

    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'

DisplayStyle'stairs' に指定した場合、histogramFaceColor プロパティを使用しません。

例: histogram(X,'FaceColor','g') はバーが緑色のヒストグラム プロットを作成します。

ヒストグラムのエッジの色。次の値の 1 つとして指定します。

  • 'none' — エッジは描画されません。

  • 'auto' — 各エッジの色が自動的に選択されます。

  • 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'

    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'

例: histogram(X,'EdgeColor','r') はバーのエッジが赤いヒストグラム プロットを作成します。

ヒストグラムのバーの透明度。0 以上 1 以下のスカラー値として指定します。histogram は同じ透明度をヒストグラムのすべてのバーで使用します。1 の値は完全な不透明を、0 の値は完全な透明 (非表示) を意味します。

例: histogram(X,'FaceAlpha',1) は完全に不透明なバーをもつヒストグラム プロットを作成します。

ヒストグラムのバーのエッジの透明度。0 以上 1 以下のスカラー値として指定します。1 の値は完全な不透明を、0 の値は完全な透明 (非表示) を意味します。

例: histogram(X,'EdgeAlpha',0.5) はバーのエッジが半透明のヒストグラム プロットを作成します。

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

ライン スタイル説明結果として得られる線
'-'実線

'--'破線

':'点線

'-.'一点鎖線

'none'ラインなしラインなし

バーの外枠の幅。ポイント単位の正の値として指定します。1 ポイントは 1/72 インチです。

例: 1.5

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

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

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

MATLAB では、Histogram オブジェクトの面の色は、その SeriesIndex を変更したとき、または座標軸の ColorOrder プロパティを変更したときに自動的に更新されます。ただし、変更が有効になるには、以下の条件に該当しなければなりません。

  • Histogram オブジェクトの FaceColor プロパティが 'auto' に設定されている。

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

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

凡例

すべて展開する

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

例: 'Text Description'

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

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

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

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

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

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

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

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

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

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

凡例にオブジェクトを含めるか除外するかの制御。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' に設定されている場合でも選択ハンドルを表示しません。

コールバック

すべて展開する

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

  • 関数ハンドル

  • 関数ハンドルと追加の引数を含む 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' に設定しなければなりません。Histogram オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest プロパティが決定します。

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

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

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

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

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

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

メモ

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

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

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

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

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

親/子

すべて展開する

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

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

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

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

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

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

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

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

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

識別子

すべて展開する

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

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

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

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

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

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

すべて展開する

R2020a 以降は非推奨

R2014b で導入