创建报告容器
创建报告 API 对象来保存内容
每个报告 API 程序都必须创建一个 mlreportgen.report.Report
对象来保存报告内容。使用 mlreportgen.report.Report
构造函数创建 Report
对象。
如果使用不带参量的构造函数,则构造函数将在当前文件夹中创建一个名为 untitled.pdf
的 PDF 文档。要指定名称和位置,请使用报告的路径名作为构造函数的第一个参量。
您可以使用 type
参量指定要生成的报告类型。您可以指定类型为:
"docx"
- Microsoft® Word 文档。"html"
- HTML 报告,打包为一个压缩文件,包含报告的 HTML 文件、图像、样式表和 JavaScript® 文件。要将 HTML 报告生成为包含解压文件的文件夹,请将PackageType
属性设置为"unzipped"
或"both"
。"html-file"
- HTML 报告,由一个 HTML 文件组成,该文件包含报告的文本、样式表、JavaScript 和 base64 编码的图像。"pdf"
- PDF 文件。"pdfa"
- PDF/A 文件。 (自 R2025a 起)
此 Report
构造函数为 Word 输出创建一个名为 myReport
的文档对象。
d = Report("myReport","docx");
使用 templatePath
参量,您可以指定自定义模板的路径名,作为格式化报告的基础。如果您希望根据定义报告外观和结构体的自定义模板来创建报告,请指定模板路径。模板类型必须与文档类型匹配。例如,此报告构造函数使用模板 myWordTemplate.dotx
为 Word 输出创建报告对象。
d = Report("myReport","docx","myWordTemplate");
创建 DOM 文档对象来保存内容
如果您打算单独使用 DOM API(即不使用报告 API 对象)来生成报告,则必须创建一个 mlreportgen.dom.Document
对象来保存报告内容。使用 mlreportgen.dom.Document
构造函数创建 Document
对象。
如果使用不带参量的构造函数,DOM API 会在当前文件夹中创建一个名为 Untitled.htmx
的 HTML 文档。要指定名称和位置,请使用报告的路径名作为构造函数的第一个参量。
您可以使用 type
参量指定要生成的报告类型。您可以指定类型为:
"docx"
用于 Microsoft Word"html"
用于 HTML 输出"html-file"
用于单文件 HTML 输出"html-multipage"
用于多页 HTML 输出 (自 R2024a 起)"pdf"
用于 PDF 输出"pdfa"
用于 PDF/A 输出 (自 R2025a 起)
此 Document
构造函数为 Word 输出创建一个名为 myReport
的文档对象。
d = Document("myReport","docx");
使用 templatePath
参量,您可以指定要用作格式化报告基础的模板的路径名。如果您希望根据定义报告外观和结构体的自定义模板来创建报告,请指定模板路径。模板类型必须与文档类型匹配。例如,此 Document
构造函数使用模板 myWordTemplate.dotx
为 Word 输出创建一个文档对象。
d = Document("myReport","docx","myWordTemplate");