mlreportgen.report.MATLABVariable 类

MATLAB 变量名称，指定为字符向量或字符串标量。指定的变量可以是以下任意数据类型：

变量的位置，指定为以下字符串之一或字符向量：

包含变量的 MAT 文件或 Simulink 模 型的名称，指定为字符串标量或字符向量。仅当 Location 属性值为 MAT-File 或 Model 时，此属性才适用。如果 Location 是 MAT-File，则文件名就是从中获取变量的 MAT 文件的名称。如果 Location 是 Model，那么 FileName 就是包含该变量的 Simulink 模 型文件的名称。

变量值的格式，指定为以下字符串或字符向量之一：

此 MATLABVariable 报告器使用的表报告器来格式化变量值，指定为 mlreportgen.report.BaseTable 对象。要自定义表格的外观，请修改默认的 BaseTable 报告器属性或将其替换为自定义的 BaseTable 报告器。如果您向默认或自定义报告器的 Title 属性添加内容，则该内容将出现在生成的报告中的表标题前面。

段落格式化程序对象用于格式化 MATLAB 变量的值，指定为 mlreportgen.dom.Paragraph 对象。要自定义段落的外观，请修改 DOM Paragraph 对象属性或将该对象替换为自定义的 Paragraph 对象。如果您向默认或替换段落对象添加内容，则该内容会出现在生成的报告中的变量内容前面。

文本格式化程序对象，用于格式化表格或段落中的 MATLAB 变量文本值，指定为 mlreportgen.dom.Text 对象。要自定义文本的外观，请修改 DOM Text 对象属性或用自定义的 Text 对象替换该对象。如果向默认或替换文本对象添加内容，则该内容会出现在生成的报告中的变量内容前面。

要显示的最大表列数，指定为正整数。对于使用表报告的数组变量，如果列数大于 MaxCols 属性的值，则对表进行垂直切片。切片将表分成多个表。

对于结构化对象或结构化对象数组的变量，要报告的最大级别数，指定为非负整数。小于或等于 DepthLimit 值的级别将被展平为一系列相互链接的表（请参阅 FormatPolicy 属性）。不会报告超过深度限制的水平。如果将 DepthLimit 属性设置为 0，则结构化对象不会扩展。

要报告的对象层次结构中的最大对象数，指定为正整数。

是否包含标题，指定为 true 或 false。标题包含变量名称和可选的数据类型。如果 IncludeTitle 是 true，则包含标题。默认情况下，标题仅包含变量的名称。要包含变量的数据类型，请将 ShowDataType 属性设置为 true。

要报告的变量的标题，指定为字符向量、字符串标量、mlreportgen.dom.Text 对象、mlreportgen.dom.InternalLink 对象或 mlreportgen.dom.ExternalLink 对象。

如果将 FormatPolicy 属性设置为 "Inline Text" 并且将 Title 属性设置为：

在这两种情况下，要格式化标题，请使用此 MATLABVariable 报告器的 TextFormatter 属性。

如果不指定 Title 属性，则标题就是变量名称。

是否在标题中显示变量的数据类型，指定为 true 或 false。

是否显示具有空值的属性，指定为 true 或 false。ShowEmptyValues 属性仅适用于 MATLAB 对象、Simulink 对象和 Stateflow 对象变量。

是否显示使用默认值的属性，指定为 true 或 false。ShowDefaultValues 属性仅适用于 MATLAB 对象、Simulink 对象和 Stateflow 对象变量。

用于从报告中过滤变量属性的函数或表达式。指定一个函数作为函数句柄。将表达式指定为字符向量或字符串标量。此属性仅适用于包含对象的变量。如果不提供 PropertyFilterFcn，则变量的所有属性都将包含在报告中。

如果提供函数句柄，则关联函数必须：

例如，此代码阻止显示 polyshape 对象的 NumRegions 和 NumHoles 属性。

import mlreportgen.report.*

rpt = mlreportgen.report.Report('variablerpt','pdf');
open(rpt);

pgon = polyshape([0 0 2 2],[2 0 0 2]);
mlVar = mlreportgen.report.MATLABVariable(pgon);
mlVar.PropertyFilterFcn = @varPropertyFilter;
add(rpt,mlVar);

close(rpt);
rptview(rpt);

function tf = varPropertyFilter(~,variableObject,propertyName)
if isa(variableObject, "polyshape")
    tf = (propertyName == "NumRegions") ||  ...
        (propertyName == "NumHoles");
    
end
end

如果您提供字符串标量或字符向量，它必须包含表达式。表达式：

例如，此代码从报告中过滤掉 polyshape 对象的 NumHoles 属性。

import mlreportgen.report.*

rpt = mlreportgen.report.Report('variablerpt','pdf');
open(rpt);


pgon = polyshape([0 0 2 2],[2 0 0 2]);
mlVar = mlreportgen.report.MATLABVariable(pgon);
mlVar.PropertyFilterFcn = "isFiltered = " + ...
            "isa(variableObject, 'polyshape') && " + ...
            "propertyName == 'NumHoles';";
add(rpt,mlVar);

close(rpt);
rptview(rpt);

用于显示非整数数值的格式或精度。

将格式指定为字符串标量或字符向量。请参阅 sprintf 参考页面上的 formatSpec 参量。

将精度指定为正整数。请参阅 num2str 参考页面上的 precision 参量。

示例: "%.2f" 显示小数点右边有两位数字的双精度值。

示例: 2 显示最多两位有效数字。

此报告器的模板来源，指定为以下选项之一：

指定的模板必须与此报告器所追加到的报告属于同一类型。例如，对于 Microsoft^® Word 报 告，TemplateSrc 必须是 Word 报告模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

此报告器的模板名称，指定为字符向量或字符串标量。该报告器的模板必须位于该报告器的模板源 (TemplateSrc) 的模板库中。

此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或指定为 mlreportgen.dom.LinkTarget 对象。字符向量或字符串标量值被转换为 LinkTarget 对象。链接目标在输出报告中紧接着此报告器的内容。