getTitleReporter

Class: mlreportgen.report.TitlePage
Namespace: mlreportgen.report

Get title page title reporter

Syntax

reporter = getTitleReporter(titlePage)


Description

reporter = getTitleReporter(titlePage) returns a reporter that the TitlePage reporter (titlePage) uses to format the value specified by its Title property. Use getTitleReporter to customize the title alignment, position, and appearance.

Input Arguments

titlePage — Title page of the report

reporter object

Title page of the report, specified as a title page reporter object. To create the tp input, you use mlreportgen.report.TitlePage.

Output Arguments

reporter — Title page title reporter

reporter object

Title page title reporter, returned as a reporter object.

Examples

Use Nondefault Title Page Title Style

1. Create a template file named MyTitlePageTemplate.

2. Customize the TitlePageTitle style.

3. Use getTitleReporter and the TemplateSrc property to use your template.

   import mlreportgen.report.*
   rpt = Report();
   titlePage = TitlePage();
   titlePage.Title = "My Report Title"
   titlePage.Title = getTitleReporter(titlePage);
   titlePage.Title.TemplateSrc = "MyTitlePageTemplate";
   add(rpt,titlePage);
   

Version History

Introduced in R2017b