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

mlreportgen.report.TitlePage 类

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

封面报告器

全页展开

描述

使用 mlreportgen.report.TitlePage 类的对象为报告添加标题页。

mlreportgen.report.TitlePage 类是一个 handle 类。

类属性

HandleCompatible
true

创建对象

描述

tp = mlreportgen.report.TitlePage 创建使用默认标题页模板的标题页报告器。

示例

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

属性

全部展开

标题页标题，指定为以下值之一：

  • 字符向量或字符串标量

  • DOM 元素对象

  • 1×N 或 N×1 字符串或 DOM 元素对象数组

  • 由字符串、字符向量或 DOM 元素对象组成的 1×N 或 N×1 元胞数组

  • 使用此标题页的 getTitleReporter 方法创建的报告器

示例: tp.Title = "My Report";

属性：

GetAccess
public
SetAccess
public

报告副标题，指定为以下值之一：

  • 字符向量或字符串标量

  • DOM 元素对象

  • 1×N 或 N×1 字符串或 DOM 元素对象数组

  • 由字符串、字符向量或 DOM 元素对象组成的 1×N 或 N×1 元胞数组

  • 报告器通过本标题页的 getSubtitleReporter 方法创建

示例: tp.Subtitle = "Part I";

属性：

GetAccess
public
SetAccess
public

要插入到标题页的图像，指定为以下值之一：

  • 指定图像文件系统路径的字符向量或字符串标量

  • mlreportgen.report.Figure 报告器

  • DOM 元素对象

  • 由图像路径、快照标记或 DOM 元素对象组成的 1×N 或 N×1 的元胞数组

  • 报告器通过本标题页的 getImageReporter 方法创建

表列出了支持的图像格式和文件扩展名。

导入图像格式支持 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 报告。

示例: tp.Image = "reports/imagedir/titleimage.jpg";

属性：

GetAccess
public
SetAccess
public

报告作者，指定为以下值之一：

  • 字符向量或字符串标量

  • DOM 元素对象

  • 1×N 或 N×1 字符串或 DOM 元素对象数组

  • 由字符串、字符向量或 DOM 元素对象组成的 1×N 或 N×1 元胞数组

  • 报告器通过本标题页的 getAuthorReporter 方法创建

如果找不到环境变量用户名，则默认值为空。

示例: TitlePage("Author","John Smith")

属性：

GetAccess
public
SetAccess
public

报告发布者，指定为以下值之一：

  • 字符向量或字符串标量

  • DOM 元素对象

  • 1×N 或 N×1 字符串或 DOM 元素对象数组

  • 由字符串、字符向量或 DOM 元素对象组成的 1×N 或 N×1 元胞数组

  • 报告器通过本标题页的 getPublisherReporter 方法创建

示例: tp.Publisher = "Smith Company";

属性：

GetAccess
public
SetAccess
public

报告发布日期，指定为以下值之一：

  • 字符向量或字符串标量

  • DOM 元素对象

  • 1×N 或 N×1 字符串或 DOM 元素对象数组

  • 由字符串、字符向量、DOM 元素对象组成的 1×N 或 N×1 元胞数组

  • 报告器通过本标题页的 getPubDateReporter 方法创建

示例: tp.PubDate = "April 23, 2017";

属性：

GetAccess
public
SetAccess
public

标题页的页面布局，指定为 mlreportgen.report.ReporterLayout 对象。使用 ReporterLayout 对象的属性来覆盖默认的页面布局属性，例如页面方向。

属性：

GetAccess
public
SetAccess
public

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

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

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

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

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public

方法

全部展开

示例

全部折叠

打开实时脚本

创建使用默认格式的标题页。将标题页添加到报告并查看报告。

import mlreportgen.report.*
rpt = Report("output","pdf");

tp = TitlePage();
tp.Title = "Aircraft Tests";
tp.Subtitle = "Monthly Data";
tp.Image = which("b747.jpg");
tp.Author = "John Smith";
tp.Publisher = "MathWorks";
tp.PubDate = date();

add(rpt,tp);
close(rpt);
rptview(rpt);

The report title page has the title, Aircraft Tests, subtitle, Monthly Data, an image of a Boeing 747, author, John Smith, publisher, MathWorks, and the date.

创建一个使用默认标题格式但将标题颜色更改为红色的标题页。将 Title 属性指定为 DOM Text 对象并将其颜色设置为红色。

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report("output","pdf");
tp = TitlePage;
tp.Title = Text("Aircraft Tests");
tp.Title.Color = "red";

add(rpt,tp);
close(rpt);
rptview(rpt);
打开实时脚本

创建一个覆盖标题属性格式的标题页。将标题字体更改为 24 磅 Arial，将标题文本颜色更改为白色，并使用蓝色背景。任何未指定的样式都使用 mlreportgen.dom.Paragraph 类默认值。

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report("output","pdf");
tp = TitlePage();
title = Paragraph("Aircraft Tests");
title.Style = {HAlign("left"),FontFamily("Arial"),...
         FontSize("24pt"),Color("white"),...
         BackgroundColor("blue"),...
         OuterMargin("0in","0in",".5in","1in"),...
         HAlign("center")};
tp.Title = title;
tp.Subtitle = "Monthly Data";
tp.Image = which("b747.jpg");
tp.Author = "John Smith";
tp.Publisher = "MathWorks";
tp.PubDate = date();

add(rpt, tp);
close(rpt);
rptview(rpt);

TitlePage 对象的模板决定页面方向、页边距、页面大小和其他页面布局属性。您可以使用默认模板的自定义版本来自定义和覆盖标题页布局。您还可以通过自定义这些元素模板来自定义单个标题页元素。TitlePage 报告器支持两种方法来覆盖标题页元素模板。

要使用自定义 TitlePage 模板：

创建默认标题页模板的副本。

在模板副本中根据需要编辑标题页元素模板。模板的名称形式为 TitlePageNAME，其中 NAME 是模板库中模板的名称。例如标题模板名称为 TitlePageTitle。

将对象的 TitlePage TemplateSrc 属性设置为自定义模板的路径。

这种方法利用了这样一个事实：TitlePage 对象使用专门的报告器（称为空位报告器）将元素模板应用于元素。因此，您可以使用 TitlePage 方法让报告器将模板应用于特定元素。例如，getTitleReporter 方法返回用于将 TitlePageTitle 模板应用于报告标题内容的报告器。

将想要自定义的标题页元素模板复制到不同的模板库中。例如，您可以复制报告的模板库或者 DOM 文档部件对象的模板库。这些模板库通常是您创建的用于存储模板自定义版本的库。

对于每个需要自定义的标题页元素，获取其元素报告器。例如，对于标题，使用 getTitleReporter 方法。

将元素报告器的 TemplateSrc 属性设置为包含元素模板自定义版本的模板库的源。

将元素报告器的 Content 属性设置为元素内容。

将标题页对象元素属性设置为元素报告器对象。

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report("MyReport","pdf","MyCustomPDFTemplate");
tp = TitlePage;
titleReporter = getTitleReporter(tp);
titleReporter.TemplateSrc = rpt;
titleReporter.Content = "My Report";
tp.Title = titleReporter;

版本历史记录

在 R2017b 中推出

全部展开

另请参阅

主题