slreportgen.report.ElementDiagram 类

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

元素图快照和标题报告器

全页展开

描述

创建 Simulink^® 或 Stateflow^® 元素图报告器。当添加到报告中时，ElementDiagram 报告器会创建元素的快照。报告器将快照以带有标题的图像形式添加到报告中。使用 Source属性指定所需的元素。

注意

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

slreportgen.report.ElementDiagram 类是 handle 类。

创建对象

描述

diagram = ElementDiagram 创建一个空的元素图报告器。设置其属性以捕获 Simulink 或 Stateflow 元素快照。

示例

diagram = ElementDiagram(source) 为 source 指定的模块图或图元素创建图报告器。将此报告器添加到报告将创建元素图的快照，并将带有标题的快照添加到报告中。快照图像文件存储在报告的临时文件夹中。关闭报告时，图像文件将被复制到报告中，并且临时文件夹将被删除。为了防止删除，请使用报告的 Debug 属性。请参阅 mlreportgen.report.Report。

示例

输入参量

全部展开

`source` — 图元素源
字符向量 | 字符串标量 | 句柄 | 对象 | `slreportgen.finder.DiagramElementResult` 对象

请参阅 Source 属性。

属性

全部展开

`Source` — 图元素源
字符向量 | 字符串标量 | 句柄 | 对象 | `slreportgen.finder.DiagramElementResult` 对象

图元素源，指定为以下值之一：

包含 Simulink 模块或 Stateflow 图模块路径的字符向量或字符串标量
Simulink 模块或 Stateflow 图模块的句柄
Stateflow 对象
Simulink 模块、注解或 Stateflow 对象的标识符 (SID)
slreportgen.finder.DiagramElementResult 对象

注意

Simulink.Port 对象不是该报告器的有效来源。

`Snapshot` — 快照报告器
`mlreportgen.report.FormalImage` 对象

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

注意

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

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

`SnapshotFormat` — 快照图像格式
`"svg"` (默认) | `"emf"` | `"gif"` | `"jpg"` | ...

快照图像格式，指定为以下格式之一：

导入图像格式	支持 HTML	支持 Word	支持 PDF	支持 PDF/A 格式 (自 R2025a 起)
Windows^® 元文件 (`.emf`)	否	是	否	否
图形交换格式 (`.gif`)	是	是	是	是
JPEG 图像 (`.jpg`)	是	是	是	否
PDF (`.pdf`)	否	否	是	否
PDF/A (`.pdf`)	否	否	是	否
可移植网络图形 (`.png`)	是	是	是	是
可缩放矢量图 (`.svg`)	是	是	是	是
TIFF 图像 (`.tif`)	否	是	是	是

注意

与 PDF 报告输出格式不同，PDF/A 格式不支持包含 PDF 或 PDF/A 图像。使用表中列出的图像格式之一将图像包含在 PDF/A 报告中。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`Scaling` — 快照图像的缩放选项
`"auto"` (默认) | `"custom"` | `"zoom"`

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

"auto" - 对于 PDF 或 Word (DOCX) 输出，使用此选项可缩放快照图像以适合当前页面布局，同时保持其纵横比。首先，报告器将快照图像缩放至页面宽度。如果图像高度超出了页面高度，报告器会再次缩小图像。这种额外的缩放可确保图像适合当前页面，并有额外一英寸的间距。缩放不适用于 HTML 输出。
"custom" - 使用此选项可根据 Height 和 Width 属性的值缩放快照图像。
"zoom" - 将元素图像尺寸放大或缩小到 Zoom 属性指定的百分比值。要指定最大图像高度和最大图像宽度，请分别使用 MaxHeight 和 MaxWidth 属性。

注意

"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 属性值。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`Height` — 快照图像的高度
`"6in"` (默认) | 字符向量 | 字符串标量

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

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 像素
"pt" - 点

注意

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

示例: "2in"

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`Width` — 快照图像的宽度
`"6.5in"` (默认) | 字符向量 | 字符串标量

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

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 像素
"pt" - 点

注意

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

