このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

BoxChart のプロパティ

ボックス チャートの外観と動作の制御

R2020a 以降

BoxChart プロパティは、BoxChart オブジェクトの外観と動作を制御します。プロパティの値を変更することによって、オブジェクトの一部の特性を変更できます。

プロパティのクエリと設定にドット表記を使用できます。たとえば、ボックス チャートのボックスの色を変更できます。

b = boxchart(rand(10,1));
b.BoxFaceColor = [0 0.5 0.5];

データの表示

BoxWidth — 個々のボックスの幅

0.5 (既定値) | 正のスカラー値

個々のボックスの幅。正のスカラー値として指定します。このプロパティは、ボックスの間隔を制御するのに使用します。既定値は 0.5 です。

• 既定値の 0.5 は、次の場合にボックスの間隔が 1 つのボックスの幅と同じであることを意味します。

  • ydata が行列である。

  • boxchart の xgroupdata 引数でグループの間隔が 1 単位になっている。

  • xgroupdata が categorical である。

  このプロパティを 1 に設定すると、ボックスが隙間なく表示されます。

  boxchart の呼び出しで cgroupdata と xgroupdata の両方を指定すると、この説明が当てはまらない場合があることに注意してください。

• cgroupdata を使用すると、boxchart は cgroupdata で指定された色 (つまりカラー データの一意の値) の数で BoxWidth を除算します。

例: b = boxchart(rand(10,3),'BoxWidth',0.75)

例: b.BoxWidth = 0.75;

JitterOutliers — 外れ値マーカー変位

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

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

JitterOutliers プロパティを 'on' に設定すると、boxchart は外れ値のマーカーを XData 方向にランダムに変位するため、類似する ydata 値をもつ外れ値が区別しやすくなります。例については、外れ値の可視化と検出を参照してください。

例: b = boxchart([rand(20,1);2;2;2],'JitterOutliers','on')

例: b.JitterOutliers = 'on';

Notch — 中央値比較表示

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

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

Notch プロパティを 'on' に設定すると、boxchart により、各中央値の周りに先細の影付き領域が作成されます。ノッチがオーバーラップしないボックス チャートには、5% の有意水準で異なる中央値があります。詳細については、ボックス チャート (箱ひげ図)を参照してください。

ノッチは下位四分位数と上位四分位数を超えて拡張できます。

例: b = boxchart(rand(10,2),'Notch','on')

例: b.Notch = 'on';

Orientation — ボックス チャートの方向

'vertical' (既定値) | 'horizontal'

ボックス チャートの方向。'vertical' または 'horizontal' として指定します。通常の設定では、ボックス チャートの方向は垂直であるため、ydata 統計は y 軸に揃えられます。方向に関係なく、boxchart は ydata 値を BoxChart オブジェクトの YData プロパティに格納します。

例: b = boxchart(rand(10,1),'Orientation','horizontal')

例: b.Orientation = 'horizontal';

色とスタイル

BoxFaceColor — ボックスの色

RGB 3 成分 | 16 進数カラー コード | 色名 | 省略名

ボックスの色。RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。ボックスには、ボックスのエッジと中央値の線が含まれます。ボックスのエッジと中央値の線の色を個別に指定するには、BoxEdgeColor プロパティを使用できます。中央値の線の色のみを指定するには、BoxMedianLineColor プロパティを使用します。

カスタム色を使用する場合は、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"

例: b = boxchart(rand(10,1),'BoxFaceColor','red')

例: b.BoxFaceColor = [0 0.5 0.5];

例: b.BoxFaceColor = '#EDB120';

BoxFaceColorMode — BoxFaceColor の設定方法

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

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

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

• 'manual' — ユーザーが BoxChart オブジェクトの作成時に色を指定するか、作成後にそのオブジェクトで BoxFaceColor を設定することにより、BoxFaceColor の値を手動で制御します。

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

BoxEdgeColor — ボックス エッジの色

RGB 3 成分 | 16 進数カラー コード | 色名 | 省略名

ボックス エッジの色。RGB 3 成分、16 進数カラー コード、色名、または省略名として指定します。ボックス エッジには中央値の線が含まれます。中央値の線の色を個別に指定するには、BoxMedianLineColor プロパティを使用します。

カスタム色を使用する場合は、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"

例: b = boxchart(rand(10,1),'BoxEdgeColor','none')

例: b.BoxEdgeColor = [0 0 0];

例: b.BoxEdgeColor = '#7E2F8E';

BoxEdgeColorMode — BoxEdgeColor の設定方法

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

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

