本页采用了机器翻译。点击此处可查看最新英文版本。

slreportgen.report.ScheduleDiagram 类

命名空间: slreportgen.report
超类: slreportgen.report.Reporter

创建调度图报告器

自 R2024b 起

全页展开

描述

为 Simulink® 进度图创建进度图报告器。调度报告器创建时间表图的快照，并将快照作为带有可选标题和可选图例快照的图像添加到报告中。使用 Source 属性指定所需的范围，使用 IncludeLegendSnapshot 属性指定是否包含图例快照。

注意

要在报告中使用 ScheduleDiagram 报告器，您必须使用 slreportgen.report.Report 类创建报告。

slreportgen.report.ScheduleDiagram 类是 handle 类。

创建对象

描述

diagram = ScheduleDiagram 根据默认报告模板创建一个空的时间表图报告器。使用 Source 属性来指定要报告的时间表。将具有空 Source 属性的 ScheduleDiagram 对象添加到报告会产生错误。

diagram = ScheduleDiagram(source) 将 Source 属性设置为 source。将此报告器添加到 slreportgen.report.Report 对象，无需任何进一步修改，即可根据 slreportgen.report.Report 对象的默认设置生成指定时间表图的快照。快照在生成的报告中显示为带有标题的图像。请参阅 slreportgen.report.Report。

示例

diagram = ScheduleDiagram(Name=Value) 使用名称-值参量设置属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

时间表图，指定为以下值之一：

快照报告器，指定为 mlreportgen.report.FormalImage 对象。使用 FormalImage 对象的属性指定快照图像的标题或进一步自定义图像的大小。

注意

报告器初始化 Snapshot 属性。请勿重置此属性。

属性：

GetAccess
公共
SetAccess
公共

快照图像格式，指定为 "png" （默认）、"jpg"、"pdf" 或 "tif"。下表列出了哪些报告类型支持哪些图像格式。

图像格式文件扩展名支持 HTML支持 Word支持 PDF
JPEG 图像.jpg是是是
PDF.pdf否否是
可移植网络图形 .png是是是
TIFF 图像.tif否是是

数据类型: char | string

快照图像的缩放选项，指定为 "auto"、"custom" 或 "none"。此属性控制图像文件中快照图像的大小。支持的缩放选项包括：

  • "auto" - 对于 PDF 或 Word (DOCX) 输出，使用此选项可缩放快照图像以适合当前页面布局，同时保持其纵横比。首先，报告器将快照图像缩放至页面宽度。如果图像高度超出了页面高度，报告器会再次缩小图像。这种额外的缩放可确保图像适合当前页面，并有额外一英寸的间距。缩放不适用于 HTML 输出。

  • "custom" - 使用此选项可根据 Height 和 Width 属性的值缩放快照图像。

  • "none" - 不执行缩放

注意

"auto" 和 "custom" 选项使用 MATLAB®print 命令来调整图形大小。如果图形太大，无法放入指定的空间，print 命令会裁剪快照图像。为了避免裁剪，请将 Scaling 属性设置为“none”，并使用 Snapshot 属性指定的报告器来调整图像大小。由于报告器将文本与图像的其他部分一起缩小，因此，除非放大图像，否则细节可能无法辨认。请参阅调整图片快照大小。

注意

当出现以下任一属性设置组合时，就会出现 java.lang.OutOfMemoryError：

  • Scaling 设置为 "zoom"，并且 Zoom、MaxHeight 和 MaxWidth 属性设置为较大值

  • Scaling 设置为 "custom"，并且 Height 和 Width 属性设置为较大值

为了避免此错误，对于缩放 Scaling，请使用较小的 Zoom、MaxHeight 和 MaxWidth 属性值。对于 Scaling 设置为 "custom" ，请使用较小的 Height 和 Width 属性值。

数据类型: char | string

快照图像的缩放选项，指定为 "auto"、"custom" 或 "none"。Scaling 控制图像文件中快照图像的大小。支持的缩放选项包括：

  • "auto" - 对于 PDF 或 Word (DOCX) 输出，使用此选项可缩放快照图像以适合当前页面布局，同时保持其纵横比。首先，报告器将快照图像缩放至页面宽度。如果图像高度超出了页面高度，报告器会再次缩小图像。这种额外的缩放可确保图像适合当前页面，并有额外一英寸的间距。缩放不适用于 HTML 输出。

  • "custom" - 使用此选项可根据 Height 和 Width 属性的值缩放快照图像。

注意

"auto" 和 "custom" 选项使用 MATLABprint 命令来调整图形大小。如果图形太大，无法放入指定的空间，print 命令会裁剪快照图像。为了避免裁剪，请将 Scaling 属性设置为“none”，并使用 Snapshot 属性指定的报告器来调整图像大小。由于报告器将文本与图像的其他部分一起缩小，因此，除非放大图像，否则细节可能无法辨认。请参阅调整图片快照大小。

注意

当 Scaling 设置为 java.lang.OutOfMemoryError 并且 Height 和 Width 属性设置为较大值时，可能会发生 "custom"。为了避免或解决此错误，请使用较小的 Height 和 Width 属性值。

数据类型: char | string

