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

mlreportgen.dom.HTMLPage 类

命名空间: mlreportgen.dom

创建多页 HTML 文档的单个 HTML 页面

自 R2024a 起

全页展开

描述

在多页 HTML 文档中创建单个 HTML 页面。将任何文档对象模型 (DOM) API 内容对象（例如 Text、Paragraph、Image、Table）添加到 HTMLPage 对象。

注意

您只能将 HTMLPage 对象添加到 html-multipage 类型的 DOM 文档。

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

类属性

HandleCompatible
true

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

创建对象

描述

htmlPageObj = mlreportgen.dom.HTMLPage 创建一个空的 HTMLPage 对象，该对象生成一个 HTML 文件。默认情况下，文件名是 Document 名称加上页码，但第一页除外，第一页是 root.html。使用其 append 方法将内容添加到 HTML 页面。当添加到类型为 html-multipage 的 DOM Document 时，API 会生成一个 HTML 文件，该文件对应于多页 HTML 报告中的单个页面。

示例

htmlPageObj = mlreportgen.dom.HTMLPage(fileName) 还指定了 fileName。

htmlPageObj = mlreportgen.dom.HTMLPage(fileName,templatePath) 还指定自定义模板 templatePath。

htmlPageObj = mlreportgen.dom.HTMLPage(fileName,domObj) 还指定 domObj 作为页面内容。

属性

全部展开

生成的 HTML 文件的名称，指定为字符向量或字符串标量。如果不指定此属性，该函数将采用 DOM Document 对象的文件名并追加 HTML 页面的页码。例如，如果多页 HTML 文档名称为 myreport，则报告的第二页为 myreport_2.html。报告的第一页始终具有名称 root.html。

如果文件名未指定扩展名，则使用 .html 作为生成的 HTML 文件的扩展名。如果文件名指定了扩展名，则必须是 .html。如果指定了除 .html 之外的任何扩展，则会引发错误。

示例: "myreport.html"

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

页面模板的路径，指定为字符向量或字符串标量。默认情况下，该属性指定默认多页 HTML 模板 default_multipage.htmtx 的路径，其主体包含三个空位：

  • "NavBarTop" 指定页面顶部的导航栏。

  • "Content" 指定页面内容。

  • "NavBarBottom" 指定页面底部的导航栏。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

此对象的子对象，指定为文档元素对象数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

打开实时脚本

创建多页 HTML 报告。

导入 DOM API 包，这样您就不必使用完全限定的类名。

import mlreportgen.dom.*

创建多页 HTML 文档。

d = Document("myreport","html-multipage");
open(d);

创建第一个带有图像的 HTML 页面。

page1 = HTMLPage;
append(page1,Heading1("Chapter 1. Image"));
img = Image(which("ngc6543a.jpg"));
img.Height = "4in";
img.Width = "4in";
append(page1,img);
append(d,page1);

创建带有表的第二个 HTML 页面。

page2 = HTMLPage;
append(page2,Heading1("Chapter 2. Table"));
tbl = Table(magic(5));
tbl.Border = "solid";
tbl.RowSep = "solid";
tbl.ColSep = "solid";
tbl.Width = "100%";
append(page2,tbl);
append(d,page2);

创建带有嵌套列表的第三个 HTML 页面。

page3 = HTMLPage();
append(page3,Heading1("Chapter 3. List"));
append(page3,UnorderedList({"a", "b", "c", {1,2,3}, "d"}));
append(d,page3);

关闭并查看报告。

close(d);
rptview(d);

版本历史记录

在 R2024a 中推出

另请参阅