Syslab使用手册
⋮
2026a

# generate_report

生成报告

函数库: TyReportGenerator

# 语法

generate_report(doc, doc_file)
generate_report(doc, doc_file, tpl_file)

# 说明

generate_report(doc, doc_file) 生成报告。示例

generate_report(doc, doc_file, tpl_file) 使用模板生成报告。示例

Windows系统中：
generate_report 根据 file_name 的后缀名支持保存为 docx、pdf、html 文件。

Linux系统中：
generate_report 根据 file_name 的后缀名支持保存为 docx 文件。

在 Linux 系统下预览文档和根据 file_name 的后缀名保存 pdf、html 功能需要用户自主安装 libreoffice。libreoffice 预览 docx 文件和生成 pdf、html 文件与和 Windows 有差异：

  • 不支持文本内书签
  • 标题编号颜色、标题样式和 Windows 有差异
  • 生成 html 段落样式和 Windows 有差异，html 打开报错可以尝试切换默认浏览器
  • 不支持在 Linux 下更新文件的页码和目录

# 示例

创建报告

创建报告添加封面、目录和章节。本章节包含两个部分，每个部分包含一个图像。查看报告。

using TyReportGenerator
doc = create_document()
titlepage = create_titlepage(create_text("My Report"))
add_titlepage(doc, titlepage)

tableofcontents = create_tableofcontents()
add_tableofcontents(doc, tableofcontents)

add_heading1(doc, "Images")
pkg_dir = pkgdir(TyReportGenerator)
pic =create_image(joinpath(pkg_dir, "examples/Resources/b747.jpg"))
add_heading(doc, create_heading("Boeing 747"; level=2, children=[pic]))
pic = create_image(joinpath(pkg_dir, "examples/Resources/peppers.png"))
add_heading2(doc, "Peppers")
add_paragraph(doc, pic)

doc_file = joinpath(
    tempdir(), "Generate reports.docx"
);
generate_report(doc, doc_file)
rptview(doc_file)
使用模板生成报告

创建报告添加封面、目录和章节。本章节包含两个部分，每个部分包含一个图像。使用模板生成报告并查看。

using TyReportGenerator
doc = create_document()

add_heading1(doc, "Images")
pkg_dir = pkgdir(TyReportGenerator)
pic = create_image(joinpath(pkg_dir, "examples/Resources/b747.jpg"))
add_heading(doc, create_heading("Boeing 747"; level=2, children=[pic]))
pic = create_image(joinpath(pkg_dir, "examples/Resources/peppers.png"))
add_heading2(doc, "Peppers")
add_paragraph(doc, pic)

doc_file = joinpath(tempdir(), "Generate reports with templates.docx");
tpl_file = joinpath(pkg_dir, "examples/Resources/文档模板-自定义.docx");
generate_report(doc, doc_file, tpl_file)
rptview(doc_file)

# 输入参数

doc — 文档对象
文档对象

用于生成报告的文档对象。

doc_file — 生成的报告文件
字符向量的路径 |字符串标量

生成的报告文件的路径，指定为字符向量或字符串标量。路径是文件系统中存储报表输出文档的位置。路径可以是完整路径，例如 C：/myreports/reportA.docx。路径也可以相对于当前文件夹，例如 reportA.docx。根据路径的后缀名可以选择保存为docx、html、pdf 文件。

tpl_file — 模板文件路径
字符向量的位置 |字符串标量

用于设置此报告格式的模板位置，指定为字符向量或字符串标量。可以使用此属性指定报告的自定义模板。