Main Content

本页翻译不是最新的。点击此处可查看最新英文版本。

BoxChart 属性

控制箱线图的外观和行为

自 R2020a 起

BoxChart 属性控制 BoxChart 对象的外观和行为。通过更改属性值,您可以修改该对象的某些方面。

您可以使用圆点表示法查询和设置属性。例如,您可以更改箱线图的箱颜色:

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

数据显示

全部展开

各个箱的宽度,指定为正标量值。使用此属性控制箱之间的间隔。默认值为 0.5

  • 默认值 0.5 表示在以下任一情况下,箱之间的距离等于单个箱的宽度:

    • ydata 是矩阵。

    • boxchartxgroupdata 参量中的组间距是 1 个单位。

    • xgroupdata 是分类数据。

    如果您将此属性设置为 1,则相邻的箱可以紧挨在一起。

    请注意,如果在对 boxchart 的调用中同时指定 cgroupdataxgroupdata,则以上描述可能不适用。

  • 如果使用 cgroupdata,则 boxchart 会将 BoxWidth 除以 cgroupdata 指定的颜色数(即颜色数据中的唯一值个数)。

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

示例: b.BoxWidth = 0.75;

离群值标记位移,指定为 'on''off',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

如果您将 JitterOutliers 属性设置为 'on',则 boxchart 会沿 XData 方向随机对离群值标记进行位移,以帮助您区分具有相似 ydata 值的离群值。有关示例,请参阅可视化和查找离群值

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

示例: b.JitterOutliers = 'on';

中位数比较显示,指定为 'on''off',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

如果您将 Notch 属性设置为 'on',则 boxchart 会在每个中位数周围创建锥形着色区域。在 5% 显著性水平上,缺口不重叠的箱线图具有不同中位数。有关详细信息,请参阅箱线图

缺口可以延伸到上下四分位数之外。

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

示例: b.Notch = 'on';

箱线图的方向,指定为 'vertical''horizontal'。默认情况下,箱线图具有垂直方向,因此 ydata 统计量与 y 轴对齐。无论方向如何,boxchart 都将 ydata 值存储在 BoxChart 对象的 YData 属性中。

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

示例: b.Orientation = 'horizontal';

颜色和样式

全部展开

箱颜色,指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。箱包括箱边缘和中位数线。要分别指定箱边缘和中位数线的颜色,可以使用 BoxEdgeColor 属性。要仅指定中位数线的颜色,请使用 BoxMedianLineColor 属性。

对于自定义颜色,请指定 RGB 三元组或十六进制颜色代码。

  • RGB 三元组是包含三个元素的行向量,其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内,例如 [0.4 0.6 0.7]

  • 十六进制颜色代码是字符串标量或字符向量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 "#FF8800""#ff8800""#F80""#f80" 是等效的。

此外,还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称短名称RGB 三元组十六进制颜色代码外观
"red""r"[1 0 0]"#FF0000"

Sample of the color red

"green""g"[0 1 0]"#00FF00"

Sample of the color green

"blue""b"[0 0 1]"#0000FF"

Sample of the color blue

"cyan" "c"[0 1 1]"#00FFFF"

Sample of the color cyan

"magenta""m"[1 0 1]"#FF00FF"

Sample of the color magenta

"yellow""y"[1 1 0]"#FFFF00"

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

"none"不适用不适用不适用无颜色

以下是 MATLAB® 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组十六进制颜色代码外观
[0 0.4470 0.7410]"#0072BD"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]"#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]"#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]"#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]"#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]"#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]"#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

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

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

示例: b.BoxFaceColor = '#EDB120';

控制如何设置 BoxFaceColor 属性,指定为下列值之一:

  • 'auto' - MATLAB 通过使用 BoxChart 对象的 SeiesIndex 属性和坐标区的 ColorOrder 属性来控制 BoxFaceColor 的值。

  • 'manual' - 手动控制 BoxFaceColor 的值,方法是在创建 BoxChart 对象时指定颜色,或在创建后对该对象设置 BoxFaceColor