• 'auto' — MATLAB は、BoxChart オブジェクトの BoxFaceColor プロパティと等しく設定することにより、BoxEdgeColor の値を制御します。

• 'manual' — ユーザーが BoxChart オブジェクトの作成時に色を指定するか、作成後にそのオブジェクトで BoxEdgeColor を設定することにより、BoxEdgeColor の値を手動で制御します。

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

BoxMedianLineColor — ボックスの中央値の線の色

RGB 3 成分 | 16 進数カラー コード | 色名 | 省略名

ボックスの中央値の線の色。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"
"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"

例: b = boxchart(rand(10,1),'BoxMedianLineColor','black')

例: b.BoxMedianLineColor = [1 0 0];

例: b.BoxMedianLineColor = '#7E2F8E';

BoxMedianLineColorMode — BoxMedianLineColor の設定方法

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

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

• 'auto' — MATLAB は、BoxChart オブジェクトの BoxEdgeColor プロパティと等しく設定することにより、BoxMedianLineColor の値を制御します。

• 'manual' — ユーザーが BoxChart オブジェクトの作成時に色を指定するか、作成後にそのオブジェクトで BoxMedianLineColor を設定することにより、BoxMedianLineColor の値を手動で制御します。

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

WhiskerLineColor — ひげの色

RGB 3 成分 | 16 進数カラー コード | 色名 | 省略名

ひげの色。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"
"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"

例: b = boxchart(rand(10,1),'WhiskerLineColor','r')

例: b.WhiskerLineColor = [0.25 0.5 0.5];

例: b.WhiskerLineColor = '#A2142F';

BoxFaceAlpha — ボックスの塗りつぶしの透明度

0.2 (既定値) | 範囲 [0,1] のスカラー

ボックスの塗りつぶしの透明度。[0,1] の範囲のスカラーとして指定します。値 1 は不透明で、値 0 は完全に透明です。0 と 1 の間の値は半透明です。

例: b = boxchart(rand(10,1),'BoxFaceAlpha',0.4)

例: b.BoxFaceAlpha = 0.4;

WhiskerLineStyle — ひげのスタイル

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

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

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

例: b = boxchart(rand(10,1),'WhiskerLineStyle','--')

例: b.WhiskerLineStyle = '--';

LineWidth — ボックス エッジおよびひげの幅

1 (既定値) | 正のスカラー

ボックス エッジおよびひげの幅。ポイント単位の正のスカラーとして指定します。1 ポイントは 1/72 インチです。LineWidth 値は中央値の線幅も制御します。

例: b = boxchart(rand(10,1),'LineWidth',1.5)

例: b.LineWidth = 1.5;

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

正の整数 | "none"

シリーズ インデックス。正の整数または "none" として指定します。このプロパティは、複数の BoxChart オブジェクトが相互に一致するように、それらのボックスの色 (BoxFaceColor)、外れ値の色 (MarkerColor)、ボックス エッジの色 (BoxEdgeColor)、およびボックスの中央値の線の色 (BoxMedianLineColor) を再代入する場合に役立ちます。通常の設定では、BoxChart オブジェクトの SeriesIndex プロパティは、1 から始まるオブジェクトの作成順序に対応する数値です。

MATLAB はこの数値を使用して、プロット関数を呼び出すときに色を割り当てるインデックスを計算します。このインデックスは、座標軸の ColorOrder プロパティに格納されている配列の行を表します。該当する SeriesIndex を変更した場合、または座標軸の ColorOrder プロパティを変更した場合、MATLAB は BoxChart オブジェクトのボックスの色または外れ値の色を自動的に更新します。

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

ただし、変更が有効になるには、以下の条件に該当しなければなりません。

• BoxChart オブジェクトの BoxFaceColorMode または MarkerColorMode プロパティが 'auto' に設定されている。

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

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

さらに、BoxChart オブジェクトの BoxEdgeColorMode プロパティが 'auto' に設定されている場合、MATLAB はボックス面の色を使用してボックス エッジの色を更新します。BoxChart オブジェクトの BoxMedianLineColorMode プロパティも 'auto' に設定されている場合は、MATLAB はボックス エッジの色の値を使用してボックスの中央値の線の色を更新します。

マーカー

MarkerStyle — 外れ値スタイル

'o' (既定値) | '+' | '*' | '.' | 'x' | ...

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

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

例: b = boxchart([rand(10,1);2],'MarkerStyle','x')

例: b.MarkerStyle = 'x';

MarkerSize — 外れ値のサイズ

6 (既定値) | 正のスカラー

外れ値のサイズ。ポイント単位の正のスカラーとして指定します。1 ポイントは 1/72 インチです。

