Main Content

Contour 属性

等高线图的外观和行为

Contour 属性控制 Contour 对象的外观和行为。通过更改属性值,您可以修改等高线图的某些方面。使用圆点表示法查询和设置属性。

[C,h] = contour(...);
w = h.LineWidth;
h.LineWidth = 2;

层级

全部展开

等高线层级,指定为 z 值向量。默认情况下,contour 函数选择涵盖 ZData 属性中的值范围的值。

设置此属性会将关联的模式属性设置为手动模式。

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

LevelList 的选择模式,指定为下列值之一:

  • 'auto' - 基于 ZData 值确定这些值。

  • 'manual' - 使用手动指定的值。要指定值,请设置 LevelList 属性。当模式为手动时,contour 函数不随您更改 ZData 而更改这些值。

等高线之间的间隔,指定为数值标量。例如,指定值 2 将以 2 为增量绘制等高线。contour 函数基于 ZData 值确定等高线间隔。

设置此属性会将关联的模式属性设置为手动模式。

示例: 3.4

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

LevelStep 的选择模式,指定为下列值之一:

  • 'auto' - 基于 ZData 值确定该值。

  • 'manual' - 使用手动指定的值。要指定值,请设置 LevelStep 属性。当模式为手动时,contour 函数不随您更改 ZData 而更改该值。

沿 z 轴的等高线位置,指定为下列值之一:

  • 'zmin' - 将等高线定位在图框中的最大 z 层级。这是 surfcmeshc 图的默认位置。

  • 'zmax' - 将等高线定位在图框中的最大 z 层级。

  • 标量数值 - 将等高线定位在指定的 z 层级。默认情况下,使用 contourcontourf 创建的图使用值 0

注意

在用 contour3 函数创建的三维等高线图上设置此属性不起作用。

颜色和样式

全部展开

自 R2022b 起

在等高线之间填充颜色,指定为 "flat"、RGB 三元组、十六进制颜色代码、颜色名称或短名称。将值设置为 "flat" 会使用当前颜色图中的颜色。颜色图中的颜色映射由等高线值、颜色图以及颜色图与数据值间的缩放映射情况确定。有关缩放数据以映射到颜色图的详细信息,请参阅控制颜色图范围

要在所有线条之间使用相同的颜色,请指定 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

自 R2022b 起

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

自 R2022b 起

等高线的颜色,指定为 "flat"、RGB 三元组、十六进制颜色代码、颜色名称或短名称。要为每个等高线使用不同的颜色,请指定 "flat"。颜色图中的颜色映射由等高线值、颜色图以及颜色图与数据值间的缩放映射情况确定。有关缩放数据以映射到颜色图的详细信息,请参阅控制颜色图范围

要对所有等高线使用相同的颜色,请指定 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

自 R2022b 起

等高线透明度,指定为 [0,1] 范围中的标量。值为 1 时不透明,值为 0 时完全透明。介于 01 之间的值表示半透明。

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

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

Sample of solid line

"--"虚线

Sample of dashed line

":"点线

Sample of dotted line

"-."点划线

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

"none"无线条无线条

等高线宽度,指定为以磅为单位的正值。一磅等于 1/72 英寸。

标签

全部展开

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

  • 'on' - 沿等高线显示高度值。

  • 'off' - 不为等高线添加标签。

自 R2023b 起

等高线标签的颜色,指定为 "flat""none"、RGB 三元组、十六进制颜色代码、颜色名称或短名称。要对每个层级的标签使用不同颜色,请指定 "flat"。颜色图中的颜色映射由等高线值、颜色图以及颜色图与数据值间的缩放映射情况确定。有关缩放数据以映射到颜色图的详细信息,请参阅控制颜色图范围

要隐藏标签,请将 LabelColor 属性设置为 "none"。设置此值还会将 ShowText 属性设置为 "off"。但是,设置 ShowText 属性对 LabelColor 属性不起作用。请注意,在将 LabelColor 属性设置为 "none" 后,将 ShowText 属性设置为 "on" 会导致等高线出现间隙。为了获得最佳效果,当 LabelColor"none" 时,请将 ShowText 设置为 "off"

要对所有等高线使用相同的颜色,请指定 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

