slreportgen.report.MATLABFunction.createTemplate

Class: slreportgen.report.MATLABFunction
Package: slreportgen.report

Create MATLAB Function reporter template

Syntax

template = createTemplate(templatePath,type)

Description

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

Input Arguments

expand all

Location of the reporter template, specified as a character vector, character array, or template source object.

Format for the output, specified as 'html', 'html-file', 'docx', or 'pdf'. If you specify a template using the templatePath property, the value for type must match the template type.

Output Arguments

expand all

Name of template, returned as the path and file name of the template. The template file name extension is assigned based on the specified output type. For example, for PDF output, the template name has a .pdftx file extension.

Examples

Create MATLAB Function Reporter Template

Before you run this example, create a copy of the default HTML MATLAB Function template in the mytemplates folder. Name the copied template myMFunction.htmtx. Edit the template as desired. To use the new template for the image, assign its path to the TemplateSrc property of slreportgen.report.MATLABFunction.

import mlreportgen.report.*
import slreportgen.report.*
rpt = Report('My Report','html');
mfunction = MATLABFunction();
template = MATLABFunction.createTemplate...
     ('mytemplates\myMFunction','html');
mfunction.TemplateSrc = template;

Introduced in R2018a