mlreportgen.report.Title class

Пакет: mlreportgen.report
Суперклассы:

Заполните генератор отчетов отверстия заголовка

Описание

Генератор отчетов для других генераторов отчетов, таких как FormalImage, и BaseTable. Эти другие генераторы отчетов используют экземпляры этого Title генератор отчетов, чтобы заполнить отверстия заголовка в их шаблонах. Генераторы отчетов имеют методы, которые возвращают экземпляры этого объекта. Используя эти экземпляры объектов, можно настроить формат содержимого, используемого, чтобы заполнить отверстия в их шаблонах. Например, для BaseTable генератор отчетов, его getTitleReporter метод возвращает экземпляр что BaseTable использование генератора отчетов, чтобы заполнить Title отверстие в его шаблоне. Чтобы настроить формат заголовка, задайте пользовательский шаблон для SectionTitle генератор отчетов возвращен getTitleReporter метод.

Примечание

Генераторы отчетов создают экземпляры этого объекта. Вы не должны создавать этот объект сами.

Свойства

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

ID отверстия, чтобы быть заполненным этим генератором отчетов, заданным как строка.

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

  • Строка или символьный массив

  • Объект DOM

  • 1 N или N-by-1 массив строк или Объектов DOM

  • 1 N или N-by-1 массив ячеек строк, символьных массивов и/или Объектов DOM

Префикс для содержимого заголовка, заданного как строка или символьный массив. Если никакой префикс не задан, префикс заголовка по умолчанию, переведенный на основе локали отчета, используется.

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

Карта перевода для префикса заголовка и суффикса, заданного как структура MATLAB®. Если заданная карта перевода не содержит перевод для локали отчета, Translations свойство использует en как резервная локаль. Смотрите свойство Locale mlreportgen.report.Report для получения информации о допустимых локалях.

Источник шаблона для этого генератора отчетов, заданного одним из этих способов:

  • Вектор символов или скаляр строки, который задает путь файла, который содержит шаблон для этого генератора отчетов

  • Генератор отчетов или отчет, шаблон которого используется в этом генераторе отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

  • Документ DOM или часть документа, шаблон которой используется в этом генераторе отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

Заданный шаблон должен быть тем же типом как отчет, к которому добавлен этот генератор отчетов. Например, для отчета Word Microsoft®, TemplateSrc должен быть шаблон генератора отчетов Word. Если TemplateSrc свойство пусто, этот генератор отчетов использует шаблон генератора отчетов по умолчанию в выходном типе отчета.

Имя шаблона для этого генератора отчетов, заданного как вектор символов или скаляр строки. Шаблон для этого генератора отчетов находится в библиотеке шаблонов источника шаблона (TemplateSrc) для этого генератора отчетов.

Цель гиперссылки для этого генератора отчетов, заданного как строка или символьный массив, который задает ID цели ссылки или mlreportgen.dom.LinkTarget объект. Значение строки или символьного массива преобразовано в LinkTarget объект. Объект цели ссылки сразу предшествует содержимому этого генератора отчетов в выходном отчете.

Введенный в R2018b

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