getSubtitleReporter

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

Get title page subtitle reporter

Syntax

reporter = getSubtitleReporter(titlePage)


Description

reporter = getSubtitleReporter(titlePage) returns a reporter that the TitlePage reporter (titlePage) uses to format the value specified by its Subtitle property. You use getSubtitleReporter to customize the subtitle 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 subtitle reporter

reporter object

Title page subtitle reporter, returned as a reporter object.

Examples

Use Nondefault Title Page Subtitle

1. Create a template file named MyTitlePageTemplate.

2. Customize the SubtitlePageTitle style.

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

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

Version History

Introduced in R2017b