如果您手动更改 BoxFaceColor 的值,MATLAB 会将 BoxFaceColorMode 属性的值更改为 'manual'

箱边缘颜色,指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。箱边缘包括中位数线。要单独指定中位数线颜色,请使用 BoxMedianLineColor 属性。

对于自定义颜色,请指定 RGB 三元组或十六进制颜色代码。

  • RGB 三元组是包含三个元素的行向量,其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内,例如 [0.4 0.6 0.7]

  • 十六进制颜色代码是字符串标量或字符向量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 "#FF8800""#ff8800""#F80""#f80" 是等效的。

此外,还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称短名称RGB 三元组十六进制颜色代码外观
"red""r"[1 0 0]"#FF0000"

Sample of the color red

"green""g"[0 1 0]"#00FF00"

Sample of the color green

"blue""b"[0 0 1]"#0000FF"

Sample of the color blue

"cyan" "c"[0 1 1]"#00FFFF"

Sample of the color cyan

"magenta""m"[1 0 1]"#FF00FF"

Sample of the color magenta

"yellow""y"[1 1 0]"#FFFF00"

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

"none"不适用不适用不适用无颜色

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组十六进制颜色代码外观
[0 0.4470 0.7410]"#0072BD"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]"#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]"#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]"#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]"#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]"#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]"#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

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

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

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

控制如何设置 BoxEdgeColor 属性,指定为下列值之一:

  • 'auto' - MATLAB 通过将 BoxEdgeColor 的值设置为等于 BoxChart 对象的 BoxFaceColor 属性来控制该值。

  • 'manual' - 手动控制 BoxEdgeColor 的值,方法是在创建 BoxChart 对象时指定颜色,或在创建后对该对象设置 BoxEdgeColor

如果您手动更改 BoxEdgeColor 的值,MATLAB 会将 BoxEdgeColorMode 属性的值更改为 'manual'

箱中位数线的颜色,指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。

对于自定义颜色,请指定 RGB 三元组或十六进制颜色代码。

  • RGB 三元组是包含三个元素的行向量,其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内,例如 [0.4 0.6 0.7]

  • 十六进制颜色代码是字符串标量或字符向量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 "#FF8800""#ff8800""#F80""#f80" 是等效的。

此外,还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称短名称RGB 三元组十六进制颜色代码外观
"red""r"[1 0 0]"#FF0000"

Sample of the color red

"green""g"[0 1 0]"#00FF00"

Sample of the color green

"blue""b"[0 0 1]"#0000FF"

Sample of the color blue

"cyan" "c"[0 1 1]"#00FFFF"

Sample of the color cyan

"magenta""m"[1 0 1]"#FF00FF"

Sample of the color magenta

"yellow""y"[1 1 0]"#FFFF00"

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

"none"不适用不适用不适用无颜色

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组十六进制颜色代码外观
[0 0.4470 0.7410]"#0072BD"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]"#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]"#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]"#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]"#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]"#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]"#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

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

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

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

控制如何设置 BoxMedianLineColor 属性,指定为下列值之一:

  • 'auto' - MATLAB 通过将 BoxMedianLineColor 的值设置为等于 BoxChart 对象的 BoxEdgeColor 属性来控制该值。

  • 'manual' - 手动控制 BoxMedianLineColor 的值,方法是在创建 BoxChart 对象时指定颜色,或在创建后对该对象设置 BoxMedianLineColor

如果您手动更改 BoxMedianLineColor 的值,MATLAB 会将 BoxMedianLineColorMode 属性的值更改为 'manual'

须线颜色,指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。

对于自定义颜色,请指定 RGB 三元组或十六进制颜色代码。

  • RGB 三元组是包含三个元素的行向量,其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内,例如 [0.4 0.6 0.7]

  • 十六进制颜色代码是字符串标量或字符向量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 "#FF8800""#ff8800""#F80""#f80" 是等效的。

此外,还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称短名称RGB 三元组十六进制颜色代码外观
"red""r"[1 0 0]"#FF0000"

Sample of the color red

"green""g"[0 1 0]"#00FF00"

Sample of the color green