示例: "2in"

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`Zoom` — 快照图像缩放量
`"100%"` (默认) | 字符向量 | 字符串标量

快照图像的缩放量，指定为字符串。Zoom 格式为 "value%" ，其中 value 是快照图像放大或缩小的百分比。

示例: "100%"

数据类型: char | string

`MaxHeight` — 缩放比例的最大高度
`"6in"` (默认) | 字符向量 | 字符串标量

缩放比例的最大高度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"10px" 指定 10 像素。有效的缩写为：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 像素
"pt" - 点

注意

此属性仅在 Scaling 设置为 "zoom" 时适用。

示例: "5in"

数据类型: char | string

`MaxWidth` — 缩放比例的最大宽度
`"6.5in"` (默认) | 字符向量 | 字符串标量

缩放比例的最大宽度，指定为字符向量或字符串标量，其中包含一个数字后跟一个测量单位的缩写。例如，"10px" 指定 10 像素。有效的缩写为：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 像素
"pt" - 点

注意

此属性仅在 Scaling 设置为 "zoom" 时适用。

示例: "5in"

数据类型: char | string

`TemplateSrc` — 此报告器的模板来源
字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部分

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

字符向量或字符串标量，指定包含此报告器模板的文件的路径
此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告
文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

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

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`true`

`TemplateName` — 此报告器的模板名称
字符向量 | 字符串标量

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

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`LinkTarget` — 此报告器的超链接目标
`[]` (默认) | 字符向量 | 字符串标量 | `mlreportgen.dom.LinkTarget` 对象

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

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

方法

全部展开

公共方法

`slreportgen.report.ElementDiagram.createTemplate`	创建元素图模板
`slreportgen.report.ElementDiagram.customizeReporter`	创建自定义元素图报告器类
`slreportgen.report.ElementDiagram.getClassFolder`	元素图类定义文件位置
`getSnapshotImage`	元素图快照图像文件位置
`copy`	创建 Simulink 报告器对象的副本并对某些属性值进行深度复制
`getImpl`	获取报告器的实施

示例

全部折叠

添加元素图和标题

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

openExample('f14')

rpt = slreportgen.report.Report("output","pdf");
open(rpt)
chap = Chapter();
chap.Title = "Element Diagram Reporter Example";

diag = ElementDiagram("f14/Actuator Model");
diag.Snapshot.Caption = "f14 Simulink Model - Actuator Model block";

add(chap,diag)
add(rpt,chap)

close(rpt)
rptview(rpt)

Element diagram with caption that reads f14 Simulink Model - Actuator Model block

添加元素图和属性表

openExample('f14')
modelsys = "f14/Aircraft Dynamics Model";

rpt = slreportgen.report.Report("output","pdf");
open(rpt)
chapter = mlreportgen.report.Chapter();
chapter.Title = "Element Snapshots";

diag = slreportgen.report.ElementDiagram(modelsys);
add (chapter,diag)

blkfinder = slreportgen.finder.BlockFinder(modelsys);
blks = find(blkfinder);
for blk = blks
   blkDiag = slreportgen.report.ElementDiagram...
       (blk.Object);
   blkDiag.Snapshot.Caption = strcat(blk.DiagramPath,...
       "/", blk.Name);
   add(chapter,blkDiag)   % Add diagram element image
   add(chapter,blk)       % Add property table
end

add(rpt,chapter)
close(rpt)
rptview(rpt)

Element diagram followed by property table

版本历史记录

在 R2018b 中推出

全部展开

R2024b: 删除 BMP 以进行图像输出

报告生成器不再支持 BMP（位图）作为输出图像格式。这会影响报表资源管理器和报表、DOM 和 PPT API 中的快照、文件中的图像和水印。请参阅 print 以了解详细信息。

R2019b: 对于所有报告类型，`SnapshotFormat` 的默认值均为 `'svg'`

从 R2019b 开始，Word 报告支持可缩放矢量图形 (SVG) 图像。对于所有报告类型（HTML、PDF 和 Word），SnapshotFormat 属性的默认值为 'svg'，而 'auto' 属性值表示 'svg'。在以前的版本中，SnapshotFormat 属性的默认值为 'auto'，对于 HTML 和 PDF 报告，它表示为 'svg'；对于 Word 报告，它表示为 'emf' 或 'png'，具体取决于平台。