沿等高线的标签间距,指定为以磅为单位的标量值,其中一磅等于 1/72 英寸。使用此属性可控制沿等高线的等高线标签的数量。值越小,标签越多。

必须将 ShowText 属性设置为 'on' 才能使 LabelSpacing 属性生效。

如果使用 clabel 函数显示标签,则 LabelSpacing 属性不起作用,并且绘图对每行显示一个标签。

自 R2022b 起

标签格式,指定为 compose 函数接受的格式化操作符之一或函数句柄。您可以选择将格式化操作符与文本结合使用。如果指定函数句柄,则函数必须接受一个包含等高线层级向量的参量,并且必须返回一个包含字符串向量或字符向量元胞数组的参量,其大小与输入向量相同。

示例:指定格式化操作符

创建一个显示标签的等高线图,标签表示为小数点后带一位数字并后跟字母 m

contour(peaks,[-4 0 2],"ShowText",true,"LabelFormat","%0.1f m")

Contour plot with labels that include one digit after the decimal point followed by the letter m

示例:指定函数句柄

创建一个名为 myfun.m 的程序文件并定义以下函数。该函数将输入从米转换为英尺,并返回一个字符串向量,其中包含以米为单位的每个值,并用括号括起相应的以英尺为单位的值。

function labels = myfun(vals)
feetPerMeter = 3.28084;
feet = round(vals.*feetPerMeter);
labels = vals + " m (" + feet + " ft)";
labels(vals == 0) = "0 m";
end

接下来,创建一个等高线图,并将 LabelFormat 属性指定为 myfun 的句柄。

contour(peaks,[-4 0 2],"ShowText",true,"LabelFormat",@myfun)

Contour plot with labels that include values in meters and feet

带有标签的等高线之间的间隔,指定为数值标量。默认情况下,当 ShowText 属性设置为 'on' 时,等高线图中每个等高线包括一个标签。

设置此属性会将关联的模式属性设置为手动模式。

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

TextStep 的选择模式,指定为下列值之一:

  • 'auto' - 基于 ZData 值确定该值。如果 ShowText 属性设置为 'on',则 contour 函数标注每个等高线。

  • 'manual' - 使用手动指定的值。要指定值,请设置 TextStep 属性。

要标注的等高线,指定为实数值向量。

设置此属性会将关联的模式属性设置为手动模式。

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

TextList 的选择模式,指定为下列值之一:

  • 'auto' - 使用等于 LevelList 属性值的值。等高线图的每个线条包括一个文本标签。

  • 'manual' - 使用手动指定的值。通过设置 TextList 属性指定这些值。

数据

全部展开

等高线矩阵,以下面形式的两行矩阵形式返回。

Z1, x1,1, x1,2, ..., x1,N1, Z2, x2,1, x2,2, ..., x2,N2, Z3, ...
N1, y1,1, y1,2, ..., y1,N1, N2, y2,1, y2,2, ..., y2,N2, N3, ...

矩阵的列定义等高线。每条等高线以一个包含 Z 和 N 值的列开始:

  • Zi - 第 i 条等高线的高度

  • Ni - 第 i 条等高线中的顶点数

  • (xij, yij) - 第 i 条等高线的顶点坐标,其中 j 的范围是从 1 到 Ni

x 值,指定为向量或矩阵。

  • 如果 XData 是向量,则 length(XData) 必须等于 size(ZData,2)YData 必须为向量。XData 值必须是严格递增或严格递减的,并且不能包含任何重复项。

  • 如果 XData 是矩阵,则 size(XData)size(YData) 必须等于 size(ZData)。通常,应设置 XData 值以使列严格递增或严格递减并且行是均匀的(或者使行严格递增或严格递减并且列是均匀的)。

设置此属性会将关联的模式属性设置为手动模式。

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

XData 的选择模式,指定为下列值之一:

  • 'auto' - 使用 ZData 的列索引设置 XData

  • 'manual' - 使用手动指定的值。要指定这些值,请直接设置 XData 属性或指定 contourcontourfcontour3 函数的输入参量 X

链接到 XData 的变量,指定为包含 MATLAB 工作区变量名称的字符向量或字符串。MATLAB 通过计算基础工作区中的变量来生成 XData

默认情况下,没有链接的变量,因此该值为空字符向量 ''。如果您链接变量,MATLAB 不会立即更新 XData 值。若要强制更新数据值,需要使用 refreshdata 函数。

