mlreportgen.dom.Image 类

命名空间: mlreportgen.dom

报告中要包含的图像

描述

使用 mlreportgen.dom.Image 类的对象将图像包含在报告中。

要了解可以将 mlreportgen.dom.Image 对象追加到哪些 DOM 对象，请参阅将 mlreportgen.dom.Image 对象追加到 DOM 类对象上。

mlreportgen.dom.Image 类是一个 handle 类。

类属性

`ConstructOnLoad`	`true`
`HandleCompatible`	`true`

有关类属性的信息，请参阅类属性。

创建对象

描述

imageObj = mlreportgen.dom.Image(imagePath) 创建一个 mlreportgen.dom.Image 对象，并将 Path 属性设置为图像的路径。

注意

当文档关闭时，指定图像文件的内容将被复制到输出文档中。关闭文档之前请勿删除或覆盖图像文件。如果在循环中创建图像文件和相应的 mlreportgen.dom.Image 对象，则对于每次循环迭代，请为该图像文件使用唯一的文件名。

示例

输入参量

全部展开

`imagePath` — 图片文件路径
字符向量 | 字符串标量

报告中要包含的图像文件的路径，指定为字符向量或字符串标量。您可以使用下面这些图像格式。

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

注意

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

属性

全部展开

`Path` — 图片文件路径
字符向量 | 字符串标量

图像文件的路径，指定为字符向量或字符串标量。

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`
`Transient`	`true`

数据类型: char | string

`Height` — 图像高度
字符向量 | 字符串标量

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

不使用缩写 - 像素
px - 像素
cm - 厘米
in - 英寸
mm - 毫米
pc - 派卡
pt - 磅
% - 百分比

当您创建 mlreportgen.dom.Image 对象时，此属性最初设置为基于 Path 属性指定的图像文件的值。

如果设置了 mlreportgen.dom.Image 对象的 Style 属性，则样式高度将覆盖此属性值。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Width` — 图像宽度
字符向量 | 字符串标量

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

不使用缩写 - 像素
px - 像素
cm - 厘米
in - 英寸
mm - 毫米
pc - 派卡
pt - 磅
% - 百分比

当您创建 mlreportgen.dom.Image 对象时，此属性最初设置为基于 Path 属性指定的图像文件的值。

如果设置了 mlreportgen.dom.Image 对象的 Style 属性，则样式宽度将覆盖此属性值。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Map` — 图像中超链接区域的地图
`[]` (默认) | `mlreportgen.dom.ImageMap` 对象

此图像中的超链接区域图，指定为 mlreportgen.dom.ImageMap 对象。Map 属性仅适用于 HTML 和 PDF 报告。

请参阅创建图像映射。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`EmbedSVG` — 是否嵌入 SVG 文件
`0` (`false`) (默认) | 逻辑值 `1` (`true`)

是否嵌入 SVG 文件，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 生成的 HTML 报告文件中包含一份 SVG 文件的副本。您可以搜索图片，但依赖 CSS 格式的 SVG 图片可能会显示不正确。
0 (false) - 该报告使用 CSS 渲染 SVG 图像。您无法搜索图片。

注意

EmbedSVG 属性仅适用于 HTML 报告。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: logical

`StyleName` — 样式表定义样式的名称
`[]` (默认) | 字符向量 | 字符串标量

样式表中定义的样式名称，指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了该元素在输出文档中的外观，除非该元素的 Style 属性指定的格式覆盖了该样式。要了解有关使用样式表的更多信息，请参阅使用样式表样式。

注意

Microsoft^® Word 报告会忽略文档模板中未定义的样式名称。有关 Microsoft Word 模板的详细信息，请参阅DOM API 报告程序模板。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Style` — 格式设定
`{}` (默认) | DOM 格式对象元胞数组

此文档元素对象的格式规范，指定为 DOM 格式对象元胞数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此文档元素对象的格式将被忽略。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: cell

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Parent` — 此对象的父对象
文档元素对象

此对象的父对象，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Children` — 忽略此属性
不适用

该类忽略此属性。