包含 SVG 图像的 Word 报告需要 Word 2016 或更高版本。在 MATLAB R2019b 或更高版本中，要生成与早期版本的 Word 兼容的图像的报告，请将 SnapshotFormat 属性设置为 'svg' 以外的值。要指定 MATLAB 早期版本中默认使用的图像格式，请将 SnapshotFormat 设置为：

"emf" 适用于 Windows 平台
"png" 适用于 UNIX^® 或 Mac 平台

另请参阅

slreportgen.report.ElementDiagram 类

描述

创建对象

描述

输入参量

source — 图元素源 字符向量 | 字符串标量 | 句柄 | 对象 | slreportgen.finder.DiagramElementResult 对象

属性

Source — 图元素源 字符向量 | 字符串标量 | 句柄 | 对象 | slreportgen.finder.DiagramElementResult 对象

Snapshot — 快照报告器 mlreportgen.report.FormalImage 对象

属性：

SnapshotFormat — 快照图像格式 "svg" (默认) | "emf" | "gif" | "jpg" | ...

属性：

Scaling — 快照图像的缩放选项 "auto" (默认) | "custom" | "zoom"

属性：

Height — 快照图像的高度 "6in" (默认) | 字符向量 | 字符串标量

属性：

Width — 快照图像的宽度 "6.5in" (默认) | 字符向量 | 字符串标量

属性：

Zoom — 快照图像缩放量 "100%" (默认) | 字符向量 | 字符串标量

MaxHeight — 缩放比例的最大高度 "6in" (默认) | 字符向量 | 字符串标量

MaxWidth — 缩放比例的最大宽度 "6.5in" (默认) | 字符向量 | 字符串标量

TemplateSrc — 此报告器的模板来源 字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部分

属性：

TemplateName — 此报告器的模板名称 字符向量 | 字符串标量

属性：

LinkTarget — 此报告器的超链接目标 [] (默认) | 字符向量 | 字符串标量 | mlreportgen.dom.LinkTarget 对象

属性：

方法

公共方法

示例

添加元素图和标题

添加元素图和属性表

版本历史记录

R2024b: 删除 BMP 以进行图像输出

R2019b: 对于所有报告类型，SnapshotFormat 的默认值均为 'svg'

另请参阅

主题

`source` — 图元素源
字符向量 | 字符串标量 | 句柄 | 对象 | `slreportgen.finder.DiagramElementResult` 对象

`Source` — 图元素源
字符向量 | 字符串标量 | 句柄 | 对象 | `slreportgen.finder.DiagramElementResult` 对象

`Snapshot` — 快照报告器
`mlreportgen.report.FormalImage` 对象

`SnapshotFormat` — 快照图像格式
`"svg"` (默认) | `"emf"` | `"gif"` | `"jpg"` | ...

`Scaling` — 快照图像的缩放选项
`"auto"` (默认) | `"custom"` | `"zoom"`

`Height` — 快照图像的高度
`"6in"` (默认) | 字符向量 | 字符串标量

`Width` — 快照图像的宽度
`"6.5in"` (默认) | 字符向量 | 字符串标量

`Zoom` — 快照图像缩放量
`"100%"` (默认) | 字符向量 | 字符串标量

`MaxHeight` — 缩放比例的最大高度
`"6in"` (默认) | 字符向量 | 字符串标量

`MaxWidth` — 缩放比例的最大宽度
`"6.5in"` (默认) | 字符向量 | 字符串标量

`TemplateSrc` — 此报告器的模板来源
字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部分

`TemplateName` — 此报告器的模板名称
字符向量 | 字符串标量

`LinkTarget` — 此报告器的超链接目标
`[]` (默认) | 字符向量 | 字符串标量 | `mlreportgen.dom.LinkTarget` 对象

R2019b: 对于所有报告类型，`SnapshotFormat` 的默认值均为 `'svg'`