注意

如果您将一个数据源属性更改为包含不同维度数据的变量,则可能会导致函数生成警告,且在将所有数据源属性更改为适当值之前将无法显示图形。

示例: 'x'

y 值,指定为向量或矩阵。

  • 如果 YData 是向量,则 length(YData) 必须等于 size(ZData,1)XData 必须为向量。XData 值必须是严格递增或严格递减的,并且不能包含任何重复项。

  • 如果 YData 是矩阵,则 size(XData)size(YData) 必须等于 size(ZData)。通常,应设置 YData 值以使列严格递增或严格递减并且行是均匀的(或者使行严格递增或严格递减并且列是均匀的)。

设置此属性会将关联的模式属性设置为手动模式。

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

YData 的选择模式,指定为下列值之一:

  • 'auto' - 使用 ZData 的行索引设置 YData

  • 'manual' - 使用手动指定的值。要指定这些值,请直接设置 YData 属性或指定 contourcontourfcontour3 函数的输入参量 Y

链接到 YData 的变量,指定为包含 MATLAB 工作区变量名称的字符向量或字符串。MATLAB 通过计算基础工作区中的变量来生成 YData

默认情况下,没有链接的变量,因此该值为空字符向量 ''。如果您链接变量,MATLAB 不会立即更新 YData 值。若要强制更新数据值,需要使用 refreshdata 函数。

注意

如果您将一个数据源属性更改为包含不同维度数据的变量,则可能会导致函数生成警告,且在将所有数据源属性更改为适当值之前将无法显示图形。

示例: 'y'

定义等高线曲面的数据,指定为矩阵。ZData 必须至少为 2×2 矩阵。

设置此属性会将关联的模式属性设置为手动模式。

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

链接到 ZData 的变量,指定为包含 MATLAB 工作区变量名称的字符向量或字符串。MATLAB 通过计算基础工作区中的变量来生成 ZData

默认情况下,没有链接的变量,因此该值为空字符向量 ''。如果您链接变量,MATLAB 不会立即更新 ZData 值。若要强制更新数据值,需要使用 refreshdata 函数。

注意

如果您将一个数据源属性更改为包含不同维度数据的变量,则可能会导致函数生成警告,且在将所有数据源属性更改为适当值之前将无法显示图形。

示例: 'z'

图例

全部展开

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

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

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

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

例如,要从图例中排除名为 objContour 对象,请将 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 对象的属性来控制数据提示中显示的内容。有关属性列表,请参阅 DataTipTemplate 属性

有关修改数据提示的示例,请参阅创建自定义数据提示

注意

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

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

注意

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

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

  • 'on' - 已选择。如果您在绘图编辑模式下点击对象,则 MATLAB 会将其 Selected 属性设置为 'on'。如果 SelectionHighlight 属性也设置为 'on',则 MATLAB 将在对象周围显示选择句柄。

  • 'off' - 未选择。

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

  • 'on' - 在 Selected 属性设置为 'on' 时显示选择句柄。

  • 'off' - 永远不显示选择句柄,即使 Selected 属性设置为 'on' 也是如此。

按照坐标区范围裁剪对象,指定为 'on''off',或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true,'off' 等效于 false。因此,您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

  • 值为 'on' 会裁剪对象超出坐标区范围的部分。

  • 值为 'off' 会显示整个对象,即使对象的某些部分超出坐标区范围。如果您创建一个图、设置 hold on、冻结坐标区缩放,然后创建比原始图更大的对象,则该对象的某些部分可能会显示在坐标区范围之外。

必须将包含该对象的坐标区的 Clipping 属性设置为 'on'。否则,此属性不起作用。有关裁剪行为的详细信息,请参阅坐标区的 Clipping 属性。

回调

全部展开

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

  • 函数句柄

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

  • 作为有效 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'HitTest 属性决定是 Contour 对象响应点击还是前代响应点击。

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

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

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

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

    • HitTest 属性设置为 'on'

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

注意

PickableParts 属性决定 Contour 对象是否可以捕获鼠标点击。如果无法捕获,则 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 属性设置如何。

标识符

全部展开

此 属性 为只读。

图形对象的类型,以 'contour' 形式返回。

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

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

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

版本历史记录

在 R2006a 之前推出

全部展开