快照图像的高度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"2in" 表示两英寸。默认快照为 6 英寸。有效的缩写为：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 像素

  • "pt" - 点

注意

对于 PDF 图像，宽度和高度的尺寸限制为 10000px。对于所有其他图像类型，尺寸限制是屏幕尺寸。

示例: "2in"

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

快照图像的宽度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"2in" 表示两英寸。默认快照宽度为 6.5 英寸。有效的缩写为：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 像素

  • "pt" - 点

注意

对于 PDF 图像，宽度和高度的尺寸限制为 10000px。对于所有其他图像类型，尺寸限制是屏幕尺寸。

示例: "2in"

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

是否包含时间表编辑器图的图例快照，指定为 true 或 false。如果为 true，则报告将包含计划编辑器图的图例快照。

数据类型: logical

图例快照报告器，指定为 mlreportgen.report.FormalImage 对象。使用 FormalImage 对象的属性指定快照图像的标题或进一步自定义图像的大小。

注意

报告器初始化 LegendSnapshot 属性。请勿重置此属性。

图例快照图像的缩放选项，指定为 "auto" 或 "custom"。Scaling 控制图像文件中图例快照图像的大小。支持的缩放选项包括：

  • "auto" - 对于 PDF 或 Word (DOCX) 输出，使用此选项可缩放快照图像以适合当前页面布局，同时保持其纵横比。首先，报告器将快照图像缩放至页面宽度。如果图像高度超出了页面高度，报告器会再次缩小图像。这种额外的缩放可确保图像适合当前页面，并有额外一英寸的间距。缩放不适用于 HTML 输出。

  • "custom" - 使用此选项可根据 LegendHeight 和 LegendWidth 属性的值缩放快照图像。

注意

"auto" 和 "custom" 选项使用 MATLABprint 命令来调整图形大小。如果图形太大，无法放入指定的空间，print 命令会裁剪快照图像。为了避免裁剪，请将 Scaling 属性设置为“none”，并使用 Snapshot 属性指定的报告器来调整图像大小。由于报告器将文本与图像的其他部分一起缩小，因此，除非放大图像，否则细节可能无法辨认。请参阅调整图片快照大小。

注意

当 Scaling 设置为 java.lang.OutOfMemoryError 并且 Height 和 Width 属性设置为较大值时，可能会发生 "custom"。为了避免或解决此错误，请使用较小的 Height 和 Width 属性值。

数据类型: char | string

图例快照图像的高度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"2in" 表示两英寸。默认的图例快照为 3.2 英寸。有效的缩写为：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 像素

  • "pt" - 点

注意

对于 PDF 图像，宽度和高度的尺寸限制为 10000px。对于所有其他图像类型，尺寸限制是屏幕尺寸。

示例: "2in"

数据类型: char | string

图例快照图像的宽度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"2in" 表示两英寸。默认的图例快照宽度为 4.5 英寸。有效的缩写为：

  • "px" - 像素

  • "cm" - 厘米

  • "in" - 英寸

  • "mm" - 毫米

  • "pc" - 像素

  • "pt" - 点

注意

对于 PDF 图像，宽度和高度的尺寸限制为 10000px。对于所有其他图像类型，尺寸限制是屏幕尺寸。

示例: "2in"

数据类型: char | string

此报告器的模板来源，以下列方式之一指定：

  • 字符向量或字符串标量，指定包含此报告器模板的文件的路径

  • 此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告

  • 文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

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

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

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

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

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

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

打开实时脚本

记录使用多个引用模型的 Simulink 模型，并包含使用计划编辑器编辑的详细任务计划。为所有计划编辑器快照添加一个图例。

导入命名空间，以便在调用对象构造函数和方法时不必包含完全限定名称。

import slreportgen.report.*
import mlreportgen.report.*
import slreportgen.finder.*

打开 Simulink 模型。

model = "ex_engine_speed_control_system";
open_system(model);
sim(model);

创建 HTML 报告和第一章。

rpt = slreportgen.report.Report("Schedule Diagram", "html-file");
open(rpt); 
ch = mlreportgen.report.Chapter("Scheduling");

在章节开头为计划编辑器快照添加图例。

schedDiag = ScheduleDiagram(model);
legendImg = getLegendSnapshotImage(schedDiag, rpt);
fm = FormalImage(legendImg);
fm.Caption = "Task Diagram Legend";
append(ch, fm);

报告模型和所有引用的模型。为每个图创建一个新的小节，并将该小节添加到章节中。

diagFinder = SystemDiagramFinder(model);
diagFinder.Properties = {'Type', 'block_diagram'};
while hasNext(diagFinder)
    result = next(diagFinder);
    % Create a section for this result
    s = Section(result.Name);
    % Add a schedule diagram
    schedDiag = ScheduleDiagram(result);
    % Legend is included at the beginning of the chapter already
    schedDiag.IncludeLegendSnapshot = false;
    append(s, schedDiag);
    append(s, ExecutionOrder(result));
    append(ch, s);
end
append(rpt, ch);

关闭并查看报告。

close(rpt);
rptview(rpt);

版本历史记录

在 R2024b 中推出

另请参阅

|

主题