"blue""b"[0 0 1]"#0000FF"

Sample of the color blue

"cyan" "c"[0 1 1]"#00FFFF"

Sample of the color cyan

"magenta""m"[1 0 1]"#FF00FF"

Sample of the color magenta

"yellow""y"[1 1 0]"#FFFF00"

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

"none"不适用不适用不适用无颜色

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组十六进制颜色代码外观
[0 0.4470 0.7410]"#0072BD"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]"#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]"#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]"#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]"#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]"#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]"#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

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

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

示例: b.WhiskerLineColor = '#A2142F';

箱填充透明度,指定为 [0,1] 范围内的标量。值为 1 时不透明,值为 0 时完全透明。介于 01 之间的值表示半透明。

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

示例: b.BoxFaceAlpha = 0.4;

须线样式,指定为下表中列出的选项之一。

线型描述表示的线条
"-"实线

Sample of solid line

"--"虚线

Sample of dashed line

":"点线

Sample of dotted line

"-."点划线

Sample of dash-dotted line, with alternating dashes and dots

"none"无线条无线条

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

示例: b.WhiskerLineStyle = '--';

箱边缘和须线宽度,指定为以磅为单位的正标量。一磅等于 1/72 英寸。LineWidth 值还控制中位数线的宽度。

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

示例: b.LineWidth = 1.5;

序列索引,指定为正整数或 "none"。此属性可用于重新分配几个 BoxChart 对象的箱颜色 (BoxFaceColor)、离群值颜色 (MarkerColor)、箱边缘颜色 (BoxEdgeColor) 和箱中位数线颜色 (BoxMedianLineColor),使它们相互匹配。默认情况下,BoxChart 对象的 SeriesIndex 属性是与该对象的创建顺序对应的编号,从 1 开始。

在您调用绘图函数时,MATLAB 使用该编号计算用于分配颜色的索引。索引引用存储在坐标区的 ColorOrder 属性中的数组的行。当您更改 BoxChart 对象的 SeriesIndex 或在坐标区上更改 ColorOrder 属性时,MATLAB 会自动更新该对象的箱颜色或离群值颜色。

SeriesIndex"none" 对应于不参与索引方案的中性颜色。 (自 R2023b 起)

但是,要使更改生效,必须满足以下条件:

  • BoxChart 对象的 BoxFaceColorModeMarkerColorMode 属性设置为 'auto'

  • BoxChart 对象的 SeriesIndex 属性大于 0

  • 坐标区对象的 NextSeriesIndex 属性大于 0

此外,如果 BoxChart 对象的 BoxEdgeColorMode 属性设置为 'auto',则 MATLAB 会用箱面颜色值更新箱边缘颜色。如果 BoxChart 对象的 BoxMedianLineColorMode 属性也设置为 'auto',则 MATLAB 用箱边缘颜色值更新箱中位数线颜色。

标记

全部展开

离群值样式,指定为下表中列出的选项之一。

标记描述生成的标记
"o"圆圈

Sample of circle marker

"+"加号

Sample of plus sign marker

"*"星号

Sample of asterisk marker

"."

Sample of point marker

"x"叉号

Sample of cross marker

"_"水平线条

Sample of horizontal line marker

"|"垂直线条

Sample of vertical line marker

"square"方形

Sample of square marker

"diamond"菱形

Sample of diamond marker

"^"上三角

Sample of upward-pointing triangle marker

"v"下三角

Sample of downward-pointing triangle marker

">"右三角

Sample of right-pointing triangle marker

"<"左三角

Sample of left-pointing triangle marker

"pentagram"五角形

Sample of pentagram marker

"hexagram"六角形

Sample of hexagram marker

"none"无标记不适用

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

示例: b.MarkerStyle = 'x';

离群值大小,指定为以磅为单位的正标量。一磅等于 1/72 英寸。

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

示例: b.MarkerSize = 8;

离群值颜色,指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。