属性：

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Tag` — 标签
字符向量 | 字符串标量

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

`Id` — 目标标识符
字符向量 | 字符串标量

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

数据类型: char | string

方法

全部展开

公共方法

方法	用途
`append`	不要使用此方法。将内容追加到 `mlreportgen.dom.Image` 对象不会对生成的输出产生任何影响。
`clone`	`copiedObj = clone(soureceObj)` 返回 `soureceObj` 指定的 `mlreportgen.dom.Image` 对象的副本。副本包含源对象的子级，但不包含父级。注意请勿将同一对象多次追加到文档中。当您希望在文档的其他位置重用相同内容时，请使用克隆功能创建副本。输入参量 `soureceObj` - 要克隆的对象，指定为 `mlreportgen.dom.Image` 对象返回值 `copiedObj` - 对象副本，以 `mlreportgen.dom.Image` 对象形式返回有关详细信息，请参阅 `mlreportgen.dom.Paragraph` 类的等效方法 `clone`。

方法

用途

append

不要使用此方法。将内容追加到 mlreportgen.dom.Image 对象不会对生成的输出产生任何影响。

clone

copiedObj = clone(soureceObj) 返回 soureceObj 指定的 mlreportgen.dom.Image 对象的副本。副本包含源对象的子级，但不包含父级。

注意

请勿将同一对象多次追加到文档中。当您希望在文档的其他位置重用相同内容时，请使用克隆功能创建副本。

输入参量

soureceObj - 要克隆的对象，指定为 mlreportgen.dom.Image 对象

返回值

copiedObj - 对象副本，以 mlreportgen.dom.Image 对象形式返回

有关详细信息，请参阅 mlreportgen.dom.Paragraph 类的等效方法 clone。

示例

全部折叠

在报告中包含图像

打开实时脚本

使用 mlreportgen.dom.Image 对象指定您想要包含在报告中的图像。通过将 Image 对象追加到报告来将图像包含在报告中。

导入 DOM 命名空间，这样您就不必使用长而完全限定的类名。

import mlreportgen.dom.*

创建报告并使用 mlreportgen.dom.Paragraph 对象为图像添加标题。

d = Document("myImageReport","docx");

p = Paragraph("Plot 1");
p.Bold = true;
append(d,p);

将图保存为图像文件。

x = 0:pi/100:2*pi;
y = sin(x);
plot(x,y);

saveas(gcf,"myPlot_img.png");

Figure contains an axes object. The axes object contains an object of type line.

创建一个指定图像文件路径的 mlreportgen.dom.Image 对象。指定宽度和高度为 4 英寸。将 Image 对象追加到报告中。

plot1 = Image("myPlot_img.png");
plot1.Width = "4in";
plot1.Height = "4in";
append(d,plot1);

关闭并查看报告。

close(d);
rptview(d);

以下是生成的报告中的图像：

详细信息

全部展开

将 `mlreportgen.dom.Image` 对象追加到 DOM 类对象上

您可以将 mlreportgen.dom.Image 对象追加到以下这些 DOM 类对象：

提示

要在报告中插入带题注的图片或图表，请使用 mlreportgen.report.FormalImage 或 mlreportgen.report.Figure。

版本历史记录

在 R2014b 中推出

全部展开

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

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

R2019b: Word 报告的 SVG 图像支持

从 R2019b 开始，您可以在 Word 报告中包含可缩放矢量图 (SVG) 图像。包含 SVG 图像的 Word 报告需要 Microsoft Word 2016 或更高版本。要生成与早期版本的 Word 兼容的图像报告，请从 SVG 以外格式的图像创建 mlreportgen.dom.Image 对象。

另请参阅

mlreportgen.dom.ScaleToFit | mlreportgen.dom.ImageMap | mlreportgen.dom.ImageArea | mlreportgen.dom.Width | mlreportgen.dom.Height

mlreportgen.dom.Image 类

描述

类属性

创建对象

描述

输入参量

imagePath — 图片文件路径 字符向量 | 字符串标量

属性

Path — 图片文件路径 字符向量 | 字符串标量

属性：

Height — 图像高度 字符向量 | 字符串标量

属性：

Width — 图像宽度 字符向量 | 字符串标量

属性：

Map — 图像中超链接区域的地图 [] (默认) | mlreportgen.dom.ImageMap 对象

属性：

EmbedSVG — 是否嵌入 SVG 文件 0 (false) (默认) | 逻辑值 1 (true)

属性：

StyleName — 样式表定义样式的名称 [] (默认) | 字符向量 | 字符串标量

属性：

Style — 格式设定 {} (默认) | DOM 格式对象元胞数组

属性：

CustomAttributes — 文档元素的自定义属性 [] (默认) | mlreportgen.dom.CustomAttribute 对象数组

属性：

Parent — 此对象的父对象 文档元素对象

属性：

Children — 忽略此属性 不适用

属性：

Tag — 标签 字符向量 | 字符串标量

属性：

Id — 目标标识符 字符向量 | 字符串标量

属性：

方法

公共方法

示例

在报告中包含图像

详细信息

将 mlreportgen.dom.Image 对象追加到 DOM 类对象上

提示

版本历史记录

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

R2019b: Word 报告的 SVG 图像支持

另请参阅

主题

`imagePath` — 图片文件路径
字符向量 | 字符串标量

`Path` — 图片文件路径
字符向量 | 字符串标量

`Height` — 图像高度
字符向量 | 字符串标量

`Width` — 图像宽度
字符向量 | 字符串标量

`Map` — 图像中超链接区域的地图
`[]` (默认) | `mlreportgen.dom.ImageMap` 对象

`EmbedSVG` — 是否嵌入 SVG 文件
`0` (`false`) (默认) | 逻辑值 `1` (`true`)

`StyleName` — 样式表定义样式的名称
`[]` (默认) | 字符向量 | 字符串标量

`Style` — 格式设定
`{}` (默认) | DOM 格式对象元胞数组

`CustomAttributes` — 文档元素的自定义属性
`[]` (默认) | `mlreportgen.dom.CustomAttribute` 对象数组

`Parent` — 此对象的父对象
文档元素对象

`Children` — 忽略此属性
不适用

`Tag` — 标签
字符向量 | 字符串标量

`Id` — 目标标识符
字符向量 | 字符串标量

将 `mlreportgen.dom.Image` 对象追加到 DOM 类对象上