mlreportgen.dom.Watermark 类

命名空间: mlreportgen.dom

在 PDF 报告各个节的页面上添加水印

描述

创建一个水印对象，您可以将其添加到 PDF 报告的一个节。水印是出现在页面背景中的图像，例如字样草稿或机密。它会在您应用它的每个页面上的文本后面运行。您可以使用以下任意文件类型：.bmp、.jpg、.png、.svg 和 .tiff。

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

创建对象

描述

wm = Watermark(image) 根据指定的图像创建一个 Watermark 对象，并返回一个 Watermark 对象。

示例

输入参量

全部展开

`image` — 用作水印的图像
路径名

用作水印的图像，指定为图像路径名。使用以下任意文件类型：

.bmp
.jpg
.pdf（仅适用于 PDF 输出类型）
.png
.svg
.tiff

属性

全部展开

`Height` — 水印高度
字符向量

形式为 valueUnits 的字符向量。使用下列任意值作为单位：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

或者，您可以使用 Watermark.Style 属性指定高度。例如：

Watermark.Style = {Height('4in')};

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

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

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

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

属性：

NonCopyable true

数据类型: cell

`Width` — 水印宽度
字符向量

水印宽度，指定为 valueUnits 形式的字符向量。使用下列任意值作为单位：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

或者，您可以使用 Watermark.Style 属性指定宽度。例如：

Watermark.Style = {Width('4in')};

`Tag` — `mlreportgen.dom.Watermark` 对象的标签
字符向量 | 字符串标量

mlreportgen.dom.Watermark 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable true

数据类型: char | string

`Id` — `mlreportgen.dom.Watermark` 对象的标识符
字符向量 | 字符串标量

mlreportgen.dom.Watermark 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable true

数据类型: char | string

示例

全部折叠

创建并插入水印

打开脚本

此示例显示如何以编程方式创建水印，然后将其应用于当前布局。以编程方式创建水印简化了文件管理，因为您不需要存储图像文件并跟踪其位置。

使用 MATLAB® 命令，以编程方式创建图像文件。使用 SVG 图像文件可以在图像缩放时保持分辨率。将图像写入文件后，您可以删除该图窗。

 wmname = 'wm';
 wmtype =  'svg';
 wmfilename = [wmname '.' wmtype];

 subplot('Position',[0, 0, 1, 1]);
 axis('off');
 text(0.25, 0.25,'Draft', ...
   'Rotation', 45, ...
   'Color', [0.85, 0.85, 0.85], ...
   'FontSize',72);

  print(wmfilename, ['-d' wmtype]);
  delete(gcf);

创建水印对象 wm 并将其应用于当前页面布局。生成报告后，您可以删除变量 wmfilename 指定的图像文件。

import mlreportgen.dom.*;

d = Document('myreport','pdf');
open(d);

wm = Watermark(wmfilename);
wm.Width = '12in';
wm.Height = [];

d.CurrentPageLayout.Watermark = wm;

append(d,'Hello');
append(d, PageBreak);
append(d,'World');

close(d);
rptview(d.OutputPath);
delete(wmfilename);