例: b = boxchart([rand(10,1);2],'MarkerSize',8)

例: b.MarkerSize = 8;

MarkerColor — 外れ値の色

RGB 3 成分 | 16 進数カラー コード | 色名 | 省略名

外れ値の色。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"
"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"

例: b = boxchart([rand(10,1);2],'MarkerColor','magenta')

例: b.MarkerColor = [0.5 0.5 1];

例: b.MarkerColor = '#7E2F8E';

MarkerColorMode — MarkerColor の設定方法

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

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

• 'auto' — 座標軸の ColorOrder プロパティから色を選択することにより、MATLAB が MarkerColor の値を制御します。

• 'manual' — ユーザーが BoxChart オブジェクトの作成時に色を指定するか、作成後にそのオブジェクトで MarkerColor を設定することにより、MarkerColor の値を手動で制御します。

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

データ

XData — 位置データ

数値ベクトル | categorical ベクトル

位置データ。数値ベクトルまたは categorical ベクトルとして指定します。

• YData がベクトルの場合、XData は YData と同じ長さのベクトルです。XData(i) 値は YData(i) 値を使用して作成されたボックス チャートの位置を示します。

• YData が行列の場合、XData は長さが YData の列の数と等しいベクトルです。XData(i) 値は列 YData(:,i) を使用して作成されたボックス チャートの位置を示します。

通常の設定では、XData が x 軸上のボックス チャートの位置を制御します。ただし、Orientation プロパティ値が 'horizontal' の場合、XData 値は y 軸上の位置に対応します。

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

YData — サンプル データ

数値ベクトル | 数値行列

サンプル データ。数値ベクトルまたは行列として指定します。

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

凡例

DisplayName — 凡例ラベル

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

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

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

Annotation オブジェクト

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

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

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

たとえば、obj という BoxChart オブジェクトを凡例から除外するには、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 のプロパティ を参照してください。

関数 datatip を使用してデータ ヒントの特性を変更できます (ヒントを参照)。ただし、関数 datatip でプロパティを設定しても DataTipTemplate プロパティには影響しません。

メモ

DataTipTemplate オブジェクトは findobj または findall によって返されず、copyobj によってコピーされません。

ContextMenu — コンテキスト メニュー

空の GraphicsPlaceholder 配列 (既定値) | ContextMenu オブジェクト

コンテキスト メニュー。ContextMenu オブジェクトとして指定します。このプロパティは、オブジェクトを右クリックしたときにコンテキスト メニューを表示するために使用します。関数 uicontextmenu を使用して、コンテキスト メニューを作成します。

メモ

PickableParts プロパティが 'none' に設定されている場合または HitTest プロパティが 'off' に設定されている場合には、このコンテキスト メニューは表示されません。

コールバック

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' に設定されていなければならず、BoxChart オブジェクトの色が定義されている部分をクリックしなければなりません。関連付けられている色のプロパティが 'none' に設定されている部分をクリックすることはできません。BoxChart オブジェクトがクリックに応答するか、先祖がクリックに応答するかは、HitTest プロパティが決定します。

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

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

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

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

メモ

PickableParts プロパティは、BoxChart オブジェクトがマウス クリックをキャプチャできるかどうかを決定します。キャプチャできない場合、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 — グラフィックス オブジェクトのタイプ

'BoxChart'

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

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

Tag — オブジェクト識別子

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

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

UserData — ユーザー データ

[] (既定値) | 配列

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

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

バージョン履歴

R2020a で導入

R2023b: SeriesIndex="none" を使用した色の自動選択のオプトアウト

SeriesIndex プロパティを "none" に設定して、BoxChart オブジェクトの色の自動選択をオプトアウトします。"none" を指定すると、BoxChart オブジェクトは中間色をもちます。

色の自動選択を再度有効にするには、SeriesIndex プロパティを正の整数に設定します。

R2023a: コールバック関数とコンテキスト メニューの作成

次のプロパティを指定して、ボックス チャートに対して独自のコールバック関数またはコンテキスト メニューを定義します。

• ContextMenu — ボックス チャートを右クリックすると表示されるコンテキスト メニューを作成します。

• ButtonDownFcn — ボックス チャートをクリックすると実行されるコールバック関数を定義します。

• CreateFcn — ボックス チャートの作成時に実行されるコールバック関数を定義します。

• DeleteFcn と BeingDeleted — ボックス チャートの削除時に実行されるコールバック関数を定義し、ボックス チャートが削除中かどうかをクエリします。

• Interruptible と BusyAction — コールバック キューイングを管理します。

参考

boxchart