Main Content

mlreportgen.report.MATLABVariable.createTemplate

Class: mlreportgen.report.MATLABVariable
Package: mlreportgen.report

Create MATLAB variable template

Syntax

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

Description

template = mlreportgen.report.MATLABVariable.createTemplate(templatePath,type) creates a copy of the MATLAB® variable reporter template specified by type at the templatePath location. You can use the copied template as a starting point to design a custom MATLAB variable 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 MATLAB Variable Template

To use the new template for the MATLAB variable, assign its path to the TemplateSrc property of mlreportgen.report.MATLABVariable.

import mlreportgen.report.*
rpt = Report('My Report','html');
mlvar = MATLABVariable();
template = MATLABVariable.createTemplate...
   ('mytemplates\myMLVar','html');
mlvar.TemplateSrc = template;

Introduced in R2018b