datatip

绘图数据的索引，指定为正整数。

例如，二维对象在笛卡尔坐标区上的绘图数据包含在其 XData 和 YData 属性中。当您指定数据提示的 DataIndex 时，MATLAB^® 通过对 XData 和 YData 进行索引在图上定位数据提示。

使用此属性创建数据提示时，请不要指定 x、y 或 z 参量。

示例: datatip(chart,'DataIndex',3) 在第三个绘图数据点上创建数据提示。

在最近的数据点上显示，指定为下列值之一：

相对于 DataIndex 的偏移量，指定为标量。使用此属性在 Line 对象上的相邻数据点之间创建数据提示，方法是：将 SnapToDataVertex 设置为 'off'，将 InterpolationFactor 设置为 0 到 1 之间的标量。

例如，通过将 InterpolationFactor 指定为 0.5，在一条直线上两个相邻数据点的正中间创建数据提示。

x = 1:4;
y = 2.*x;
p = plot(x,y,'-*');
dt = datatip(p,'DataIndex',2, ...
               'Location','southeast', ...
               'SnapToDataVertex','off', ...
               'InterpolationFactor',0.5);

并非所有类型的对象上的数据提示都支持 InterpolationFactor。

相对于数据点的位置，指定为下列值之一：

示例: dt.Location = 'southwest';

Location 属性值的选择模式，指定为下列值之一：

此 属性 为只读。

数据提示内容，指定为元胞数组。默认情况下，对于二维数据提示，数据提示内容是 2×1 元胞数组，对于三维数据提示，数据提示内容是 3×1 元胞数组。

要向数据提示内容添加更多行，请使用 dataTipTextRow。

字体名称，指定为支持的字体名称或 "FixedWidth"。要正确显示和打印文本，您必须选择系统支持的字体。默认字体取决于您的操作系统和区域设置。

要使用在任何区域设置中都有较好显示效果的等宽字体，请使用 "FixedWidth"。等宽字体依赖于根 FixedWidthFontName 属性。设置根 FixedWidthFontName 属性会导致立即更新显示方式以使用新字体。

FontName 属性的选择模式，指定为下列值之一：

字体大小，指定为大于 0 的标量值（以磅为单位）。一磅等于 1/72 英寸。

字体大小的选择模式，指定为下列值之一：

字符倾斜，指定为 'normal' 或 'italic'。

并非所有字体都有两种字体样式。因此，斜体可能看上去和常规字体一样。

FontAngle 属性的选择模式，指定为下列值之一：

文本解释器，指定为下列值之一：

TeX 标记

默认情况下，MATLAB 支持一部分 TeX 标记。使用 TeX 标记可添加下标和上标，修改字体类型和颜色，并在文本中包括特殊字符。

修饰符会一直作用到文本结尾，但上标和下标除外，因为它们仅修饰下一个字符或花括号中的字符。当您将解释器设置为 'tex' 时，支持的修饰符如下所示。

下表列出了 'tex' 解释器所支持的特殊字符。

LaTeX 标记

要使用 LaTeX 标记，请将解释器设置为 'latex'。对于行内模式，用单美元符号 ($) 将标记括起来。对于显示模式，用双美元符号 ($$) 将标记括起来。

'$\int_1^{20} x^2 dx$'

'$$\int_1^{20} x^2 dx$$'

显示的文本将使用默认的 LaTeX 字体样式。FontName、FontWeight 和 FontAngle 属性不起任何作用。要更改字体样式，请使用 LaTeX 标记。

用于 LaTeX 解释器的文本最多可以包含 1200 个字符。对于多行文本，请在此数量的基础上每行减少约 10 个字符。

有关使用 TeX 和 LaTeX 的示例，请参阅图文本中的希腊字母和特殊字符。有关 LaTeX 系统的详细信息，请访问 LaTeX Project 网站：https://www.latex-project.org/。

Interpreter 属性的选择模式，指定为下列值之一：

沿 x 轴的位置，指定为标量，使用与数据相同的单位。

沿 y 轴的位置，指定为标量，使用与数据相同的单位。

沿 z 轴的位置，指定为标量，使用与数据相同的单位。

半径，指定为标量，使用与数据相同的单位。

此属性仅适用于极坐标图上的数据提示。

角度，指定为标量，以度为单位。

此属性仅适用于极坐标图上的数据提示。

纬度，指定为标量，以度为单位。

此属性仅适用于地理图上的数据提示。

经度，指定为标量，以度为单位。

此属性仅适用于地理图上的数据提示。

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

上下文菜单，指定为提供数据提示选项的 ContextMenu 对象。您不能设置该属性。

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

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

鼠标点击回调，指定为下列值之一：

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

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

对象创建函数，指定为下列值之一：

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

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

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

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

对象删除函数，指定为下列值之一：

有关将回调指定为函数句柄、元胞数组或字符向量的详细信息，请参阅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 都会确定回调中断行为。这些命令包括 drawnow、figure、uifigure、getframe、waitfor 和 pause。

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

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

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

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

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

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

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

此 属性 为只读。

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

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

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

父级，指定为具有 DataTipTemplate 属性的对象。具有数据提示模板的对象示例包括 Line、Histogram、Surface 和 FunctionLine 对象。通过设置此属性将数据提示移至另一个对象。

对象没有任何子级。您不能设置该属性。

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

如果父级的 Children 属性中未列出该对象，则通过搜索对象层次结构或查询句柄属性获取对象句柄的函数无法返回该对象。此类函数的示例包括 get、findobj、gca、gcf、gco、newplot、cla、clf 和 close 函数。

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

此 属性 为只读。

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

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

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

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