getSubtitleReporter

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

Get title page subtitle reporter

expand all in page

Syntax

reporter = getSubtitleReporter(tp)

Description

reporter = getSubtitleReporter(tp) returns a reporter that the TitlePage reporter (tp) uses to format the value specified by its Subtitle property. You use getSubtitleReporter to customize the subtitle alignment, position, and appearance.

Input Arguments

expand all

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

Output Arguments

expand all

Title page subtitle reporter, returned as a reporter object.

Examples

Use Nondefault Title Page Subtitle

Create a style for your title page subtitle that differs from the default. Before you run this example, create a template file named MyTitlePageTemplate and customize its SubtitlePageTitle style. Then, use getSubtitleReporter and the TemplateSrc property to use your template.

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

Version History

Introduced in R2017b

See Also

| |