对于自定义颜色,请指定 RGB 三元组或十六进制颜色代码。

  • RGB 三元组是包含三个元素的行向量,其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内,例如 [0.4 0.6 0.7]

  • 十六进制颜色代码是字符串标量或字符向量,以井号 (#) 开头,后跟三个或六个十六进制数字,范围可以是 0F。这些值不区分大小写。因此,颜色代码 "#FF8800""#ff8800""#F80""#f80" 是等效的。

此外,还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称短名称RGB 三元组十六进制颜色代码外观
"red""r"[1 0 0]"#FF0000"

Sample of the color red

"green""g"[0 1 0]"#00FF00"

Sample of the color green

"blue""b"[0 0 1]"#0000FF"

Sample of the color blue

"cyan" "c"[0 1 1]"#00FFFF"

Sample of the color cyan

"magenta""m"[1 0 1]"#FF00FF"

Sample of the color magenta

"yellow""y"[1 1 0]"#FFFF00"

Sample of the color yellow

"black""k"[0 0 0]"#000000"

Sample of the color black

"white""w"[1 1 1]"#FFFFFF"

Sample of the color white

"none"不适用不适用不适用无颜色

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组十六进制颜色代码外观
[0 0.4470 0.7410]"#0072BD"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

[0.8500 0.3250 0.0980]"#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

[0.9290 0.6940 0.1250]"#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

[0.4940 0.1840 0.5560]"#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

[0.4660 0.6740 0.1880]"#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

[0.3010 0.7450 0.9330]"#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

[0.6350 0.0780 0.1840]"#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

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

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

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

控制如何设置 MarkerColor 属性,指定为下列值之一:

  • 'auto' - MATLAB 通过从坐标区的 ColorOrder 属性中选择一种颜色来控制 MarkerColor 的值。

  • 'manual' - 手动控制 MarkerColor 的值,方法是在创建 BoxChart 对象时指定颜色,或在创建后对该对象设置 MarkerColor

如果您手动更改 MarkerColor 的值,MATLAB 会将 MarkerColorMode 属性的值更改为 'manual'

数据

全部展开

位置数据,指定为数值或分类向量。

  • 如果 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

样本数据,指定为数值向量或矩阵。

数据类型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

图例

全部展开

图例标签,指定为字符向量或字符串标量。只有调用 legend 命令之后,才会显示图例。如果未指定文本,则 legend 使用 'dataN' 形式设置标签。

在图例中包含对象,指定为 Annotation 对象。将 Annotation 对象的基础 IconDisplayStyle 属性设置为以下值之一:

  • "on" - 在图例中包含对象(默认值)。

  • "off" - 不在图例中包含对象。

例如,要从图例中排除名为 objBoxChart 对象,请将 IconDisplayStyle 属性设置为 "off"

obj.Annotation.LegendInformation.IconDisplayStyle = "off";

您也可以使用 legend 函数控制图例中的项目。将第一个输入参量指定为要包含的图形对象的向量。如果未在第一个输入参量中指定现有图形对象,则该图形对象不会显示在图例中。但在创建图例后添加到坐标区的图形对象会显示在图例中。请考虑在创建所有绘图后创建图例以避免出现额外的项。

交互性

全部展开

可见性状态,指定为 "on""off",或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 "on" 等效于 true"off" 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

  • "on" - 显示对象。

  • "off" - 隐藏对象而不删除它。您仍然可以访问不可见对象的属性。

此 属性 为只读。

数据提示内容,指定为 DataTipTemplate 对象。有关属性列表,请参阅 DataTipTemplate 属性

您可以使用 datatip 函数来修改数据提示的各个方面(请参阅提示)。但是,使用 datatip 函数设置属性对 DataTipTemplate 属性不起作用。

注意

findobjfindall 不返回 DataTipTemplate 对象,copyobj 也不复制该对象。

上下文菜单,指定为 ContextMenu 对象。使用此属性在您右键点击对象时显示上下文菜单。使用 uicontextmenu 函数创建上下文菜单。

注意

如果 PickableParts 属性设置为 'none' 或者 HitTest 属性设置为 'off',该上下文菜单将不显示。

回调

全部展开

鼠标点击回调,指定为下列值之一:

  • 函数句柄

  • 元胞数组,包含一个函数句柄和其他参量

  • 作为有效 MATLAB 命令或函数(在基础工作区中计算)的字符向量(不推荐)

使用此属性在您点击对象时执行代码。如果使用函数句柄指定此属性,则 MATLAB 在执行回调时将向回调函数传递两个参量:

  • 点击的对象 - 从回调函数中访问点击的对象的属性。

  • 事件数据 - 空参量。在函数定义中将其替换为波浪号字符 (~) 以指示不使用此参量。

有关如何使用函数句柄定义回调函数的详细信息,请参阅Create Callbacks for Graphics Objects

注意

如果 PickableParts 属性设置为 'none' 或者 HitTest 属性设置为 'off',则不执行此回调。

对象创建函数,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参量。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息,请参阅Create Callbacks for Graphics Objects

此属性指定要在 MATLAB 创建对象时执行的回调函数。MATLAB 将在执行 CreateFcn 回调之前初始化所有属性值。如果不指定 CreateFcn 属性,则 MATLAB 执行默认的创建函数。

对现有组件设置 CreateFcn 属性没有任何作用。

如果将此属性指定为函数句柄或元胞数组,则可以使用回调函数的第一个参量访问正在创建的对象。否则,使用 gcbo 函数访问该对象。

对象删除函数,指定为下列值之一:

  • 函数句柄。

  • 第一个元素是函数句柄的元胞数组。元胞数组中的后续元素是传递到回调函数的参量。

  • 包含有效 MATLAB 表达式的字符向量(不推荐)。MATLAB 在基础工作区计算此表达式。

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息,请参阅Create Callbacks for Graphics Objects

此属性指定在 MATLAB 删除对象时要执行的回调函数。MATLAB 在销毁对象的属性之前执行 DeleteFcn 回调。如果不指定 DeleteFcn 属性,则 MATLAB 执行默认的删除函数。

如果将此属性指定为函数句柄或元胞数组,则可以使用回调函数的第一个参量访问要删除的对象。否则,使用 gcbo 函数访问该对象。

回调执行控件

全部展开

回调中断,指定为 'on''off',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

此属性确定是否可以中断运行中回调。有以下两种回调状态要考虑:

  • 运行中回调是当前正在执行的回调。

  • 中断回调是试图中断运行中回调的回调。

每次执行处理回调队列的命令时,MATLAB 都会确定回调中断行为。这些命令包括 drawnowfigureuifiguregetframewaitforpause

如果运行中回调不包含上述命令之一,则不会发生中断。MATLAB 首先完成执行运行中回调,然后执行中断回调。

如果运行中回调确实包含上述命令之一,则由运行中回调所属对象的 Interruptible 属性来确定是否发生中断:

  • 如果 Interruptible 的值为 'off',则不会发生中断。此时,由中断回调所属对象的 BusyAction 属性确定中断回调是被丢弃还是添加到回调队列中。

  • 如果 Interruptible 的值为 'on',则发生中断。下次 MATLAB 处理回调队列时,它会停止运行中回调的执行,并执行中断回调。在中断回调完成后,MATLAB 将继续执行运行中回调。

注意

回调的中断和执行在以下情况下会有不同的表现:

  • 如果中断回调是 DeleteFcnCloseRequestFcnSizeChangedFcn 回调,则无论是否存在 Interruptible 属性值都会发生中断。

  • 如果运行中回调当前正在执行 waitfor 函数,则无论是否存在 Interruptible 属性值都会发生中断。

  • 如果中断回调由 Timer 对象所有,则回调将根据调度执行,而不考虑 Interruptible 属性值。

注意

发生中断时,MATLAB 不保存属性状态或显示内容。例如,gcagcf 命令返回的对象可能会在另一个回调执行时发生改变。

回调排队,指定为 'queue''cancel'BusyAction 属性决定 MATLAB 如何处理中断回调的执行。有以下两种回调状态要考虑:

  • 运行中回调是当前正在执行的回调。

  • 中断回调是试图中断运行中回调的回调。

BusyAction 属性仅在同时满足以下两个条件时才确定回调排队行为:

在这些情况下,由中断回调所属对象的 BusyAction 属性确定 MATLAB 如何处理中断回调。以下是 BusyAction 属性的可能值:

  • 'queue' - 将中断回调放入队列中,以便在运行中回调执行完毕后进行处理。

  • 'cancel' - 不执行中断回调。

捕获鼠标点击的能力,指定为以下值之一:

  • 'visible' - 当对象可见时,捕获鼠标点击。Visible 属性必须设置为 'on',而且您必须点击 BoxChart 对象中具有定义颜色的部分。不能点击包含设置为 'none' 的相关颜色属性的部分。HitTest 属性决定是 BoxChart 对象响应点击还是前代响应点击。

  • 'none' - 无法捕获鼠标点击。点击 BoxChart 对象会将点击操作传递给图窗窗口的当前视图中该对象下面的对象。BoxChart 对象的 HitTest 属性没有任何作用。

对捕获的鼠标点击的响应,指定为 'on''off',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true,'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

  • 'on' - 触发 BoxChart 对象的 ButtonDownFcn 回调。如果您已定义 ContextMenu 属性,则调用上下文菜单。

  • 'off' - 触发满足以下条件之一的 BoxChart 对象的最近前代的回调:

    • HitTest 属性设置为 'on'

    • PickableParts 属性所设置的值允许前代捕获鼠标点击

注意

PickableParts 属性决定 BoxChart 对象是否可以捕获鼠标点击。如果无法捕获,则 HitTest 属性没有任何作用。

此 属性 为只读。

删除状态,以 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值形式返回。

DeleteFcn 回调开始执行时,MATLAB 会将 BeingDeleted 属性设置为 'on'BeingDeleted 属性将一直保持 'on' 设置状态,直到组件对象不再存在为止。

在查询或修改对象之前,请先检查其 BeingDeleted 属性的值,以确认它不是待删除项。

父级/子级

全部展开

父级,指定为 AxesGroupTransform 对象。

子级,以空的 GraphicsPlaceholder 数组或 DataTip 对象数组形式返回。使用此属性来查看在图上绘制的数据提示的列表。

不能使用 Children 属性添加或删除子级。要向此列表中添加子级,请将 DataTip 对象的 Parent 属性设置为图对象。

父级的 Children 属性中对象句柄的可见性,指定为下列值之一:

  • "on" - 对象句柄始终可见。

  • "off" - 对象句柄始终不可见。该选项用于防止另一函数无意中对其进行更改。将 HandleVisibility 设置为 "off" 可在执行该函数时暂时隐藏句柄。

  • "callback" - 对象句柄在回调或回调所调用的函数中可见,但在从命令行调用的函数中不可见。此选项阻止通过命令行访问对象,但允许回调函数访问对象。

如果父级的 Children 属性中未列出该对象,则通过搜索对象层次结构或查询句柄属性获取对象句柄的函数无法返回该对象。此类函数的示例包括 getfindobjgcagcfgconewplotclaclfclose 函数。

隐藏的对象句柄仍有效。将根 ShowHiddenHandles 属性设置为 "on" 以列出所有对象句柄,而不管其 HandleVisibility 属性设置如何。

标识符

全部展开

此 属性 为只读。

图形对象的类型,以 'BoxChart' 形式返回。使用该属性在绘制层次结构中查找指定类型的所有对象,例如,使用 findobj 搜索该类型。

对象标识符,指定为字符向量或字符串标量。您可以指定唯一的 Tag 值作为对象的标识符。如果需要访问您代码中其他位置的对象,可以使用 findobj 函数基于 Tag 值搜索对象。

用户数据,指定为任何 MATLAB 数组。例如,您可以指定标量、向量、矩阵、元胞数组、字符数组、表或结构体。使用此属性存储对象上的任意数据。

如果您在 App 设计工具中工作,请在该 App 中创建公共或私有属性以共享数据,而不是使用 UserData 属性。有关详细信息,请参阅在用 App 设计工具创建的 App 内共享数据

版本历史记录

在 R2020a 中推出

全部展开

另请参阅