getTitleReporter

Класс: mlreportgen.report.ListOfCaptions
Пакет: mlreportgen.report

Получить список подписей title reporter

Синтаксис

titleReporter = getTitleReporter(loc)

Описание

titleReporter = getTitleReporter(loc) возвращает mlreportgen.report.Title reporter, что заданный mlreportgen.report.ListOfCaptions reporter используется для форматирования списка заголовков раздела. Используйте Title reporter, чтобы настроить выравнивание, положение и внешний вид заголовка.

Входные параметры

расширить все

Список подписей reporter, заданный как mlreportgen.report.ListOfCaptions объект.

Выходные аргументы

расширить все

Список титров title reporter, возвращенный как mlreportgen.report.Title объект.

Примеры

расширить все

Предположим, что вы определили пользовательский шаблон для заголовка списка подписей в библиотеке шаблонов шаблона для вашего типа выхода отчета. Чтобы использовать пользовательский шаблон:

  1. Получите репортера заголовка с помощью getTitleReporter.

  2. Установите свойства репортера заголовка. Установите Content свойство текста заголовка, TemplateSrc свойство пути и имени файла шаблона и TemplateName свойство имени пользовательского шаблона для заголовка списка подписей.

  3. Установите Title свойство списка подписей репортера для заголовка репортера.

Например, предположим, что файл шаблона myTemplate.pdftx задает два шаблона для использования со списком заголовков. Один шаблон, ListOfCaptionsTitleRed, использует стиль, который делает заголовок красным. Второй шаблон, ListOfCaptionsTitleBlue, использует стиль, который делает заголовок синим. Этот код применяет шаблон, который делает заголовок синим:

import mlreportgen.report.*
import mlreportgen.dom.*
rpt = Report('myReport','pdf');
open(rpt);

loc = ListOfCaptions;
loc.AutoNumberStreamName = "equation";

titleReporter = getTitleReporter(loc);
titleReporter.Content = "List of Equations";
titleReporter.TemplateSrc = "myTemplate.pdftx";
titleReporter.TemplateName = "ListOfCaptionsTitleBlue";
loc.Title = titleReporter;
append(rpt,loc);

ch = Chapter("Physics Principles")
eq = Equation("e = m * c^2");
eq.DisplayInline = true;
append(ch,eq);
      
p = Paragraph("Equation ");
p.Style = {CounterInc('equation'),WhiteSpace("preserve")};
append(p,AutoNumber("equation"));
append(p," Mass–energy equivalence");
append(ch,p);
append(rpt,ch);

close(rpt);
rptview(rpt);
Введенный в R2020b