Exponenta Banner
exponenta event banner

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

Поддержка