Main Content

mlreportgen.report.BaseTable.createTemplate

Class: mlreportgen.report.BaseTable
Package: mlreportgen.report

Create table template

Syntax

template = mlreportgen.report.BaseTable.createTemplate(templatePath,type)

Description

template = mlreportgen.report.BaseTable.createTemplate(templatePath,type) creates a copy of the default table reporter template specified by type at the location specified by templatePath. You can use the copied template as a starting point to design a custom table template for your report.

Input Arguments

expand all

Path and file name of the new template, specified as a character vector or string scalar.

Type of template, specified as 'html', 'html-file', 'docx', or 'pdf'.

Output Arguments

expand all

Path and file name of the copy of the template, returned as a string scalar. The file name extension of the template is based on the specified template type. For example, if the type argument is 'pdf', the file name extension is .pdftx.

Examples

Create Title Page Template

Before you run this example, create a copy of the default HTML BaseTable template in the mytemplates folder. Name the copied template myTable.htmtx. Edit the template as desired. To use the new template for the title page, assign its path to the BaseTable TemplateSrc property.

import mlreportgen.report.*
rpt = Report('My Report','html');
table = BaseTable(magic(5));
table.Title = 'Rank 5 Magic Square';
template = BaseTable.createTemplate('mytemplates\myTable','html');
table.TemplateSrc = template;

Introduced in R2017b