mlreportgen.report.FormalImage.createTemplate

Class: mlreportgen.report.FormalImage
Package: mlreportgen.report

Create formal image template

Syntax

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

Description

template = mlreportgen.report.FormalImage.createTemplate(templatePath,type) creates a copy of the formal image reporter template specified by type at the templatePath location . You can use the copied template as a starting point to design a custom formal image 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 assigned based on the specified output type. For example, if type is 'pdf', the file name extension is .pdftx.

Examples

Create Formal Image Template

Before you run this example, create a copy of the default HTML Formal Image template in the mytemplates folder. Name the copied template myImage.htmtx. Edit the template as desired. To use the new template for the image, assign its path to the TemplateSrc property of mlreportgen.report.FormalImage.

import mlreportgen.report.*
rpt = Report('My Report','html');
image = FormalImage();
template = FormalImage.createTemplate('mytemplates\myImage','html');
image.TemplateSrc = template;

Introduced in R2017b