getTitleReporter

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

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

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

Синтаксис

reporter = getTitleReporter(section)

Описание

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

  • Формат значения Title свойство mlreportgen.report.Section репортер, заданный section.

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

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

  1. Активируйте mlreportgen.report.Section.getTitleReporter метод для получения SectionTitle по умолчанию репортер.

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

  3. Установите Title свойство Section репортер в настраиваемый SectionTitle репортер.

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

  • TemplateSrc

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

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

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

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

  • TemplateName

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

  • OutlineLevel

    По умолчанию это свойство пустое. The Section репортер getImpl метод, который вызывает getTitleReporter метод по умолчанию устанавливает это свойство на уровень сечения, когда Section репортер добавлен в отчет. The SectionTitle reporter затем добавляет значение 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

Поддержка

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