getTitleReporter

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

Создайте генератор отчетов заголовка раздела

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

Синтаксис

reporter = getTitleReporter(section)

Описание

reporter = getTitleReporter(section) создает mlreportgen.report.SectionTitle генератор отчетов, который частично сконфигурирован к:

  • Отформатируйте значение Title свойство mlreportgen.report.Section генератор отчетов задан section.

  • Заполните Title отверстие в Section шаблон генератора отчетов с отформатированным заголовком.

SectionTitle генератор отчетов getImpl метод использует mlreportgen.report.Section.getTitleReporter метод, чтобы отформатировать встроенное содержимое заголовка. Можно использовать mlreportgen.report.Section.getTitleReporter метод, чтобы настроить встроенный формат заголовка можно следующим образом:

  1. Вызовите mlreportgen.report.Section.getTitleReporter метод, чтобы получить SectionTitle по умолчанию генератор отчетов.

  2. Настройте SectionTitle свойства генератора отчетов. Например, задайте источник шаблона, который содержит индивидуально настраиваемые шаблоны заголовка.

  3. Установите Title свойство Section генератор отчетов к индивидуально настраиваемому SectionTitle генератор отчетов.

Можно настроить формат заголовка путем изменения значений по умолчанию их SectionTitle свойства генератора отчетов:

  • TemplateSrc

    Это свойство установлено по умолчанию в Section шаблон генератора отчетов. Библиотека шаблонов этого шаблона содержит названные шаблоны заголовка раздела по умолчанию:

    • SectionTitle1, SectionTitle2, и так далее, для непронумерованных заголовков

    • SectionNumberedTitle1, SectionNumberedTitle2, и так далее, для иерархически пронумерованных заголовков.

    Можно установить это свойство на источник файла шаблона, который содержит пользовательские определения этих шаблонов.

  • TemplateName

    Это свойство установлено по умолчанию в 'SectionNumberedTitle' если Section генератор отчетов Numbered свойством является true (значение по умолчанию). В противном случае это свойство установлено в 'SectionTitle'. Вы не должны изменять эти настройки, если ваша пользовательская библиотека шаблонов настраивает определения стандартных шаблонов заголовка, но не их имена. Например, если ваша библиотека шаблонов содержит шаблон под названием SectionNumberedTitle1 с настроенной версией стандартного определения для SectionNumberedTitle1, вы не должны изменять значение этого свойства.

  • OutlineLevel

    Это свойство пусто по умолчанию. Section генератор отчетов getImpl метод, который вызывает getTitleReporter метод по умолчанию, устанавливает это свойство на уровень раздела когда Section генератор отчетов добавляется к отчету. SectionTitle генератор отчетов затем добавляет значение OutlineLevel свойство к значению TemplateName свойство создать полное имя SectionTitle обработайте по шаблону для уровня раздела, например, SectionNumberedTitle2 для подраздела второго уровня.

  • Содержимое

    Это свойство установлено по умолчанию в значение Section генератор отчетов Title свойство.

  • NumberPrefix

    Это свойство установлено по умолчанию в [].

  • NumberSuffix

    Это свойство установлено в '. ' если Section Numbered свойством является true (значение по умолчанию). В противном случае это свойство установлено в [].

  • Переводы

    Это свойство не установлено по умолчанию. Установите это свойство локализовать префикс номера заголовка раздела и суффиксное содержимое заголовка.

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

развернуть все

Раздел отчета в виде mlreportgen.report.Section объект.

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

развернуть все

Разделите генератор отчетов заголовка, возвращенный как mlreportgen.report.SectionTitle объект.

Примеры

развернуть все

Следующий пример показывает, как использовать пользовательский шаблон, чтобы сгенерировать заголовок уровня один раздел в отчете.

Предположим тот MyCustomTemplate.pdftx содержит настроенную версию стандартного шаблона SectionNumberedTitle1.

Использовать пользовательский шаблон:

  1. Получите SectionTitle генератор отчетов для раздела.

  2. Установите TemplateSrc свойство генератора отчетов к MyCustomTemplate.pdftx и набор OutlineLevel свойство к уровню раздела.

  3. Установите Title свойство Section генератор отчетов к SectionTitle генератор отчетов.

Например:

import mlreportgen.report.*

rpt = Report("myrpt","pdf");

sec = Section("Title","Introduction");
titleRptr = getTitleReporter(sec);
titleRptr.TemplateSrc = "MyCustomTemplate.pdftx";
titleRptr.OutlineLevel = 1;
sec.Title = titleRptr;
add(rpt,sec);
close(rpt);

Смотрите также

| |

Введенный в R2017b

Документация MATLAB Report Generator
Поддержка
Для просмотра документации необходимо авторизоваться на сайте